开发人员指南概述

亚马逊广告 API 概览

报告类型

根据广告活动实体结构,广告 API 支持多种报告类型。根据广告类型,广告活动效果可以按各种维度进行细分,其中包括广告活动、广告组、广告、关键词、投放内容和 ASIN。

广告类型可用性划分

每种类型的搜索广告都支持不同的报告类型,并且定义了单独的路径。

报告类型 商品推广 品牌推广
广告活动 x
投放 x
搜索词 x
推广的商品 x
已购买商品 x x

广告活动报告

广告活动报告包含广告活动级别细分的效果数据。对于请求的搜索广告类型,广告活动报告包括所有在请求的日期具有效果活动的广告活动。例如,商品推广活动报告会返回在选定日期获得展示量的所有商品推广活动的效果数据。广告活动报告也可以按广告组和广告位进行分组,以获得更精细的数据。

商品推广

配置

配置 可用值
reportTypeId spCampaigns
最大日期范围 31 天
数据保留 95 天
timeUnit SUMMARYDAILY
groupBy campaignadGroupcampaignPlacement
format GZIP_JSON

基本指标

impressionsclickscostpurchases1dpurchases7dpurchases14dpurchases30dpurchasesSameSku1dpurchasesSameSku7dpurchasesSameSku14dpurchasesSameSku30dunitsSoldClicks1dunitsSoldClicks7dunitsSoldClicks14dunitsSoldClicks30dsales1dsales7dsales14dsales30dattributedSalesSameSku1dattributedSalesSameSku7dattributedSalesSameSku14dattributedSalesSameSku30dunitsSoldSameSku1dunitsSoldSameSku7dunitsSoldSameSku14dunitsSoldSameSku30dkindleEditionNormalizedPagesRead14dkindleEditionNormalizedPagesRoyalties14ddatestartDateendDatecampaignBiddingStrategycostPerClickclickThroughRatespend

分组条件:campaign

其他指标:campaignNamecampaignIdcampaignStatuscampaignBudgetAmountcampaignBudgetTypecampaignRuleBasedBudgetAmountcampaignApplicableBudgetRuleIdcampaignApplicableBudgetRuleNamecampaignBudgetCurrencyCodetopOfSearchImpressionShare

筛选条件:

分组条件:adGroup

其他指标:adGroupNameadGroupIdadStatus

筛选条件:

分组条件:campaignPlacement

其他指标:placementClassification

筛选条件: 不适用

注意

您只能使用报告配置中包含的所有 groupBy 值都支持的筛选条件。对于广告活动报告,这意味着仅当添加单个 groupBy 值时,才支持筛选条件。

调用示例

按广告活动和广告组进行分组的广告活动每日报告

curl --location --request POST 'https://advertising-api.amazon.com/reporting/reports' \
--header 'Content-Type: application/vnd.createasyncreportrequest.v3+json' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxx' \
--header 'Amazon-Advertising-API-Scope: xxxxxxxx' \
--header 'Authorization: Bearer Atza|xxxxxxxxx' \
--data-raw '{
    "name":"SP campaigns report 7/5-7/10",
    "startDate":"2022-07-05",
    "endDate":"2022-07-10",
    "configuration":{
        "adProduct":"SPONSORED_PRODUCTS",
        "groupBy":["campaign","adGroup"],
        "columns":["impressions","clicks","cost","campaignId","adGroupId","date"],
        "reportTypeId":"spCampaigns",
        timeUnit":"DAILY",
        "format":"GZIP_JSON"
    }
}'

按广告活动和广告位进行分组的广告活动汇总报告

curl --location --request POST 'https://advertising-api.amazon.com/reporting/reports' \
--header 'Content-Type: application/vnd.createasyncreportrequest.v3+json' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxx' \
--header 'Amazon-Advertising-API-Scope: xxxxxxxx' \
--header 'Authorization: Bearer Atza|xxxxxxxxxxx' \
 --data-raw '{
    "name":"SP campaigns report 7/5-7/10",
    "startDate":"2022-07-05",
    "endDate":"2022-07-10",
    "configuration":{
        "adProduct":"SPONSORED_PRODUCTS",
        "groupBy":["campaign","campaignPlacement"],
        "columns":["impressions","clicks","cost","campaignId","placementClassification","startDate","endDate"],
        "reportTypeId":"spCampaigns",
        "timeUnit":"SUMMARY",
        "format":"GZIP_JSON"
    }
}'

投放报告

投放报告包含按投放表达式和关键词细分的效果指标。要仅查看投放表达式,请将 keywordType 筛选条件设置为 TARGETING_EXPRESSIONTARGETING_EXPRESSION_PREDEFINED。要仅查看关键词,请将 keywordType 筛选条件设置为 BROADPHRASEEXACT

