開発者ガイドの概要

Amazon Ads APIの概要

手順3： プロファイルIDを取得する

概要 | 1.認可グラントを作成する | 2.アクセストークンを生成する | 3.プロファイルを取得する

「開始」の概要で説明されているように、Amazon Ads APIを呼び出すために必要な認証情報には次の2つがあります。

さらに、APIに対するほぼすべてのリクエストで、_特定の_マーケットプレイスにおけるユーザーの広告アカウントを表すプロファイルIDが必要です。アクセストークンを生成したら、以下の手順に従って、APIへのリクエストで使用するプロファイルIDを取得します。

プロファイルリソースにアクセスする

利用可能なプロファイルのリストを取得するには、ユーザーアカウントが広告アカウントを管理する地域で、/v2/profilesエンドポイントに対してGETリクエストを行います。

たとえば、MXマーケットプレイスで広告アカウントを管理するユーザーアカウントの場合は、北米のホストにリクエストを送信する必要があります。

https://advertising-api.amazon.com/v2/profiles

リクエストには次の2つのヘッダーが必要です。

cURLを使用して北米のサーバーに対して呼び出しを行う場合は、次のリクエストにご使用の値を代入してください。

curl  \
    -H "Amazon-Advertising-API-ClientId: YOUR_CLIENT_ID"\
    -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    https://advertising-api.amazon.com/v2/profiles

プロファイルレスポンス

このエンドポイントでの呼び出しが完了した場合、レスポンスには、APIホストの地域のユーザーアカウントに紐づけられているプロファイルのリストが含まれます。

たとえば、（MXマーケットプレイスで）1つの広告アカウントのみを管理するユーザーアカウントに対する北米のサーバーからのレスポンスは、次のようになります。

[
  {
    "profileId": 888888888,
    "countryCode": "MX",
    "currencyCode": "MXN",
    "timezone": "America/Los_Angeles",
    "accountInfo": {
      "marketplaceStringId": "A1AM78C64UM0Y8",
      "id": "ENTITY2Ihjasdjkeru",
      "type": "vendor",
      "name": "Name of the Account",
      "validPaymentMethod": false
    }
  }
]

ヒント：複数のプロファイルが表示される場合 -

各プロファイルは、異なるマーケットプレイスの広告アカウントを表します。特定のプロファイルのマーケットプレイスを判別するために、countryCodeの値をメモに残してください。

ヒント：プロファイルが表示されない場合 -

レスポンスボディに空の配列（[ ]）が含まれている場合、認証は成功したものの、ユーザーアカウントにこの地域の広告アカウントに対する表示および編集権限がないことを示しています。地域の詳細については、APIエンドポイントをご覧ください。

リクエストでオプションのパラメーターを使用すると、表示専用権限があるプロファイルを表示できます。権限の詳細、またはプロファイルの仕様でaccessLevelおよびapiProgramパラメーターをご確認ください。

また、どの地域にもアクセスできる広告アカウントがない場合であっても、承認済みのLwAクライアントを使用して、APIのテストアカウントを生成できます。テストアカウントの詳細をご覧ください。

ヒント：マネージャーアカウントをご使用の場合 -

リクエストを承認するユーザーアカウントがマネージャーアカウントの場合、レスポンスには、そのマネージャーアカウントが編集者アクセス権を持つ、現在の地域のすべてのアカウントが含まれます。閲覧者アクセス権のみを持つアカウントの場合は、GET /managerAccountsエンドポイントを使用してプロファイルIDを取得します。マネージャーアカウントの詳細をご覧ください。

後続のリクエストでプロファイルIDを渡す

/v2/profilesエンドポイントのほかにAmazon Ads APIへのリクエストがアクセスできるのは、1つのプロファイルのリソースのみです。選択されるプロファイルは、Amazon-Advertising-API-Scopeヘッダーで渡されるプロファイルIDによって決まります。

後続のAPIへのリクエストでは、次の3つの必須ヘッダーの値として、クライアントID、アクセストークン、プロファイルIDを渡します。

注

アクセストークンは60分後に期限切れとなります。リクエストに期限切れのアクセストークンを使用した場合、Unauthorizedレスポンスが返されます。必要に応じて新しいトークンを生成するには、リフレッシュトークンを使用したアクセストークンの生成をご覧ください。

次の手順

認証情報の使用方法については、初めての呼び出しをご覧ください。

テクニカルサポート

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

Amazon Advertising logo