開発者ガイドの概要

Amazon Ads APIの概要

ディメンション

ディメンションによって、レポートデータの集計レベルが決まります。使用可能なディメンションは、選択したレポートタイプによって異なります。ディメンションごとに特定の指標がレポートに自動的に追加されます。下記の表に、各レポートタイプで使用できるディメンションと、自動的に追加される指標を示しています。

何も指定しない場合は、「注文」がデフォルトのディメンションになります。

概要表

| ディメンション | レポートタイプ | デフォルトの指標 | |--- |--- |--- | | 注文 | すべて | orderName
orderId
orderStartDate
orderEndDate
orderBudget
orderExternalId
orderCurrency | | ラインアイテム | すべて | lineItemName
lineItemId
lineItemStartDate
lineItemEndDate
lineItemBudget
lineItemExternalId | | クリエイティブ | キャンペーン
コンバージョンソース | creativeName
creativeID
creativeType
creativeSize
creativeAdIdコンバージョンソースレポートでは利用不可) | | サイト | 在庫 | siteName | | 広告在庫 | 在庫 | supplySourceName | | セール | 在庫 | deal
dealID | | 国 | 地理 | country | | State_country_region | 地理 | region | | 市区町村 | 地理 | city | | DMA | 地理 | designatedMarketAreaCode
designatedMarketAreaName | | 郵便番号 | 地理 | postalCode | | オペレーティングシステム | テクノロジー | operatingSystem | | ブラウザータイプ | テクノロジー | browser | | ブラウザーバージョン | テクノロジー | browserVersion | | デバイスタイプ | テクノロジー | device | | 環境 | テクノロジー | environmentType |

各ディメンションのデフォルト指標

レポートデータには、ディメンションごとにデフォルトの指標が自動的に含められます。これらのデフォルトの指標をリクエスト本文の指標リストに指定しようとすると、エラーが返されます。

リクエスト本文にデフォルトの指標を指定した場合のエラー例

この誤ったリクエストのレポートタイプは地理、ディメンションはDMAです。

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" ["DMA"],
         "metrics": ["designatedMarketAreaCode"],
         "startDate": "2022-12-05",
         "endDate": "2022-12-19"
     }'

metricsフィールドにDMAディメンションのデフォルトの指標であるdesignatedMarketAreaCodeが含まれているために、APIからエラーが返されます。

{
    "message": "'1' validation error(s) occurred.Please correct them and request again.",
    "requestId": "c4e391f6-cdcc-4ee1-a4df-3ff50a8f25d7",
    "errors": [
    {
        "errorType": "REQUEST_BODY_FIELD_INVALID_METRICS",
        "field": "metrics",
        "message": "Request body field 'metrics' has invalid values: [designatedMarketAreaCode]"
        }
    ]
}