商品推广

配置

配置 可用值
reportTypeId spTargeting
最大日期范围 31 天
数据保留 95 天
timeUnit SUMMARYDAILY
groupBy targeting
format GZIP_JSON

基本指标

impressionsclickscostPerClickclickThroughRatecostpurchases1dpurchases7dpurchases14dpurchases30dpurchasesSameSku1dpurchasesSameSku7dpurchasesSameSku14dpurchasesSameSku30dunitsSoldClicks1dunitsSoldClicks7dunitsSoldClicks14dunitsSoldClicks30dsales1dsales7dsales14dsales30dattributedSalesSameSku1dattributedSalesSameSku7dattributedSalesSameSku14dattributedSalesSameSku30dunitsSoldSameSku1dunitsSoldSameSku7dunitsSoldSameSku14dunitsSoldSameSku30dkindleEditionNormalizedPagesRead14dkindleEditionNormalizedPagesRoyalties14dsalesOtherSku7dunitsSoldOtherSku7dacosClicks7dacosClicks14droasClicks7droasClicks14dkeywordIdkeywordcampaignBudgetCurrencyCodedatestartDateendDateportfolioIdcampaignNamecampaignIdcampaignBudgetTypecampaignBudgetAmountcampaignStatuskeywordBidadGroupNameadGroupIdkeywordTypematchTypetargetingtopOfSearchImpressionShare

分组条件:targeting

其他指标:adKeywordStatus

筛选条件:

调用示例

仅限投放表达式

curl --location --request POST 'https://advertising-api.amazon.com/reporting/reports' \
--header 'Content-Type: application/vnd.createasyncreportrequest.v3+json' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxx' \
--header 'Amazon-Advertising-API-Scope: xxxxxxxx' \
--header 'Authorization: Bearer Atza|xxxxxxxxx' \
--data-raw '{
       "name":"SP targeting report 7/5-7/10",
       "startDate":"2022-07-05",
       "endDate":"2022-07-10",
       "configuration":{
           "adProduct":"SPONSORED_PRODUCTS",
           "groupBy":["targeting"],
           "columns":["adGroupId","campaignId", "targeting","keywordId","matchType","impressions", "clicks", "cost", "purchases1d", "purchases7d", "purchases14d", "purchases30d","startDate","endDate"],
           "filters": [
               {
                   "field": "keywordType",
                   "values": [
                   "TARGETING_EXPRESSION",
                   "TARGETING_EXPRESSION_PREDEFINED"
                   ]
               }
           ],
           "reportTypeId":"spTargeting",
           "timeUnit":"SUMMARY",
           "format":"GZIP_JSON"
       }
   }'

仅限关键词

curl --location --request POST 'https://advertising-api.amazon.com/reporting/reports' \
--header 'Content-Type: application/vnd.createasyncreportrequest.v3+json' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxx' \
--header 'Amazon-Advertising-API-Scope: xxxxxxxx' \
--header 'Authorization: Bearer Atza|xxxxxxxxx' \
--data-raw '{
       "name":"SP keywords report 7/5-7/10",
       "startDate":"2022-07-05",
       "endDate":"2022-07-10",
       "configuration":{
           "adProduct":"SPONSORED_PRODUCTS",
           "groupBy":["targeting"],
           "columns":["adGroupId","campaignId","keywordId","matchType","keyword","impressions", "clicks", "cost", "purchases1d", "purchases7d", "purchases14d", "purchases30d","startDate","endDate"],
           "filters": [
               {
                   "field": "keywordType",
                   "values": [
                   "BROAD",
                   "PHRASE",
                   "EXACT"
                   ]
               }
           ],
           "reportTypeId":"spTargeting",
           "timeUnit":"SUMMARY",
           "format":"GZIP_JSON"
       }
   }'

搜索词报告

搜索词报告包含按投放表达式和关键词细分的搜索词效果指标。请注意,搜索词报告仅包括导致至少一次广告点击的展示量。使用 keywordType 筛选条件在报告中包含投放表达式或关键词。

商品推广

配置

配置 可用值
reportTypeId spSearchTerm
最大日期范围 31 天
数据保留 95 天
timeUnit SUMMARYDAILY
groupBy searchTerm
format GZIP_JSON

基本指标

