REST Resource: advertisers.insertionOrders

{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "displayName": string,
  "insertionOrderType": enum (InsertionOrderType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "performanceGoal": {
    object (PerformanceGoal)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "billableOutcome": enum (BillableOutcome)
}

string

出力専用。広告掲載オーダーのリソース名。

string (int64 format)

出力専用。広告掲載オーダーが属する広告主の一意の ID。

string (int64 format)

必須。変更不可。広告掲載オーダーが属するキャンペーンの一意の ID。

string (int64 format)

出力専用。広告掲載オーダーの一意の ID。システムによって割り当てられます。

string

必須。広告掲載オーダーの表示名。

UTF-8 でエンコードし、最大サイズを 240 バイトにする必要があります。

enum (InsertionOrderType)

広告掲載オーダーのタイプ。

作成時にこのフィールドを指定しない場合、値はデフォルトで RTB になります。

enum (EntityStatus)

必須。広告掲載オーダーの予算を消化して広告枠に入札できるかどうかを制御します。

• insertionOrders.create メソッドの場合、ENTITY_STATUS_DRAFT のみを使用できます。広告掲載オーダーを有効にするには、insertionOrders.patch メソッドを使用して、作成後にステータスを ENTITY_STATUS_ACTIVE に更新します。
• 広告掲載オーダーは、他のステータスから ENTITY_STATUS_DRAFT に戻すことはできません。
• 親キャンペーンが有効でなければ、広告掲載オーダーを ENTITY_STATUS_ACTIVE に設定することはできません。

string (Timestamp format)

出力専用。広告掲載オーダーが最後に更新されたときのタイムスタンプ。システムによって割り当てられます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

object (PartnerCost)

広告掲載オーダーに関連付けられたパートナー費用。

insertionOrders.create メソッドに指定されていない場合、または指定されていない場合、新しく作成された広告掲載オーダーはパートナーの設定からパートナー費用を継承します。

object (Pacing)

必須。広告掲載オーダーの予算支出速度の設定。

object (FrequencyCap)

必須。広告掲載オーダーのフリークエンシー キャップ設定。

object (IntegrationDetails)

広告掲載オーダーの統合に関する追加の詳細。

object (PerformanceGoal)

必須。広告掲載オーダーのパフォーマンス目標。

object (InsertionOrderBudget)

必須。広告掲載オーダーの予算割り当て設定。

object (BiddingStrategy)

広告掲載オーダーの入札戦略。デフォルトでは fixedBid が設定されています。

enum (ReservationType)

出力専用。広告掲載オーダーの予約タイプ。

enum (BillableOutcome)

変更不可。広告掲載オーダーの請求対象。

成果ベースの購入はサポート終了となりました。有効な値は BILLABLE_OUTCOME_PAY_PER_IMPRESSION のみです。

{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}

enum (BudgetUnit)

必須。変更不可。予算単位では、予算が通貨ベースかインプレッション ベースかを指定します。

enum (InsertionOrderAutomationType)

広告掲載オーダーの入札単価と予算の管理に使用する自動化のタイプ。

作成時にこのフィールドを指定しなかった場合、値はデフォルトで INSERTION_ORDER_AUTOMATION_TYPE_NONE になります。

object (InsertionOrderBudgetSegment)

必須。予算セグメントのリスト。予算セグメントを使用すると、広告掲載オーダーの一定期間における特定の予算を指定できます。

{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}

string (int64 format)

必須。指定された dateRange に広告掲載オーダーで使用される予算額。金額はマイクロ秒単位です。0 より大きくする必要があります。たとえば、500000000 は 500 通貨の標準単位を表します。

string

予算セグメントの説明。これを使用して、各予算セグメントの注文書情報を入力でき、その情報を請求書に印刷できます。

UTF-8 でエンコードする必要があります。

object (DateRange)

必須。予算セグメントの開始日と終了日の設定。親広告主のタイムゾーンを基準にして解決されます。

• 新しい予算セグメントを作成する際は、startDate と endDate の両方を将来の日付にする必要があります。
• 過去に startDate が設定されている既存の予算セグメントには、endDate は変更可能ですが、startDate は変更できません。
• endDate は、startDate 以降で、どちらも 2037 年より前の日付にする必要があります。

string (int64 format)

この広告掲載オーダーの予算セグメントが含まれているキャンペーン予算の budgetId。