PRODUCT
Follow

In-Stream Ad Object Definition

Note

Note: The Required column includes the following values:

  • Required: The field must be included in the POST call.

  • Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.

  • Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.

  • Internal: (For Sizmek Ad Suite (SAS) internal use) If the field was received in the GET call, include it in the PUT call.

Parameter

Description

Type

Required

Notes

type

Type of entity.

String

Required

InStreamAd

templateData

VAST template info

templateData Object

Read-only

linears

List of the ad's linear assets.

Array of linear Object or Array of adAssetFolder Object

Required

linearSettings

Settings related to the linear assets.

linearSettings Object

Optional

nonLinears

Internal.

Internal

Internal

companions

List of companion assets.

Array of companion Objects

Optional

advancedCompanions

List of advanced companion ads.

Array of advancedCompanion Objects

Optional

deliveryType

Determines how to deliver the video.

String

Optional

enhanced

Indicates whether this is an enhanced In-Stream Ad (relevant to non-VPAID ads).

Boolean

Optional

Default value: False

vpaid

Instructs the platform to convert VAST linear ads into VPAID units when served on sites that support Flash VPAID or HTML5 VPAID. By serving the VPAID units on certified sites, SAS can add either their own or 3rd party Verification and Viewability scripts, without the need for a creative developer to produce a VPAID creative. For sites that do not support VPAID, the linear VAST video ads are served as is.

String

Read-only

additionalAssets

List of additional assets used by the ad.

Array of additionalAsset Objects

Optional

customInteractions

List of custom interactions defined on the ad and its assets.

Array of adCustomInteraction Objects

Optional

Can get ANY implementations of AdCustomInteraction.

performAutoVideoTranscoding

Whether to perform auto-transcoding on the ad's video assets.

Boolean

Optional

Default value: True

adTranscodingStatus

Indicates the status of the auto-transcoding process of the ad.

String

Read-only

variables

List of ad variables.

Array of variable Object

Optional

authoringTool

Authoring tool used to create the ad.

String

Read-only

minFlashVersion

Minimum version of Flash required to play the ad.

Double

Read-only

mxpVersion

Version of the Multimedia Extension Package (MXP) file.

String

Read-only

osVersion

Version of the operating system.

String

Read-only

asVersion

Minimum version of ActionScript required to play the ad.

String

Read-only

flashIDE

Legacy field.

String

Read-only

VASTMassVersioning

Determines if the ad is a DCO In-Stream ad.

Boolean

Required

adSmartVersionSchema

Object that contains catalog and smart elements.

adSmartVersionSchema Object

Optional

disableIncomplete

Internal.

Boolean

Internal

enableRetargeting

Determines whether multiple retargeting tags and values can be set for each version of a Dynamic Creative ad.

Boolean

Required

rotationType

Determines the rotation methods by which to serve the versions.

String

Optional

versionTargetingType

Determines the targeting type by which to serve the versions.

String

Optional

versionBasePath

Internal.

String

Internal

advancedRetargeting

Internal.

Internal object

Internal

In a Dynamic Creative ad, this object includes the IDs of the tags from the Dynamic Creative version.

automaticOptimizationData

Internal.

automaticOptimizationData Object

Internal

vastSmartElement

For VAST formats, includes the versions' Vast elements.

vastSmartElement Object

Optional

For VAST DCO ads.

name

Name of the ad.

String

Required

masterAdId

(In case of a placement ad) ID of the master ad it originated from, empty otherwise.

Long

Read-only

changed

(In case of a placement ad) Indicates whether the ad was modified since it was created from its master ad.

Boolean

Read-only

adStatus

Status of the ad.

String

Read-only

enabled

(For serving purposes) Indicates whether the ad is enabled or disabled.

Boolean

Optional

Default value: True

adFormat

(In case of custom ad format) Base ad format of the ad.

String

Required

adFormatId

ID of the ad format.

Long

Optional

adFormatName

Name of the ad format, for example, 'HTML5 Expandable Ad'.

String

Read-only

accountId

ID of the account of the user who created the ad.

Long

Required

accountName

Name of the account of the user who created the ad.

String

Read-only

placementId

(Placement ad only) ID of the placement to which the ad is attached.

Long

Read-only

placementName