impressionsclickscostPerClickclickThroughRatecostpurchases1dpurchases7dpurchases14dpurchases30dpurchasesSameSku1dpurchasesSameSku7dpurchasesSameSku14dpurchasesSameSku30dunitsSoldClicks1dunitsSoldClicks7dunitsSoldClicks14dunitsSoldClicks30dsales1dsales7dsales14dsales30dattributedSalesSameSku1dattributedSalesSameSku7dattributedSalesSameSku14dattributedSalesSameSku30dunitsSoldSameSku1dunitsSoldSameSku7dunitsSoldSameSku14dunitsSoldSameSku30dkindleEditionNormalizedPagesRead14dkindleEditionNormalizedPagesRoyalties14dsalesOtherSku7dunitsSoldOtherSku7dacosClicks7dacosClicks14droasClicks7droasClicks14dkeywordIdkeywordcampaignBudgetCurrencyCodedatestartDateendDateportfolioIdsearchTermcampaignNamecampaignIdcampaignBudgetTypecampaignBudgetAmountcampaignStatuskeywordBidadGroupNameadGroupIdkeywordTypematchTypetargetingadKeywordStatus

分组条件:searchTerm

其他指标:adKeywordStatus

筛选条件:

调用示例

仅限投放表达式

curl --location --request POST 'https://advertising-api.amazon.com/reporting/reports' \
--header 'Content-Type: application/vnd.createasyncreportrequest.v3+json' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxx' \
--header 'Amazon-Advertising-API-Scope: xxxxxxxx' \
--header 'Authorization: Bearer Atza|xxxxxxxxx' \
--data-raw '{
    "name":"SP search term report 7/5-7/10",
    "startDate":"2022-07-05",
    "endDate":"2022-07-10",
    "configuration":{
        "adProduct":"SPONSORED_PRODUCTS",
        "groupBy":["searchTerm"],
        "columns":["impressions","clicks","cost","campaignId","adGroupId","date","targeting","searchTerm","keywordType","keywordId"],
        "filters": [
            {
                "field": "keywordType",
                "values": [
                    "TARGETING_EXPRESSION",
                    "TARGETING_EXPRESSION_PREDEFINED"
                ]
            }
        ],
        "reportTypeId":"spSearchTerm",
        "timeUnit":"DAILY",
        "format":"GZIP_JSON"
    }
}'

仅限关键词

curl --location --request POST 'https://advertising-api.amazon.com/reporting/reports' \
--header 'Content-Type: application/vnd.createasyncreportrequest.v3+json' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxx' \
--header 'Amazon-Advertising-API-Scope: xxxxxxxx' \
--header 'Authorization: Bearer Atza|xxxxxxxxx' \
--data-raw '{
    "name":"SP search terms report 7/5-7/10",
    "startDate":"2022-07-05",
    "endDate":"2022-07-10",
    "configuration":{
        "adProduct":"SPONSORED_PRODUCTS",
        "groupBy":["searchTerm"],
        "columns":["impressions","clicks","cost","campaignId","adGroupId","startDate","endDate","keywordType","keyword","matchType","keywordId","searchTerm"],
        "filters": [
            {
                "field": "keywordType",
                "values": [
                    "BROAD",
                    "PHRASE",
                    "EXACT"
                ]
            }
        ],
        "reportTypeId":"spSearchTerm",
        "timeUnit":"SUMMARY",
        "format":"GZIP_JSON"
    }
}'

推广的商品报告

推广的商品报告包含作为广告活动一部分进行推广的商品的效果数据。

商品推广

配置

配置 可用值
reportTypeId spAdvertisedProduct
最大日期范围 31 天
数据保留 95 天
timeUnit SUMMARYDAILY
groupBy advertiser
format GZIP_JSON

基本指标

datestartDateendDatecampaignNamecampaignIdadGroupNameadGroupIdadIdportfolioIdimpressionsclickscostPerClickclickThroughRatecostspendcampaignBudgetCurrencyCodecampaignBudgetAmountcampaignBudgetTypecampaignStatusadvertisedAsinadvertisedSkupurchases1dpurchases7dpurchases14dpurchases30dpurchasesSameSku1dpurchasesSameSku7dpurchasesSameSku14dpurchasesSameSku30dunitsSoldClicks1dunitsSoldClicks7dunitsSoldClicks14dunitsSoldClicks30dsales1dsales7dsales14dsales30dattributedSalesSameSku1dattributedSalesSameSku7dattributedSalesSameSku14dattributedSalesSameSku30dsalesOtherSku7dunitsSoldSameSku1dunitsSoldSameSku7dunitsSoldSameSku14dunitsSoldSameSku30dunitsSoldOtherSku7dkindleEditionNormalizedPagesRead14dkindleEditionNormalizedPagesRoyalties14dacosClicks7dacosClicks14droasClicks7droasClicks14d

分组条件:advertiser

其他指标: 不适用

筛选条件:

调用示例

