開発者ガイドの概要

Amazon Ads APIの概要

Postmanの使用方法

Postmanは、開発者がユーザーインターフェイスを使用してAPI呼び出しを行うことのできるツールです。Postmanでは変数を保存し、基本的な自動化を行うこともできるため、APIのテストが簡単になります。Amazon Adsでは、開発者がAPIを簡単にテストできるように、最もよく使用されるエンドポイントを含むPostmanコレクションをご用意しています。Postmanでは、開発者がさまざまなプログラミング言語で自動的にコードサンプルを生成することもできます。

このチュートリアルでは、Amazon Ads APIのPostmanコレクションを設定する方法について説明します。

始める前に

使用するPostmanのバージョンを決めます。Postmanアカウントをお持ちでない場合は、デスクトップアプリケーションをダウンロードできます。無料アカウントを作成して、Webアプリケーションを使用することもできます。

このチュートリアルでは、すでにAPIのオンボーディングを完了しており、アクセストークンとリフレッシュトークンを生成していることを前提としています。

チュートリアル

**ファイルのインポートと環境設定 **

  1. GitHubからPostmanの環境ファイルおよびコレクションファイルをダウンロードします。

  2. 両方のファイルをPostmanにインポートします。

    1. Collectionsタブには、Amazon Ads APIコレクションが表示されます。
    2. Environmentsタブには、Amazon Ads API環境が表示されます。

  3. Environmentsタブで、「Amazon Ads API Environment」を選択します。

  4. 認証情報を環境に追加します。次の変数のCurrent Value列に認証情報を入力します。

    変数 説明
    client_id Login with Amazonアプリケーションに紐づけられているクライアントID。
    client_secret Login with Amazonアプリケーションに紐づけられているクライアントID。
    refresh_token 新しいアクセストークンの取得に使用するリフレッシュトークン。

  5. （オプション）URL接頭辞を更新します。ダウンロードしたファイルでは、api_urlに北米のURLが設定されています。ご使用の広告アカウントが北米以外の場所にある場合は、api_urlを更新してください。各地域で使用可能なURLは、APIの概要をご覧ください。

  6. 環境の変更内容を保存します。

新しいアクセストークンの取得

  1. PostmanのCollectionsタブで、Amazon Ads APIコレクションに移動します。
  2. Amazon Ads APIにアクティブな環境を設定します。
  3. POSTリフレッシュトークンからアクセストークンを取得エンドポイントを開きます。{{refresh_token}}、{{client_id}、および{{client_secret}}の値にマウスオーバーして、ご使用の環境の正しい値が取り込まれていることを確認します。
  4. リクエストを送信します。200 OKレスポンスコードが返されるはずです。
  5. Amazon Ads API Environmentに戻ります。access_tokenのCurrent Valueに新しい値が、token_expires_atのCurrent Valueにタイムスタンプが表示されているはずです。

ヒント

token_expires_atは、ご使用のトークンの期限を監視しています。デフォルトでは、ユーザーがコレクション内で呼び出しを行うたびに、Postmanによってトークンが期限切れになっていないかを確認します。期限切れになっている場合、Postmanは呼び出しを行う前に自動的にトークンを更新します。

プロファイルIDの取得

  1. APIを使用して他の呼び出しを行うには、プロファイルIDが必要です。プロファイルIDがわかっている場合は、 Amazon Ads API EnvironmentのprofileId変数に直接そのIDを入力できます。

ヒント：プロファイルIDがわからない場合

プロファイルIDがわからない場合は、「プロファイル」>「GETプロファイル」エンドポイントを使用すると、ご使用のアカウントに紐づけられているプロファイルが返されます。最初に返されたプロファイルが自動的に環境に追加されます。プロファイルIDが複数ある場合は、必要なプロファイルIDをコピーして環境に貼り付けてください。

環境に有効なアクセストークンとプロファイルIDを設定した後、Amazon Ads APIの呼び出しを行えるようになります。

次の手順

以下のいずれかのチュートリアルをご覧ください。

ヒント：Amazon Adsを初めてご利用の場合

Postmanを使用してテストアカウントを作成すると、広告費をかけずにキャンペーンの作成を練習できます。

現在サポートされている機能

Amazon Ads APIのPostmanコレクションでは現在、以下の機能がサポートされています。

注

スポンサーディスプレイ広告エンドポイントには、別のコレクションが用意されています。スポンサーディスプレイ広告エンドポイントをテストする場合は、スポンサーディスプレイ広告のPostmanチュートリアルをご利用ください。

環境変数の定義

次の表で、環境ファイル内のすべての変数について説明します。

変数 説明
client_id 承認済みのLogin with AmazonアプリケーションのクライアントID。
client_secret 承認済みのLogin with Amazonアプリケーションのクライアントシークレット。
permission_scope アカウント権限の決定に使用されるスコープ。一般的なAPIの用途では、デフォルト値のadvertising::campaign_managementのままにしてください。
redirect_uri Login with Amazonアプリケーションの許可された戻りURL設定に含まれているURLを入力します。デフォルトではhttps://amazon.comに設定されています。Login with AmazonでこのURLを有効にします。
access_token API呼び出しの認証に使用されるアクセストークン。各トークンは60分間有効です。
refresh_token アクセストークンの更新に使用されるトークン。
token_expires_at アクセストークンが期限切れになる時間のタイムスタンプ。
profileId ご使用のAmazon Adsアカウントに関連付けられているプロファイルID。
auth_grant_url 認証呼び出しに使用されるURL接頭辞。
token_url トークンの呼び出しに使用されるURL接頭辞。
api_url 一般的なAPI呼び出しに使用されるURL接頭辞。

サポート

Postmanコレクションに関するフィードバックやご質問がある場合は、GitHubリポジトリで問題を作成してください。

Amazon Advertising logo