開発者ガイドの概要

Amazon Ads APIの概要

AmazonアトリビューションAPIの使用方法

広告主のプロフィールにアクセスする権限を付与されたら、AmazonアトリビューションAPIを使用して、広告主に関連付けられている以下のリソースを読み取ることができます。

プロフィールリソース

プロフィールとは、特定のマーケットにおける広告主のアカウントを表すものです。AmazonアトリビューションAPIエンドポイントを呼び出すたびに、プロフィールIDをAmazon-Advertising-Api-Scopeヘッダーとして渡す必要があります。/v2/profilesを呼び出すことで、アクセスできるプロフィールのリストを取得できます。

広告主リソース

警告

Amazonアトリビューションの広告主リソースは、このAPIの将来のバージョンで廃止される予定です。現在は、下位互換性を確保するためにすべてのプロフィールでサポートされています。広告コンソールのプロフィールのみをサポートするインテグレーターは、このリソースを使用しないでください。

広告主リソースを使用して、プロフィールに関連付けられているAmazonアトリビューションの「広告主」を取得できます。広告コンソールのプロフィールに含まれる広告主は1つのみです。広告主様(お取引会社様)のDSPベースのプロフィールにはAmazonアトリビューションの広告主が複数含まれる場合がありますが、出品者の広告主は常に1つのみです。以下のいずれかのエンドポイントに対して、advertiserIdをオプションパラメーターとして渡すこともできます。

パブリッシャーリソース

パブリッシャーリソースを使用して、サポートされているすべてのパブリッシャーのリストを取得できます。リストの各項目には、パブリッシャー名、パブリッシャーID、およびパブリッシャーのタグにマクロ(動的パラメーター)が含まれるかどうかが入っています。どの広告主でもパブリッシャーリソースは同じです。アトリビューションタグ取得エンドポイントを呼び出すときに、パブリッシャーIDを渡します。

リストにパブリッシャーが含まれていない場合は、Amazon Ads APIサポートのJiraサービスデスク経由でAPIサポートチームにお問い合わせください。

アトリビューションタグリソース

広告主のprofileIdとパブリッシャーのリストを取得したら、タグを取得するために呼び出すアトリビューションタグリソースを選択します。

Amazonアトリビューションでは、Google広告、Facebook、Microsoft広告、Pinterestなどのパブリッシャー向けマクロが含まれているタグを提供しています。このようなパブリッシャーの場合、/attribution/tags/macroTagを呼び出します。これらのタグは意図したパブリッシャーでのみ機能し、そのパブリッシャーから提供されたキャンペーンID値を使用します。

マクロタグをサポートしていないパブリッシャーの場合には、/attribution/tags/nonMacroTemplateTagを呼び出してタグを取得します。非マクロタグの場合は、タグパラメーターに固有のキャンペーンID値を指定する必要があります。

警告

タグ取得エンドポイントを呼び出すことは、利用する各プロフィールの効果測定を有効にするための必須手順です。この手順はスキップしないでください。スキップすると、タグが機能しなくなります。

AmazonアトリビューションのAPIタグは、Amazon Adsコンソールで作成したAmazonアトリビューションタグとは異なります。Amazon Adsコンソールで作成したタグをこのAPIで使用するために変更したり、Amazon Adsコンソールで作成したキャンペーンに新しいタグを追加するためにAPIタグを使用したりしないでください。

マクロタグ

特定のパブリッシャーと広告主にマクロタグを使用すると、そのパブリッシャーに関して対象の広告主のすべてのキャンペーンで同じタグを使用できます。マクロタグを使用すると、広告の表示を準備するときに、クリックスルーURLにキャンペーン情報を動的に挿入できます。各タグには、パブリッシャーによって異なるパブリッシャー固有のマクロが含まれます。

たとえば、以下は、macroTagエンドポイントに対する呼び出しから返されたGoogle広告の架空のマクロタグです。

