スナップショットの概要
スナップショットを使用して、スポンサープロダクト広告、スポンサーブランド広告、スポンサーディスプレイ広告キャンペーンの構造を効率的に取得できます。スナップショットは非同期で生成され、キャンペーン、広告グループ、プロダクト広告、ターゲット、キーワードなど、複数のレベルでリクエストできます。
スナップショットとレポート
レポートには指定した日のパフォーマンスデータが含まれますが、スナップショットにはリクエスト時のキャンペーンに関するメタデータが含まれます。つまり、スナップショットを使用して、キャンペーンタイプに応じて、設定されているすべてのキャンペーン、広告グループ、ターゲティングエクスプレッションなどのメタデータを取得できます。
スナップショットとリスト操作
スナップショットは、キャンペーン、広告グループ、キーワード、その他のキャンペーンエンティティのGETおよびGET /extended操作に同様の情報を返します。GETとGET /extendedは同期ですが、スナップショットは非同期で実行されます。多数のキャンペーンや複雑なキャンペーン構造があり、アカウント内のすべてのキャンペーンの情報を取得したい場合は、スナップショットを使用することをおすすめします。
1つのキャンペーンの詳細が必要な場合は、スナップショットの代わりにクエリパラメーターを指定したGETリクエストを使用します。
サンプルスナップショット
スナップショットはJSON形式です。
この例は、1つのターゲティングレコードを含むスポンサープロダクト広告のスナップショットを示しています。
[
{
"targetId":1234567890,
"adGroupId":2345678901,
"campaignId":345678901,
"expressionType":"manual",
"state":"enabled",
"bid":1.18,
"expression":[
{
"type":"asinCategorySameAs",
"value":"2475895011"}
],
"resolvedExpression":[
{
"type":"asinCategorySameAs",
"value":"Men's Wallets"
}
]
}
]
広告タイプ別のスナップショットタイプ
広告タイプごとに、異なるタイプのスナップショットがサポートされます。
| スナップショットのタイプ |
スポンサープロダクト広告 |
スポンサーブランド広告 |
スポンサーディスプレイ広告 |
| campaigns |
x |
x |
x |
| adGroups |
x |
|
x |
| keywords |
x |
x |
|
| negativeKeywords |
x |
|
|
| campaignNegativeKeywords |
x |
|
|
| productAds |
x |
|
x |
| targets |
x |
|
x |
| negativeTargets |
x |
|
|
広告およびスナップショットのタイプ別のフィールド
広告タイプごとにスナップショットに含まれるフィールドが異なります。次のセクションの表には、各タイプのスナップショットに含まれるフィールドが一覧表示されています。
スポンサープロダクト広告
キャンペーン
| フィールド |
説明 |
| campaignId |
キャンペーンのID。レポートデータとの結合に使用できます。 |
| name |
広告主様が指定したキャンペーンの名前。 |
| campaignType |
キャンペーンに関連する広告タイプ。常にsponsoredProducts。 |
| targetingType |
キャンペーンに使用されるターゲティングのタイプ。manualまたはauto。 |
| premiumBidAdjustment |
キャンペーンのプレミアム入札調整が有効になっているかどうかを表すブール値。 |
| dailyBudget |
広告主様が設定したキャンペーンの1日の予算。 |
| startDate |
キャンペーンの開始日。 |
| state |
キャンペーンのステータス（enabled、paused、またはarchived）。 |
| bidding.strategy |
入札戦略。legacyForSales、autoForSales、またはmanual。 |
| bidding.adjustments.predicate |
入札コントロールが使用される掲載枠の位置。placementTopまたはplacementProductPage。 |
| bidding.adjustments.percentage |
入札額調整の割合の値。 |
広告グループ
| フィールド |
説明 |
| adGroupId |
広告グループのID。レポートデータとの結合に使用できます。 |
| name |
広告主様が指定した広告グループの名前。 |
| campaignId |
キャンペーンのID。 |
| defaultBid |
広告グループの入札額の初期値。 |
| state |
広告グループのステータス（enabled、paused、またはarchived）。 |
キーワード
注
オートターゲティングを使用するスポンサープロダクト広告キャンペーンがある場合は、keywordsとtargetsの両方のスナップショットを必ずリクエストして、すべてのキャンペーンターゲティング構造を確実に受け取れるようにしてください。
| フィールド |
説明 |
| keywordId |
キーワードのID。レポートデータとの結合に使用できます。 |
| adGroupId |
広告主様が指定した広告グループの名前。 |
| campaignId |
キャンペーンのID。 |
| keywordText |
キーワードの正確なテキスト。 |
| matchType |
broad、exact、またはphraseのいずれか。 |
| state |
キーワードのステータス（enabled、paused、またはarchived）。 |
| bid |
キーワードの入札額。 |
除外キーワード
| フィールド |
説明 |
| keywordId |
広告グループのID。レポートデータとの結合に使用できます。 |
| adGroupId |
広告主様が指定した広告グループの名前。 |
| campaignId |
キャンペーンのID。 |
| keywordText |
除外キーワードのテキスト。 |
| matchType |
broad、exact、またはphraseのいずれか。 |
| state |
キーワードのステータス（enabled、paused、またはarchived）。 |
キャンペーンの除外キーワード
| フィールド |
説明 |
| keywordId |
広告グループのID。レポートデータとの結合に使用できます。 |
| campaignId |
キャンペーンのID。 |
| keywordText |
除外キーワードのテキスト。 |
| matchType |
broad、exact、またはphraseのいずれか。 |
| state |
キーワードのステータス（enabled、paused、またはarchived）。 |
プロダクト広告
| フィールド |
説明 |
| adId |
広告のID。レポートデータとの結合に使用できます。 |
| adGroupId |
広告グループのID。 |
| campaignId |
キャンペーンのID。 |
| asin |
広告に関連付けられているASIN。 |
| sku |
広告に関連付けられている商品SKU。出品用アカウントにのみ含まれます。 |
| state |
広告のステータス（enabled、paused、またはarchived）。 |
ターゲット
注
オートターゲティングを使用するスポンサープロダクト広告キャンペーンがある場合は、keywordsとtargetsの両方のスナップショットを必ずリクエストして、すべてのキャンペーンターゲティング構造を確実に受け取れるようにしてください。
| フィールド |
説明 |
| targetId |
ターゲティングエクスプレッションのID。レポートデータとの結合に使用できます。 |
| adGroupId |
広告グループのID。 |
| campaignId |
キャンペーンのID。 |
| expressionType |
ターゲティング戦略。manualまたはauto。 |
| state |
ターゲティングエクスプレッションのステータス（enabled、paused、またはarchived）。 |
| bid |
ターゲティングエクスプレッションの入札額。 |
| expression.type |
ターゲティングエクスプレッションで使用される演算子。 |
| expression.value |
ターゲティングエクスプレッションの値。 |
| resolvedExpression.type |
ターゲティングエクスプレッションで使用される演算子。 |
| resolvedExpression.value |
ターゲティングエクスプレッションの解決された値。 |
除外ターゲティング
| フィールド |
説明 |
| targetId |
ターゲティングエクスプレッションのID。レポートデータとの結合に使用できます。 |
| adGroupId |
広告グループのID。 |
| campaignId |
キャンペーンのID。 |
| expressionType |
ターゲティング戦略。manualまたはauto。 |
| state |
ターゲティングエクスプレッションのステータス（enabled、paused、またはarchived）。 |
| expression.type |
ターゲティングエクスプレッションで使用される演算子。 |
| expression.value |
ターゲティングエクスプレッションの値。 |
| resolvedExpression.type |
ターゲティングエクスプレッションで使用される演算子。 |
| resolvedExpression.value |
ターゲティングエクスプレッションの解決された値。 |
スポンサーブランド広告
警告
現在、広告APIは、スポンサーブランド動画広告キャンペーン、またはバージョン4のエンドポイントを使用して作成されたキャンペーンのスナップショットをサポートしていません。スナップショットには、バージョン3の動画以外のキャンペーンのみのレコードが含まれます。
キャンペーン
| フィールド |
説明 |
| campaignId |
キャンペーンのID。レポートデータとの結合に使用できます。 |
| name |
広告主様が指定したキャンペーンの名前。 |
| budget |
広告主様が設定したキャンペーンの1日の予算。 |
| budgetType |
予算の期間。dailyまたはlifetime。 |
| startDate |
キャンペーンの開始日。 |
| state |
キャンペーンのステータス（enabled、paused、またはarchived）。 |
| servingStatus |
キャンペーンの計算されたステータス。 |
| spendingPolicy |
キャンペーンの支出ポリシー。 |
| bidOptimization |
キャンペーンで入札額の自動最適化が有効になっているかどうか。trueまたはfalse。 |
| ruleBasedBudget.value |
ルールに基づく予算の値。 |
| ruleBasedBudget.applicableRuleId |
アクティブなルールの識別子。 |
| ruleBasedBudget.applicableRuleName |
アクティブなルールの名前。 |
| ruleBasedBudget.isProcessing |
ルールの評価が進行中の場合は、trueに設定します。評価が完了し、ルール予算値が更新されたら、falseに設定します。 |
キーワード
| フィールド |
説明 |
| keywordId |
キーワードのID。レポートデータとの結合に使用できます。 |
| adGroupId |
広告主様が指定した広告グループの名前。 |
| campaignId |
キャンペーンのID。 |
| keywordText |
キーワードの正確なテキスト。 |
| matchType |
BROAD、EXACT、またはPHRASEのいずれか。 |
| state |
キーワードのステータス（enabled、paused、またはarchived）。 |
| bid |
キーワードの入札額。 |
スポンサーディスプレイ広告
キャンペーン
| フィールド |
説明 |
| campaignId |
キャンペーンのID。レポートデータとの結合に使用できます。 |
| name |
広告主様が指定したキャンペーンの名前。 |
| tactic |
キャンペーンのターゲティング戦略。T00020またはT00030。 |
| budget |
広告主様が設定したキャンペーンの予算額。 |
| budgetType |
予算が割り当てられる期間。 |
| startDate |
キャンペーンの開始日。 |
| state |
キャンペーンのステータス（enabled、paused、またはarchived）。 |
| costType |
キャンペーンの請求方法。vCPM（1,000件あたりのビューアブルインプレッション単価）またはCPC（クリック課金制）。 |
| deliveryProfile |
常にas_soon_as_possible。 |
| servingStatus |
キャンペーンの計算されたステータス。 |
| creationDate |
キャンペーンが作成された日付。 |
| lastUpdateDate |
キャンペーンの最終更新日。 |
広告グループ
| フィールド |
説明 |
| adGroupId |
広告グループのID。レポートデータとの結合に使用できます。 |
| name |
広告主様が指定した広告グループの名前。 |
| campaignId |
キャンペーンのID。 |
| tactic |
キャンペーンのターゲティング戦略。T00020またはT00030。 |
| defaultBid |
広告グループの入札額の初期値。 |
| bidOptimization |
vCPMキャンペーンの場合、値は常にreachです。CPCキャンペーンの場合、値はclicksまたはconversionsです。 |
| state |
広告グループのステータス（enabled、paused、またはarchived）。 |
| servingStatus |
広告グループの計算されたステータス。 |
| creationDate |
広告グループが作成された日付。 |
| lastUpdateDate |
広告グループの最終更新日。 |
プロダクト広告
| フィールド |
説明 |
| adId |
広告のID。レポートデータとの結合に使用できます。 |
| adGroupId |
広告グループのID。 |
| campaignId |
キャンペーンのID。 |
| asin |
広告に関連付けられているASIN。 |
| sku |
広告に関連付けられている商品SKU。出品用アカウントにのみ含まれます。 |
| state |
広告のステータス（enabled、paused、またはarchived）。 |
| servingStatus |
広告の計算されたステータス。 |
| creationDate |
広告が作成された日付。 |
| lastUpdateDate |
広告の最終更新日。 |
ターゲット
| フィールド |
説明 |
| targetId |
ターゲティングエクスプレッションのID。レポートデータとの結合に使用できます。 |
| adGroupId |
広告グループのID。 |
| expressionType |
ターゲティング戦略。manualまたはauto。 |
| state |
ターゲティングエクスプレッションのステータス（enabled、paused、またはarchived）。 |
| expression.type |
ターゲティングエクスプレッションで使用される演算子。 |
| expression.value |
ターゲティングエクスプレッションの値。 |
| resolvedExpression.type |
ターゲティングエクスプレッションで使用される演算子。 |
| resolvedExpression.value |
ターゲティングエクスプレッションの解決された値。 |
| servingStatus |
ターゲティングエクスプレッションの計算されたステータス。 |
| creationDate |
ターゲティングエクスプレッションが作成された日付。 |
| lastUpdateDate |
ターゲティングエクスプレッションの最終更新日。 |
