PRODUCT
Follow

AdVersion 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.

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

type

Type of entity.

String

Read-only

AdVersion

id

ID of the ad version.

Integer

Read-only

relationsBag

Internal.

relationsBag Object

Read-only

version

Internal.

Internal

Internal

createdBy

ID of the user that created the ad version.

Long

Read-only

createdByName

Name of the user that created the ad version.

String

Read-only

createdByAccount

ID of the account that created the ad version.

Long

Read-only

createdByAccountName

Name of the account that created the ad version.

String

Read-only

createdOn

Date of creation (Date epoch).

Long

Read-only

lastUpdatedBy

ID of the user that was last to update the entity.

Long

Read-only

lastUpdatedByName

Name of the user that was last to update the ad version.

String

Read-only

lastUpdatedByAccount

ID of the account that was last to update the entity.

Long

Read-only

lastUpdatedByAccountName

Name of the account that was last to update the entity.

String

Read-only

lastUpdateOn

Date of last update (Date epoch).

Long

Read-only

schema

Includes the list of dynamic elements and their values.

schema Object

Required

masterAdId

ID of the master ad.

Integer

Read-only

defaultVersion

Ad version that is shown as a default.

Boolean

Required

active

Activates the ad version.

Boolean

Required

status

Determines whether the ad version is active or inactive.

String

Required

preferred

Serves the selected ad version in all cases where SAS cannot find any available versions from the selected target audience.

Boolean

Optional

lockType

Internal.

Internal

Internal

targetingType

Internal.

Internal

Internal

versionFileName

Internal.

Internal

Internal

versionBasePath

Internal.

Internal

Internal

accountId

Account ID of the master ad.

Long

Read-only

externalId

In versions created from a feed - this is the file's unique identifier.

String

Read-only

product

Additional naming/classification field used to identify the product in a version, for example, car model.

String

Optional

clickthrough

Object that defines click-through URL for each version.

clickthrough Object

Optional

thirdPartyImpressionTrackers

List of 3rd party impressions trackers.

Array

Optional

thirdPartyClickTrackers

List of 3rd party click trackers.

Array

Optional

targetingInfo

Object that defines targeting information for the ad version.

targetingInfo Object

Optional

defaultImage

Object that defines the image that is shown as a default.

defaultImage Object

Optional

defaultImageClickthrough

Default images' clickthrough URL.

String

Optional

name

Name of the master ad.

String

Optional

advancedRetargeting

Object that includes the retargeting tag and values assigned to the version.

advancedRetargeting Object

Optional

vastSmartElement

For VAST formats, includes the versions' Vast elements.

vastSmartElement Object

Optional

For VAST DCO ads.

vastVersion

Internal.

Internal

Internal

vastElementURLWithToken

Internal.

Internal

Internal

Object JSON Example

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

Comments

Powered by Zendesk