Amazon Ads APIの利用を開始する
Amazon Ads APIを使用すると、REST APIを使用してAmazon広告主に紐づけられている広告リソースを管理できます。APIへのほとんどのリクエストを承認するには、次の3つの認証情報が必要です。
- Login with AmazonアプリケーションのクライアントID
- クライアントアプリケーションがユーザーアカウントの代わりに動作するためのアクセス許可を表すアクセストークン
- 特定のマーケットプレイスにおけるユーザーの広告アカウントのプロファイルID
このガイドでは、これらの必要な認証情報を取得する方法について説明します。
始める前に
このガイドを完了するには、以下が必要です。
- Amazon Ads APIの使用が承認されたLogin with Amazonクライアントアプリケーション。承認済みのクライアントをまだ確立していない場合は、オンボーディングをご覧ください。
- Amazon Adsアカウントを管理するAmazonユーザーアカウントのログイン認証情報。(Amazon Adsアカウントのログイン認証情報をお持ちでない場合は、テストアカウントについての説明をご覧ください。)
Amazon Ads APIの認証とID
Amazon Ads APIへのリクエストは、Amazon Adsアカウントへのアクセス権を持つユーザーアカウントに代わってクライアントアプリケーションによって行われます。ユーザーアカウントは、**Login with Amazon(LwA)**を使用してクライアントアプリケーションに明示的な認証を与える必要があります。
この関係に関する概要について、続行する前に以下をお読みください。
このプロセスの手順
広告主のデータやサービスへのアクセスに必要な認証情報を取得するには、以下3つの手順を実行します。
広告アカウント用の認可グラントを作成します。広告ユーザーアカウントを有効にして、LwAクライアントへのアクセス権を付与します。
アクセストークンとリフレッシュトークンを生成します。認可グラントを、APIの呼び出しに使用されるアクセストークンと、新しいアクセストークンの生成に使用されるリフレッシュトークンと引き換えます。
プロファイルを取得します。特定の広告マーケットプレイスのユーザーアカウントを表すプロファイルIDを取得します。
LwAクライアントIDと併せて、ここで取得したアクセストークンとプロファイルIDを使用して、APIへの今後のリクエストを承認できます。
ヒント:Postmanコレクションの使用を開始する
お客様によっては、Amazon Ads API Postmanコレクションで、Postmanユーザーインターフェイスを使用してこれらの手順を簡単に完了できる場合があります。Amazon Ads API Postmanコレクションを使用開始する方法について、詳しくはこちらをご覧ください。
開始する
Amazon Ads APIを呼び出す準備ができたら、以下2つの方法のいずれかを実行してください。
「開始」の手順
ステップバイステップのウォークスルーには、認可グラントの作成、アクセストークンの生成、プロファイルの取得の手順が含まれています。はじめに、認可グラントを作成するをご覧ください。
注
このプロセスでは、HTTPリクエストに関する技術的な知識を備え、リクエストの送信やレスポンスの読み取りが可能である必要があります。
cURL
を使用した例が手順ごとに示されています。Amazon Ads API Postmanコレクション
Postmanのコレクションには、認証の管理に役立つスクリプトと、APIへのよくあるリクエスト用の既製テンプレートが含まれています。はじめに、Amazon Ads API Postmanコレクションの使用をご覧ください。