開発者ガイドの概要

Amazon Ads APIの概要

テストアカウントの認可

Amazon Ads APIにおける認可は、OAuth 2.0の呼び出しフローに基づきLogin with Amazonによって処理されます。標準の広告アカウントのデータとサービスにアクセスするには、APIへのリクエストに、承認済みのLogin with AmazonアプリケーションのクライアントIDと、advertising::campaign_managementスコープ内のデータやサービスにアクセスすることについてのAmazonユーザーアカウントからの許可を表すアクセストークンを含める必要があります。

テストアカウントを作成するには、追加の権限スコープadvertising::test:create_accountも必要です。このスコープは、Amazon Ads APIを使用することを承認されたすべてのLogin with Amazonクライアントアプリケーションがリクエストできます。

警告

この権限スコープは、既存のユーザーアカウントに対してリクエストするのではなく、以下の説明のようにテスト用に特別に作成したAmazonユーザーアカウントに対してのみリスエストすることをおすすめします。既存の広告アカウントを管理するユーザーアカウントは、このAPIでテストアカウントを作成することはできません。

前提条件

テストアカウントAPIにアクセスするには、以下の前提条件が必要です。

  1. **Amazon Ads APIへのアクセスを承認されたLogin with Amazonクライアントアプリケーション。**承認されたクライアントは、権限スコープadvertising::test:create_accountをリクエストすることが許可されます。APIへのアクセスを承認されていない場合は、オンボーディングの概要から開始してください。
  2. *現時点でAmazon Adsアカウントを管理していない*Amazonユーザーアカウント。*開発チームが利用できる有効なメールアドレスを使用して、この目的のための新しい*Amazonユーザーアカウントを作成することをおすすめします。そのアカウントのログイン認証情報をメモし、テストアカウントを使用する予定のマーケットプレイスでそのAmazonアカウントが有効であることを確認してください。

認可グラント

テストアカウントに認可を付与するプロセスは、認可グラントで説明されているプロセスと似ています。

認可グラントURL

最も簡単な方法は、単一の認可グラントURLを使用して、_両方_の権限スコープをテストユーザーアカウントにリクエストすることです。

Login with Amazonドキュメントで説明されているように、URLエンコードされたスペース文字（%20）を使用して複数のスコープを区切ることによって、1つの認可グラントURLで複数のスコープをリクエストすることができます。以下に例を示します。

advertising::test:create_account%20advertising::campaign_management

たとえば、両方のスコープを指定した認可グラントURL（読みやすくするために複数行に分割しています）は次のようになります。

https://www.amazon.com/ap/oa
    ?client_id=YOUR_LWA_CLIENT_ID
    &scope=advertising::test:create_account%20advertising::campaign_management
    &response_type=code
    &redirect_uri=YOUR_RETURN_URL

YOUR_LWA_CLIENT_IDおよびYOUR_RETURN_URLの文字列は、Login with Amazonアプリケーションの該当する値に置き換えてください。これらの値を確認し、適切な地域ホストを選択する方法の詳細については、認可グラントをご覧ください。

アクセストークンの取得

Amazonユーザーアカウントにサインインして_いない_ブラウザで、上記のようにして決定したURLにアクセスします。上記の前提条件2のアカウントを使用してサインインし、Login with Amazon ユーザーインターフェイスで権限を与えます。

指定したリダイレクトURLにcodeクエリパラメーターとして認可グラントコードが付加された宛先にリダイレクトされます。認可コードの取得をご覧ください。

取得したコードの有効期間は5分間です。アクセストークンで説明されているように、このコードを使用してアクセストークンとリフレッシュトークンを取得できます。

アクセストークンの使用

上記の方法で取得したアクセストークンによって、クライアントアプリケーションに次を実行する権限が付与されます。

注

認可グラントとトークン取得のプロセスを繰り返すことで、スコープごとに個別に権限をリクエストすることができます。詳細については、認可グラントおよび認可の概要をご覧ください。

Amazon Ads APIの他のアクセストークン同様、アクセストークンの有効期限は60分間です。新しいアクセストークンは、リフレッシュトークンを使用して必要に応じて生成が可能です。

開始するには、テストアカウントの作成をご覧ください。

Amazon Advertising logo