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)
  },
  "kpi": {
    object (Kpi)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "optimizationObjective": enum (OptimizationObjective)
}

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 世界標準時間「Zulu」格式的時間戳記，解析度以奈秒為單位，小數點後最多 9 位。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

object (PartnerCost)

與廣告訂單相關聯的夥伴費用。

如果 insertionOrders.create 方法中未提供或空白，新建立的廣告訂單會沿用夥伴設定中的夥伴費用。

object (Pacing)

必要欄位。廣告訂單的預算支出速度設定。

object (FrequencyCap)

必要欄位。廣告訂單的展示頻率上限設定。

object (IntegrationDetails)

廣告訂單的其他整合詳細資料。

object (Kpi)

必要欄位。廣告訂單的主要成效指標 (KPI)。

這在 Display & Video 360 介面中稱為「目標」。

object (InsertionOrderBudget)

必要欄位。廣告訂單的預算分配設定。

object (BiddingStrategy)

廣告訂單的出價策略。根據預設，系統會設定 fixedBid。

enum (ReservationType)

僅供輸出。廣告訂單的預訂類型。

enum (OptimizationObjective)

選用設定。廣告訂單的最佳化目標。

這個欄位僅適用於許可清單中的客戶。如果客戶未加入許可清單，這個欄位將為空值，且嘗試設定時會傳回錯誤。

{
  "kpiType": enum (KpiType),
  "kpiAlgorithmId": string,

  // Union field kpi_value can be only one of the following:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of list of possible types for union field kpi_value.
}

enum (KpiType)

必要欄位。KPI 的類型。

string (int64 format)

選用設定。與 KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST 相關聯的自訂出價演算法 ID。如未選取適當的 KPI，系統會忽略這個欄位。

string (int64 format)

目標金額 (以廣告客戶貨幣的百萬分之一表示)。

當 kpiType 為下列任一值時即適用：

• KPI_TYPE_CPM
• KPI_TYPE_CPC
• KPI_TYPE_CPA
• KPI_TYPE_CPIAVC
• KPI_TYPE_VCPM

例如：1500000 代表貨幣的 1.5 個標準單位。

string (int64 format)

目標百分比的十進位表示法，以微量為單位。

當 kpiType 為下列任一值時即適用：

• KPI_TYPE_CTR
• KPI_TYPE_VIEWABILITY
• KPI_TYPE_CLICK_CVR
• KPI_TYPE_IMPRESSION_CVR
• KPI_TYPE_VTR
• KPI_TYPE_AUDIO_COMPLETION_RATE
• KPI_TYPE_VIDEO_COMPLETION_RATE

例如：70000 代表 7% (十進位 0.07)。

string

KPI 字串，可留空。必須是 UTF-8 編碼，且長度不超過 100 個字元。

當 kpiType 為 KPI_TYPE_OTHER 時適用。

{
  "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 必須是 2037 年之前的 startDate。

string (int64 format)

這個廣告訂單預算區隔包含的廣告活動預算budgetId。