DSP 报告类型

DSP API 支持多种报告类型。每种报告类型都允许您请求与该报告类型相关的指标。您报告中的数据的聚合级别取决于您请求的维度。例如，一个 ORDER 维度的报告将按订单分组数据，而 LINE_ITEM 维度的报告将按订单项分组数据。如果您请求多个维度，报告将按最低聚合级别分组数据，并包含所有请求维度的字段。

请参见具有多个维度的示例报告。

默认指标

无论维度或报告类型如何，所有报告都默认包含以下指标：

date（适用于 timeUnit DAILY）
intervalStart（适用于 timeUnit SUMMARY）
intervalEnd（适用于 timeUnit SUMMARY）
entityId
advertiserName
advertiserId

某些报告类型包含默认指标，与维度包含默认指标的方式类似。您可以在每个报告类型下找到默认指标的列表。

警告

如果在请求的 metrics 字段中包含默认指标，将会收到错误提示。默认指标根据请求的报告类型或维度自动包含在报告中。

报告类型

广告活动

广告活动报告中包含了广告活动的效果数据，这些广告活动需在您发出请求的日期产生与效果有关的活动。例如，如果希望查看广告活动中使用的创意素材以及广告的浏览次数，可请求一个包含 CREATIVE 维度以及 viewableImpressions 指标的广告活动报告。

可用维度： ORDER、LINE_ITEM、CREATIVE

默认指标：无

请求示例

curl --location --request POST 'https://advertising-api.amazon.com/accounts/ID123456789/dsp/reports' \
     --header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxxxxxx' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer Atza|xxxxxxxxxxx' \
     --header 'Accept: application/vnd.dspcreatereports.v3+json' \
     --data-raw '{
         "type": "CAMPAIGN",
         "dimensions": ["ORDER", "LINE_ITEM", "CREATIVE"],
         "metrics": ["viewableImpressions"],
         "startDate": "2022-12-05",
         "endDate": "2022-12-19"
     }'

库存

库存报告包含基于您的库存的数据，例如交易和广告库存来源信息。例如，要获取有关投放广告活动所在的网站的信息（网站名称和广告位名称等），请使用 SITE 维度和 placementName 指标来请求广告库存报告。

维度：

在广告库存报告类型的请求中，必须包含 SITE 或 SUPPLY 维度之一。

SITE 解锁指标：placementSize、placementName
DEAL解锁指标：dealType

默认指标：无

请求示例

curl --location --request POST 'https://advertising-api.amazon.com/accounts/ID123456789/dsp/reports' \
     --header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxxxxxx' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer Atza|xxxxxxxxxxx' \
     --header 'Accept: application/vnd.dspcreatereports.v3+json' \
     --data-raw '{
         "type": "INVENTORY",
         "dimensions": ["ORDER", "LINE_ITEM", "SITE", "SUPPLY", "DEAL"],
         "metrics": ["placementName"],
         "startDate": "2022-12-05",
         "endDate": "2022-12-19"
     }'

受众

受众报告包含基于您的受众的数据。例如，要查看广告活动中使用的投放方法，可请求一个包含 targetingMethod 指标的受众报告。

维度： ORDER, LINE_ITEM

默认指标：segment

请求示例

curl --location --request POST 'https://advertising-api.amazon.com/accounts/ID123456789/dsp/reports' \
     --header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxxxxxx' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer Atza|xxxxxxxxxxx' \
     --header 'Accept: application/vnd.dspcreatereports.v3+json' \
     --data-raw '{
         "type": "AUDIENCE",
         "dimensions": ["ORDER", "LINE_ITEM"],
         "metrics": ["targetingMethod"],
         "startDate": "2022-12-05",
         "endDate": "2022-12-19"
     }'

商品

商品报告包含基于广告活动中的首选商品的数据。例如，要查看您在亚马逊零售目录中展示的商品名称，请使用 productName 指标来请求商品报告。

维度： ORDER, LINE_ITEM

默认指标：amazonStandardId、asinConversionType、parentAsin、brandName、reportGranularity、marketplace、featuredAsin

请求示例

