レポートタイプ

Ads APIは、キャンペーンのエンティティ構造に基づいてさまざまなレポートタイプをサポートしています。広告タイプに応じて、キャンペーン、広告グループ、広告、キーワード、ターゲット、ASINなどのさまざまなディメンションでキャンペーンのパフォーマンスを分析できます。

広告タイプ別の利用可否

スポンサー広告のタイプごとに、異なるレポートタイプがサポートされ、別個のパスが定義されています。

レポートタイプ	スポンサープロダクト広告	スポンサーブランド広告
キャンペーン	x
ターゲティング	x
検索ワード	x
広告対象商品	x
購入商品	x	x

キャンペーンレポート

キャンペーンレポートには、キャンペーンレベルで分析されたパフォーマンスデータが含まれています。キャンペーンレポートには、リクエストしたスポンサー広告タイプで、リクエストした日付のパフォーマンスアクティビティが存在するすべてのキャンペーンが含まれています。たとえば、スポンサープロダクト広告のキャンペーンレポートでは、選択した日付にインプレッションを獲得したすべてのスポンサープロダクト広告キャンペーンのパフォーマンスデータが返されます。キャンペーンレポートを広告グループや掲載枠別にグループ化して、より詳細なデータを取得することもできます。

スポンサープロダクト広告

設定

設定	利用可能な値
`reportTypeId`	`spCampaigns`
最大期間	31日間
データ保持	95日間
`timeUnit`	`SUMMARY`または`DAILY`
`groupBy`	`campaign`、`adGroup`、または`campaignPlacement`
`format`	`GZIP_JSON`

基本の指標

impressions、clicks、cost、purchases1d、purchases7d、purchases14d、purchases30d、purchasesSameSku1d、purchasesSameSku7d、purchasesSameSku14d、purchasesSameSku30d、unitsSoldClicks1d、unitsSoldClicks7d、unitsSoldClicks14d、unitsSoldClicks30d、sales1d、sales7d、sales14d、sales30d、attributedSalesSameSku1d、attributedSalesSameSku7d、attributedSalesSameSku14d、attributedSalesSameSku30d、unitsSoldSameSku1d、unitsSoldSameSku7d、unitsSoldSameSku14d、unitsSoldSameSku30d、kindleEditionNormalizedPagesRead14d、kindleEditionNormalizedPagesRoyalties14d、date、startDate、endDate、campaignBiddingStrategy、costPerClick、clickThroughRate、spend

`campaign`でグループ化する場合

追加の指標：campaignName、campaignId、campaignStatus、campaignBudgetAmount、campaignBudgetType、campaignRuleBasedBudgetAmount、campaignApplicableBudgetRuleId、campaignApplicableBudgetRuleName、campaignBudgetCurrencyCode、topOfSearchImpressionShare

フィルター：

campaignStatus（値： ENABLED、PAUSED、ARCHIVED）

`adGroup`でグループ化する場合

追加の指標：adGroupName、adGroupId、adStatus

フィルター：

adStatus（値： ENABLED、PAUSED、ARCHIVED）

`campaignPlacement`でグループ化する場合

追加の指標：placementClassification

フィルター：該当なし

注

レポート設定に指定したすべてのgroupBy値でサポートされるフィルターのみを使用できます。つまり、キャンペーンレポートでは、groupBy値を1つ指定した場合にしか、ファルターは使用できません。

呼び出し例

キャンペーンと広告グループ別にグループ化したキャンペーン日次レポート

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_EXPRESSIONおよびTARGETING_EXPRESSION_PREDEFINEDを設定します。キーワードのみを表示する場合は、keywordTypeフィルターにBROAD、PHRASE、およびEXACTを設定します。

スポンサープロダクト広告

設定

設定	利用可能な値
`reportTypeId`	`spTargeting`
最大期間	31日間
データ保持	95日間
`timeUnit`	`SUMMARY`または`DAILY`
`groupBy`	`targeting`
`format`	`GZIP_JSON`

基本の指標

