REST Resource: guaranteedOrders

資源：sureOrder

保證訂單。

保證訂單是保證廣告空間來源的上層實體。建立保證廣告空間來源時，你必須將保證訂單 ID 指派給廣告空間來源。

JSON 表示法 
{
  "name": string,
  "legacyGuaranteedOrderId": string,
  "exchange": enum (Exchange),
  "guaranteedOrderId": string,
  "displayName": string,
  "status": {
    object (GuaranteedOrderStatus)
  },
  "updateTime": string,
  "publisherName": string,
  "readAccessInherited": boolean,
  "readAdvertiserIds": [
    string
  ],
  "defaultAdvertiserId": string,
  "defaultCampaignId": string,

  // Union field read_write_accessor can be only one of the following:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of list of possible types for union field read_write_accessor.
}
欄位
name

string

僅供輸出。保證訂單的資源名稱。
legacyGuaranteedOrderId

string

僅供輸出。保證訂單的舊版 ID。由原始廣告交易平台指派。同一個廣告交易平台中的舊版 ID 不會重複，但不保證在所有保證訂單中都是獨一無二的。這個 ID 會用於 SDF 和 UI。
exchange

enum (Exchange)

必要欄位。無法變更。保證訂單來源的廣告交易平台。
guaranteedOrderId

string

僅供輸出。保證訂單的專屬 ID。保證訂單 ID 的格式是 {exchange}-{legacyGuaranteedOrderId}。
displayName

string

必要欄位。保證訂單的顯示名稱。

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

object (GuaranteedOrderStatus)

保證訂單的狀態設定。
updateTime

string (Timestamp format)

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

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

string

必要欄位。保證訂單的發布商名稱。

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

boolean

「readWritePartnerId」的所有廣告主是否具備保證訂單的讀取權限。必須先設定 readWritePartnerId 才能使用。如為 True，會覆寫 readAdvertiserIds。
readAdvertiserIds[]

string (int64 format)

有權讀取保證訂單的廣告客戶 ID。

這個欄位不得包含指派給 readWriteAdvertiserId 的廣告主 (如有設定)。這個欄位中的所有廣告主都必須隸屬於 readWritePartnerId 或與 readWriteAdvertiserId 的夥伴。
defaultAdvertiserId

string (int64 format)

僅供輸出。保證訂單的預設廣告主 ID。

預設廣告主為「readWriteAdvertiserId」。如未設定，則會顯示「readAdvertiserIds」中列出的第一個廣告主。否則，系統就不會提供預設廣告主。
defaultCampaignId

string (int64 format)

指派給保證訂單的預設廣告活動 ID。

預設廣告活動必須屬於預設廣告主。

聯集欄位 read_write_accessor。這是必填欄位。

具備保證訂單讀取/寫入權限的夥伴或廣告主。read_write_accessor 只能採用下列其中一種設定：
readWritePartnerId

string (int64 format)

具備保證訂單讀取/寫入權限的合作夥伴。
readWriteAdvertiserId

string (int64 format)

有權讀取/寫入保證訂單的廣告主。這也是保證訂單的預設廣告主。

GuaranteedOrderStatus

保證訂單的狀態設定。

JSON 表示法 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "configStatus": enum (GuaranteedOrderConfigStatus)
}
欄位
entityStatus

enum (EntityStatus)

保證訂單是否可放送。

可接受的值為 ENTITY_STATUS_ACTIVE、ENTITY_STATUS_ARCHIVED 和 ENTITY_STATUS_PAUSED。預設值為 ENTITY_STATUS_ACTIVE。
entityPauseReason

string

使用者提供暫停此保證訂單的原因。

必須採用 UTF-8 編碼，且長度上限為 100 個位元組。

只有在 entityStatus 設為 ENTITY_STATUS_PAUSED 時才能使用。
configStatus

enum (GuaranteedOrderConfigStatus)

僅供輸出。保證訂單的設定狀態。

可接受的值為 PENDING 和 COMPLETED。

您必須設定保證訂單 (填妥必填欄位、選擇廣告素材，並選取預設廣告活動)，才能放送。設定動作目前只能透過 UI 執行。

GuaranteedOrderConfigStatus

保證訂單的可能設定狀態。

列舉
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED 未指定核准狀態，或這個版本中的狀態不明。
PENDING 保證訂單的開始狀態。必須先設定這個狀態的保證訂單，委刊項才能放送。
COMPLETED 買方設定保證訂單之後的狀態。

方法

create

 建立新的保證訂單。

editGuaranteedOrderReadAccessors

 編輯保證訂單的已讀取廣告客戶資料。

get

 取得保證訂單。

list

 列出目前使用者可存取的保證訂單。

patch

 更新現有的保證訂單。