- Auth
- Accounts
- First call
- Reporting
- DSP report
- Sponsored ads V3
- Sponsored ads V2
- Snapshots
- Test accounts
- Amazon Marketing Stream
- Amazon Marketing Cloud
- Administration
- Accounts
- Instances
- Create an instance
- List all instances
- List information about the requested instance
- Update instance details
- Update AWS account metadata in the requested instance
- List advertisers in instance
- Create advertiser update
- Get advertiser update
- Gets advertiser information about the requested AMC instance
- Delete AMC instance
- Reporting
- AMC Audiences
- Rule-based audiences
- Creates query based audience execution metadata information
- Get all query based audiences execution metadata.
- Get query based audience execution metadata for a given audienceExecutionId.
- Update query based audience execution metadata for a given audienceExecutionId.
- Delete query based audience execution metadata for a given audienceExecutionId.
- Lookalike audiences
- Rule-based audiences
- Administration
- Sponsored Products
- Campaigns
- Ad groups
- Product ads
- Product targeting
- Keywords
- Theme-based bid recommendations
- Negative keywords
- Campaign negative keywords
- Negative targets
- Campaign negative targets
- Budget recommendations and missed opportunities
- Budget rules
- Sponsored Brands
- Campaigns
- Ad groups
- Ads
- Targeting
- Recommendations
- Theme targeting
- Create keywords
- Update keyword
- Get keyword
- Delete keyword
- Create negative keywords
- Update negative keyword
- Get negative keyword
- Delete negative keyword
- Create product targets
- Update a product target
- Get product target
- Delete product target
- Create negative product target
- Update negative product target
- Get negative product target
- Delete negative product target
- Get all categories
- Get category refinements
- Ad creatives
- Get brands
- Get landing page ASINS
- Sponsored Display
- Stores
- Product metadata
- Budget rules
- Budget usage
- Creative asset library
- Locations
- Exports
- Sponsored TV
- Amazon DSP
- Partner opportunities
List keywords
POST
/sp/keywords/list
最后修改时间:2025-03-16 02:19:30
责任人:未设置
请求参数
Header 参数
Amazon-Advertising-API-ClientId
string
必需
示例值:
{{client_id}}
Amazon-Advertising-API-Scope
string
必需
示例值:
{{profileId}}
Authorization
string
必需
示例值:
Bearer {{access_token}}
Accept
string
必需
示例值:
application/vnd.spKeyword.v3+json
Content-Type
string
必需
示例值:
application/vnd.spKeyword.v3+json
Body 参数application/json
campaignIdFilter
object
必需
include
array[string]
必需
stateFilter
object
必需
include
array[string]
必需
maxResults
integer
必需
adGroupIdFilter
object
必需
include
array[string]
必需
includeExtendedDataFields
boolean
必需
locale
string
必需
keywordTextFilter
object
必需
queryTermMatchType
string
必需
include
array[string]
必需
keywordIdFilter
object
必需
include
array[string]
必需
matchTypeFilter
array[string]
必需
示例
{
"campaignIdFilter": {
"include": [
"{{campaignId}}"
]
},
"stateFilter": {
"include": [
"ENABLED"
]
},
"maxResults": 10,
"adGroupIdFilter": {
"include": [
"{{adGroupId}}"
]
},
"includeExtendedDataFields": true,
"locale": "es_MX",
"keywordTextFilter": {
"queryTermMatchType": "BROAD_MATCH",
"include": [
"soap"
]
},
"keywordIdFilter": {
"include": [
"{{keywordId}}"
]
},
"matchTypeFilter": [
"EXACT"
]
}
示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://www.amazon.com/ap/oa/sp/keywords/list' \
--header 'Amazon-Advertising-API-ClientId: {{client_id}}' \
--header 'Amazon-Advertising-API-Scope: {{profileId}}' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Accept: application/vnd.spKeyword.v3+json' \
--header 'Content-Type: application/vnd.spKeyword.v3+json' \
--data-raw '{
"campaignIdFilter": {
"include": [
"{{campaignId}}"
]
},
"stateFilter": {
"include": [
"ENABLED"
]
},
"maxResults": 10,
"adGroupIdFilter": {
"include": [
"{{adGroupId}}"
]
},
"includeExtendedDataFields": true,
"locale": "es_MX",
"keywordTextFilter": {
"queryTermMatchType": "BROAD_MATCH",
"include": [
"soap"
]
},
"keywordIdFilter": {
"include": [
"{{keywordId}}"
]
},
"matchTypeFilter": [
"EXACT"
]
}'
返回响应
🟢200Success
application/json
Body
keywords
array [object {8}]
必需
adGroupId
string
可选
bid
number
可选
campaignId
string
可选
extendedData
object
可选
keywordId
string
可选
keywordText
string
可选
matchType
string
可选
state
string
可选
totalResults
integer
必需
示例
{
"keywords": [
{
"adGroupId": "220795965021387",
"bid": 0.02,
"campaignId": "102579222643121",
"extendedData": {
"creationDate": 1663287636750,
"creationDateTime": "2022-09-16T00:20:36.750Z",
"lastUpdateDate": 1663287636750,
"lastUpdateDateTime": "2022-09-16T00:20:36.750Z",
"servingStatus": "PENDING_START_DATE",
"statusReasons": [
"AD_GROUP_INCOMPLETE_DETAIL",
"PENDING_START_DATE_DETAIL",
"AD_GROUP_PAUSED_DETAIL"
]
},
"keywordId": "88150926783794",
"keywordText": "soap bar",
"matchType": "EXACT",
"state": "ENABLED"
}
],
"totalResults": 1
}