Endpoints
Method | Endpoint | Description |
|---|---|---|
POST |
| Create a new campaign for the specified account. |
GET |
| Retrieve all campaigns associated with the specified account. |
GET |
| Retrieve details of a specific campaign by its ID. |
PUT |
| Update details of a specific campaign by its ID. |
- When using the
POSTmethod to create a resource, all Required fields must be included. Any Optional fields that are omitted will be set to their default values.
- When using the
PUTmethod to update a resource, all Write fields can be specified. Omitting any of these fields is treated as setting them tonull, where applicable.
Campaign Attributes
Attribute | Data Type | Description |
|---|---|---|
|
| Campaign ID, generated internally by Criteo Accepted values: int64 Writeable? N / Nullable? N |
|
| AccountID associated with the campaign, generated internally by Criteo Accepted values: int64 Writeable? N / Nullable? N |
|
| Campaign name; must be unique within anAccount Accepted values: up to 255-chars string Writeable? Y / Nullable? N |
|
| Campaign type If the attribute is passed in the call, a value must be specified Accepted values: Default: Writeable? Y / Nullable? N |
|
| Campaign lifetime spend cap; uncapped if omitted or set to Note that preferred campaign types cannot have budgets as these campaign types must be uncapped Accepted values: equals/greater than zero Default: Writeable? Y / Nullable? Y |
|
| Amount the campaign has already spent Accepted values: equals/greater than zero Default: Writeable? N / Nullable? N |
|
| Amount the campaign has remaining until cap is hit; Accepted values: between zero and Default: Writeable? N / Nullable? Y |
| list | List of brand IDs from promoted products in the campaign, originated from the retailer’sCatalog
Accepted values: list of strings Default: empty list Writeable? N / Nullable? N |
|
| Post-click attribution window Accepted values: Default: Writeable? Y / Nullable? N |
|
| Post-view attribution window Accepted values: Default: Writeable? Y / Nullable? N |
|
| Post-click attribution scope Accepted values: Default: Writeable? Y / Nullable? N |
|
| Post-view attribution scope Accepted values: Default: Writeable? Y / Nullable? N |
| list | List ofBalancesthe campaign is able to draw from; at least one balance is required for a campaign to start Accepted values: list of Default: empty list Writeable? N / Nullable? N |
|
| Campaign status, derived from the status ofLine Itemsit holds; Accepted values: Default: Writeable? N / Nullable? N |
|
| The maximum monthly spend allowed for the campaign in the currency of the account. The spend is constrained by remaining account balance and total budget of the campaign. Monthly budget spend reset monthly at the start of the month based on the account timezone Accepted values: Default: Writeable? Y / Nullable? Y |
|
| The maximum daily spend allowed for the campaign in the currency of the account, as long as not set to Accepted values: Default: Writeable? Y / Nullable? Y |
|
| Auto daily pacing flag for the campaign budget. The daily pacing value is automatically calculated with respect to the days left in the month for the account. The campaign’s remaining account balance, total budget, and monthly pacing value are constrained by account’s timezone and the campaign status. If auto daily pacing is enabled, Note the value may be affected by budget override. Daily budget spend is reset daily at the start of the day based on the account timezone. To activate, either campaign’s Accepted values: Writeable? Y / Nullable? N |
|
| Campaign start date. The campaign starts inactive if invalid start date is not today or end date is in previous day. Accepted values: Default: creation timestamp Writeable? Y / Nullable? Y ⚠️Note: if time/timezone designators are not provided, the default value to be considered will be |
|
| Campaign end date. The campaign starts inactive if invalid start date is not today or end date is in previous day Accepted values: Default: Writeable? Y / Nullable? Y ⚠️Note: if time/timezone designators are not provided, the default value to be considered will be |
|
| Timestamp of campaign creation, in UTC Accepted values: Writeable? N / Nullable? N |
|
| Timestamp of last campaign update, in UTC Accepted values: Writeable? N / Nullable? N |
|
| This optional field, exclusively accessible to marketplaces within the European Union (in compliance with the Digital Service Act - DSA), will display the name of the company associated with the advertisement. Accepted values: up to 255-chars string Writeable? Y / Nullable? Y |
|
| This optional field, exclusively accessible to marketplaces within the European Union (in compliance with the Digital Service Act - DSA), will display the name of the company (on behalf of Accepted values: up to 255-chars string Writeable? Y / Nullable? Y |
Digital Service Act (DSA)
In compliance with the Digital Services Act (DSA), marketplaces within the European Union will receive information about the company name associated with each advertisement.Create a Campaign
This endpoint creates a new campaign in the specified account. Sample RequestGet all Campaigns by Account ID
This endpoint lists all campaigns in the specified account. Results are paginated usingpageIndex and pageSize query parameters; if omitted, defaults to 0 and 25, respectively. See API Response.
Sample Request
Get a specific Campaign
This endpoint retrieves the specified campaign. Sample RequestUpdate a specific Campaign
This endpoint allows you to update a specified campaign. The following example demonstrates how to switch to an uncapped campaign budget and modify the post-view attribution window. Sample RequestResponses
Response | Description |
|---|---|
🟢 | Call completed with success |
🟢 | Campaign was created successfully |
🔴 | Validation Error - one or more required field was not found. Confirm if all required fields are present in the API call
IsAutoDailyPacing and Daily Pacing can not be active at the same time. Passing this in the call will return a 400 error
|