A maximum of 50 campaigns can be created/updated in a single POST/PUT batch request
A maximum of 50 campaigns can be deleted in a single PUT batch request
Limit on length of campaign name is 255 characters
There is no limit on number of ad groups to be created within a campaign
There is no limit on number of campaigns to be created for an advertiser
There is no limit on the amount of daily budget that can carry forward to the next day
If the daily budget is defined, unspent budget from present day will be carried forward to the next day. Maximum budget spent on a given day will be limited to twice of the set dailyBudget amount
Campaigns go live at PST midnight of the scheduled start date
Maximum number of campaigns that an advertiser can create per advertiser account is 5000
List All the Campaigns
Description: Retrieve a specific campaign or all the campaigns for a specific advertiser.
Note: It will not return deleted campaigns.
URL: GET/api/v1/campaigns
Query Parameters
Parameter
Description
type
Required
Possible Values
campaignId
The ID of the campaign. It returns a specific
campaign in response
Advertiser ID
for which the campaign(s) is(are) to be retrieved
Filter[name]
A valid campaign name with which the desired
campaign can be searched in the absence of campaign id
string
N
Provide a campaign name to search the relevant
campaign by name instead of campaign Id.
Filter[lastModifiedDate]
Provide a
date to fetch only those campaigns which were modified on or after that date
Note:
Modified here means:
If
there was any change to campaign set up
Type of
campaign. Possible values for campaign type are:
sponsoredProductssba
Note: you receive campaign type “sba” in
association with targeting type “manual” (for Sponsored
Brands campaigns)
string
targetingType
The targeting type of the campaign is a set of options to create campaigns with different bidding types. Possible values to targeting type are: 1) manual Note: You receive targeting type as “manual” in case of keyword bidding campaigns (including Sponsored Brands) 2) auto
string
status
Specified status of campaign. Possible status values are:
Note: If you extend an already completed campaign, the campaign status will change to “rescheduled” and will eventually switch to “live”
budgetType
The type of budget allocation chosen for this campaign. Possible values of budgetType are:
string
startDate
The date to start campaign
date
endDate
The date when Campaign ends.
It returns value 9999-12-30 if running indefinitely
date
totalBudget
Total budget of campaign
double
dailyBudget
Daily budget of campaign
double
rollover
The indicator
to suggest if the unspent daily budget from the previous day should be
carried forward to next day’s daily budget or not.
The default
and only value of rollover is “true” at present.
boolean
campaignId
The ID of the campaign
integer
advertiserId
The ID of the
advertiser for whom the campaign is retrieved
Possible values: enabled: use this status to schedule a paused campaign Note: When you try to enable an Sponsored Brands campaign in “paused”/ “proposal” state, and if the campaign is not eligible to go live, the error message will specifically outline the criteria that campaign fails to meet, which could be either or a combination of these: Sponsored Brands Profile enabled and approved 2 Items enabled and approved 1 Keyword enabled and approved • paused: use this status to pause a live campaign •completed: use this status to end a live campaign • extend: You can resume an already completed campaign to reuse it without having to create same campaign again with help of “extend” • proposal: use this status when a scheduled campaign which has never gone live, has been modified and needs to be re-submitted for review Note:proposal status is only applicable for Sponsored Brandscampaigns. Post review completion, the campaign status will automatically change to “enabled” then “scheduled” and finally to “live”. However, the campaign must be eligible to go live. A campaign can only go “live” when its start date is defined and following are approved for it:Sponsored Brands profile1 Keyword2 Items If a campaign review is revised for Sponsored Brands Profile such that the Sponsored Brands profile is rejected, the campaign will be “paused”. A campaign cannot stay “live” if profile is rejected by WMC team. If this happens, you need to change the campaign profile as per guidelines and resubmit it for review.If you extend an ended campaign, the system will auto-change the status to “rescheduled” and then to “live” as per the defined start date for campaignA campaign can be auto scheduled only if it is in “proposal” state. A “paused” campaign cannot be auto scheduled
startDate
The date to start campaign
date
N
Date should be in format: yyyy-mm-dd
endDate
The date when
Campaign ends. You can choose to run the campaign indefinitely as well
date
N
To run campaign
indefinitely, set its value as 9999-12-30
budgetType
The type of budget allocation you want to choose
for your campaign.
string
N
Possible values:
dailytotalboth
totalBudget
Total budget of campaign
double
N
For 1p seller:
The value of Total budget should at least be $100For 3p seller:
The value of Total budget should at least be $50
dailyBudget
Daily budget of campaign.
Note:
Daily budget cannot exceed your total
budget amountThere is no limit on the amount of
daily budget that can carry forward to the next day
double
N
For 1p seller:
The value of daily budget should at least be $50For 3p seller:
The value of daily budget should at least be $10
rollover
The indicator to suggest if the unspent daily budget
from the previous day should be carried forward to next day’s daily budget
boolean
N
Possible values:
true
Note: Currently rollover only accepts “true” as a
value. However, in future it may be updated to accept “false” as well.
Description: Use this operation to delete an existing campaign and its ad groups if campaign is scheduled but hasn’t gone live. You cannot delete a campaign that has gone live.
Note:
It
allows you to delete one or more campaigns.
You
will be able to delete any campaign which has never gone Live
Once
campaigns go live:
They
cannot be deleted
Items/Ad
Groups/Keywords in the campaign cannot be deleted, but they can be disabled
Campaign
start date and end date cannot be changed
Possible values of response code: success, failure
string
details
Details of the response code:
Response message for success: “”
Response message for failure: “Campaign with ID <> cannot be deleted as it has been scheduled before”
string
campaignId
Id of the campaign
integer
Sample Response
[
{
"code": "success",
"details": "",
"campaignId": 500002
}
{
"code": "failure",
"details": "Campaign with ID < 500001 >cannot be deleted as it has been scheduled before",
"campaignId": 500001
}
]
Rate limits on API operations
There is a rate
limit in place on the allowed number of API operations per hour.
Operations per hour are computed as the sum of number of changes requested across all API requests during the hour.
For example, 5 keyword bid changes, creation of an ad group, adding an item, and a snapshot report request in any given hour, would be counted as 8 operations.
You will
receive an HTTP 429 status error code and an error message about rule enforced
in case of breaking ops limit.
To learn more
about current applicable limits specific to your integration, please reach out
to the API Partner Enablement team.
