Campaigns
View and manage all your campaigns
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} | Retrieve 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.Update Operations:
- 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
Data Type: string
Description: Campaign ID
Accepted Value: int64
Default Values: None
Write? No
Nullable? No
Data Type: string
Description: Account ID
Accepted Value: int64
Default Value: None
Write? No
Nullable? No
Data Type: string
Description: Campaign name; must be unique within an account
Values: 255 char limit
Default Value: None
Write? Yes
Nullable? No
Data Type: enum
Description: Campaing type
Accepted Values: auction, preferred
Default Value: auction
Write? None other than the accepted values
Nullable? No - if attribute is passed in the call, a value must be specified
Data Type: number
Description: Campaign lifetime spend cap; uncapped if omitted or set to null. Note that preferred campaign types cannot have budgets as these campaings types must be uncapped.
Accepted Values: at least 0
Default Value: null
Write? Yes
Nullable? Yes
Data Type: number
Description: Amount the campaign has already spent
Accepted Values: at least 0
Default Value: 0.0
Write? No
Nullable? No
Data Type: number
Description: Amount the campaign has remaining until cap is hit; null if budget is uncapped
Accepted Values: between 0 and budget Amount
Default Value: null
Write? No
Nullable? Yes
Data Type: enum
Description: Post-click attribution window
Accepted Values: 7D, 14D, 30D, unknown
Default Value: 30D
Write? Yes
Nullable? No
Data Type: enum
Description: Post-view attribution window
Accepted Values: None, 7D, 14D, 30D, unknown
Default Value: None
Write? Yes
Nullable? No
Data Type: enum
Description: Post-click attribution scope
Accepted Values: samesku, sameskucategory, sameskucategorybrand, unknown For more information on what these values mean please refer to this page. Note, if you select sameskucategory the resulting logic allows for attribution to be awarded to an event for the given sku, OR a sku with the same category, and if you select sameskucategorybrand the resulting logic allows for attribution to be awarded to an event for the given sku, OR a sku with the same category, OR a sku with the same brand
- Note:
sameskucategory and sameskucategoryseller are currently unsupported options for marketplace sellers. Default Value: sameskucategory
Write? None other than the accepted values
Nullable? No
Data Type: enum
Description: Post-view attribution scope
Accepted Values: samesku, sameskucategory, sameskucategorybrand For more information on what these values mean please refer to this page.
Note, if you select sameskucategory the resulting logic allows for attribution to be awarded to an event for the given sku, OR a sku with the same category, and if you select sameskucategorybrand the resulting logic allows for attribution to be awarded to an event for the given sku, OR a sku with the same category, OR a sku with the same brand
- Note:
sameskucategory and sameskucategoryseller are currently unsupported options for marketplace sellers. Default Value: sameskucategory
Write? None other than the accepted values
Nullable? No
Data Type: string array
Description: Set of brands represented in line items of the campaign; note this set is append only
Accepted Values: list of brandId
Default Value: [ ]
Write? No
Nullable? No
Data Type: string array
Description: List of balances the campaign is able to draw from; at least one balance is required for a campaign to begin
Accepted Values: list of balanceId
Default Value: [ ]
Write? No
Nullable? No
Data Type: enum
Description: 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 our status page
Accepted Values: active, inactive
Default Value: inactive
Write? No
Nullable? No
Data Type: decimal
Description: 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: null or a value that is greater or equal to 0.01
Default Value: null
Write? Yes
Nullable? Yes
- If monthly pacing is set to
nulland auto daily pacing is set tofalse, then no daily spend limit will be enforced. - The maximum daily spend allowed for the campaign in the currency of the account.
Data Type: decimal
Description: The maximum daily spend allowed for the campaign in the currency of the account. As long as the parameter is not set to null and auto daily pacing is not set to true then monthly pacing will be applied to the campaign.
Accepted Values: null or a value that is greater or equal to 0.01
Default Value: null
Write? Yes
Nullable? Yes
Data Type: boolean
Description: 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 is constrained by the account 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 line item endDate and budget, or monthlyPace, must be specified; overwrites dailyPacing with a calculation if not set prior
Accepted Values: true, false
Default Value: N/A
Write? Yes
Nullable? No