REST Resource: operators.planStatuses

Ressource: PlanStatus

Der PlanStatus enthält Details zu allen mobilen Paketen der obersten Ebene, die ein Nutzer gekauft 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)
  }
}
Felder
name

string

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

plans[]

object (Plan)

Liste der Pläne, die diesem Nutzer gehören.

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. Zeit, in der die Informationen zur Gruppe des freigegebenen Plans veraltet sind. Nach diesen Zeiten wird PlanStatus nicht mehr für Anwendungen verwendet.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ in Nanosekunden. Beispiel: "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Erforderlich. Zeitpunkt, zu dem der Datenplan-Agent (DPA) die Tarifstatusinformationen aus den Back-End-Systemen abgerufen hat. Kann verwendet werden, um die Aktualität des Tarifstatus zu ermitteln.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ in Nanosekunden. Beispiel: "2014-10-02T15:01:23.045123456Z".
title

string

Titel des Vertrags, den der Nutzer mit dem Betreiber hat. Dies wird in der Benutzeroberfläche angezeigt.

subscriberId

string

Eindeutige stabile Kennung im Mobilfunkanbieter, um den Nutzer zu identifizieren.

accountInfo

object (AccountInfo)

Erforderlich für Nutzer mit Vorauszahlung. Informationen zum Kontostand des Nutzers.

uiCompatibility

enum (UiCompatibility)

Legt fest, ob der PlanStatus dem Nutzer auf einer Benutzeroberfläche angezeigt werden kann. Wenn dieser Parameter auf „UI_INCOMPATIBLE“ festgelegt ist, kann er verwendet werden, um Benachrichtigungen an den Nutzer zu senden. Die Informationen zum Tarif werden ihm jedoch nicht angezeigt.

notifications[]

enum (NotificationType)

Die Benachrichtigungstypen, die an den Nutzer gesendet wurden.

planInfoPerClient

object (PlanInfoPerClient)

Methoden

create

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