REST Resource: orders

资源：订单

订单是一系列 Lines，用于指定广告的展示时间和展示位置。

JSON 表示法 
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "orderState": enum (OrderState),
  "createTime": string,
  "updateTime": string,
  "advertiserInfo": {
    object (AdvertiserInfo)
  }
}
字段
name

string

仅限输出。订单的资源名称，格式为： orders/{id}。
externalId

string

可选。用于将此实体映射到外部来源的 ID。
displayName

string

仅限输出。订单的显示名称。

必须采用 UTF-8 编码，大小不超过 240 个字节。
description

string

仅限输出。用于描述订单的其他自由格式字段。
orderState

enum (OrderState)

仅限输出。表示根据订单行的状态计算得出的其状态。
createTime

string (Timestamp format)

仅限输出。订单的创建时间戳。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

仅限输出。订单的上次更新时间戳。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
advertiserInfo

object (AdvertiserInfo)

仅限输出。广告客户信息。

OrderState

订单的状态。

枚举
ORDER_STATE_UNSPECIFIED 此版本中的订单状态未指定或未知时的默认值。
ORDER_STATE_PENDING_RESERVATION

该订单包含：

  • 一行或多行处于待处理预留状态。
  • 0 行或更多行处于保留状态。
  • 在所有其他状态下，均以零行的形式出现。
ORDER_STATE_RESERVED

该订单包含：

  • 处于待处理预留状态的 0 行。
  • 一行或多行。
  • 被卖方状态拒绝。
  • 在所有其他状态下，均以零行的形式出现。
ORDER_STATE_PENDING_BOOKING

该订单包含：

  • 处于待处理预留状态的 0 行。
  • 处于保留状态的 0 行。
  • 一行或多行处于待预订状态。
  • 被卖方状态拒绝。
  • 买方已取消其中 0 行或 0 行以上的交易。
  • 在所有其他状态下，均以零行的形式出现。
ORDER_STATE_BOOKED

该订单包含：

  • 处于待处理预留状态的 0 行。
  • 处于保留状态的 0 行。
  • 处于待预订状态，没有任何行。
  • 处于已预订状态的一行或多行。
  • 被卖方状态拒绝。
  • 买方已取消其中 0 行或 0 行以上的交易。
  • 在所有其他状态下，均以零行的形式出现。
ORDER_STATE_REJECTED_BY_SELLER

该订单包含：

  • 处于待处理预留状态的 0 行。
  • 处于保留状态的 0 行。
  • 处于待预订状态，没有任何行。
  • 处于预订状态，没有任何行。
  • 有一行或多行被卖方状态拒绝。
  • 有 0 行代码已被买方取消。
  • 在所有其他状态下，均以零行的形式出现。
ORDER_STATE_CANCELLED_BY_BUYER

该订单包含：

  • 处于待处理预留状态的 0 行。
  • 处于保留状态的 0 行。
  • 处于待预订状态，没有任何行。
  • 处于预订状态，没有任何行。
  • 被卖方状态拒绝。
  • 一行或多行已被买方取消。
  • 在所有其他状态下，均以零行的形式出现。
ORDER_STATE_PENDING_RESERVATION_EXPIRED

该订单包含：

  • 待处理的预订中的一行或多行已过期。
  • 在所有其他状态下，均以零行的形式出现。
ORDER_STATE_RESERVED_EXPIRED

该订单包含：

  • 预留中的一行或多行已过期。
  • 在所有其他状态下，均以零行的形式出现。

方法

get

 检索单个订单。

list

 列出订单。

patch

 更新现有订单。