Amazon Ads
App · 20 actions
Read Sponsored Products campaign structure, budgets, portfolios and targeting; run Amazon advertising reports.
Actions
| Action | What it does |
|---|---|
| Create report | Start an asynchronous Sponsored Products report. |
| Delete report | Delete report in Amazon Ads. |
| Get budget rule | Get budget rule in Amazon Ads. |
| Get category refinements | Get category refinements in Amazon Ads. |
| Get profile | Get profile in Amazon Ads. |
| Get report | Get report in Amazon Ads. |
| List ad groups | List ad groups in Amazon Ads. |
| List budget rules | List budget rules in Amazon Ads. |
| List campaign budget rules | List campaign budget rules in Amazon Ads. |
| List campaign negative keywords | List campaign negative keywords in Amazon Ads. |
| List campaign negative targets | List campaign negative targets in Amazon Ads. |
| List campaigns | List campaigns in Amazon Ads. |
| List keywords | List keywords in Amazon Ads. |
| List negative keywords | List negative keywords in Amazon Ads. |
| List negative targets | List negative targets in Amazon Ads. |
| List portfolios | List portfolios in Amazon Ads. |
| List product ads | List product ads in Amazon Ads. |
| List profiles | List profiles in Amazon Ads. |
| List target categories | List target categories in Amazon Ads. |
| List targets | List targets in Amazon Ads. |
Create report
Start an asynchronous Sponsored Products report. Returns its report ID; use Get report to check readiness without starting a second report.
Inputs
- Profile
profile_idtextRequired - Profile id.
- Name
nametext - Name.
- Start date
start_datedateRequired - Start date.
- End date
end_datedateRequired - End date.
- Report type
report_typetextRequired - Report type.One of:
spCampaigns,spTargeting,spSearchTerm,spAdvertisedProduct,spPurchasedProduct. - Group by
group_bylistRequired - Group by.One or more of:
campaign,adGroup,targeting,searchTerm,advertiser. - Columns
columnslistRequired - Columns.
- Time unit
time_unittextRequired - Time unit.One of:
DAILY,SUMMARY.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"id": "Example",
"reportId": "Example"
},
"has_more": false,
"next_cursor": null
}Delete report
Delete report in Amazon Ads.
Inputs
- Profile
profile_idtextRequired - Profile id.
- Report ID
report_idtextRequired - Report id.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get budget rule
Get budget rule in Amazon Ads.
Inputs
- Profile
profile_idtextRequired - Profile id.
- Budget rule ID
budget_rule_idtextRequired - Budget rule id.
Outputs
Response.
dataobject- data.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"budgetRule": {
"createdDate": 0,
"lastUpdatedDate": 0,
"ruleDetails": {
"budgetIncreaseBy": {},
"duration": {},
"name": {},
"performanceMeasureCondition": {},
"recurrence": {},
"ruleType": {}
},
"ruleId": "Example",
"ruleState": "ACTIVE",
"ruleStatus": "Example"
}
},
"has_more": false,
"next_cursor": null
}Get category refinements
Get category refinements in Amazon Ads.
Inputs
- Profile
profile_idtextRequired - Profile id.
- Category ID
category_idtextRequired - Category id.
Outputs
Response.
dataobject- Response object for the GetRefinementsForCategory API, containing information on Brand Nodes, Age Range Nodes, and Genre Nodes.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"ageRanges": [],
"brands": [],
"genres": []
},
"has_more": false,
"next_cursor": null
}Get profile
Get profile in Amazon Ads.
Inputs
- Profile
profile_idtextRequired - Profile id.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get report
Get report in Amazon Ads.
Inputs
- Profile
profile_idtextRequired - Profile id.
- Report ID
report_idtextRequired - Report id.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List ad groups
List ad groups in Amazon Ads.
Inputs
- Profile
profile_idtextRequired - Profile id.
- Next token
next_tokentext - Next token.
- Max results
max_resultsnumber - Max results.At least 1.
Outputs
Response.
dataobject- data.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"adGroups": [],
"nextToken": "Example",
"totalResults": 0
},
"has_more": false,
"next_cursor": null
}List budget rules
List budget rules in Amazon Ads.
Inputs
- Profile
profile_idtextRequired - Profile id.
- Next token
next_tokentext - Next token.
- Page size
page_sizenumber - Number of rules per page, up to 30.From 1 to 30.
Outputs
Response.
dataobject- data.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"budgetRulesForAdvertiserResponse": [],
"nextToken": "Example"
},
"has_more": false,
"next_cursor": null
}List campaign budget rules
List campaign budget rules in Amazon Ads.
Inputs
- Profile
profile_idtextRequired - Profile id.
- Campaign
campaign_idtextRequired - Campaign id.
Outputs
Response.
dataobject- data.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"associatedRules": []
},
"has_more": false,
"next_cursor": null
}List campaign negative keywords
List campaign negative keywords in Amazon Ads.
Inputs
- Profile
profile_idtextRequired - Profile id.
- Next token
next_tokentext - Next token.
- Max results
max_resultsnumber - Max results.At least 1.
Outputs
Response.
dataobject- data.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"campaignNegativeKeywords": [],
"nextToken": "Example",
"totalResults": 0
},
"has_more": false,
"next_cursor": null
}List campaign negative targets
List campaign negative targets in Amazon Ads.
Inputs
- Profile
profile_idtextRequired - Profile id.
- Next token
next_tokentext - Next token.
- Max results
max_resultsnumber - Max results.At least 1.
Outputs
Response.
dataobject- data.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"campaignNegativeTargetingClauses": [],
"nextToken": "Example",
"totalResults": 0
},
"has_more": false,
"next_cursor": null
}List campaigns
List campaigns in Amazon Ads.
Inputs
- Profile
profile_idtextRequired - Profile id.
- Next token
next_tokentext - Next token.
- Max results
max_resultsnumber - Max results.At least 1.
Outputs
Response.
dataobject- data.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"campaigns": [],
"nextToken": "Example",
"totalResults": 0
},
"has_more": false,
"next_cursor": null
}List keywords
List keywords in Amazon Ads.
Inputs
- Profile
profile_idtextRequired - Profile id.
- Next token
next_tokentext - Next token.
- Max results
max_resultsnumber - Max results.At least 1.
Outputs
Response.
dataobject- data.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"keywords": [],
"nextToken": "Example",
"totalResults": 0
},
"has_more": false,
"next_cursor": null
}List negative keywords
List negative keywords in Amazon Ads.
Inputs
- Profile
profile_idtextRequired - Profile id.
- Next token
next_tokentext - Next token.
- Max results
max_resultsnumber - Max results.At least 1.
Outputs
Response.
dataobject- data.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"negativeKeywords": [],
"nextToken": "Example",
"totalResults": 0
},
"has_more": false,
"next_cursor": null
}List negative targets
List negative targets in Amazon Ads.
Inputs
- Profile
profile_idtextRequired - Profile id.
- Next token
next_tokentext - Next token.
- Max results
max_resultsnumber - Max results.At least 1.
Outputs
Response.
dataobject- data.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"negativeTargetingClauses": [],
"nextToken": "Example",
"totalResults": 0
},
"has_more": false,
"next_cursor": null
}List portfolios
List portfolios in Amazon Ads.
Inputs
- Profile
profile_idtextRequired - Profile id.
- Next token
next_tokentext - Next token.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"portfolios": []
},
"has_more": false,
"next_cursor": null
}List product ads
List product ads in Amazon Ads.
Inputs
- Profile
profile_idtextRequired - Profile id.
- Next token
next_tokentext - Next token.
- Max results
max_resultsnumber - Max results.At least 1.
Outputs
Response.
dataobject- data.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"nextToken": "Example",
"productAds": [],
"totalResults": 0
},
"has_more": false,
"next_cursor": null
}List profiles
List profiles in Amazon Ads.
Inputs
None.
Outputs
Response.
datalist- The records returned by the official API.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": [],
"has_more": false,
"next_cursor": null
}List target categories
List target categories in Amazon Ads.
Inputs
- Profile
profile_idtextRequired - Profile id.
- Locale
localetext - Language and country code, such as en_US.
Outputs
Response.
dataobject- Response object containing all targetable categories for the advertiser's marketplace. ID is the category ID. NA is the name. CH is the list of child categories. TA is if the category is targetable. AsinCountRange is the AsinCounts of the node. Version 4 adds the number of targetable ASINs to each category.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"categoryTree": "Example"
},
"has_more": false,
"next_cursor": null
}List targets
List targets in Amazon Ads.
Inputs
- Profile
profile_idtextRequired - Profile id.
- Next token
next_tokentext - Next token.
- Max results
max_resultsnumber - Max results.At least 1.
Outputs
Response.
dataobject- data.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"nextToken": "Example",
"targetingClauses": [],
"totalResults": 0
},
"has_more": false,
"next_cursor": null
}