開発者ガイドの概要

Amazon Ads APIの概要

テストアカウントの作成

Amazon Ads APIの/testAccountsエンドポイントを使用すると、ユーザーは以下のことができるようになります。

テストアカウントAPIの技術仕様。

認可ヘッダー

/TestAccountsエンドポイントへのリクエストには、以下のヘッダーが必要です。

Amazon Ads APIの認可ヘッダーの詳細については、必要な認可ヘッダーをご覧ください。

テストアカウントの作成

新しいテストアカウントは、/testAccountsに対するPOSTリクエストで作成できます。

JSONリクエストの本文には次の3つのパラメーターを指定します。

アカウントタイプ別のサポート対象マーケットプレイス

アカウントタイプ サポート対象マーケットプレイス
取引会社 US、CA、BR、MX、JP、AU、SG、UK、IT、ES、FR、DE、AE、SA、NL、TR、PL、SE、EG、BE
著者 US、UK、IT、ES、FR、DE

ヒント：ベンダーコード

ベンダーコードとは、登録済みの取引会社様の5文字のコードのことです。ベンダーコードで作成されたテストアカウントは、リンクされた取引会社様の商品ASINとメタデータを使用して、テストキャンペーンを作成できます。

Amazon Adsコンソールでベンダーコードを確認する手順*（クリックして展開）*
  1. 登録済みのベンダーアカウントを使用してAmazon Adsコンソールにログインします。
  2. 「歯車」アイコンをクリックして、「管理」メニューにアクセスします。
  3. 「アクセスと設定」を選択します。
  4. 左側のメニューから、「出品用アカウント」を選択します。
  5. 右側の「アカウントの関連付け」で、「ベンダーセントラルのアカウント」の下に表示されているアカウントをクリックして展開します。
  6. 表示される5文字のコードがベンダーコードです。APIへのリクエストに含めるものを1つ選択してください。

JSONリクエスト本文の例

{
    "countryCode": "US",
    "accountMetaData": {
        "vendorCode": "ABCDE"
    },
    "accountType": "VENDOR"
}

cURLを使用したリクエストの例

curl -X POST 'https://advertising-api.amazon.com/testAccounts' \
-H 'amazon-advertising-api-clientid: YOUR_LWA_CLIENT_ID' \
-H 'authorization: Bearer YOUR_ACCESS_TOKEN' \
-H 'content-type: application/json' \
-d '{"countryCode": "US","accountMetaData":{"vendorCode":"YOUR_VENDOR_CODE"},"accountType": "VENDOR"}'

注

登録済みのベンダーコードにアクセスできない場合は、accountMetaDataキーを省略します。

注

各マーケットプレイスのAmazonユーザーアカウントに対して作成できる著者広告テストアカウントは1つだけです。

レスポンス

正常なレスポンスでは、コード200と次の形式のJSON本文が返されます。

{ "requestId": "A7BCDGCEVXQ1CJJ4301V" }

次のセクションで説明しているように、requestIdを使用してステータス情報を取得できます。

エラーレスポンスについては、技術仕様をご覧ください。

アカウント作成リクエストのステータスの確認

/testAccountsに対するGETリクエストを使用して、作成ステータスと作成済みアカウントに関する詳細を取得できます。

正常に実行されたPOSTリクエストから取得したrequestIdをクエリパラメーターとして渡すことで、そのリクエストに関する詳細を取得することができます。requestIdパラメーターを指定せずにリクエストを実行すると、現在のクライアントIDと、認可を与えたユーザーアカウントによって作成されたすべてのテストアカウントのリストが返されます。

cURLを使用したリクエストの例

curl -X GET \
https://advertising-api.amazon.com/testAccounts?requestId=A7BCDGCEVXQ1CJJ4301V \
-H 'amazon-advertising-api-clientid: YOUR_LWA_CLIENT_ID' \
-H 'authorization: Bearer YOUR_ACCESS_TOKEN'

注

「A7BCDGCEVXQ1CJJ4301V」が、requestIdの例です。アカウント作成リクエストに対するレスポンスで取得したrequestIdを使用して、リクエストのステータスを確認します。

レスポンス

requestIDクエリパラメーターを使用したリクエストの場合は、正常なレスポンスでコード200と次の形式のJSON本文が返されます。

[
    {
        "countryCode": "US",
        "asins": [],
        "accountType": "VENDOR",
        "id": "ENTITY012345678910",
        "status": "COMPLETED"
    }
]

ヒント：著者アカウント

上記の例は、ベンダーテストアカウント作成後のレスポンスを示しています。著者アカウントの場合、そのアカウントにリンクされたテスト電子書籍ASINも3つ作成されます。これらのASINは、このリクエストからのレスポンスのASINキーの下にリストされ、48時間後にテストキャンペーン作成に使用できるようになります。

レスポンススキーマとエラーレスポンスに関する詳細については、技術仕様をご覧ください。

ステータスがCOMPLETEDになったら、広告テストアカウントを使用する準備は完了です。

使用を開始するには、テストアカウントの使用をご覧ください。

Amazon Advertising logo