REST リソース: accounts.customers.orders

リソース: Order

顧客のために販売パートナーによって発注された注文を表すエンティティ。

JSON 表現 

{
  "name": string,
  "offer": string,
  "orderState": enum(OrderState),
  "orderStateReason": string,
  "orderItems": [
    {
      object(OrderItem)
    }
  ],
  "entitlements": [
    string
  ],
  "createTime": string,
  "updateTime": string
}
フィールド
name

string

注文のリソース名。注文の名前の形式は accounts/{account_id}/customers/{customer_id}/orders/{orderId} で、読み取り専用です。

offer

string

この注文が行われるオファーのリソース名。オファーの形式は accounts/{account_id}/offers/{offer_id} です。

orderState

enum(OrderState)

注文の現在の状態。読み取り専用。

orderStateReason

string

注文の状態の説明。

orderItems[]

object(OrderItem)

現在の注文のアイテム。

entitlements[]

string

エンタイトルメントのリソース名の形式は accounts/{account_id}/customers/{customer_id}/entitlements/{id} で、読み取り専用です。

createTime

string（Timestamp 形式）

読み取り専用。注文が作成された時刻。

RFC3339 UTC「ズールー」形式でナノ秒の精度のタイムスタンプ。例: "2014-10-02T15:01:23.045123456Z"
updateTime

string（Timestamp 形式）

注文が更新される時刻。

RFC3339 UTC「ズールー」形式でナノ秒の精度のタイムスタンプ。例: "2014-10-02T15:01:23.045123456Z"

OrderState

OrderState は注文の現在のステータスを示します。

列挙型
ORDER_STATE_UNSPECIFIED 状態は指定されていません。
PENDING 注文処理が保留中です。
COMPLETED 注文が実行されました。
ERROR 注文はエラー状態です。

OrderItem

注文の商品を表します。

JSON 表現 

{
  "offerItem": string,
  "commitmentSettings": {
    object(CommitmentSettings)
  },
  "numUnits": number,
  "maxUnits": number,
  "renewalSettings": {
    object(RenewalSettings)
  }
}
フィールド
offerItem

string

オファーで参照される単一のアイテムのリソース名。オファー アイテムの形式は accounts/{account_id}/offers/{offer_id}/offerItems/{offer_item_id} です。

commitmentSettings

object(CommitmentSettings)

コミットメント ベースのプランの場合はコミットメント設定。読み取り専用。

numUnits

number

注文の数量（該当する場合）。たとえば、ユーザー数に基づくオファーの場合、これはユーザーの数になります。ライセンス数に基づくオファーの場合、これはライセンスの数になります。
maxUnits

number

この注文に対して割り当て可能な最大数量。

renewalSettings

object(RenewalSettings)

更新可能プランの更新設定。

CommitmentSettings

コミットメント ベースのオファーのコミットメント設定。

JSON 表現 

{
  "startDate": string,
  "endDate": string
}
フィールド
startDate

string（Timestamp 形式）

コミットメント開始のタイムスタンプ。

RFC3339 UTC「ズールー」形式でナノ秒の精度のタイムスタンプ。例: "2014-10-02T15:01:23.045123456Z"
endDate

string（Timestamp 形式）

コミットメント終了のタイムスタンプ。

RFC3339 UTC「ズールー」形式でナノ秒の精度のタイムスタンプ。例: "2014-10-02T15:01:23.045123456Z"

RenewalSettings

更新可能なオファーの更新設定。

JSON 表現 

{
  "enableRenewal": boolean,
  "resizeUnitCount": boolean,
  "disableCommitment": boolean
}
フィールド
enableRenewal

boolean

false の場合、プランは終了日に完了します。

resizeUnitCount

boolean

true であり、かつ enableRenewal が true の場合、更新時に数量（ユーザー数やライセンス数など）が有効な数量に設定されます。

disableCommitment

boolean

true の場合、更新時にコミットメント ベースのプランを無効にし、フレキシブル プランまたは従量課金制プランに切り替えます。

メソッド

activate

 以前停止した注文を有効にします。

create

 顧客の代わりに Order を作成します。

get

 リクエストされた Order リソースを返します。

list

 ある顧客に属する Order のリストを取得します。

patch

 既存の顧客の [注文] を更新します。

suspend

 以前処理された注文を停止します。