開発者ガイドの概要

Amazon Ads APIの概要

Amazon Marketing Streamの推奨施策ユーザーガイド

推奨施策APIは、スポンサー広告キャンペーンのパフォーマンスを向上させるためのAmazonからの提案を提供します。

この機能は現在ベータ版です。

Amazon Marketing Streamは、ほぼリアルタイムの指標と推奨事項をプッシュ形式でAWSアカウントに直接送信します。Streamを通じてsponsored-ads-campaign-diagnostics-recommendationsデータセットに登録すると、キャンペーンの推奨事項を含むプッシュ通知が自動的に届きます。各推奨メッセージには、推奨事項を適用するために推奨施策APIで使用できる推奨事項IDが含まれています。

たとえば、スポンサープロダクト広告キャンペーンの予算増額を提案する次のような推奨メッセージをStreamから受け取ったとします。

{
  "recommendation_id": "2d384ce5-8f4d-403a-afac-7437b99313f6",
  "group_id": "67653abe-44fc-11ed-b878-0242ac120002",
  "apply_endpoint": "/recommendations/apply",
  "type": "CAMPAIGN_BUDGET",
  "published_date": "2022-10-04T21:39:49",
  "expiry_date": "2022-10-18T21:39:49",
  "explanation": {
    "description": "High-performing campaign with ROAS greater than 3 and last week's budget utilization greater than 80%.We've estimated this is a missed opportunity in sales, clicks.Apply the recommended budget.",
    "missed_opportunities": {
      "impressions": "200-1000",
      "clicks": "100-3000",
      "conversions": "10-100",
      "time_period": "Last 7 days"
    },
    "campaign_id": "182756610092559",
    "campaign_name": "All Fabrics",
    "ad_product": "SP",
    "current_campaign_settings": {
      "budget": {
        "campaign_budget": 221
      }
    },
    "recommended_campaign_settings": {
      "budget": {
        "campaign_budget": 321
      }
    }
  }
}

この例では、recommendation_idは2d384ce5-8f4d-403a-afac-7437b99313f6です。

推奨事項の適用

Streamペイロードで提案されたとおりに推奨事項を適用するには、POST /recommendations/applyエンドポイントのリクエストボディでStreamから受け取ったrecommendation_idを使用します。一度に最大100個の推奨事項IDを適用できます。

リクエストの例

curl --location 'https://advertising-api.amazon.com/recommendations/apply' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxxx' \
--header 'Authorization: Bearer Atza|xxxxxxxx' \
--header 'Amazon-Advertising-API-Scope: xxxxxxx' \
--data '{
  "maxResults": 0,
  "nextToken": "string",
  "filters": [
    {
      "include": true,
      "field": "RECOMMENDATION_ID",
      "values": [
        "2d384ce5-8f4d-403a-afac-7437b99313f6"
      ],
      "operator": "EXACT"
    }
  ]
}'

推奨事項の更新

適用する前に推奨事項を変更する場合は、PUT /recommendations/{recommendationId}エンドポイントを使用して推奨事項を更新できます。

リクエストの例

予算を321に更新することが推奨されましたが、代わりに300に更新したいとします。この例では、recommendedValueを300に更新します。

curl --location --request PUT 'https://advertising-api.amazon.com/recommendations/2d384ce5-8f4d-403a-afac-7437b99313f6' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxx' \
--header 'Authorization: Bearer Atza|xxxxxxxxx' \
--header 'Amazon-Advertising-API-Scope: xxxxxxx' \
--data '{
  "recommendedValue": "300"
}'

推奨事項の編集が完了したら、POST /recomendations/applyを使用して推奨事項をキャンペーンに適用します。