開発者ガイドの概要

Amazon Ads APIの概要

Amazon Ads APIを初めて呼び出す

Ads APIを使用することで、キャンペーンの管理やレポートデータの取得が可能です。このチュートリアルは、適切なGET campaignsエンドポイントを使用して、有効なスポンサー広告（スポンサープロダクト広告、スポンサーブランド広告、スポンサーディスプレイ広告）のキャンペーンをすべて表示する方法の理解に役立ちます。

始める前に

注

このチュートリアルは、Ads APIの「オンボーディング」と「開始する」プロセスが完了していることを前提としています。

このチュートリアルを実行する際に、以下をご用意ください：

リクエスト

URLプレフィックス

Ads APIを呼び出す際に使用するプレフィックスは、リクエストで使用されたプロフィールの地域に基づいています。

URL 地域とマーケットプレイス
https://advertising-api.amazon.com 北米（NA）。米国、カナダ、メキシコ、ブラジルのマーケットプレイスが対象
https://advertising-api-eu.amazon.com ヨーロッパ (EU)。英国、フランス、イタリア、スペイン、ドイツ、オランダ、アラブ首長国連邦、ポーランド、トルコのマーケットプレイスが対象
https://advertising-api-fe.amazon.com 極東（FE）。日本、オーストラリア、シンガポールのマーケットプレイスが対象。

ヘッダー

Amazon Ads APIのほとんどの呼び出しには、共通のヘッダーが必要です。

| ヘッダー | 必須？ | 説明 | |--------|-------------| | Amazon-Advertising-API-ClientId | はい | Login with Amazon アプリケーションに関連するクライアント ID。 | | Authorization | はい | Bearer access_token形式の有効な API アクセストークン。アクセストークンの有効期間は1時間のみです。 | | Amazon-Advertising-API-Scope | はい | Amazon AdsのプロフィールID。 | | Accept | いいえ | acceptヘッダーはバージョンを指定するために使用します。acceptヘッダーを指定しない場合、デフォルトで application/jsonになります。 |

サンプルリクエスト

サンプルをコピーする場合は、必ず自身のクライアントID、アクセストークン、プロフィールIDを入力してください。

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

リファレンス全体： POST sp/campaigns/list

cURL 
<p>この例は、北米のURLプレフィックスを使用してスポンサープロダクト広告キャンペーンを一覧表示するリクエストを示しています。</p>

```bash
    curl --location --request POST 'https://advertising-api.amazon.com/sp/campaigns/list' \
    --header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxxx' \
    --header 'Amazon-Advertising-API-Scope: xxxxxxxxx' \
    --header 'Authorization: Bearer xxxxxxxxxxxx' \
    --header 'Accept: application/vnd.spCampaign.v3+json' \
    --header 'Content-Type: application/vnd.spCampaign.v3+json' \
```
Postman
  1. Amazon Ads API Postmanコレクションと環境ファイルがPostmanにインポートされていることを確認してください。Postmanのセットアップを完了していない場合は、Postmanチュートリアルをご覧ください。
  2. Postmanで、Amazon Ads APIコレクションに移動します。
  3. 「First call」フォルダーに移動し、POST List SP campaignsエンドポイントを開きます。
  4. 「Headers」タブで、環境変数が正しく入力されていることを確認します。
  5. リクエストを送信します。

スポンサーブランド広告

リファレンス全体： POST sb/beta/campaigns/list

cURL 
<p>この例は、北米のURLプレフィックスを使用してスポンサーブランド広告キャンペーンを一覧表示するリクエストを示しています。</p>

```bash
    curl --location --request GET 'https://advertising-api.amazon.com/sb/beta/campaigns/list' \
    --header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxxx' \
    --header 'Amazon-Advertising-API-Scope: xxxxxxxxx' \
    --header 'Authorization: Bearer xxxxxxxxxxxx' \
    --header 'Accept: application/vnd.sbcampaignresource.v4+json'
    --header 'Content-Type: application/vnd.sbcampaignresource.v4+json'
```
Postman
  1. Amazon Ads API Postmanコレクションと環境ファイルがPostmanにインポートされていることを確認してください。Postmanのセットアップを完了していない場合は、Postmanチュートリアルをご覧ください。
  2. Postmanで、Amazon Ads APIコレクションに移動します。
  3. 「First call」フォルダーに移動し、** POST List SB campaigns**エンドポイントを開きます。
  4. 「Headers」タブで、環境変数が正しく入力されていることを確認します。
  5. リクエストを送信します。

スポンサーディスプレイ広告

リファレンス全体： GET sd/campaigns

cURL 
<p>この例は、北米のURLプレフィックスを使用してスポンサーディスプレイ広告キャンペーンを一覧表示するリクエストを示しています。</p>

```bash
    curl --location --request GET 'https://advertising-api.amazon.com/sd/campaigns' \
    --header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxxx' \
    --header 'Amazon-Advertising-API-Scope: xxxxxxxxx' \
    --header 'Authorization: Bearer xxxxxxxxxxxx' \
```
Postman
  1. Amazon Ads API Postmanコレクションと環境ファイルがPostmanにインポートされていることを確認してください。Postmanのセットアップを完了していない場合は、Postmanチュートリアルをご覧ください。
  2. Postmanで、Amazon Ads APIコレクションに移動します。
  3. 「First call」フォルダーに移動し、GET List SD campaignsエンドポイントを開きます。
  4. 「Headers」タブで、環境変数が正しく入力されていることを確認します。
  5. リクエストを送信します。

応答

GET campaignsエンドポイントの正常な応答では、応答コード200が返されます。応答本文には、キャンペーンオブジェクトのJSON配列が含まれています。

サンプル

次のサンプル応答には、スポンサーディスプレイ広告キャンペーンが1つ含まれています。

[
    {
        "campaignId": 127519806194475,
        "name": "SdTestCampaign-26/01/2022 15:37:31",
        "tactic": "T00020",
        "startDate": "20220126",
        "state": "enabled",
        "costType": "cpc",
        "budget": 100,
        "budgetType": "daily",
        "deliveryProfile": "as_soon_as_possible"
    }
]

空の応答を受け取る

特定の広告タイプのキャンペーンをまだ作成していない場合は、空のJSON配列（[]）を含む応答200が返されます。有効なキャンペーンがあるかどうかを確認するには、Amazon広告コンソールにログインします。

ヒント

Amazon Adsを使用したことがなく、まだキャンペーンが存在しない場合は、テストアカウントを作成してください。テストアカウントを作成すると、支出に影響を与えることなくキャンペーンの構築方法を試すことができます。

次のステップ

Amazon Ads APIのリクエストと応答の基本的構造を理解できた後は、実際のニーズに合ったユースケースに取り組んでみましょう。

有効なキャンペーンを所有している広告主様向け

Amazon Adsを初めてご利用になる広告主様向け

Amazon Advertising logo