curl --location --request POST 'https://advertising-api.amazon.com/reporting/reports' \
--header 'Content-Type: application/vnd.createasyncreportrequest.v3+json' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxx' \
--header 'Amazon-Advertising-API-Scope: xxxxxxx' \
--header 'Authorization: Bearer Atza|xxxxxxxxxxxxx' \
--data-raw '{
   "name":"SP advertised product report 7/5-7/10",
   "startDate":"2022-07-05",
   "endDate":"2022-07-10",
   "configuration":{
       "adProduct":"SPONSORED_PRODUCTS",
       "groupBy":["advertiser"],
       "columns":["impressions","clicks","cost","campaignId","advertisedAsin"],
       "reportTypeId":"spAdvertisedProduct",
       "timeUnit":"SUMMARY",
       "format":"GZIP_JSON"
   }
}'

已购买商品报告

商品推广

商品推广已购买商品报告包含已购买但未作为广告活动的一部分进行推广的商品的效果数据。已购买商品报告包含投放表达式和关键词编号。收到报告后,您可以对 keywordType 进行筛选,以区分投放表达式和关键词。

配置

配置 可用值
reportTypeId spPurchasedProduct
最大日期范围 31 天
数据保留 95 天
timeUnit SUMMARYDAILY
groupBy asin
format GZIP_JSON

基本指标

datestartDateendDateportfolioIdcampaignNamecampaignIdadGroupNameadGroupIdkeywordIdkeywordkeywordTypeadvertisedAsinpurchasedAsinadvertisedSkucampaignBudgetCurrencyCodematchTypeunitsSoldClicks1dunitsSoldClicks7dunitsSoldClicks14dunitsSoldClicks30dsales1dsales7dsales14dsales30dpurchases1dpurchases7dpurchases14dpurchases30dunitsSoldOtherSku1dunitsSoldOtherSku7dunitsSoldOtherSku14dunitsSoldOtherSku30dsalesOtherSku1dsalesOtherSku7dsalesOtherSku14dsalesOtherSku30dpurchasesOtherSku1dpurchasesOtherSku7dpurchasesOtherSku14dpurchasesOtherSku30dkindleEditionNormalizedPagesRead14dkindleEditionNormalizedPagesRoyalties14d

分组条件:asin

其他指标: 不适用

筛选条件: 不适用

调用示例

curl --location --request POST 'https://advertising-api.amazon.com/reporting/reports' \
--header 'Content-Type: application/vnd.createasyncreportrequest.v3+json' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxx' \
--header 'Amazon-Advertising-API-Scope: xxxxxxxx' \
--header 'Authorization: Bearer Atza|xxxxxxxxxx' \
--data-raw '{
    "name":"SP purchased product report 7/5-7/10",
    "startDate":"2022-07-05",
    "endDate":"2022-07-10",
    "configuration":{
        "adProduct":"SPONSORED_PRODUCTS",
        "groupBy":["asin"],
        "columns":["purchasedAsin","advertisedAsin","adGroupName","campaignName","sales14d","campaignId","adGroupId","keywordId","keywordType","keyword"],
        "reportTypeId":"spPurchasedProduct",
        "timeUnit":"SUMMARY",
        "format":"GZIP_JSON"
    }
}'

品牌推广

品牌推广已购买商品报告包含因广告活动而购买的商品的效果数据。

配置

配置 可用值
reportTypeId sbPurchasedProduct
最大日期范围 731 天
数据保留 731 天
timeUnit SUMMARYDAILY
groupBy purchasedAsin
format GZIP_JSON

基本指标

datestartDateendDatecampaignBudgetCurrencyCodecampaignNameadGroupNameattributionTypepurchasedAsinproductNameproductCategorysales14dorders14dunitsSold14dnewToBrandSales14dnewToBrandPurchases14dnewToBrandUnitsSold14dnewToBrandSalesPercentage14dnewToBrandPurchasesPercentage14dnewToBrandUnitsSoldPercentage14d

分组条件:purchasedAsin

其他指标: 不适用

筛选条件: 不适用

调用示例

curl --location --request POST 'https://advertising-api.amazon.com/reporting/reports' \
--header 'Content-Type: application/vnd.createasyncreportrequest.v3+json' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxx' \
--header 'Amazon-Advertising-API-Scope: xxxxxxxx' \
--header 'Authorization: Bearer Atza|xxxxxxxxxx' \
--data-raw '{
    "name":"SB purchased product report 7/5-7/10",
    "startDate":"2022-07-05",
    "endDate":"2022-07-10",
    "configuration":{
        "adProduct":"SPONSORED_BRANDS",
        "groupBy":["purchasedAsin"],
        "columns":["purchasedAsin","attributionType","adGroupName","campaignName","sales14d","startDate","endDate"],
        "reportTypeId":"sbPurchasedProduct",
        "timeUnit":"SUMMARY",
        "format":"GZIP_JSON"
    }
}'