開発者ガイドの概要

Amazon Ads APIの概要

アカウントタイプ別のDSPレポート

Amazon DSPは現在、マネージドサービスアカウントとセルフサービスアカウント両方のサポートを提供しています。セルフサービスアカウントは独自のキャンペーンを管理しますが、マネージドサービスアカウントは、Amazonまたはサードパーティの代理店にキャンペーンを管理してもらいます。マネージドサービスとセルフサービスの両方の広告主がAmazon Ads APIを使用してレポートデータを取得できますが、そのプロセスはアカウントのタイプによって異なります。

セルフサービスアカウント

セルフサービスのDSPエンティティ所有者はキャンペーンを管理し、自身のDSPエンティティに複数の広告主を結びつけることができます。エンティティ所有者は、1社以上の広告主のキャンペーンを管理したり、ツールプロバイダーになったりすることができます。

DSPレポーティングAPIを呼び出すには、次のようにします。

  1. Login with Amazonアプリケーションが、エンティティレベルのアクセス権を持つDSPアカウントによって認可されていることを確認します。

  2. GET /v2/profilesエンドポイントを使用して、エンティティIDを取得します。

    a.サンプルレスポンス：

    [
  {
    "profileId": 1111111111111111,
    "countryCode": "US",
    "currencyCode": "USD",
    "timezone": "America/Los_Angeles",
    "accountInfo": {
      "marketplaceStringId": "ATVPDKIKX0DER",
      "id": "ENTITY2XYZ1234",
      "type": "agency",
      "name": "Demo: US"
    }
  }
]

    b.上記の例では、エンティティIDはENTITY2XYZ1234のaccountInfo.idです。 DSPプロフィールは常にagencyタイプになることに注意してください。

注

エンティティIDは、URLを見て、DSPコンソール で確認することもできます。URLのパターンは次のとおりです。https://advertising.amazon.com/dsp/{ENTITY_ID}/advertisers

  1. エンティティIDをPOST /accounts/{accountId}/dsp/reportsのURIのaccountIdとして使用します。

    a.呼び出しの例：

    （エンティティIDがENTITY2XYZ1234の場合）

    curl --location --request POST 'https://advertising-api.amazon.com/accounts/ENTITY2XYZ1234/dsp/reports' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer Atza|xxxxxxxxxxxxx' \
--header 'Accept: application/vnd.dspcreatereports.v3+json' \
--data-raw '{
    "startDate": "2022-12-05",
    "endDate": "2022-12-19"
}'

    b.個々の広告主のレポートデータが必要な場合は、リクエスト本文のadvertiserIds配列を使用して、該当するIDを指定します。エンティティに関連付けられている広告主IDは、DSPコンソールで確認できます。

    呼び出しの例：

    （エンティティIDがENTITY2XYZ1234、広告主IDが123456789の場合）

    curl --location --request POST 'https://advertising-api.amazon.com/accounts/ENTITY2XYZ1234/dsp/reports' \
    --header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxxxx' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer Atza|xxxxxxxxxxx' \
    --header 'Accept: application/vnd.dspcreatereports.v3+json' \
    --data-raw '{
      "advertiserIds": [
        "123456789"
      ],
      "startDate": "2022-12-05",
      "endDate": "2022-12-19"
    }'

    注

    一度にリクエストできる広告主IDは100個までです。エンティティに100以上の広告主がいる場合は、複数のレポートをリクエストする必要があります。

マネージドサービスアカウント

マネージドサービスの広告主は、マネージャーアカウントを使用してレポーティングAPIを呼び出す必要があります。このプロセスにより、エンティティ管理者は、そのエンティティ内の1社以上の広告主用のマネージャーアカウントに読み取り専用の権限を付与できます。

注

以下のプロセスの手順の一部は、マネージャーアカウントUIを使用しないと実行できません。現時点では、APIのみのソリューションはありません。APIのマネージャーアカウントについての詳細はこちらをご覧ください。

DSPレポーティングAPIを呼び出すには、次のようにします。

  1. マネージャーアカウントUIにアクセスし、「マネージャーアカウントの作成」をクリックします。

  2. 名前を入力し、これが代理店アカウントであるか広告主アカウントであるかを選択します。

  3. 「アカウントをリンク」セクションから、「アクセスをリクエストする」タブに移動します。

  4. レポートデータが必要なDSP広告主IDとマーケットプレイスを追加します。広告主IDは、DSPエンティティへのアクセス権を持つ人から取得する必要があります。

  5. 広告主IDの追加が完了したら、「マネージャーアカウントの作成」を選択します。

  6. 画面の左下で歯車アイコンを選択し、次に 「マネージャーアカウントのアクセス権」を選択します。

  7. 「リンクされたアカウント」をクリックします。

  8. リクエストした広告主に関連付けられた承認リンクをコピーして、承認を受けるためにDSPエンティティの管理者にこのURLを提供します。

    a.AmazonがDSPキャンペーンを管理している場合は、そのURLをAmazonアカウントマネージャーに提供してください。

  9. 承認が付与されたら、マネージャーアカウントへのアクセス権を持つユーザーが、Login with Amazonアプリケーションを認可する必要があります。

  10. これで、APIを呼び出すときに、（手順4の）DSPの広告主IDをPOST /accounts/{accountId}/dsp/reportsのURIのaccountIdとして使用できるようになりました。

呼び出しの例：

（広告主IDが1234567890の場合）

curl --location --request POST 'https://advertising-api.amazon.com/accounts/1234567890/dsp/reports' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer Atza|xxxxxxxxxxxxx' \
--header 'Accept: application/vnd.dspcreatereports.v3+json' \
--data-raw '{
    "startDate": "2022-12-05",
    "endDate": "2022-12-19"
}'

マネージャーアカウントの広告主ID

GET /managerAccountsエンドポイントを使用して、マネージャーアカウントでアクセスできる広告主IDを取得することもできます。

レスポンスの例：

{
  "managerAccounts": [
    {
      "linkedAccounts": [
        {
          "accountId": "ENTITY3G3R4D4E0FEIV",
          "accountName": "ADVERTISER_NAME_456",
          "accountType": "DSP_ADVERTISING_ACCOUNT",
          "dspAdvertiserId": "12345678",
          "marketplaceId": "ATVPDKIKX0DER",
          "profileId": ""
        },
        {
          "accountId": "ENTITY147ELY1DV9VO0",
          "accountName": "ADVERTISER_NAME_123",
          "accountType": "DSP_ADVERTISING_ACCOUNT",
          "dspAdvertiserId": "98765432",
          "marketplaceId": "ATVPDKIKX0DER",
          "profileId": ""
        }
      ],
      "managerAccountId": "amzn1.ads1.ma1.7xxxxxxxxxxx",
      "managerAccountName": "Test Agency"
    }
  ]
}

dspAdvertiserId（上記の例の値12345678と98765432）をPOST /accounts/{accountId}/dsp/reportsのURIのaccountIdとして使用できます。

次のステップ

レポートのリクエストの詳細については、以下をご覧ください。

Amazon Advertising logo