開発者ガイドの概要

Amazon Ads APIの概要

パートナーオポチュニティAPIの使用方法

以下の例は、cURLを使用してパートナーオポチュニティAPIを呼び出す方法です。

partnerOpportunitiesリソース

リクエスト

GET https://advertising-api.amazon.com/partnerOpportunities

cURLコマンドの例

curl 'https://advertising-api.amazon.com/partnerOpportunities' \
 -H 'Accept: application/vnd.partneropportunity.v1+json' \
 -H 'Amazon-Advertising-API-ClientId: <LWA_APP_CLIENT_ID>' \
 -H 'Amazon-Advertising-API-Manager-Account: <PARTNER_NETWORK_ACCOUNT_ID>' \
 -H 'Authorization: Bearer <ACCESS_TOKEN>'

レスポンスの例

{
  "opportunities": [
    {
      "partnerOpportunityId": "opportunity-1-id",
      "title": "Title for opportunity-1",
      "description": "Description for opportunity-1",
      "callToAction": "Action that opportunity-1 recommends you to take",
      "product": "Amazon advertising product that opportunity-1 corresponds to",
      "objective": "Objective that opportunity-1 intends to improve e.g. brand engagement",
      "createdDate": "2022-05-15T23:42:33.823Z",
      "updatedDate": "2022-05-16T23:43:54.867Z",
      "dataUrl": "/partnerOpportunities/opportunity-1-id/file"
    },
    {
      "partnerOpportunityId": "opportunity-2-id",
      "title": "Title for opportunity-2",
      "description": "Description for opportunity-2",
      "callToAction": "Action that opportunity-2 recommends you to take",
      "product": "Amazon advertising product that opportunity-2 corresponds to",
      "objective": "Objective that opportunity-2 intends to improve e.g. sales",
      "createdDate": "2022-05-14T23:42:33.823Z",
      "updatedDate": "2022-05-15T23:43:54.867Z",
      "dataUrl": "/partnerOpportunities/opportunity-2-id/file"
    },
    {
      "partnerOpportunityId": "opportunity-3-id",
      "title": "Title for opportunity-3",
      "description": "Description for opportunity-3",
      "callToAction": "Action that opportunity-3 recommends you to take",
      "product": "Amazon advertising product that opportunity-3 corresponds to",
      "objective": "Objective that opportunity-3 intends to improve e.g. awareness",
      "createdDate": "2022-05-13T23:42:33.823Z",
      "updatedDate": "2022-05-14T23:43:54.867Z",
      "dataUrl": "/partnerOpportunities/opportunity-3-id/file"
    },
    {
      "partnerOpportunityId": "opportunity-4-id",
      "title": "Title for opportunity-4",
      "description": "Description for opportunity-4",
      "callToAction": "Action that opportunity-4 recommends you to take",
      "product": "Amazon advertising product that opportunity-4 corresponds to",
      "objective": "Objective that opportunity-4 intends to improve e.g. retention",
      "createdDate": "2022-05-15T23:42:33.823Z",
      "updatedDate": "2022-05-16T23:43:54.867Z",
      "dataUrl": "/partnerOpportunities/opportunity-4-id/file"
    }
  ]
}

ファイルリソース

リクエスト

GET https://advertising-api.amazon.com/partnerOpportunities/<partnerOpportunityId>/file

curlコマンドの例

curl 'https://advertising-api.amazon.com/partnerOpportunities/<partnerOpportunityId>/file' \
 -H 'Accept: application/vnd.partneropportunity.v1+json' \
 -H 'Amazon-Advertising-API-ClientId: <LWA_APP_CLIENT_ID>' \
 -H 'Amazon-Advertising-API-Manager-Account: <PARTNER_NETWORK_ACCOUNT_ID>' \
 -H 'Authorization: Bearer <ACCESS_TOKEN>'

レスポンスの例

HTTP/1.1 307 Temporary Redirect
location: <S3_DOWNLOAD_URL>

