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 和界面中使用。
exchange

enum (Exchange)

必需。不可变。发起有保证订单的广告交易平台。
guaranteedOrderId

string

仅供输出。有保证的订单的唯一标识符。有保证订单 ID 的格式为 {exchange}-{legacyGuaranteedOrderId}。
displayName

string

必需。有保证的订单的显示名称。

必须采用 UTF-8 编码，大小上限为 240 个字节。
status

object (GuaranteedOrderStatus)

有保证订单的状态设置。
updateTime

string (Timestamp format)

仅供输出。上次更新有保证订单时的时间戳。由系统分配。

采用 RFC3339 世界协调时间 (UTC)（即“祖鲁时”）格式的时间戳，采用纳秒级精度，最多包含九个小数位。示例："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。

必须先配置有保证订单（填写必填字段、选择广告素材并选择默认广告系列），然后该订单才能投放。目前只能通过界面执行配置操作。

GuaranteedOrderConfigStatus

有保证订单的可能配置状态。

枚举
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED 该版本中未指定审批状态或审批状态未知。
PENDING 有保证订单的起始状态。处于此状态的有保证订单需要先配置，然后才能投放。
COMPLETED 买方配置有保证订单后的状态。

方法

create

 创建新的有保证订单。

editGuaranteedOrderReadAccessors

 可以修改有保证订单的广告客户。

get

 获取有保证的订单。

list

 列出当前用户访问的有保证订单。

patch

 更新现有的有保证订单。