開発者ガイドの概要

Amazon Ads APIの概要

開発者メモ

オブジェクトID

APIはすべてのエンティティに不変のIDを割り当てます。これらのエンティティIDは、レポートインターフェイスから取得されたパフォーマンスデータを、キャンペーン管理インターフェイスで管理されるキャンペーンエンティティと照合するために使用されます。すべてのエンティティのIDは、64ビットの符号なし整数の範囲内になります。特定のタイプではIDは固有ですが、タイプが異なる2つのオブジェクトは同一IDを持つことはあります（たとえば、キャンペーンのcampaignIdが、関連のない広告グループのadGroupIdと同じであることがあります）。

プロファイル内では各タイプのIDは一意です。たとえば、同じプロファイルに紐づけられている2つのキャンペーン（広告タイプを問わない）が同じcampaignIdを持つことはありませんが、異なるプロファイルで同じcampaignIdが表示されることはあります。

アーカイブ

これは変更です。非表示にしたエンティティを変更することはできませんが、現在キャンペーンマネージャーとダウンロード可能なレポートで表示しているのと同様に、非表示にしたエンティティとそのパフォーマンスを表示することはできます。また、非表示にしたエンティティはエンティティ数の制限の対象には含められないため、実質上、エンティティ数の上限が増えることになります。

ページ番号表示の一貫性

管理APIを使用してバッチリクエストを行う場合、各ページリクエストは個別に行われます。結果には一定の順序で並べられますが、フィルタリング基準を満たすレコードセットが各ページリクエスト間で異なる場合、ページ番号表示で重複レコードや欠落レコードが発生することがあります。エンティティのスナップショットとレポートでは、この問題は発生しません。

操作のアトミシティ

バッチ更新操作およびバッチ作成操作は非アトミックであることに注意してください。

冪等性

同じ操作を複数回実行した場合に、最終的なサーバーの状態は変わらないという点で、すべての操作は冪等です。ただし、作成操作を重複して行った場合は2回目のリクエストでエラーが生じるため、必ずしも同じレスポンスが返されるとは限りません。

作成操作では、以下の一意性の制約を順守することで冪等性が保証されます。この制約に違反した場合、リソースがすでに存在することを示すエラーが返されます。

レポートとスナップショットの場合は、ファイルが記憶されるため、リクエストを重複して行うと同じレポートIDが返されます

一部更新

エンティティを更新するために必要な唯一の属性はIDです。これを使用することで一部更新が可能になります。一部更新では、属性の一部のみが提供され、その他すべての属性は変更されません。これにより、大量のキーワード入札の変更といった一般的な操作のリクエストを簡潔に行えるようになります。

暗黙的な操作

バッチ更新を使用して、エンティティを暗黙的に作成することや、非表示にする/削除することができます。更新にIDが存在せず、作成に必要なすべての属性は存在する場合、新しいエンティティを作成するものと解釈されます。同様に、IDが存在し、状態が非表示であるバッチ更新を使用して、エンティティを非表示にすることができます。

キャンペーン管理の非同期スナップショットと同期バッチGET

同期バッチ操作でAPIを使用して、キャンペーン、広告グループ、キーワード、広告を取得できます。また、APIによって、タイプが同じであるエンティティすべての完全なスナップショットを取得するための同期インターフェイスが提供されます。クライアントがすべてのキャンペーン、広告グループ、キーワード、または広告を一括で取得しようとする場合、一般にはスナップショットのほうが効率的です。これは、アカウント構造をローカルで複製するクライアントで役立ちます。

各広告タイプのスナップショットの仕様については、以下をご覧ください。

拡張属性を持つGET

拡張属性には計算済み/継承されたステータスが含まれるため、これらの属性がリクエストされたバッチGETは本質的にコストが高くなります。特にアカウント構造が1日に複数回リクエストされる場合、クライアントでは保存されている親と祖父母のステータスを使用して、継承されたステータスをローカルで計算することが推奨されます。

スポンサーブランド広告審査

Amazon Adsでは、広告のカスタマーエクスペリエンスの基準を高く維持することが、広告主様により良い結果をもたらすことに役立つと考えています。そこで、カスタマーエクスペリエンスの品質維持および向上に役立つお客様中心の広告ポリシーを制定しました。ユーザーが新しいスポンサーブランド広告キャンペーンを送信したり、既存のキャンペーンに変更を加えたりした場合、Amazonは審査プロセスを実施して、Amazonでのお客様のショッピング体験に設定している高い品質水準を満たしていることを確認します。審査中のキャンペーンは「審査のため保留中」の状態に設定されます。広告主様には、アカウントにリンクされているメールアドレスに、キャンペーンが審査中であることを伝えるメールが届きます。広告主様には、広告の承認可否を通知するメールが72時間以内に届きます。現時点では、サンドボックスでは審査をご利用いただけません。

Amazon Advertising logo