Retail campaigns

accountId

string

Mandatory

path

ID of the account

templateCampaignIdx

integer

Mandatory

Index of the template campaign to clone from.

retailCampaignName

string

Mandatory

Name for the new retail campaign.

email

string

Mandatory

Email address for notifications.

labelId

integer

Mandatory

Label ID to associate with the campaign.

assetSourceType

enum (string)

Mandatory

Asset source type. Values: productFeed, uploadAsset, hybridAsset

mediaChannelIdx

integer

Mandatory

Index of the media channel to use.

isDaVinciCreated

integer

Optional

Flag indicating whether the campaign was created via Da Vinci.

dspCampaignInfo

object (JSON string)

Optional

DSP campaign configuration object (serialized as JSON string).

dspAdditionalCampaignInfo

object

Optional

Additional DSP campaign info. See DSPAdditionalCampaignInfo below.

adServerId

string

Optional

ID of the ad server to use.

templateCampaignName

string

Optional

Name of the source template campaign.

faceCardAsset

string

Optional

Asset identifier for the face card.

faceCardAssetDimension

string

Optional

Dimension string for the face card asset (e.g. 300x250).

inventoryType

enum (string)

Optional

Inventory type. Values: offsite, onsite

retailerId

integer

Optional

ID of the retailer.

landingUrl

string

Optional

Landing URL for the campaign.

agenticInfo

object

Optional

Agentic campaign info. See CampaignAgenticInfo below.

countryCode

string

Country code (e.g. US).

domain

string

Domain for the DSP campaign.

campaignType

enum (string)

DSP campaign type. Values: Third_Party_Tags, Responsive_E_Commerce, Standard_Display_Creatives, Criteo_Creative_Generation

amzSourceCampaignId

string

Amazon source campaign ID (default: -1).

isAdGroupCloned

boolean

Whether ad groups were cloned (default: false).

criteoAttributeAssetSourceMappings

array

List of Criteo attribute-to-asset-source mappings.

adIdx

integer

Index of the ad unit.

adUnitAssetPropertyMap

array

List of ad unit to asset property mappings.

adUnitAssetPropertyMap[].adUnitIdx

integer

Index of the ad unit.

adUnitAssetPropertyMap[].assetProperty

string

Asset property name.

ctaText

string

Call-to-action text for the campaign.

llmProvider

string

LLM provider name for agentic generation.

message

string

Success message.

retailCampaignIdx

integer

Index of the newly created retail campaign.

accountId

string

Mandatory

path

ID of the account.

retailCampaignIdx

integer

Mandatory

path

Index of the retail campaign to update.

templateCampaignIdx

integer

Mandatory

Index of the source template campaign.

retailCampaignName

string

Mandatory

Updated name for the retail campaign.

email

string

Mandatory

Email address for notifications.

labelId

integer

Mandatory

Label ID to associate with the campaign.

assetSourceType

enum (string)

Mandatory

Asset source type. Values: productFeed, uploadAsset, hybridAsset

mediaChannelIdx

integer

Mandatory

Index of the media channel to use.

isDaVinciCreated

integer

Optional

Flag indicating whether the campaign was created via DaVinci.

dspCampaignInfo

object (JSON string)

Optional

DSP campaign configuration object.

dspAdditionalCampaignInfo

object

Optional

Additional DSP campaign info (see DSPAdditionalCampaignInfo).

adServerId

string

Optional

ID of the ad server to use.

templateCampaignName

string

Optional

Name of the source template campaign.

faceCardAsset

string

Optional

Asset identifier for the face card.

faceCardAssetDimension

string

Optional

Dimension string for the face card asset (e.g. 300x250).

inventoryType

enum (string)

Optional

Inventory type. Values: offsite, onsite

retailerId

integer

Optional

ID of the retailer.

landingUrl

string

Optional

Landing URL for the campaign.

agenticInfo

object

Optional

Agentic campaign info (see CampaignAgenticInfo).

msg

string

Result message describing the outcome of the update.

cloneId

string/null

Clone ID if a background clone was triggered.

messageId

string/null

Message/task ID for async processing, if applicable.

accountId

string

Mandatory

path

ID of the account.

retailCampaignIdx

string

Mandatory

path

Index of the retail campaign to delete.

message

string

Deletion confirmation.

accountId

string

Mandatory

path

ID of the account.

offset

integer

Optional

query

Pagination offset (e.g. 0).

limit

integer

Optional

query

Number of items per page (e.g. 25).

campaigns

array

List of retail campaign objects.

campaigns[].retailCampaignName

string/null

Name of the retail campaign.

campaigns[].retailCampaignIdx

integer/null

Index of the retail campaign.

campaigns[].mediaPlanName

string/null

Name of the associated media plan.

campaigns[].mediaPlanId

integer/null

ID of the associated media plan.

campaigns[].mediaChannelIdx

integer/null

Index of the media channel.

campaigns[].mediaChannelName

string/null

Name of the media channel.

campaigns[].dspLogoURL

string/null

Logo URL of the DSP.

