开发人员指南概述

亚马逊广告 API 概览

建议关键词

注意: 请在限制一节中查看有效关键词字符和约束的完整列表。

用于请求广告组和 ASIN 级别的建议关键词。 建议关键词按有效性从最高到最低的顺序排列。

方法 URL 用例
GET /adGroups/{adGroupId}/suggested/keywords 为指定的广告组请求建议关键词
GET /adGroups/{adGroupId}/suggested/keywords/extended 为广告组提供建议关键词。对每个建议关键词返回附加字段:campaignIdadGroupId 和(广告的)state
GET /asins/{asinValue}/suggested/keywords 为指定的 ASIN 提供建议关键词
POST /asins/suggested/keywords 为指定的 ASIN 列表提供建议关键词

操作

getAdGroupSuggestedKeywords

GET /adGroups/{adGroupId}/suggested/keywords

为指定的 adGroupId 检索建议关键词数据

参数

参数名称 类型 指定位置 描述
adGroupId number URL 路径 请求的广告组的编号
maxNumSuggestions number URL 查询 返回的建议关键词的最大数量。默认值为 100,最大值为 1000
adStateFilter string URL 查询 广告状态筛选条件(值以逗号分隔),用于筛选出广告,为其 ASIN 获取建议关键词。有效值为:enabledpausedarchived。默认值为 enabledpaused

响应

状态码 响应对象
200 - Success 为指定的 adGroupId 提供的建议关键词
400 – Error 未找到指定 adGroupId 的广告组
404 – Error 一个或多个不正确的 URL 查询参数

getAdGroupSuggestedKeywordsEx

GET /adGroups/{adGroupId}/suggested/keywords/extended

为指定的 adGroupId 检索扩展的建议关键词数据

参数

参数名称 类型 指定位置 描述
adGroupId number URL 路径 请求的广告组的编号
maxNumSuggestions number URL 查询 建议关键词的最大预期数量。默认值为 100,最大值为 1000
suggestBids string URL 查询 有效值为“yes”和“no”。默认值为“no”。如果是“yes”,则任何建议关键词都可以包含额外竞价字段,其中竞价将由计算出的建议竞价填充。 **注意:**如果关键词没有建议竞价,则竞价字段将缺失
adStateFilter string URL 查询 广告状态筛选条件(值以逗号分隔),用于筛选出广告,为其 ASIN 获取建议关键词。有效值为:enabledpausedarchived。默认值为 enabledpaused

响应

状态码 响应对象
200 - Success 为指定的 adGroupId 提供的扩展建议关键词
404 – Not Found 未找到指定 adGroupId 的广告组
400 – Error 一个或多个不正确的 URL 查询参数

getAsinSuggestedKeywords

GET /asins/{asinValue}/suggested/keywords

为指定的 ASIN 提供建议关键词。建议关键词按有效性从最高到最低的顺序排列。

参数

参数名称 类型 指定位置 描述
asinValue string URL 路径 ASIN
maxNumSuggestions number URL 查询 返回的建议关键词的最大数量。默认值为 100,最大值为 1000

响应

状态码 响应对象
200 – Success 为指定的 asinValue 提供的建议关键词
400 – Error 一个或多个不正确的 URL 查询参数,或不正确的 ASIN

bulkGetAsinSuggestedKeywords

POST /asins/suggested/keywords

为指定的 ASIN 列表提供关键词建议。建议关键词按有效性从最高到最低的顺序排列。

参数

参数名称 类型 指定位置 描述
asins List of strings 为其提供了建议关键词的 ASIN 列表
maxNumSuggestions Number 返回的建议关键词的最大数量。默认值为 100,最大值为 1000

响应

状态码 响应对象
200 – Success 为指定的 ASIN 列表提供的建议关键词
400 – Error 一个或多个不正确的 URL 查询参数,或不正确的 ASIN

资源表现

AdGroupSuggestedKeywordsResponse

{
    "title": "AdGroupSuggestedKeywordsResponse",
    "type": "object",
    "properties": {
        "adGroupId": {
            "description": "The ID of the requested ad group.",
            "type": "number"
        },
        "suggestedKeywords": {
            "description": "List of suggested keywords.",
            "type": "array"
        }
    }
}

GetAdGroupSuggestedKeywordsExResponse

{
    "title": "GetAdGroupSuggestedKeywordsExResponse",
    "type": "array",
    "properties": {
        "adGroupId": {
            "description": "The ID of the requested ad group",
            "type": "number"
        },
        "campaignId": {
            "description": "The campaign ID in which the ad group belongs to",
            "type": "number"
        },
        "keywordText": {
            "description": "The suggested keyword",
            "type": "string"
        },
        "matchType": {
            "description": "Match type of the suggested keyword",
            "type": "string"
        },
        "state": {
            "description": "The state of the ad for which the keyword is suggested.Should be either enabled or paused",
            "type": "string"
        },
        "bid": {
            "description": "The keyword bid suggestion.Will only be shown if suggestBid is 'yes' and the keyword has a bid suggestion",
            "type": "number"
        }
    }
}

GetAsinSuggestedKeywordsResponse

{
    "title": "GetAsinSuggestedKeywordsResponse",
    "type": "object",
    "properties": {
        "asin": {
            "description": "The ASIN for which a keyword suggestion is requested",
            "type": "string"
        },
        "suggestedKeywords": {
            "description": "List of suggested keywords",
            "type": "array",
            "properties": {
                "keywordText": {
                    "description": "The suggested keyword",
                    "type": "string"
                },
                "matchType": {
                    "description": "Match type of the suggested keyword",
                    "type": "string"
                }
            }
        }
    }
}

BulkGetAsinSuggestedKeywordsResponse

{
    "title": "BulkGetAsinSuggestedKeywordsResponse",
    "type": "array",
    "properties": {
        "keywordText": {
            "description": "The suggested keyword",
            "type": "string"
        },
        "matchType": {
            "description": "Match type of the suggested keyword",
            "type": "string"
        }
    }
}

Error

请参阅开发人员备注中的错误对象返回 格式。