curl --location --request POST 'https://advertising-api.amazon.com/accounts/ID123456789/dsp/reports' \
     --header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxxxxxx' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer Atza|xxxxxxxxxxx' \
     --header 'Accept: application/vnd.dspcreatereports.v3+json' \
     --data-raw '{
         "type": "PRODUCTS",
         "dimensions": ["ORDER", "LINE_ITEM"],
         "metrics": ["productName"],
         "startDate": "2022-12-05",
         "endDate": "2022-12-19"
     }'

技术

技术报告包含基于客户技术的数据。例如，要查看顾客浏览广告时所使用的操作系统，请使用 OPERATING_SYSTEM 维度来请求技术报告。

维度： ORDER、LINE_ITEM、OPERATING_SYSTEM、BROWSER_TYPE、BROWSER_VERSION、DEVICE_TYPE、ENVIRONMENT_TYPE

默认指标：无

请求示例

curl --location --request POST 'https://advertising-api.amazon.com/accounts/ID123456789/dsp/reports' \
     --header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxxxxxx' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer Atza|xxxxxxxxxxx' \
     --header 'Accept: application/vnd.dspcreatereports.v3+json' \
     --data-raw '{
         "type": "TECHNOLOGY",
         "dimensions": ["ORDER", "LINE_ITEM", "OPERATING_SYSTEM", "BROWSER_TYPE", "BROWSER_VERSION", "DEVICE_TYPE", "ENVIRONMENT_TYPE"],
         "startDate": "2022-12-05",
         "endDate": "2022-12-19"
     }'

地理位置

地理报告包含顾客所在的地理位置的数据。例如，要查看顾客在浏览广告时所在的州/省或地区，请使用 STATE_COUNTY_REGION 维度来请求地理位置报告。

维度： ORDER、LINE_ITEM、COUNTRY、STATE_COUNTY_REGION、CITY、DMA、POSTAL_CODE

默认指标：无

请求示例

curl --location --request POST 'https://advertising-api.amazon.com/accounts/ID123456789/dsp/reports' \
     --header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxxxxxx' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer Atza|xxxxxxxxxxx' \
     --header 'Accept: application/vnd.dspcreatereports.v3+json' \
     --data-raw '{
         "type": "GEOGRAPHY",
         "dimensions": ["ORDER", "LINE_ITEM", "COUNTRY", "STATE_COUNTY_REGION", "CITY", "DMA", "POSTAL_CODE"],
         "startDate": "2022-12-05",
         "endDate": "2022-12-19"
     }'

转化来源

转化来源报告包含基于顾客转化量的数据。例如，要查看转化来源的名称，可请求转化来源报告。默认情况下，conversionSourceName 包含在您的转化来源报告中。

维度： ORDER、LINE_ITEM、CREATIVE

默认指标：conversionSourceName、conversionSourceOwner、conversionSourceAttributionType、conversionSourceScaled、maxExpectedLatencyHours

请求示例

curl --location --request POST 'https://advertising-api.amazon.com/accounts/ID123456789/dsp/reports' \
     --header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxxxxxx' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer Atza|xxxxxxxxxxx' \
     --header 'Accept: application/vnd.dspcreatereports.v3+json' \
     --data-raw '{
         "type": "CAMPAIGN",
         "dimensions": ["ORDER", "LINE_ITEM", "CREATIVE"],
         "startDate": "2022-12-05",
         "endDate": "2022-12-19"
     }'

示例报告

ORDER 维度的广告活动示例报告:

[
  {
    "orderExternalId": "0",
    "orderEndDate": 1896163140000,
    "orderId": 594085153805041900,
    "orderStartDate": 1620198000000,
    "orderCurrency": "USD",
    "intervalEnd": 1675814400000,
    "orderBudget": 1000000,
    "entityId": "ENTITY222TEST",
    "intervalStart": 1673308800000,
    "advertiserName": "TEST 1",
    "advertiserId": 586529349521920400,
    "orderName": "TEST 1"
  },
  {
    "orderExternalId": null,
    "orderEndDate": 1685602740000,
    "orderId": 589909325330865300,
    "orderStartDate": 1666354800000,
    "orderCurrency": "USD",
    "intervalEnd": 1675814400000,
    "orderBudget": 50000,
    "entityId": "ENTITY222TEST",
    "intervalStart": 1673308800000,
    "advertiserName": "TEST 2",
    "advertiserId": 586529349521920400,
    "orderName": "TEST 2"
  },
  {
    "orderExternalId": null,
    "orderEndDate": 1795679940000,
    "orderId": 587863702290425100,
    "orderStartDate": 1675727460000,
    "orderCurrency": "USD",
    "intervalEnd": 1675814400000,
    "orderBudget": 501,
    "entityId": "ENTITY2W3MXDBG96VM7",
    "intervalStart": 1675641600000,
    "advertiserName": "APS Web - Evergreen Test Campaigns",
    "advertiserId": 586529349521920400,
    "orderName": "MW Deal Ops Test Order_NA"
  }
]

具有相同 accountId、timeUnit 及时间段的LINE_ITEM 维度广告活动示例报告：

[
  {
    "lineItemBudget": 1000000,
    "lineItemId": 585942847172442200,
    "intervalEnd": 1675728000000,
    "lineItemName": "PMP Display Test Campaign",
    "lineItemExternalId": null,
    "lineItemStartDate": 1620198000000,
    "entityId": "ENTITY2W3MXDBG96VM7",
    "intervalStart": 1673395200000,
    "lineItemEndDate": 1896163140000,
    "advertiserName": "APS Web - Evergreen Test Campaigns",
    "advertiserId": 586529349521920400
  },
  {
    "lineItemBudget": 1000000,
    "lineItemId": 577618115260091000,
    "intervalEnd": 1675728000000,
    "lineItemName": "PMP Video Test Campaign",
    "lineItemExternalId": null,
    "lineItemStartDate": 1620198000000,
    "entityId": "ENTITY2W3MXDBG96VM7",
    "intervalStart": 1673481600000,
    "lineItemEndDate": 1896163140000,
    "advertiserName": "APS Web - Evergreen Test Campaigns",
    "advertiserId": 586529349521920400
  }
]

同时包含 LINE_ITEM 和 ORDER 这两个维度且具有相同 accountId、timeUnit 及时间段的广告活动示例报告：

[
  {
    "orderEndDate": 1896163140000,
    "lineItemBudget": 1000000,
    "orderId": 594085153805041900,
    "orderCurrency": "USD",
    "lineItemId": 585942847172442200,
    "orderBudget": 1000000,
    "lineItemName": "PMP Display Test Campaign",
    "lineItemExternalId": null,
    "lineItemStartDate": 1620198000000,
    "entityId": "ENTITY2W3MXDBG96VM7",
    "lineItemEndDate": 1896163140000,
    "advertiserName": "APS Web - Evergreen Test Campaigns",
    "advertiserId": 586529349521920400,
    "orderExternalId": "0",
    "orderStartDate": 1620198000000,
    "intervalEnd": 1675728000000,
    "intervalStart": 1673395200000,
    "orderName": "APS Web - Evergreen Test Order"
  },
  {
    "orderEndDate": 1896163140000,
    "lineItemBudget": 1000000,
    "orderId": 594085153805041900,
    "orderCurrency": "USD",
    "lineItemId": 577618115260091000,
    "orderBudget": 1000000,
    "lineItemName": "PMP Video Test Campaign",
    "lineItemExternalId": null,
    "lineItemStartDate": 1620198000000,
    "entityId": "ENTITY2W3MXDBG96VM7",
    "lineItemEndDate": 1896163140000,
    "advertiserName": "APS Web - Evergreen Test Campaigns",
    "advertiserId": 586529349521920400,
    "orderExternalId": "0",
    "orderStartDate": 1620198000000,
    "intervalEnd": 1675728000000,
    "intervalStart": 1673481600000,
    "orderName": "APS Web - Evergreen Test Order"
  }
]

请注意，尽管请求了 LINE_ITEM 和 ORDER 维度，但报告仍然按订单项分组数据。由于订单包含订单项，因此 LINE_ITEM 维度的聚合级别比 ORDER 维度的聚合级别更低。

开发人员指南概述

亚马逊广告 API 概览

DSP 报告类型

默认指标

警告

报告类型

广告活动

库存

受众

商品

技术

地理位置

转化来源

示例报告