注文を作成および更新する方法
前提条件
まだ完了していない場合は、このチュートリアルの前提条件を完了しておく必要があります。
このチュートリアルでは、以下が必要になります。
- Amazon Ads APIのクライアントID。
- Amazon Ads APIのスコープ。
- 認証トークン。
- 広告主ID。
最適化目標と主要業績評価指標(KPI)に関連する値も必要です。これらの値を取得するには、目標設定リソースを使用します。
注文の作成
注文を作成するには、注文リソースのPOST
操作を使用します。注文の値として、広告配信期間、予算、最適化目標など、キャンペーンに使用する設定を指定できます。注文を作成する際には、以下のパラメーターが必要です。
advertiserId
: 注文の作成に使用する広告主ID。このフィールドの値は、前提条件で取得済みです。name
: 注文の名前。この値は、注文が終了した後には変更できないことに注意してください。budget
: 注文の予算と広告配信期間。startDateTime
とendDateTime
: これにより、注文の関連ラインアイテムを実行できる日付範囲に制限が設定されます。注文の処理が始まったら、開始日は更新できなくなることに注意してください。終了日は、注文が終了してから5日以内であれば更新できます。amount
: 予算額。
frequencyCap
: フリークエンシーキャップのタイプを設定します。フリークエンシーキャップのタイプをUNCAPPED
に設定するか、時間単位あたりのインプレッション数を指定してCUSTOM
タイプを定義することができます。optimization
:productLocation
、goal
、goalKpi
を設定します。これらの値は、前提条件セクションの目標設定リソースを使用して取得済みです。
注文リクエストの例は以下のようになります。
[{
"advertiserId": "170xxxxxxxx01",
"name": "This is my user friendly Order Name",
"externalId": "This is my external Id to uniquely identify this resource",
"comments": "Additional comments",
"budget": {
"budgetCaps": [{
"amount": 2,
"recurrenceTimePeriod": "DAILY"
}],
"flights": [{
"startDateTime": "2021-12-11 05:00:00 UTC",
"endDateTime": "2021-12-19 02:59:00 UTC",
"amount": 120,
}]
},
"agencyFee": {
"feePercentage": 2
},
"frequencyCap": {
"type": "CUSTOM",
"maxImpressions": 3,
"timeUnitCount": 5,
"timeUnit": "DAYS"
},
"optimization": {
"productLocation": "SOLD_ON_AMAZON",
"goal": "AWARENESS",
"goalKpi": "CLICK_THROUGH_RATE",
"autoOptimizations": [
"BUDGET"
],
"biddingStrategy": "SPEND_BUDGET_IN_FULL"
}
}]
注文を更新する
注文リソースのPUT操作を使用して、IDで指定した注文に関連付けられた値を更新できます。更新するフィールドには新しいフィールド値を指定し、その他のフィールドには変更していない値を指定して、完全形の注文リソースを送信する必要があります。
まず、注文リソースのGET操作を使用して、更新する注文を取得します。
次に、対象の各フィールド値を更新します。
最後に、注文リソースのPUT操作を使用して注文を更新します。