REST リソース: accounts.customers.entitlements

リソース: エンタイトルメント

エンタイトルメントは、サービスの使用を開始するための販売手段を提供するエンティティを表します。エンタイトルメントは読み取り専用で、注文の実行の一部として更新されます。

JSON 表現 

{
  "name": string,
  "orderId": string,
  "state": enum(State),
  "stateReason": string,
  "createTime": string,
  "updateTime": string,
  "channelPartnerId": string
}
フィールド
name

string

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

orderId

string

このエンタイトルメントを作成した注文 ID。

state

enum(State)

エンタイトルメントの状態。

stateReason

string

エンタイトルメントの状態の説明。

createTime

string（Timestamp 形式）

読み取り専用。エンタイトルメントが作成された時刻。

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

string（Timestamp 形式）

エンタイトルメントが更新された時刻。

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

string

顧客の注文の直接販売パートナーとなるチャネル パートナーの Cloud Identity ID。このフィールドは通常、チャネル パートナーや販売パートナーの代わりに最上位のディストリビュータが注文を行う 2 層注文で使用されます。

State

エンタイトルメントの現在の状態を示します。

列挙型
STATE_UNSPECIFIED デフォルト値。この値が戻されてはいけません。
ERROR エンタイトルメントを作成または有効化する際にエラーが発生しました。
ACTIVE エンタイトルメントは現在アクティブです。
COMPLETE エンタイトルメントが失効し、更新されなかったか、またはキャンセルされました。エンタイトルメントが COMPLETE になった場合、このステータスが変更されることはありません。
CANCELED エンタイトルメントは処理されませんでした。エンタイトルメントが CANCELED になった場合、このステータスが変更されることはありません。
PENDING エンタイトルメントは作成されましたが、プロビジョニングされていません。ToS への同意が保留中の場合、エンタイトルメントがこの状態になることがあります。
SUSPENDED エンタイトルメントは現在停止中です。

メソッド

assignChannelPartner

 チャネル パートナーを Entitlement リソースに割り当てます。

get

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

list

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