REST Resource: orders

資源：Order

訂單是一組 Lines，用於指定顯示廣告的時機和位置。

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

string

僅供輸出。訂單的資源名稱，格式為：訂單/{id}。
externalId

string

選用設定。用於將這個實體對應至外部來源的 ID。
displayName

string

僅供輸出。訂單的顯示名稱。

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

string

僅供輸出。用於描述訂單的其他任意形式欄位。
orderState

enum (OrderState)

僅供輸出。代表根據其線條狀態的訂單計算狀態。
createTime

string (Timestamp format)

僅供輸出。訂單的建立時間戳記。

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

string (Timestamp format)

僅供輸出。訂單上次更新時間戳記。

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

object (AdvertiserInfo)

僅供輸出。廣告客戶資訊。

OrderState

訂單狀態。

列舉
ORDER_STATE_UNSPECIFIED 此預設值尚未指定訂單狀態，或此版本不明時的預設值。
ORDER_STATE_PENDING_RESERVATION

訂單包含：

  • 處於待處理預訂狀態的一或多行內容。
  • 處於保留狀態的零或多個行。
  • 其他所有狀態的零線路。
ORDER_STATE_RESERVED

訂單包含：

  • 待處理的預留項目狀態沒有任何內容
  • 處於保留狀態的一或多行。
  • 賣方狀態拒絕為零或多行
  • 其他所有狀態的零線路。
ORDER_STATE_PENDING_BOOKING

訂單包含：

  • 待處理的預留項目狀態沒有任何內容
  • 保留狀態中的零行程式碼。
  • 有一或多條線屬於待處理的預訂狀態。
  • 賣方狀態拒絕為零或多行
  • 買方已取消零或多行。
  • 其他所有狀態的零線路。
ORDER_STATE_BOOKED

訂單包含：

  • 待處理的預留項目狀態沒有任何內容
  • 保留狀態中的零行程式碼。
  • 待處理的預訂狀態為零行。
  • 處於預訂狀態中的一或多條路線。
  • 賣方狀態拒絕為零或多行
  • 買方已取消零或多行。
  • 其他所有狀態的零線路。
ORDER_STATE_REJECTED_BY_SELLER

訂單包含：

  • 待處理的預留項目狀態沒有任何內容
  • 保留狀態中的零行程式碼。
  • 待處理的預訂狀態為零行。
  • 預訂狀態為零行
  • 由賣方狀態拒絕的一或多行內容。
  • 買方已取消零行。
  • 其他所有狀態的零線路。
ORDER_STATE_CANCELLED_BY_BUYER

訂單包含：

  • 待處理的預留項目狀態沒有任何內容
  • 保留狀態中的零行程式碼。
  • 待處理的預訂狀態為零行。
  • 預訂狀態為零行
  • 沒有由賣家狀態拒絕的 0 行。
  • 買方已取消一或多行。
  • 其他所有狀態的零線路。
ORDER_STATE_PENDING_RESERVATION_EXPIRED

訂單包含：

  • 待處理的預留項目中的一或多條路線已過期。
  • 其他所有狀態的零線路。
ORDER_STATE_RESERVED_EXPIRED

訂單包含：

  • 保留的一或多行程式碼已過期。
  • 其他所有狀態的零線路。

方法

get

 擷取個別訂單。

list

 列出訂單。

patch

 更新現有訂單。