campaigns[].status

enum (string)

Status of the retail media plan (e.g. Active, Inactive).

campaigns[].campaignIdx

integer/null

Index of the associated campaign.

campaigns[].dspCampaignId

string/null

DSP campaign ID.

campaigns[].creationDate

string/null

Creation date of the campaign.

campaigns[].modifiedDate

string/null

Last modified date.

campaigns[].dcmCampaignId

integer/null

DCM campaign ID, if applicable.

campaigns[].isDCMAdvertiserMappingExists

boolean/null

Whether a DCM advertiser mapping exists.

campaigns[].retailDSPCampaign

object/null

DSP campaign details (see RetailDSPCampaign in Get retail campaign by ID).

campaigns[].activationConfiguration

object/null

Activation configuration for the campaign.

campaigns[].activationConfiguration.tagGeneration

boolean

Whether tag generation is enabled.

campaigns[].activationConfiguration.creativeGeneration

boolean

Whether creative generation is enabled.

campaigns[].assetGenerationType

enum (string)

Asset generation type.

campaigns[].isRunningOrApproved

boolean/null

Whether the campaign is currently running or approved.

campaigns[].isMetaIntegrated

boolean/null

Whether the campaign is integrated with Meta.

count

integer

Total number of matching campaigns.

next

string/null

URL for the next page of results.

previous

string/null

URL for the previous page of results.

accountId

string

Mandatory

path

ID of the account.

retailCampaignIdx

integer

Mandatory

path

Index of the retail campaign to fetch.

offset

integer

Optional

query

Pagination offset

limit

integer

Optional

query

Number of items per page

retailCampaignName

string/null

Name of the retail campaign.

retailCampaignIdx

integer/null

Index of the retail campaign

mediaPlanIdx

integer/null

Index of the associated media plan.

labelId

integer/null

Label ID associated with the campaign.

templateCampaignIdx

integer/null

Index of the source template campaign.

campaignIdx

integer/null

Index of the associated campaign.

cloneIdx

string/null

Clone index identifier.

assetSourceType

string/null

Asset source type. Values: productFeed, uploadAsset, hybridAsset

adIdx

integer/null

Index of the ad unit.

numOfCards

integer/null

Number of cards in the creative.

availableDimensions

array of string

List of available ad dimensions (e.g. ["300x250", "728x90"]).

isVideoCampaign

boolean/null

Whether the campaign is a video campaign.

isSocialCampaign

boolean/null

Whether the campaign is a social campaign.

isDCMMediaPlanUsed

boolean/null

Whether a DCM media plan is used.

isDCMAdvertiserMappingExists

boolean/null

Whether a DCM advertiser mapping exists.

assetGenerationType

string/null

Asset generation type.

mediaChannel

object/null

Media channel mapping details.

retailDSPCampaign

object/null

DSP campaign details (see RetailDSPCampaign below).

isAnimatedImageSupported

boolean/null

Whether animated images are supported.

status

string/null

Status of the retail campaign

landingUrl

string/null

Landing URL for the campaign

dcmCampaignId

integer/null

DCM campaign ID, if applicable.

templateCampaignName

string/null

Name of the source template campaign.

faceCardAsset

string/null

Face card asset identifier.

faceCardAssetDimension

string/null

Dimension string for the face card asset.

faceCardAssetHtml

string/null

HTML content of the face card asset.

inventoryType

string/null

Inventory type. Values: offsite, onsite

retailerId

integer/null

Retailer ID.

ctaText

string/null

Call-to-action text.

rowIdx

integer/null

Row index.

retailCampaignId

integer/null

Retail campaign ID.

dspCampaignId

string/null

DSP campaign ID.

adServerId

string/null

Ad server ID.

isDaVinciCreated

boolean/null

Whether created via DaVinci.

createdTime

string/null

Creation timestamp.

dspAdditionalCampaignInfo

object/null

Additional DSP info (see DSPAdditionalCampaignInfo).

accountId

string

Mandatory

path

ID of the source account.

destAccountId

string

Mandatory

path

ID of the destination account. Needs to be same as accountId

cloneObject

enum (string)

Mandatory

Type of object being cloned. For campaigns: Campaign

srcAdvertiserId

integer

Mandatory

Advertiser ID of the source account.

destAdvertiserId

integer

Mandatory

Advertiser ID of the destination account.

cloneObjectId

integer

Mandatory

ID of the campaign to clone.

email

string

Mandatory

Email address for notifications on completion.

messageId

string

SQS message ID for the async clone job.

cloneId

string

UUID generated for this clone request (for status tracking).

accountId

string

Mandatory

path

ID of the account.

retailCampaignIdx

integer

Mandatory

path

Index of the retail campaign to check status for.

clonePercentCompleted

integer

Percentage of clone completion (0–100).

cloneStatus

enum (string)

Current status of the clone. Values: Queued, Completed, Failed

accountId

string

Mandatory

path

ID of the advertiser account created on the platform.

accountId

string

Mandatory

path

ID of the advertiser account created on the platform.