REST Resource: operators.planStatuses

Ressource: PlanStatus

PlanStatus enthält Details zu allen Mobilfunkdienstpaketen der obersten Ebene, die ein Nutzer erworben hat.

JSON-Darstellung
{
  "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)
}
Felder
name

string

Der Ressourcenname von PlanStatus im folgenden Format: operators/{asn_id}/planStatuses/{userKey}. Der Name wird beim Erstellen eines PlanStatus-Eintrags ignoriert.

plans[]

object (Plan)

Liste der Tarife, die dieser Nutzer besitzt.

languageCode

string

Erforderlich. Der BCP-47-Sprachcode, z. B. "en-US" oder "sr-Latn" Weitere Informationen finden Sie unter http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

expireTime

string (Timestamp format)

Erforderlich. Zeitpunkt, zu dem die Informationen zur freigegebenen Plangruppe veraltet sind. Nach diesem Zeitpunkt wird PlanStatus nicht mehr für Anwendungen bereitgestellt. Die Ablaufzeit muss in der Zukunft liegen.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Erforderlich. Zeitpunkt, zu dem der Datenplan-Agent (DPA) die Informationen zum Planstatus aus den Backend-Systemen abgerufen hat. Kann verwendet werden, um zu ermitteln, wie aktuell die Informationen zum Planstatus sind. Die Aktualisierungszeit muss in der Vergangenheit liegen, darf aber nicht länger als 30 Tage zurückliegen.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

title

string

Titel des Vertrags, den der Nutzer mit dem Mobilfunkanbieter hat. Er wird im Header der Benutzeroberfläche angezeigt.

subscriberId

string

Eindeutige, stabile Kennung im System des Mobilfunkanbieters zur Identifizierung des Nutzers.

accountInfo

object (AccountInfo)

Für Prepaid-Nutzer erforderlich. Informationen zum Nutzerkontostand.

uiCompatibility

enum (UiCompatibility)

Gibt an, ob der PlanStatus dem Nutzer in einer Benutzeroberfläche angezeigt werden kann. Wenn der Wert auf UI_INCOMPATIBLE festgelegt ist, kann der PlanStatus zum Senden von Benachrichtigungen an den Nutzer verwendet werden, aber nicht zum Anzeigen der Planinformationen für den Nutzer.

notifications[]

enum (NotificationType)

Enthält die Liste der Benachrichtigungstypen, die von GTAF an den Nutzer gesendet werden. GTAF ignoriert dieses Feld, wenn es vom Aufrufer ausgefüllt wird.

planInfoPerClient

object (PlanInfoPerClient)

Informationen zum Datentarif, die für einen bestimmten Google-Client relevant sind.

cpidState

enum (CpidState)

Status der CPID, die mit diesem Planstatus verknüpft ist.

Methoden

create

Ermöglicht einem Mobilfunkanbieter (identifiziert durch seine eindeutige Autonomous System Number (ASN)), einen neuen PlanStatus-Eintrag hinzuzufügen.