(Placement ad only) Name of the placement to which the ad is attached.

String

Read-only

placementType

Type of placement.

String

Read-only

siteId

(Placement ad only) ID of the site of the placement to which the ad is attached.

Long

Read-only

siteName

(Placement ad only) Name of the site of the placement to which the ad is attached.

String

Read-only

adAssignmentData

Assignment data of the ad, for example campaign or brand.

adAssignmentData Object

Read-only

mainClickthrough

Main click-through that will be fired when clicking on the ad.

mainClickthrough Object

Optional

adURLs

List of all ad 3rd party tracking URLs.

Array of thirdPartyURL Object

Optional

pricingSize

(For billing purposes) Size of the ad, calculated in KB.

Long

Read-only

overallSize

Size of the ad (in KB) including all of its assets.

Long

Read-only

initialSize

Size of the ad (in KB) calculated by the asset that is initially loaded.

Long

Read-only

width

Width of the ad.

Long

Read-only

height

Height of the ad.

Long

Read-only

dimensions

String representation of the dimensions as width x height.

String

Read-only

templateScriptName

Maps to the correct base AdConfig.js file.

String

Read-only

urlTokens

Determines the tokens that are appended to URLs.

String

Read-only

minAudioVersion

Internal.

Internal

Internal

fourthPartyTag

Deprecated.

String

Read-only

adChoicesStatus

Determines whether the ad choices icon is shown.

Boolean

Optional

Default value: False

adChoicesLocation

Determines the relative location of the ad choices icon on the ad.

String

Optional

qaStatus

Indicates the status of the ad qa review process.

String

Read-only

numberOfPlacementAds

Number of placement ads the master ad has (only the ones visible to the user).

Integer

Read-only

overallNumberOfPlacementAds

Number of placements ad the master ad has (All).

Integer

Read-only

servingMethod

Describes the type of serving method used to display the ad.

String

Read-only

analyticsData

Provides ad analytics statistics on the ad.

adAnalyticsData Object

Read-only

analyticsSettings

Analytics settings for the campaign. By default, these settings are inherited from the advertiser.

analyticsSettings Object

Optional

customFields

Custom fields values on entity level, each field must have metadata definition on parent account.

customFields Object

Optional

massVersioning

Indicates if the ad is a mass versioned ad.

Boolean

Optional

usedAsTemplate

Indicates if this ad is used as part of an ad template.

Boolean

Read-only

unSavedTemplateAd

Indicates if the ad was created from Ad Builder for HTML5 from an ad template but was not actually saved yet.

Boolean

Read-only

adTemplateId

ID of the ad template from which ad originated.

Long

Read-only

feedEnabled

Indicates if the Dynamic Creative feed is set up for the ad.

Boolean

Read-only

feedStatus

Status of the Dynamic Creative feed.

String

Read-only

enableTimeBasedServing

Determines time-based settings according to the brand's time zone or the user's time zone.

Boolean

Optional

servingTimeZoneType

Used for Delivery Groups.

String

Optional

videoAudioAdAssetData

Internal.

Internal

Internal

native

Determines if the ad is a native DCO ad.

Boolean

Optional

containsNonWorkspaceAssets

Internal.

Internal

Internal

adFeatures

List of ad features.

Array of adFeature Object

Read-only

createdBy

ID of the user who created the ad.

Long

Read-only

createdByName

Name of the user who created the ad.

String

Read-only

createdByAccount

ID of the account of the user who created the ad.

Long

Read-only

createdByAccountName

Name of the account of the user who created the ad.

String

Read-only

createdOn

Date and time the ad was created (Date epoch).

Date (Long)

Read-only

lastUpdatedBy

ID of the user who last updated the ad.

Long

Read-only

lastUpdatedByName

Name of the user who last updated the ad.

String

Read-only

lastUpdatedByAccount

ID of the account of the user who last updated the ad.

Long

Read-only

lastUpdatedByAccountName

Name of the account of the user who last updated the ad.

String

Read-only

lastUpdateOn

Date and time the ad was last updated (Date epoch).

Date (Long)

Read-only

id

ID of the ad.

Long

Read-only

relationsBag

Internal.

relationsBag Object

Read-only

version

Internal.

Long

Read-only

Object JSON Example

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk