DSPレポートタイプ

DSP APIでは、さまざまなレポートタイプをサポートしています。レポートタイプごとに、レポートタイプに関連する指標をリクエストできます。レポートのデータの集計レベルは、リクエストしたディメンションにより異なります。たとえば、ORDERディメンションレポートはデータを注文ごとにグループ化し、LINE_ITEMディメンションレポートはデータをラインアイテムごとにグループ化します。複数のディメンションをリクエストしたレポートでは、最も低い集計レベルでデータがグループ化され、リクエストしたすべてのディメンションのすべてのフィールドが含められます。

複数のディメンションを含むレポートの例を参照してください。

デフォルトの指標

ディメンションやレポートタイプに関係なく、すべてのレポートに以下の指標がデフォルトで含まれます。

date（timeUnitがDAILYの場合）
intervalStart（timeUnitがSUMMARYの場合）
intervalEnd（timeUnitがSUMMARYの場合）
entityId
advertiserName
advertiserId

ディメンションにデフォルトの指標があるのと同じように、レポートタイプの中にもデフォルトの指標があるものがあります。レポートタイプごとに記載されているデフォルトの指標を確認してください。

警告

リクエストのmetricsフィールドにデフォルトの指標を指定すると、エラーが返されます。デフォルトの指標は、リクエストしたレポートタイプまたはディメンションに従ってレポートに自動的に含められます。

レポートタイプ

キャンペーン

キャンペーンレポートには、指定した日付にパフォーマンスアクティビティがあったキャンペーンのパフォーマンスデータが記載されます。たとえば、広告が閲覧された回数に加えてキャンペーンで使用されたクリエイティブを確認するには、CREATIVEディメンションと[viewableInpressions](../../../guides/reporting/dsp/metrics .html)指標を指定してキャンペーンレポートをリクエストします。

利用可能なディメンション： 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](../../../guides/reporting/dsp/metrics .html)指標を指定してオーディエンスレポートをリクエストします。

ディメンション： 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"
     }'

商品

商品レポートには、キャンペーンで取り上げられた商品に基づくデータが記載されます。たとえば、Amazonリテールカタログに表示された商品名を確認するには、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、time periodについての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
  }
]

同じaccountId、timeUnit、time periodについて、LINE_ITEMディメンションとORDERディメンションの両方を指定したキャンペーンレポートの例：

[
  {
    "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ディメンションよりも低い集計レベルになります。

開発者ガイドの概要

Amazon Ads APIの概要

DSPレポートタイプ

デフォルトの指標

警告

レポートタイプ

キャンペーン

在庫

オーディエンス

商品

テクノロジー

地域

コンバージョンソース

レポートの例