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

出力専用。注文のリソース名。形式は orders/{id} です。
externalId

string

省略可。このエンティティを外部ソースにマッピングするために使用される ID。
displayName

string

出力専用。オーダーの表示名。

UTF-8 でエンコードし、最大サイズを 240 バイトにする必要があります。
description

string

出力専用。注文の説明に使用する追加の自由形式フィールド。
orderState

enum (OrderState)

出力専用。行の状態に基づいて計算された注文の状態を表します。
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"。
advertiserInfo

object (AdvertiserInfo)

出力専用。広告主の情報。

OrderState

注文のステータス。

列挙型
ORDER_STATE_UNSPECIFIED 注文の状態が指定されていない場合、またはこのバージョンで不明な場合のデフォルト値。
ORDER_STATE_PENDING_RESERVATION

注文には以下が含まれます。

  • 保留中の予約状態の 1 つ以上の行。
  • 0 行以上であることが必要です。
  • ゼロラインになります。
ORDER_STATE_RESERVED

注文には以下が含まれます。

  • 行が 0 行になっている。
  • 行が予約されています。
  • 販売者のステータスによって 0 行以上の不承認となっています。
  • ゼロラインになります。
ORDER_STATE_PENDING_BOOKING

注文には以下が含まれます。

  • 行が 0 行になっている。
  • 行いません。
  • 予約ステータスの 1 つ以上の行。
  • 販売者のステータスによって不承認となっている行が 0 行以上である。
  • 0 行以上が購入者によってキャンセルされました。
  • ゼロラインになります。
ORDER_STATE_BOOKED

注文には以下が含まれます。

  • 行が 0 行になっている。
  • 行いません。
  • 保留中の予約ステータスは 0 行です。
  • 予約された状態の 1 つ以上の行。
  • 販売者のステータスによって不承認となっている行が 0 行以上である。
  • 0 行以上が購入者によってキャンセルされました。
  • ゼロラインになります。
ORDER_STATE_REJECTED_BY_SELLER

注文には以下が含まれます。

  • 行が 0 行になっている。
  • 行いません。
  • 保留中の予約ステータスは 0 行です。
  • 予約された状態の行が 0 行。
  • 販売者のステータスによって不承認となっている行が 1 件以上あります。
  • 購入者によってキャンセルされた取引はありません。
  • ゼロラインになります。
ORDER_STATE_CANCELLED_BY_BUYER

注文には以下が含まれます。

  • 行が 0 行になっている。
  • 行いません。
  • 保留中の予約ステータスは 0 行です。
  • 予約された状態の行が 0 行。
  • 販売者のステータスによって不承認になった行が 0 行です。
  • 1 つ以上の行が購入者によってキャンセルされました。
  • ゼロラインになります。
ORDER_STATE_PENDING_RESERVATION_EXPIRED

注文に含まれる情報:

  • 保留中の予約の 1 つ以上の行の有効期限が切れています。
  • ゼロラインになります。
ORDER_STATE_RESERVED_EXPIRED

注文に含まれる情報:

  • 予約済みの 1 つ以上の行の有効期限が切れています。
  • ゼロラインになります。

メソッド

get

 個々の注文を取得します。

list

 注文を一覧表示します。

patch

 既存の注文を更新します。