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 のステータスです。

Methods

create

携帯電話会社(一意の自律システム番号(ASN)で識別)が新しい PlanStatus エントリを追加できるようにする。