impressinos、clicks、costPerClick、clickThroughRate、cost、purchases1d、purchases7d、purchases14d、purchases30d、purchasesSameSku1d、purchasesSameSku7d、purchasesSameSku14d、purchasesSameSku30d、unitsSoldClicks1d、unitsSoldClicks7d、unitsSoldClicks14d、unitsSoldClicks30d、sales1d、sales7d、sales14d、sales30d、attributedSalesSameSku1d、attributedSalesSameSku7d、attributedSalesSameSku14d、attributedSalesSameSku30d、unitsSoldSameSku1d、unitsSoldSameSku7d、unitsSoldSameSku14d、unitsSoldSameSku30d、kindleEditionNormalizedPagesRead14d、kindleEditionNormalizedPagesRoyalties14d、salesOtherSku7d、unitsSoldOtherSku7d、acosClicks7d、acosClicks14d、roasClicks7d、roasClicks14d、keywordId、keyword、campaignBudgetCurrencyCode、date、startDate、endDate、portfolioId、campaignName、campaignId、campaignBudgetType、campaignBudgetAmount、campaignStatus、keywordBid、adGroupName、adGroupId、keywordType、matchType、targeting、topOfSearchImpressionShare

`targeting`でグループ化する場合

追加の指標：adKeywordStatus

フィルター：

adKeywordStatus（値： ENABLED、PAUSED、ARCHIVED）
keywordType（値： BROAD、PHRASE、EXACT、TARGETING_EXPRESSION、TARGETING_EXPRESSION_PREDEFINED）

呼び出し例

ターゲティングエクスプレッションのみ

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"
       }
   }'

検索ワードレポート

検索ワードレポートには、ターゲティングエクスプレッションとキーワード別に分析された検索ワードパフォーマンス指標が含まれています。検索ワードレポートには、広告が1回以上クリックされたインプレッションのみが含まれることに注意してください。keywordTypeフィルターを使用すると、ターゲティングエクスプレッションまたはキーワードのどちらかをレポートに含めることができます。

スポンサープロダクト広告

設定

設定	利用可能な値
`reportTypeId`	`spSearchTerm`
最大期間	31日間
データ保持	95日間
`timeUnit`	`SUMMARY`または`DAILY`
`groupBy`	`searchTerm`
`format`	`GZIP_JSON`

基本の指標

impressions、clicks、costPerClick、clickThroughRate、cost、purchases1d、purchases7d、purchases14d、purchases30d、purchasesSameSku1d、purchasesSameSku7d、purchasesSameSku14d、purchasesSameSku30d、unitsSoldClicks1d、unitsSoldClicks7d、unitsSoldClicks14d、unitsSoldClicks30d、sales1d、sales7d、sales14d、sales30d、attributedSalesSameSku1d、attributedSalesSameSku7d、attributedSalesSameSku14d、attributedSalesSameSku30d、unitsSoldSameSku1d、unitsSoldSameSku7d、unitsSoldSameSku14d、unitsSoldSameSku30d、kindleEditionNormalizedPagesRead14d、kindleEditionNormalizedPagesRoyalties14d、salesOtherSku7d、unitsSoldOtherSku7d、acosClicks7d、acosClicks14d、roasClicks7d、roasClicks14d、keywordId、keyword、campaignBudgetCurrencyCode、date、startDate、endDate、portfolioId、searchTerm、campaignName、campaignId、campaignBudgetType、campaignBudgetAmount、campaignStatus、keywordBid、adGroupName、adGroupId、keywordType、matchType、targeting、adKeywordStatus

`searchTerm`でグループ化する場合

追加の指標：adKeywordStatus

フィルター：

keywordType（値： BROAD、PHRASE、EXACT、TARGETING_EXPRESSION、TARGETING_EXPRESSION_PREDEFINED）

呼び出し例

