開発者ガイドの概要

Amazon Ads APIの概要

テストアカウントの使用

テストアカウントの作成が完了したら、同じクライアントIDとadvertising::campaign_managementスコープに対する権限を持つアクセストークンを使用して、APIで他のエンドポイントにアクセスできます。

テストアカウントの商品データ

アカウントの作成時にベンダーテストアカウントにベンダーコードをリンクした場合は、商品メタデータAPIを使用して、出品アカウントでASINに関する情報を取得し、この情報をテストキャンペーンの作成に使用できます。

著者様用テストアカウントの場合は、テストアカウントと共にテスト用の電子書籍ASINが作成されます。これらのASINは、/testAccountsでGETリクエストを行うすることで取得できます。

プロファイル

プロファイルリソースに対してGETリクエストを行うと、認証ユーザーアカウントで使用可能なプロファイルが返されます。Amazon Ads APIの各プロファイルは、特定のマーケットプレイスにおける、ユーザーアカウントの広告アカウントを表します。

テストアカウントの場合は、返されたプロファイルのaccountInfoのidキーが、/testAccountsでGETリクエストを行った場合に返されるidと一致します。

[
    {
        "profileId": "xxxxx",
        "countryCode": "US",
        "currencyCode": "USD",
        "timezone": "America/Los_Angeles",
        "accountInfo": {
            "marketplaceStringId": "ATVPDKIKX0DER",
            "id": "ENTITYxxxxxxxxxxx",
            "type": "vendor",
            "name": "3PTestBrand-xxxxxxx",
            "validPaymentMethod": true
        }
    }
]

Amazon Ads APIのテストを開始するには、返されたプロファイルのprofileIdを、以降のリクエストのAmazon-Advertising-API-Scopeヘッダーの値として使用します。

スポンサープロダクト広告のテスト

テストアカウントのprofileIdを使用して、スポンサープロダクト広告で任意のAPIをテストできます。

注

テストアカウントを使用して、予算ルールおよび規則に基づく入札APIをテストすることはできますが、テストではすべての機能は利用できません。テストアカウントを使用して予算ルールと入札ルールを設定することはできますが、広告が配信されていないため、ルールは有効になりません。

スポンサーブランド広告のテスト

テストアカウントのprofileIdを使用して、スポンサーブランド広告でAPIをテストできます。

実際のアカウントで作成する場合と同様にテストキャンペーンを作成するには、スポンサーブランド広告キャンペーン作成の技術仕様をご覧ください。

注

テストアカウントを使用して予算ルールAPIをテストすることはできますが、テストではすべての機能は利用できません。テストアカウントを使用してルールを設定することはできますが、広告が配信されていないため、ルールは有効になりません。

スポンサーブランド広告キャンペーンの審査

Amazon Adsのテストアカウントでは、スポンサーブランド広告キャンペーンおよびAPIを簡単にテストできるように、自動審査が有効になっています。テストアカウントで作成されたすべてのスポンサーブランド広告キャンペーンが承認され、テストに使用可能となります。

注

テストアカウントでキャンペーンが承認されても、実際の広告主アカウントで作成された同じキャンペーンが承認されるとは限りません。標準の広告主アカウントで作成されたキャンペーンは、通常のプロセスに基づき審査されます。

スポンサーブランド広告キャンペーンのクリエイティブアセットのテスト

スポンサーブランド広告キャンペーンのクリエイティブを作成するには、クリエイティブアセットが必要です。テストアカウントを使用して新しいアセットを作成する方法には、次の2種類があります。

ストアAPIを使用してアセットを作成する

  1. stores/createAsset操作を使用して、新しいアセットを作成します。レスポンスで返されるassetIDをメモします。
  2. 前の手順でメモしたassetIDを使用して、スポンサーブランド広告キャンペーンを作成します。

クリエイティブアセットAPIを使用してアセットを作成する*（画像のみ）*

  1. クリエイティブアセットAPIのドキュメントで説明されているプロセスに従って、新しい画像アセットをアップロードして登録します。
  2. アセットの登録が完了したら、登録リクエストから返されるassetIdをメモし、それを使用してスポンサーブランド広告キャンペーンを作成します。

いずれの方法でも、キャンペーンとクリエイティブは両方とも自動審査によって承認されます。クリエイティブアセットを別途審査する必要はありません。アセットは、キャンペーンの作成時に使用したbrandEntityIdで使用可能になります。

stores/listAssets操作を使用して既存のアセットのリストを取得し、以降のスポンサーブランド広告キャンペーンの作成で使用できます。

サポート対象外のスポンサーブランド広告API

スポンサーブランド広告の次のAPIはテストアカウントではサポートされていないため、使用しないようにしてください。

その他のサポート対象外機能については、テストアカウントでサポートされない機能をご覧ください。

スポンサーブランド動画広告キャンペーンのテスト

スポンサーブランド動画広告キャンペーンを作成するには、動画アセットが必要です。テストアカウントを使用して新しい動画アセットを作成する方法は、次のとおりです。

  1. media/uploadリソースを使用して、動画のアップロードに使用するURLを取得します。

    現時点では、サポートされているプログラムタイプはスポンサーブランド広告のみで、サポートされているクリエイティブタイプは動画のみです。リクエストボディは次のとおりです。

    {
"programType": "SponsoredBrands",
"creativeType": "Video"
}

    レスポンスには、動画のアップロードに使用するURLが含まれます。

    {
"uploadLocation" : "URL for uploading your file"
}

  2. 署名済みURLを使用のうえ動画をアップロードする方法は複数あります。この例では、Postmanを使用する方法を説明します。

    1. Postmanで、「File」、「New」の順に選択します。
    2. 「HTTP Request」を選択して、HTTPリクエストを作成します。
    3. HTTP操作ドロップダウンで、「PUT」を選択します。
    4. Enter request URLテキストボックスに、先ほどのレスポンスで取得した署名済みURLを追加します。
    5. 手順4のEnter request URLテキストボックスの下にある、縦方向の属性一覧で「Body」を選択します。
    6. 「binary」ラジオボタンをクリックします。
    7. 手順5の縦方向の属性一覧のすぐ下にあるペインで、「Select File」ボタンをクリックします。アップロードする動画ファイルの場所を開きます。ファイルを選択し、「OK」を選択します。
    8. 「Send」をクリックします。

  3. アップロードが完了したら、media/completeリソースを使用して、mediaIdプロパティを取得します。

  4. 手順3でプロパティを取得したら、スポンサーブランド動画広告キャンペーンに対する作成操作のリクエストオブジェクト内のcreativeプロパティのvideoMediaIds配列でmediaIdを渡します。

Amazon Advertising logo