PRODUCT
Follow

Endpoints Using the Dynamic Creative Object

Dynamic Creative 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 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

Required

FeedSettings

id

ID of the ad.

Integer

Required

relationsBag

Internal.

relationsBag Object

Internal

version

Internal.

Internal

Internal

createdBy

ID of the user that created the feed settings (subscribed the ad to the feed).

Long

Read-only

createdByName

Name of the user that created the feed settings (subscribed the ad to the feed).

String

Read-only

createdByAccount

ID of the account that created the entity.

Long

Read-only

createdByAccountName

Name of the account that created the entity.

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

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

feedInputSetting

Location and type of the feed file.

feedInputSetting Object

Required

feedMappingSetting

Maps the fields in the data feed to the fields in the platform.

feedMappingSetting Object

Required

fetchInterval

Defines the times and intervals of the feed update.

Long

Required

fetchStartTime

Time at which the feed update will start (Date epoch).

Long

Required

fetchEndTime

Time at which the feed update will end (Date epoch).

Long

Required

incrementalIngest

Internal.

Boolean

Required

nextFetchTime

Time at which the next feed update will start (Date epoch).

Long

Read-only

prevFetchTime

Time at which the previous feed update occurred (Date epoch).

Long

Read-only

active

Determines if the feed is valid for fetching (dates between start and end date).

Boolean

Read-only

disableNewVersions

Disables any new versions that were created by the data feed, and prevents these new versions from serving until you manually (either from the platform or spreadsheet) change their status back to active.

Boolean

Required

disableUpdatedVersions

Disables any versions that were updated right after the data feed fetch.

Boolean

Required

accountId

Account ID of the ad and its feed settings.

Long

Read-only

executeOnce

Determines whether the feed fetches just once, or on a recurring basis (every x days/hours).

Boolean

Required

feedFilter

Filters the feed file according to the condition list.

feedFilter Object

Optional

sendEmailOnFeedUpdate

Sends e-mail message when feed is updated.

Boolean

Optional

recipientIds

ID of the recipients that will receive an e-mail notification message when the feed is updated.

recipientIds Object

Required

Object JSON Example

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

Comments

Powered by Zendesk