REST Resource: advertisers.insertionOrders

資源：InsertOrder

單一廣告訂單。

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 計費。

方法

create

 建立新的廣告訂單。

delete

 刪除廣告訂單。

get

 取得廣告訂單。

list

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

listAssignedTargetingOptions

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

patch

 更新現有的廣告訂單。