REST Resource: guaranteedOrders

資源：GuaranteedOrder

保證訂單。

保證訂單是保證廣告空間來源的父項實體。建立保證廣告空間來源時，必須為廣告空間來源指派保證訂單 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)

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

使用 RFC 3339，產生的輸出內容一律會經過 Z 標準化，並使用 0、3、6 或 9 個小數點後位數。系統也接受「Z」以外的偏移量。例如："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
publisherName

string

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

必須採用 UTF-8 編碼，大小上限為 240 個位元組。
readAccessInherited

boolean

readWritePartnerId 的所有廣告主是否都具有保證訂單的讀取權限。只有在設定 readWritePartnerId 時才適用。如為 True，則會覆寫 readAdvertiserIds。
readAdvertiserIds[]

string (int64 format)

可讀取保證訂單的廣告主 ID。

如果已設定 readWriteAdvertiserId，這個欄位就不得包含指派給 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。

您必須先設定保證訂單 (填寫必填欄位、選擇廣告素材及選取預設廣告活動)，才能放送廣告。目前只能透過使用者介面執行設定動作。

GuaranteedOrderConfigStatus

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

列舉
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED 這個版本的核准狀態不明或未指定。
PENDING 保證訂單的初始狀態。處於這種狀態的保證訂單必須先完成設定，才能放送。
COMPLETED 買方設定保證訂單後的狀態。

方法

create

 建立新的保證交易訂單。

editGuaranteedOrderReadAccessors

 編輯保證訂單的讀取廣告主。

get

 保證獲得訂單。

list

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

patch

 更新現有的保證訂單。