REST Resource: orders.lines

資源:Line

代表已設定產品的單一訂單行。

JSON 表示法
{
  "name": string,
  "product": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "lineState": enum (LineState),
  "rejection": {
    object (Rejection)
  },
  "startTime": string,
  "endTime": string,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "budget": {
    object (Money)
  },
  "lineTerms": {
    object (LineTerms)
  },
  "pendingReservationExpirationTime": string,
  "reservationExpirationTime": string,
  "targeting": {
    object (Targeting)
  },
  "createTime": string,
  "updateTime": string
}
欄位
name

string

僅供輸出。線條的資源名稱,格式如下:orders/{order_id}/lines/{id}

product

string

僅供輸出。這一行所設定的 Product 名稱。格式 = products/123

externalId

string

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

displayName

string

僅供輸出。線條的顯示名稱。

description

string

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

lineState

enum (LineState)

僅供輸出。線條的狀態。如要瞭解線的生命週期,請參閱 LineState

賣方可以使用以下自訂方法:ReserveBookReject 設為下列任一值:

  • LINE_STATE_RESERVED
  • LINE_STATE_BOOKED
  • LINE_STATE_REJECTED_BY_SELLER

所有其他路線狀態都是由買方設定。

rejection

object (Rejection)

選用設定。路線的拒絕詳細資料。

startTime
(deprecated)

string (Timestamp format)

僅供輸出。委刊項開始放送的時間 (含首尾)。

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

endTime
(deprecated)

string (Timestamp format)

僅供輸出。該行停止放送的時間 (不含)。

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

startDate

object (Date)

僅供輸出。委刊項開始放送的日期 (含)。與廣告單元採用相同的時區。

endDate

object (Date)

僅供輸出。委刊項停止放送的日期 (含此日期)。與廣告單元採用相同的時區。

budget

object (Money)

僅供輸出。行預算。

lineTerms

object (LineTerms)

僅供輸出。這行賣家的保證條款。

pendingReservationExpirationTime

string (Timestamp format)

僅供輸出。待處理預留項目的到期日時間戳記。賣方必須在待處理的預訂到期前預訂或拒絕,否則交易會遭到拒絕。

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

reservationExpirationTime

string (Timestamp format)

僅供輸出。預留項目的到期日時間戳記。買方必須在預訂到期前預訂,否則系統會將該預訂視為已取消。

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

targeting

object (Targeting)

僅供輸出。線條的指定目標。

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"

LineState

線條的狀態。

列舉
LINE_STATE_UNSPECIFIED 此版本未指定行狀態,或此版本不明時的預設值。
LINE_STATE_PENDING_RESERVATION 這一行是由買方建立,並要求預訂產品,並更新價格和供應情形資訊。
LINE_STATE_RESERVED 這一行是由賣家預訂。只有在先前狀態是待處理預留項目時,系統才會提供這個狀態。
LINE_STATE_PENDING_BOOKING 買方已接受預訂,並要求預訂委刊項。
LINE_STATE_BOOKED 賣方已預訂了這行訂單。先前狀態必須設為待預訂,才能設定此狀態。這個階段預計不會拒絕。
LINE_STATE_REJECTED_BY_SELLER 賣方拒絕了這行文字。只有在先前狀態是待處理預留項目時,系統才會提供這個狀態。
LINE_STATE_CANCELLED_BY_BUYER 買家已取消委刊項。
LINE_STATE_PENDING_RESERVATION_EXPIRED 預訂未完成,因此無法使用這一行。
LINE_STATE_RESERVED_EXPIRED 這一行已過期,正在等待買方回應。

方法

book

預訂現有電話。

get

擷取訂單的個別行。

list

列出訂單的行。

patch

更新現有的行。

reject

拒絕現有的行。

reserve

保留現有的路線。