オポチュニティデータファイルの例

オポチュニティデータファイルのデータは、オポチュニティのタイプごとに異なります。

たとえば、余剰在庫ASIN用の広告キャンペーンを作成するオポチュニティを含むファイルには、次の列が含まれる可能性があります。

| マーケットプレイス | 広告プロダクトタイプ | 暗号化された広告主ID | ASIN | 広告主名 | |--- |--- |--- |--- |--- | | | | | | |

トラブルシューティング

401「unauthorized」エラーレスポンス

API呼び出しに必要なヘッダーがすべて含まれていることを確認します。これらの必要なヘッダーとそのサンプル値の詳細については、パートナーオポチュニティAPIの使用を開始するを参照してください。

問題が解決しない場合は、LwAアプリケーションに関連付けられているユーザーアカウントが、 API呼び出しのアクセストークンとリフレッシュトークンの生成に使用したアカウントと同じであることを確認します。

また、このユーザーアカウントに、パートナーネットワークアカウントの管理者権限または開発者権限があることを併せて確認します。パートナーネットワークアカウントの管理者は、ユーザーの管理ページでLwAアプリケーションユーザーのアクセスレベルを管理者または開発者に変更できます。詳細については、マネージャーのユーザーヘルプのページ をご覧ください。

これらの権限を変更すると、APIに反映されるまでに最大2時間かかる場合があります。最大2時間経過しても反映されない場合にのみ、APIを再度呼び出してください。

このエラーが引き続き表示される場合は、まずLwAアプリケーションの新しい認可コードを作成して、LwAに現在ログインしているユーザーが、上記の管理者権限または開発者権限を付与されたユーザーであることを確認します。次に、新しいアクセストークンとリフレッシュトークンを取得し、これらの値を適切なヘッダーに入れて渡します。

403「forbidden」エラーのレスポンス

認可コードの作成時にLwAにログインしていたユーザーに、パートナーネットワークアカウントの管理者権限または開発者権限があることを確認します。詳細については、ユーザーの作成とユーザーのアクセスレベルの管理を参照してください。

このエラーが引き続き表示される場合は、Amazon-Advertising-API-Manager-Accountヘッダーで渡されたIDが、パートナーネットワークアカウントIDに関連付けられた値であることを確認します。この値は、パートナーネットワークコンソールで、右上隅にある「ユーザー設定」リンクを選択し、「アカウント詳細」を表示し、「パートナーネットワークアカウントID」フィールドの値をコピーして取得できます。

404「not found」エラーのレスポンス

/partnerOpportunities/{partnerOpportunityId}/fileリソースを取得しているときにこのレスポンスを受け取った場合は、partnerOpportunityIdパスパラメーターの値が有効であることを確認します。このIDの値を確認するには、partnerOpportunitiesリソースを取得し、opportunitiesリストのpartnerOpportunityIdプロパティを調査します。各オポチュニティには、dataUrlプロパティに正しいpartnerOpportunityId値が入力されたURLが含まれていることに注意してください。

このエラーが引き続き表示される場合は、オポチュニティの基準に一致する広告主またはASINがあることを確認します。たとえば、「余剰在庫」ASINのスポンサープロダクト広告キャンペーンを作成するようにオポチュニティから求められた場合、広告主には「余剰在庫」のあるASINがなければなりません。

広告主やASINに最近行った変更がオポチュニティAPIに反映されるまでに最大1日かかる可能性があることに注意してください。

415「unsupported media type」エラーのレスポンス

APIリクエストのAcceptヘッダーがapplication/vnd.partneropportunity.v1+jsonに設定されていることを確認します。ワイルドカードはAcceptヘッダーの有効な値ではないことに注意してください。たとえば、Accept: */*は許可されていません。

次のステップ

パートナーオポチュニティAPIの詳細については、リソースリファレンスを参照してください。

Amazon Advertising logo