"?maas=maas_adg_api_123456789_macro_1_99&ref_=aa_maas&tag=maas&aa_campaignid={campaignid}&aa_adgroupid={adgroupid}&aa_creativeid=ad-{creative}_{targetid}_dev-{device}_ext-{feeditemid}"

キャンペーンが誘導するランディングページURLの例を以下に示します。

https://www.amazon.com/AmazonBasics-Performance-Alkaline-Batteries-Count/dp/B00MNV8E0C

パブリッシャーの広告マネージャーでキャンペーンにタグが適用された後に、パブリッシャーがそれぞれの広告の表示を準備するときに、{campaignid}{adgroupid}{creative}{targetid}{device}{feeditemid}の各マクロが実際のキャンペーン値に動的に置き換えられます。

この例の場合、結果のクリックスルーURLは次のようになります。

https://www.amazon.com/AmazonBasics-Performance-Alkaline-Batteries-Count/dp/B00MNV8E0C?maas=maas_adg_api_123456789_macro_1_99&ref_=aa_maas&tag=maas&aa_campaignid=1234&aa_adgroupid=6789&aa_creativeid=ad-1357_kwd-123_dev-c_ext-2468

非マクロタグ

動的パラメーターをサポートしていないパブリッシャーに対して非マクロタグを使用して、Amazonストアや商品詳細ページに誘導する広告に関するAmazonアトリビューション効果測定を有効にすることもできます。非マクロタグを実装するための準備として、まず、nonMacroTemplateTagエンドポイントを呼び出して広告主の非マクロテンプレートタグを取得します。そして、新しいタグの作成が必要になるたびに、システムでaa_campaignidaa_adgroupidaa_creativeidの各URLパラメーターのテンプレート値を設定できます。

非マクロタグテンプレートの例を次に示します。テンプレート値を置き換えない限り、このテンプレートは機能しません。

?maas=maas_adg_api_123456789_static_9_99&ref_=aa_maas&tag=maas&aa_campaignid={campaignId}&aa_adgroupid={adgroupId}&aa_creativeid={creativeId}

非マクロタグを使用する場合、複数のランディングページURLで同じタグを使用することはできません。ライブタグのランディングページを変更する必要がある場合は、固有のクリエイティブIDを使用して新しいタグを用意し、更新したランディングページにその新しいタグを実装します。

警告

aa_campaignidaa_adgroupidaa_creativeidパラメーターの値は255文字以内(すべてのマクロを展開後の長さ)でなければならず、URLエスケープをしたとしても文字/、&、=、#、?、+、’、”、%、$を含めることはできません。

aa_campaignid値は、アカウントごとに固有でなければなりません。複数の広告主や複数のマーケットで同じキャンペーンIDを再利用しないでください。マクロタグを使用する場合は、Amazonアカウントとマーケットごとに別々のキャンペーンが適用されるように、3Pキャンペーンを編成してください。

アトリビューションタグの実装

アトリビューションタグは、広告がクリックされたときに有効なURLが呼び出されるのであれば任意の方法で実装することができます。ただし、ランディングページがAmazonストアまたは商品詳細ページである必要があります。アトリビューションタグを実装する一般的な方法をいくつか紹介します。

ランディングページURLの末尾にアトリビューションタグを追加し、そのURLをパブリッシャーのクリックスルーURLフィールドに入力します。パブリッシャーによっては、URLパラメーターをランディングページとは別に保持し、動的に組み合わせることもできます。

Amazonアトリビューションタグは、通常Amazonへのリンクを作成するのと同じように、ブログ投稿やEメールでオーガニックに使用されるランディングページURLに追加することができます。

マクロタグを使用する場合は、マクロ処理をサポートするフィールドに配置する必要があります。これはパブリッシャーによって異なりますので、問題がある場合はパブリッシャーのヘルプドキュメントを確認してください。

