REST Resource: orders.lines

リソース: Line

構成されたプロダクトを表す 1 つの注文行。

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)

出力専用。線の状態。Line のライフサイクルについては、LineState をご覧ください。

販売者は、Reserve、Book、Reject のカスタム メソッドを使用して、次のいずれかに設定します。

  • LINE_STATE_RESERVED
  • LINE_STATE_BOOKED
  • LINE_STATE_REJECTED_BY_SELLER。

その他のすべてのステータスは購入者が設定します。
rejection

object (Rejection)

省略可。回線の拒否の詳細。
startTime
(deprecated)

string (Timestamp format)

出力専用。路線の配信が開始される時間（両端を含む）。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
endTime
(deprecated)

string (Timestamp format)

出力専用。広告申込情報の配信を停止するタイミング（この時間を含まない）。

RFC3339 UTC「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 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
reservationExpirationTime

string (Timestamp format)

出力専用。予約の有効期限のタイムスタンプ。購入者は、有効期限が切れる前に予約する必要があります。期限が過ぎると、予約はキャンセルしたものとして扱われます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
targeting

object (Targeting)

出力専用。ラインのターゲティング。
createTime

string (Timestamp format)

出力専用。行の作成タイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

出力専用。行の最終更新日のタイムスタンプ。

RFC3339 UTC「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

 既存の回線を予約します。