ターゲティングエクスプレッションのみ

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`	`SUMMARY`または`DAILY`
`groupBy`	`advertiser`
`format`	`GZIP_JSON`

基本の指標

date、startDate、endDate、campaignName、campaignId、adGroupName、adGroupId、adId、portfolioId、impressions、clicks、costPerClick、clickThroughRate、cost、spend、campaignBudgetCurrencyCode、campaignBudgetAmount、campaignBudgetType、campaignStatus、advertisedAsin、advertisedSku、purchases1d、purchases7d、purchases14d、purchases30d、purchasesSameSku1d、purchasesSameSku7d、purchasesSameSku14d、purchasesSameSku30d、unitsSoldClicks1d、unitsSoldClicks7d、unitsSoldClicks14d、unitsSoldClicks30d、sales1d、sales7d、sales14d、sales30d、attributedSalesSameSku1d、attributedSalesSameSku7d、attributedSalesSameSku14d、attributedSalesSameSku30d、salesOtherSku7d、unitsSoldSameSku1d、unitsSoldSameSku7d、unitsSoldSameSku14d、unitsSoldSameSku30d、unitsSoldOtherSku7d、kindleEditionNormalizedPagesRead14d、kindleEditionNormalizedPagesRoyalties14d、acosClicks7d、acosClicks14d、roasClicks7d、roasClicks14d

`advertiser`でグループ化する場合

追加の指標：該当なし

フィルター：

adCreativeStatus（値： ENABLED、PAUSED、ARCHIVED）

呼び出し例

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"
   }
}'

購入商品レポート

スポンサープロダクト広告

スポンサープロダクト広告の購入商品レポートには、キャンペーンの一環として広告を掲載した商品ではないのに購入された商品のパフォーマンスデータが含まれています。購入商品レポートには、ターゲティングエクスプレッションとキーワードIDの両方が含まれています。レポートを受け取ったら、keywordTypeでフィルタリングして、ターゲットエクスプレッションとキーワードを区別できます。

設定

設定	利用可能な値
`reportTypeId`	`spPurchasedProduct`
最大期間	31日間
データ保持	95日間
`timeUnit`	`SUMMARY`または`DAILY`
`groupBy`	`asin`
`format`	`GZIP_JSON`

基本の指標

date、startDate、endDate、portfolioId、campaignName、campaignId、adGroupName、adGroupId、keywordId、keyword、keywordType、advertisedAsin、purchasedAsin、advertisedSku、campaignBudgetCurrencyCode、matchType、unitsSoldClicks1d、unitsSoldClicks7d、unitsSoldClicks14d、unitsSoldClicks30d、sales1d、sales7d、sales14d、sales30d、purchases1d、purchases7d、purchases14d、purchases30d、unitsSoldOtherSku1d、unitsSoldOtherSku7d、unitsSoldOtherSku14d、unitsSoldOtherSku30d、salesOtherSku1d、salesOtherSku7d、salesOtherSku14d、salesOtherSku30d、purchasesOtherSku1d、purchasesOtherSku7d、purchasesOtherSku14d、purchasesOtherSku30d、kindleEditionNormalizedPagesRead14d、kindleEditionNormalizedPagesRoyalties14d

`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`	`SUMMARY`または`DAILY`
`groupBy`	`purchasedAsin`
`format`	`GZIP_JSON`

基本の指標

date、startDate、endDate、campaignBudgetCurrencyCode、campaignName、adGroupName、attributionType、purchasedAsin、productName、productCategory、sales14d、orders14d、unitsSold14d、newToBrandSales14d、newToBrandPurchases14d、newToBrandUnitsSold14d、newToBrandSalesPercentage14d、newToBrandPurchasesPercentage14d、newToBrandUnitsSoldPercentage14d

`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"
    }
}'

開発者ガイドの概要

Amazon Ads APIの概要

レポートタイプ

広告タイプ別の利用可否

キャンペーンレポート

スポンサープロダクト広告

設定

基本の指標

campaignでグループ化する場合

adGroupでグループ化する場合

campaignPlacementでグループ化する場合

注

呼び出し例

キャンペーンと広告グループ別にグループ化したキャンペーン日次レポート

キャンペーンと掲載枠別にグループ化したキャンペーンサマリレポート

ターゲティングレポート

スポンサープロダクト広告

設定

基本の指標

targetingでグループ化する場合

呼び出し例

ターゲティングエクスプレッションのみ

キーワードのみ

検索ワードレポート

スポンサープロダクト広告

設定

基本の指標

searchTermでグループ化する場合

呼び出し例

ターゲティングエクスプレッションのみ

キーワードのみ

広告商品レポート

スポンサープロダクト広告

設定

基本の指標

advertiserでグループ化する場合

呼び出し例

購入商品レポート

スポンサープロダクト広告

設定

基本の指標

asinでグループ化する場合

呼び出し例

スポンサーブランド広告

設定

基本の指標

purchasedAsinでグループ化する場合

呼び出し例

`campaign`でグループ化する場合

`adGroup`でグループ化する場合

`campaignPlacement`でグループ化する場合

`targeting`でグループ化する場合

`searchTerm`でグループ化する場合

`advertiser`でグループ化する場合

`asin`でグループ化する場合

`purchasedAsin`でグループ化する場合