パブリッシャーによっては、広告がクリックされるたびに起動するクリックトラッカーとしてアトリビューションタグを実装できる場合があります。こうしたトラッキングフィールドはパブリッシャーごとに異なります。アトリビューションタグは、ランディングページがAmazonストアまたは商品詳細ページである場合にしか機能しないことに注意してください。

Facebookなどのソーシャルキャンペーンでは、「URLパラメーター」トラッキングフィールドに広告主のアトリビューションタグを実装できます。

Google広告やMicrosoft広告などの検索キャンペーンでは、トラッキングテンプレートフィールド内に広告主のアトリビューションタグを実装します。その前に、Googleの場合には{unescapedlpurl}マクロを、Microsoftの場合には{lpurl}マクロを記述します。以下はGoogleの例です。

{unescapedlpurl}?maas=maas_adg_api_123456789_macro_1_99&ref_=aa_maas&tag=maas&aa_campaignid={campaignid}&aa_adgroupid={adgroupid}&aa_creativeid=ad-{creative}_{targetid}_dev-{device}_ext-{feeditemid}

他のトラッキングテンプレートが干渉しない場合は、キャンペーンレベルでアトリビューションタグを実装できます。ただし、キャンペーンのさまざまなレベルで複数のトラッキングテンプレートが実装されている場合は、最も低いレベルのトラッキングテンプレートのみが起動することに注意してください。

警告

クリックスルーURLから既存のref_パラメーターまたはtagパラメーターを削除して、それらがAmazonアトリビューションのref_パラメーターおよびtagパラメーターと干渉しないようにしてください。URLに同じ名前のパラメーターが2つ含まれていると、効果測定が正確になりません。

効果測定

AmazonアトリビューションAPIのタグパラメーターを含むAmazonストアまたは商品詳細ページのURLがクリックされると、Amazonアトリビューションがトリガーされ、キャンペーンの構造が推測されて、クリックに起因するコンバージョンイベントがAmazonで測定されます。特定のプロフィールについては、そのプロフィールのAmazonアトリビューションタグを含むリンクのみがコンバージョンアトリビューションの対象となり、14日間以内にクリックされたタグがフルクレジットの評価を受けます。Amazon Adsや、特定のプロフィールのタグが付いていないその他のリンクがコンバージョンに寄与したと見なされることはありません。

Amazonアトリビューションでは、aa_campaignidaa_adgroupidaa_creativeidの各パラメーター値を使用してAmazonアトリビューションキャンペーン、広告グループ、およびクリエイティブが自動的に作成されます。キャンペーンが作成されると、広告掲載商品がキャンペーンに自動的に関連付けられ、商品のコンバージョン指標の効果測定が可能になります。商品詳細ページをクリックすると、対象商品とそのバリエーションがキャンペーンに自動的に関連付けられます。Amazonストアページをクリックすると、ストアページに表示されている商品がキャンペーンに自動的に関連付けられます。

キャンペーン、広告グループ、クリエイティブが自動作成され、商品がキャンペーンに自動的に関連付けられると、Amazonアトリビューションによってクリック数、コンバージョン、売上が測定されます。関連付けられた商品のコンバージョンは、レポートに「広告掲載」のコンバージョン指標として表示されます。「合計」と「ブランドハロー効果」のコンバージョン指標には、同じブランドの非広告掲載商品のコンバージョンが反映されます。

表示する商品をリアルタイムで選択する動的ウィジェットをストアページで使用している場合、それらの商品はAmazonアトリビューションによってキャンペーンに関連付けられない可能性があります。例としては、「ベストセラー」、「おすすめ」、「限定セール」などの動的ウィジェットや、検索キーワードに基づく商品グリッド/リストがあります。この制限を回避するには、測定するASINをストアページに直接追加してください。

レポートリソース

アトリビューションタグを実装し、買い物客がリンクをクリックしたら、レポートエンドポイントを呼び出してレポートを取得できます。クリック数が表示されるまで最大24時間、コンバージョンが表示されるまで最大48時間かかる場合があります。

