A Few Things to KnowLearn more about campaign management with our API here!
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST | /accounts/{accountId}/campaigns | Create a new campaign for the specified account. |
| GET | /accounts/{accountId}/campaigns | Retrieve all campaigns associated with the specified account. |
| GET | /campaigns/{campaignId} | Retrieve details of a specific campaign by its ID. |
| PUT | /campaigns/{campaignId} | Update details of a specific campaign by its ID. |
InfoCreate Operations:
- 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 |
|---|---|---|
id | string | Campaign IDAccepted values: int64 Writeable? N / Nullable? N |
accountId* | string | Account IDAccepted values: int64 Writeable? N / Nullable? N |
name* | string | Campaign name; must be unique within an AccountAccepted values: up to 255-chars string Writeable? Y / Nullable? N |
type | enum | Campaign type If attribute is passed in the call, a value must be specifiedAccepted values: auction, preferredDefault: auctionWriteable? Y / Nullable? N |
budget | decimal | Campaign lifetime spend cap; uncapped if omitted or set to null.Note that preferred campaign types cannot have budgets as these campaign types must be uncappedAccepted values: equals/greater than zero Default: nullWriteable? Y / Nullable? Y |
budgetSpent | decimal | Amount the campaign has already spentAccepted values: equals/greater than zero Default: 0.0Writeable? N / Nullable? N |
budgetRemaining | decimal | Amount the campaign has remaining until cap is hit; null if budget is uncappedAccepted values: between zero and budgetDefault: nullWriteable? N / Nullable? Y |
clickAttributionWindow* | enum | Post-click attribution windowAccepted values: 7D, 14D, 30DDefault: 30DWriteable? Y / Nullable? N |
viewAttributionWindow* | enum | Post-view attribution windowAccepted values: None,1D,7D, 14D, 30DDefault: NoneWriteable? Y / Nullable? N |
clickAttributionScope | enum | Post-click attribution scopeAccepted values: sameSku, sameSkuCategory, sameSkuCategoryBrandDefault: sameSkuCategoryWriteable? Y / Nullable? N |
viewAttributionScope | enum | Post-view attribution scopeAccepted values: sameSku, sameSkuCategory, sameSkuCategoryBrandDefault: sameSkuWriteable? Y / Nullable? N |
drawableBalanceIds | list<string> | List of Balances the campaign is able to draw from; at least one balance is required for a campaign to startAccepted values: list of balanceIdDefault: []Writeable? N / Nullable? N |
status | enum | Campaign status, derived from the status of Line Items it holds; active if at least one line item is active. To understand the conditions that will cause a status to change, check out Campaign & Line Item StatusAccepted values: active, inactiveDefault: inactiveWriteable? N / Nullable? N |
monthlyPacing | decimal | 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 timezoneAccepted values: null or greater than zeroDefault: nullWriteable? Y / Nullable? Y |
dailyPacing | decimal | The maximum daily spend allowed for the campaign in the currency of the account, as long as not set to null and isAutoDailyPacing = false; otherwise no daily spend limit will be enforcedAccepted values: null or greater than zeroDefault: nullWriteable? Y / Nullable? Y |
isAutoDailyPacing | boolean | 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, dailyPacing value should be left empty (null).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 endDate and budget or monthlyPacing must be specified, overwriting dailyPacing with the new respective pace (if not set previously)Accepted values: true, falseWriteable? Y / Nullable? N |
startDate* | timestamp | Campaign start date. The campaign starts inactive if invalid start date is not today or end date is in previous day.Accepted values: yyyy-mm-ddThh:mm:ss±hh:mm(in ISO-8601)Default: creation timestamp Writeable? Y / Nullable? Y⚠️ Note: if time/timezone designators are not provided, the default value to be considered will be 00:00:00+00:00 (i.e., midnight in UTC - account timezone not taken in consideration here) |
endDate* | timestamp | Campaign end date. The campaign starts inactive if invalid start date is not today or end date is in previous dayAccepted values: yyyy-mm-ddThh:mm:ss±hh:mm(in ISO-8601)Default: nullWriteable? Y / Nullable? Y⚠️ Note: if time/timezone designators are not provided, the default value to be considered will be 00:00:00+00:00 (i.e., midnight in UTC - account timezone not taken in consideration here) |
createdAt | timestamp | Timestamp of campaign creation, in UTCAccepted values: yyyy-mm-ddThh:mm:ss±hh:mm(in ISO-8601)Writeable? N / Nullable? N |
updatedAt | timestamp | Timestamp of last campaign update, in UTCAccepted values: yyyy-mm-ddThh:mm:ss±hh:mm(in ISO-8601)Writeable? N / Nullable? N |
companyName | string | 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 |
onBehalfCompanyName | string | 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 companyName) associated with the advertisementAccepted values: up to 255-chars stringWriteable? 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. Sample RequestGet 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 |
|---|---|
🟢200 | Call completed with success |
🟢201 | Campaign was created successfully |
🔴 400 | Validation Error - one or more required field was not found. Confirm if all required fields are present in the API call
|