REST Resource: advertisers.insertionOrders

資源：廣告訂單

單一廣告訂單。

JSON 表示法 
{
  "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)
}
欄位
name

string

僅供輸出。廣告訂單的資源名稱。
advertiserId

string (int64 format)

僅供輸出。廣告訂單所屬的廣告客戶專屬 ID。
campaignId

string (int64 format)

必要欄位。無法變更。廣告訂單所屬的廣告活動專屬 ID。
insertionOrderId

string (int64 format)

僅供輸出。廣告訂單的專屬 ID。由系統指派。
displayName

string

必要欄位。廣告訂單的顯示名稱。

必須採用 UTF-8 編碼，且大小不得超過 240 個位元組。
insertionOrderType

enum (InsertionOrderType)

廣告訂單的類型。

如果在建立過程中未指定這個欄位，則值會預設為 RTB。
entityStatus

enum (EntityStatus)

必要欄位。控制廣告訂單是否能夠支出預算並對廣告空間出價。

  • insertionOrders.create 方法只允許使用 ENTITY_STATUS_DRAFT。如要啟用廣告訂單，請使用 insertionOrders.patch 方法，並在建立後將狀態更新為 ENTITY_STATUS_ACTIVE。
  • 廣告訂單無法從其他狀態改回「ENTITY_STATUS_DRAFT」狀態。
  • 如果廣告訂單的上層廣告活動未啟用，您就無法將廣告訂單設為 ENTITY_STATUS_ACTIVE。
updateTime

string (Timestamp format)

僅供輸出。廣告訂單上次更新時的時間戳記。由系統指派。

RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
partnerCosts[]

object (PartnerCost)

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

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

object (Pacing)

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

object (FrequencyCap)

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

object (IntegrationDetails)

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

object (PerformanceGoal)

必要欄位。廣告訂單的成效目標。
budget

object (InsertionOrderBudget)

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

object (BiddingStrategy)

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

enum (ReservationType)

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

enum (BillableOutcome)

無法變更。廣告訂單的可結算結果。

已淘汰依據結果採購，BILLABLE_OUTCOME_PAY_PER_IMPRESSION 是唯一的有效值。

InsertionOrderType

可能的廣告訂單類型。

廣告訂單的類型會決定適用的設定和選項，例如廣告或指定目標選項的格式。

列舉
INSERTION_ORDER_TYPE_UNSPECIFIED 未指定廣告訂單類型或不明。
RTB 即時出價。
OVER_THE_TOP Over-the-top。

InsertionOrderBudget

控管廣告訂單預算分配方式的設定。

JSON 表示法 
{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}
欄位
budgetUnit

enum (BudgetUnit)

必要欄位。無法變更。預算單位會指定預算是以貨幣或曝光為依據。
automationType

enum (InsertionOrderAutomationType)

用於管理廣告訂單出價和預算的自動化類型。

如果在建立過程中未指定這個欄位，則值會預設為 INSERTION_ORDER_AUTOMATION_TYPE_NONE。
budgetSegments[]

object (InsertionOrderBudgetSegment)

必要欄位。預算區隔清單。您可以使用預算區隔，為廣告訂單執行的特定時間範圍指定特定預算。

InsertionOrderAutomationType

自動化廣告訂單出價和預算的選項。

列舉
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED 未指定廣告訂單自動化選項，或這個版本不明。
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET 自動分配預算。允許系統自動調整委刊項的預算，以提升「performanceGoal」定義的成效。出價設定沒有自動化。
INSERTION_ORDER_AUTOMATION_TYPE_NONE 廣告訂單層級不會自動設定出價或預算。您必須在委刊項層級手動設定出價和預算。
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET 允許系統自動調整出價，並將預算挪給擁有的委刊項，以提升「performanceGoal」定義的成效。

InsertionOrderBudgetSegment

控管單一預算區隔預算的設定。

JSON 表示法 
{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}
欄位
budgetAmountMicros

string (int64 format)

必要欄位。廣告訂單針對特定dateRange支出的預算金額。金額以百萬分之一為單位。(必須大於 0)。舉例來說，500000000 代表 500 的貨幣單位。
description

string

預算區隔說明。這種方式可用來為每個預算區隔輸入訂購單資訊，並將這項資訊列印在月結單上。

必須採用 UTF-8 編碼。
dateRange

object (DateRange)

必要欄位。預算區隔的開始和結束日期設定。然後以上層廣告客戶的時區相對解析。

  • 建立新預算區隔時，startDate和endDate都必須是未來的時間。
  • 過去採用 startDate 的預算區隔，有一個可變動的 endDate，但 startDate 不可變動。
  • 「endDate」必須是在 2037 年前的 startDate 以上版本。
campaignBudgetId

string (int64 format)

這個廣告訂單預算區隔所屬廣告活動預算的 budgetId。

BillableOutcome

廣告訂單的可能計費結果。

列舉
BILLABLE_OUTCOME_UNSPECIFIED 未指定的可結算結果。
BILLABLE_OUTCOME_PAY_PER_IMPRESSION 根據曝光次數付費。
BILLABLE_OUTCOME_PAY_PER_CLICK

每次點擊付費。
BILLABLE_OUTCOME_PAY_PER_VIEWABLE_IMPRESSION

依 Active View 付費。

方法

bulkListInsertionOrderAssignedTargetingOptions

 針對各種指定類型，列出廣告訂單的指派指定目標選項。

create

 建立新的廣告訂單。

delete

 刪除廣告訂單。

get

 取得廣告訂單。

list

 列出廣告客戶中的廣告訂單。

patch

 更新現有的廣告訂單。