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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of mutually exclusive fields.
}
字段
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)

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

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 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 的广告客户。此字段中的所有广告客户都必须属于 readWritePartnerId 或与 readWriteAdvertiserId 属于同一合作伙伴。
defaultAdvertiserId

string (int64 format)

仅限输出。有保证的订单的默认广告客户的 ID。

默认广告客户为 readWriteAdvertiserId，如果未设置该值，则为 readAdvertiserIds 中列出的第一个广告客户。否则，没有默认广告客户。
defaultCampaignId

string (int64 format)

分配给有保证订单的默认广告系列的 ID。

默认广告系列必须属于默认广告客户。

必填。

对有保证的订单具备读写权限的合作伙伴或广告客户。以下是互斥字段的列表。在响应中，最多只能设置以下字段之一：
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

 更新现有的有保证订单。