REST Resource: guaranteedOrders

{
  "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.
}

string

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

string

僅供輸出。保證訂單的舊版 ID。由原始廣告交易平台指派。舊版 ID 在單一廣告交易平台中是獨一無二的，但不保證所有保證訂單 ID 均不得重複。系統會在 SDF 和使用者介面中使用這個 ID。

enum (Exchange)

必要欄位。不可變動。產生保證訂單的廣告交易平台。

string

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

string

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

必須是 UTF-8 編碼，且長度上限為 240 個位元組。

object (GuaranteedOrderStatus)

保證訂單的狀態設定。

string (Timestamp format)

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

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

string

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

必須是 UTF-8 編碼，且長度上限為 240 個位元組。

boolean

「readWritePartnerId」的所有廣告主是否都能讀取保證訂單。只有在已設定 readWritePartnerId 的情況下才能使用。如果為 True，會覆寫 readAdvertiserIds。

string (int64 format)

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

如果已設定這個欄位，就不得包含指派給 readWriteAdvertiserId 的廣告主。這個欄位的所有廣告主都必須屬於 readWritePartnerId 或與 readWriteAdvertiserId 同屬一個夥伴。

string (int64 format)

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

預設廣告客戶會是 readWriteAdvertiserId；如果未設定，則預設廣告客戶是 readAdvertiserIds 中列出的第一個廣告客戶。否則沒有預設廣告客戶。

string (int64 format)

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

預設廣告活動必須屬於預設廣告客戶。

string (int64 format)

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

string (int64 format)

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

{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "configStatus": enum (GuaranteedOrderConfigStatus)
}

enum (EntityStatus)

保證訂單是否可放送。

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

string

使用者為這個保證訂單暫停的原因。

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

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

enum (GuaranteedOrderConfigStatus)

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

可接受的值為 PENDING 和 COMPLETED。

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