開発者ガイドの概要

Amazon Ads APIの概要

クイックスタートガイド： Amazon Ads API Postmanコレクションの使用を開始する

Amazon Ads API Postmanコレクションには、APIを呼び出すための認証および認可情報の管理を容易にするスクリプトと、APIの一般的な使用法を示すための事前作成されたリクエストが含まれています。

最初の呼び出しを行う方の多くは、開始の説明の代わりに、PostmanがAPIの理解に役立つと感じるかもしれません。

次のクイックセットアップでは、APIにリクエストを行うようにPostmanコレクションを設定する手順を段階的に説明しています。

始める前に

このガイドを完了するには、次のものが必要です。

ヒント：Postmanユーザーインターフェイス

このドキュメントで使用されているPostman UI要素の用語は、Postmanで使用されている用語と一致しています。詳細とビジュアルエイド（視覚資料）については、Postmanインターフェイスのドキュメントをご覧ください。

クイックセットアップ

コレクションと環境ファイルをインポートする

  1. GitHubからPostmanの環境ファイルおよびコレクションファイルをダウンロードします。
  2. 両方のファイルをPostmanにインポートします。インポートを確認するには、次の手順に従います。
    • 左側のサイドバーにある「コレクション」アイコンを選択します。Amazon Ads APIコレクションが表示されます。
    • 左側のサイドバーにある「環境」アイコンを選択します。Amazon Ads API環境が表示されます。
  3. 環境セレクターから「Amazon Ads API環境」を選択して環境を有効にします。

環境を設定する

  1. 左側のサイドバーから「環境」を選択し、次に「Amazon Ads API環境」を選択します。

  2. 次の変数の現在の値を手動で設定します。

    変数 説明
    client_id APIの使用が承認されたLogin with AmazonクライアントアプリケーションのクライアントID。
    client_secret APIの使用が承認されたLogin with Amazonクライアントアプリケーションのクライアントシークレット。
    redirect_uri Login with Amazonアプリケーションの「許可された戻りURL」設定に含まれているURL。

    環境では、これはデフォルトでhttps://amazon.comに設定されています。ただし、Login with Amazon、許可されている別のURLを反映するようにこの変数を変更する必要があります。

    注

    デフォルトの環境は、APIの北米ホストにアクセスするように設定されています。他の地域のAPIにアクセスするための変更については、地域をご覧ください。

  3. 環境に対する変更を保存します。

認可グラントを作成する

  1. Postmanの左側のサイドバーから、「コレクション」>「Amazon Ads API」に移動します。

  2. コレクション内のAuthフォルダーを選択し、GET Auth grant loginリクエストを探します。

  3. Postmanのフッターにある「コンソール」を開きます。

  4. リクエストを送信します。このアクションでは、PostmanのプレビューウィンドウでURLをテストし、適切なURLをPostmanコンソールに記録します。

  5. コンソールから認可グラントURLをコピーしてWebブラウザでその場所にアクセスし、Amazon Adsアカウントを管理するAmazonユーザーアカウントでログインします。

    警告

    認可URLにアクセスする前に、他のAmazonユーザーアカウントからログアウトしていることを確認してください。

  6. 環境ファイルに設定したredirect_uriにリダイレクトされます。認可グラントコードは、codeクエリパラメーターとしてこのURLに追加されます。

ブラウザのURLバーのアドレスは、次のようになります。ここで、XXXXXは認可グラントコードです。

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

次の手順で使用するために、このコードを書き留めておきます。認可コードは、クライアントアプリケーションがアカウントの広告データやサービスにアクセスするためのユーザーアカウントからの許可を表します。

注

認可グラントコードは5分で期限切れになります。認可グラントプロセスを繰り返すことで、新しいコードを生成できます。

アクセストークンとリフレッシュトークンを取得する

  1. コレクションのAuthフォルダーから、POST Access token from auth grantリクエストを選択します。
  2. このリクエストのボディで、codeパラメーターを見つけて前の手順で取得したコードを入力します。
  3. リクエストを送信します。

リクエストが成功すると、環境内のaccess_token変数とrefresh_token変数が設定されます。

ヒント：トークンの有効期限

アクセストークンは60分で期限切れになります。リフレッシュトークンに有効期限はありません。

APIへのその後のリクエストでは、Amazon Ads API Postmanコレクションのスクリプトによってリフレッシュトークンが使用され、必要に応じて新しいアクセストークンが自動的に生成されます。

プロファイルIDを取得する

  1. コレクション内のProfilesフォルダーを選択します。
  2. GET Profilesリクエストを選択し、リクエストを送信します。

このリクエストへのレスポンスは_profiles_のリストで、それぞれが特定のマーケットプレイスにおけるユーザーアカウントのAmazon Adsアカウントを表します。

デフォルトでは、コレクション内のスクリプトは、環境内のprofileId変数をレスポンスで返された_最初の_プロファイルに設定します。この値は、その後の呼び出しで使用されます。プロファイルの詳細については、プロファイルをご覧ください。

次のステップ

これで、Postman環境にAmazon Ads APIへの他のリクエストを行うために必要な次の認証情報が設定されました。

Postmanコレクションは、以降のリクエストに備えてこれらの値をヘッダーに含めるように設定されています。

APIへの一般的な最初の呼び出しをテストするには、初めての呼び出しをご覧ください。

テクニカルサポート

Amazon Ads APIへの接続に問題がある場合は、テクニカルサポートページをご覧ください。

問題がこのドキュメントまたはPostmanコレクション自体に関連していると思われる場合は、GitHubリポジトリで問題を開くことができます。

オプションの変更

地域

提供されている環境は、Amazon Ads APIの北米ホストを呼び出すように設定されています。ヨーロッパまたはアジアの広告データおよびサービスにアクセスするには、環境内のapi_url、auth_grant_url、およびtoken_url変数を適切な地域ホストに変更します。

地域 api_url auth_grant_url token_url
NA https://advertising-api.amazon.com https://www.amazon.com/ap/oa https://api.amazon.com/auth/o2/token
EU https://advertising-api-eu.amazon.com https://eu.account.amazon.com/ap/oa https://api.amazon.co.uk/auth/o2/token
FE https://advertising-api-fe.amazon.com https://apac.account.amazon.com/ap/oa https://api.amazon.co.jp/auth/o2/token

各地域のマーケットプレイスのリストについては、APIエンドポイントをご覧ください。

Amazon Advertising logo