REST Resource: operators.planStatuses

リソース: PlanStatus

PlanStatus には、ユーザーが購入したすべてのトップレベルのモバイル サービス パッケージの詳細が含まれます。

JSON 表現
{
  "name": string,
  "plans": [
    {
      object (Plan)
    }
  ],
  "languageCode": string,
  "expireTime": string,
  "updateTime": string,
  "title": string,
  "subscriberId": string,
  "accountInfo": {
    object (AccountInfo)
  },
  "uiCompatibility": enum (UiCompatibility),
  "notifications": [
    enum (NotificationType)
  ],
  "planInfoPerClient": {
    object (PlanInfoPerClient)
  },
  "cpidState": enum (CpidState)
}
フィールド
name

string

PlanStatus のリソース名。次の形式になります。operators/{asn_id}/planStatuses/{userKey}PlanStatus エントリの作成時に、この名前は無視されます。

plans[]

object (Plan)

このユーザーが所有するプランのリスト。

languageCode

string

必須。「en-US」や「sr-Latn」などの BCP-47 言語コード。詳しくは、http://www.unicode.org/reports/tr35/#Unicode_locale_identifier をご覧ください。

expireTime

string (Timestamp format)

必須。共有プラン グループの情報が古くなる時刻。この時間以降、PlanStatus はアプリケーションに提供されなくなります。有効期限は将来の日付にする必要があります。

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

updateTime

string (Timestamp format)

必須。データプラン エージェント(DPA)がバックエンド システムからプランのステータス情報を取得した時刻。プランのステータス情報の最新度を判断するために使用できます。更新時間は過去のものでなければなりませんが、30 日以上前のものにすることはできません。

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

title

string

ユーザーが携帯通信会社と結んでいる契約のタイトル。これは UI ヘッダーに表示されます。

subscriberId

string

ユーザーを識別するための、携帯通信会社のシステム内の一意の安定した識別子。

accountInfo

object (AccountInfo)

プリペイド ユーザーに必要です。ユーザー アカウントの残高に関する情報。

uiCompatibility

enum (UiCompatibility)

PlanStatus をユーザー インターフェースでユーザーに表示できるかどうかを判断します。UI_INCOMPATIBLE に設定すると、PlanStatus はユーザーへの通知の送信に使用できますが、ユーザーへのプラン情報の表示には使用されません。

notifications[]

enum (NotificationType)

GTAF からユーザーに送信される通知の種類のリストが含まれます。呼び出し元によってこのフィールドが入力された場合、GTAF はこのフィールドを無視します。

planInfoPerClient

object (PlanInfoPerClient)

特定の Google クライアントに関連するデータプラン情報。

cpidState

enum (CpidState)

このプランのステータスに関連付けられている CPID のステータス。

メソッド

create

モバイル オペレーター(固有の自律システム番号(ASN)で識別)が新しい PlanStatus エントリを追加できるようにします。