利用できるレポートには、 「パフォーマンス」と「商品」の2種類があります。オプションのreportTypeリクエスト本文プロパティに値PERFORMANCE(デフォルト)またはPRODUCTSを入力することにより、それぞれのタイプのレポートにアクセスできます。レポートタイプごとに、集計レベル、ディメンション、指標が異なります。パフォーマンスレポートの場合、groupByリクエスト本文プロパティに値CAMPAIGN、ADGROUP、CREATIVE(デフォルト)のいずれかを指定して渡すことにより、集計レベルを選択できます。商品レポートは常に広告グループレベルで集計され、売上、購入、DPVによるランク付けで上位100に入る商品のみがキャンペーン別に表示されます。

レポートに含める指標を指定しない場合、レスポンスには(brb_bonus_amount以外の)利用可能なすべての指標が含められます。より効率的なレポートを作成するために、必要な指標のリストをリクエスト本文に含めることができます。

ヒント:ブランド紹介ボーナスの指標

ブランド紹介ボーナス(BRB)プログラムに登録済みの広告主様は、パフォーマンスレポートでbrb_bonus_amount指標をリクエストできます。そのためには、この指標を明示的に要求し、groupBy値としてCAMPAIGNまたはADGROUPを渡す必要があります。BRBに登録していない広告主様がこの指標をリクエストしてもエラーにはなりません。レスポンスにこの指標が含まれないだけです。

それぞれのレポートタイプで利用可能なディメンションと指標については、ReportRequestBodyドキュメントをご覧ください。

レポートタイプ 含まれるディメンション 集計レベル 指標 レポートできる日数
パフォーマンス aa_campaignidaa_adgroupidaa_creativeidpublisher 集計レベルとしてCAMPAIGN、ADGROUP、またはCREATIVE(デフォルト: CREATIVE)を選択できます。 クリックスルー、およびすべての広告掲載コンバージョンと合計コンバージョンの指標。詳しいリストについては、レポートエンドポイントをご覧ください。 過去13か月間
商品 aa_campaignidaa_adgroupidpublisherproductNameproductGroupproductCategoryproductSubcategorybrandNameproductAsinproductConversionType 常に広告グループレベルで集計されます。 広告掲載コンバージョンとブランドハローコンバージョンの指標、およびブランド紹介ボーナス。クリックスルーなし。詳しいリストについては、レポートエンドポイントをご覧ください。 過去90日間

Amazonは、Amazonアトリビューションレポートを少なくとも1日1回更新し、1日、7日、28日ごとに過去のレポートを再集計し、最新のコンバージョンを反映してレポートを更新し、返品や返金も考慮に入れています。過去30日間のレポートを毎日取得することをおすすめします。

買い物客のプライバシーを保護するために、Amazonアトリビューションでは、期間中のクリック数が10回未満のタグまたはタググループを表すレポート行のデータはマスクされます。たとえば、広告グループレベルで集計されたレポートでは、広告グループの一部のタグのクリック数が10回未満であっても、10回以上クリックされた広告グループのデータがすべて表示されます。クリックのしきい値を超えるまで、マスクされた行の指標値はゼロと表示されます。予算が非常に少ないキャンペーンや、非常に少数のオーディエンスに表示されるキャンペーンでは、このしきい値を超えるまでに時間がかかる場合があります。

キャンペーンレベルまたは広告グループレベルでレポートを表示するには、データを自分で集計するのではなく、特定の集計レベルでパフォーマンスレポートをリクエストする必要があります。そのようにすることにより、利用可能なデータがすべてレポートに含まれ、Amazon Adsコンソールと確実に一致するようになります。

次のステップ

Amazon Attribution APIの使用中に問題が発生した場合は、トラブルシューティングガイドを参照すると、問題の診断と解決に役立ちます。