REST Resource: sellers.orders

资源：订单

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

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

string

订单的资源名称。格式：sellers/{seller}/orders/{order}
externalId

string

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

string

订单的显示名称。

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

string

用于描述订单的其他自由格式字段。
state

enum (State)

仅限输出。订单的状态。

卖方可以使用以下自定义方法：orders.completeOrderReservation 和 orders.completeOrderBooking，以将其设置为以下项之一：

  • STATE_RESERVATION_COMPLETE
  • STATE_BOOKING_COMPLETE。

所有其他订单状态均由买方设置。
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)

广告客户信息。
cancellationReason

enum (CancellationReason)

仅限输出。取消原因。

州

订单的状态。

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

该订单包含：

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

该订单包含：

  • 一行或多行，被卖方状态预订或拒绝。
  • 在所有其他状态下，均以零行的形式出现。
STATE_PENDING_BOOKING

该订单包含：

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

该订单包含：

  • 一行或多行（已被卖方状态预订或拒绝）。
  • 在所有其他状态下，均以零行的形式出现。
STATE_CANCELLED_BY_BUYER

该订单包含：

  • 一行或多行，被买方取消或被卖方状态拒绝。
  • 在所有其他状态下，均以零行的形式出现。
STATE_PENDING_RESERVATION_EXPIRED

该订单包含：

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

该订单包含：

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

CancellationReason

取消原因（如果订单已取消）。

枚举
CANCELLATION_REASON_UNSPECIFIED 在此版本中，取消原因未指定或未知时的默认值。
CANCELLATION_REASON_BUYER_REQUESTED 买家请求取消订单。
CANCELLATION_REASON_INVALID_ADVERTISER_INFO 提供的广告客户信息无效。

方法

completeOrderBooking

 完成订单预订。

completeOrderReservation

 完成订单预留。

create

 创建新订单。

get

 检索单个订单。

list

 列出订单。

patch

 更新现有订单。