認可付与

認可の概要で説明しているように、Amazon Ads APIに対する呼び出しを正常に実行するためには、広告主がクライアントアプリケーションに対して、広告主のデータにアクセスすることを明示的に認可する必要があります。

この認可プロセスは、Login with Amazon（LwA）サービスによって複数の段階に分けて処理されます。最初にこの許可を表すものが、認可コードです。

以下のアイデンティティについて簡単に確認しておきましょう。

• 広告主： Amazon Adsの広告主様アカウント。
• クライアント： Amazon Ads APIを呼び出すことを承認されたLogin with Amazonクライアントアプリケーション。

また、以下の図にて、認可コードが、Amazon Advertising APIを使用して特定のクライアントが特定の広告主のデータとサービスにアクセスすることについて、その広告主が同意したことを表すものであることを確認してください。

認可コードは、Login with Amazonによって有効化された同意リクエストによって生成されます。

Login with Amazon同意リクエスト

広告主がLogin with Amazonを使用することで、LwAユーザーインターフェースを通じてクライアントに認可を付与できます。

広告主がウェブブラウザで特定のURLにアクセスすると、Amazon認証情報を使用してログインするように求められます。その後、広告主は、リクエストを作成したクライアントが、広告主のAmazon Adsデータとサービスにアクセスすることについて同意することを確認できます。

• LwAにおける認可付与の詳細に関する一般情報については、認可付与をご覧ください。

同意リクエストURL

同意リクエストページは、Amazonによって以下3つの地域サーバーのいずれかから提供されます。

地域	URL接頭辞
北米（NA）	https://www.amazon.com/ap/oa
ヨーロッパ（EU）	https://eu.account.amazon.com/ap/oa
極東（FE）	https://apac.account.amazon.com/ap/oa

リクエストは、固有のURLに含まれるクエリパラメーターによって特定のクライアントアプリケーションおよびスコープに紐づけられます。

パラメーター	説明
client_id	クライアントアプリケーションのクライアントID。
スコープ	OAuth 2.0の権限スコープで、アプリケーションが広告主のアカウントにアクセスできる範囲を表します。 Amazon Ads APIを使用する場合はほとんど、scopeにはadvertising::campaign_managementを設定します。データプロバイダーAPIの場合、scopeにはadvertising::audiencesを設定します。
response_type	レスポンスのタイプ。必ずcodeに設定します。
redirect_uri	アクセスが許可された後に広告主がリダイレクトされるURL。
state	*オプション。*このリクエストからレスポンスまでの状態を維持するために使用する不透明型の値。この値はリダイレクトに含まれます。
code_challenge	*オプション。*Proof Key for Code Exchange（PKCE）を介して認可コードグラントを保護するために使用されます。
code_challenge_method	オプション。code_challengeパラメーターのcode_verifierをエンコードするために使用するメソッド。

例：

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

広告主が同意すると、Login with Amazonにより認可コードが生成されます。これは、指定された範囲の広告主データへのアクセスをクライアントに許可することを表します。

ヒント

セキュリティ上の理由から、Login with Amazonでは、アプリケーション統合のためにstate、code_challenge、code_challenge_methodを使用することをおすすめします。これらのパラメーターの詳細については、認可リクエストをご覧ください。

認可コードの取得

同意を確認すると、広告主は、リクエストURLで指定されたredirect_uriにリダイレクトされます。認可コードがクエリパラメーターとして追加されます。

たとえば、https://www.amazon.comのredirect_uriの場合、リダイレクト全体は以下のようになります。

https://www.amazon.com/?code=xxxxxxxxxxxxxxxxxxx&scope=advertising%3A%3Acampaign_management

codeパラメーターが認可コードです。

リダレクトURIの選択

redirect_uriには、Login with Amazonクライアントに許可されている任意のURLを指定できます。許可されたリターンURLは、Amazon開発者コンソールで、クライアントの「ウェブの設定」の「許可されたリターンURL」フィールドを編集のうえ調整できます。リターンURLの設定に関する詳しい手順については、オンボーディングウォークスルーをご覧ください。

認可コードは広告主のウェブブラウザでクエリパラメーターとして返されるので、API呼び出し元によっては、認可コードをプログラムで処理するページに広告主をリダイレクトすることが必要になる場合もあります。詳細については、ユーザーを動的にリダイレクトするをご覧ください。

認可コードの使用

認可コードを使用して、Login with Amazonからアクセストークンとリフレッシュトークンを取得できます。そして、そのアクセストークンをAmazon Ads APIへの呼び出しの認証情報として使用します。

現在、認可コードの有効期間は5分間です。

認可コードはLwAホスト全体でグローバルに有効です。

• 詳細については、アクセストークンとリフレッシュトークンの取得をご覧ください。

認可許可の概要

• 認可コードとは、広告主が特定のクライアントに「特定の範囲における広告主のデータやサービス」にアクセスすることを明示的に許可することを表すものです。
• クライアントは、Login with Amazonホストから提供されたURLにパラメーターを含めることによって同意リクエストを作成します。
• 広告主は、そのURLに表示されているLogin with Amazonユーザーインターフェースを介して同意できます。
• その後、広告主はクライアントが指定したURLにリダイレクトされます。このURLには、認可コードがクエリパラメーターとして追加されます。

詳細

概要の詳細については、以下のドキュメントをご覧ください。

• 認可の概要
• アクセストークン
• 認可付与（Login with Amazonドキュメント）

詳しいガイドに従ってAmazon Ads APIで認可を設定するには、「開始」の手順をご覧ください。