- Ressource: PlanStatus
- JSON-Darstellung
- Planen
- PlanCategory
- PlanModule
- ByteQuota
- TimeQuota
- BalanceLevel
- PlanModuleTrafficCategory
- OverUsagePolicy
- PlanState
- RefreshPeriod
- AccountInfo
- Geld
- AccountBalanceStatus
- UiCompatibility
- NotificationType
- PlanInfoPerClient
- YouTube
- RateLimitedStreaming
- AndroidSystemInfo
- CellularInfo
- ConnectionType
- Messbarkeit
- CpidState
- Methoden
Ressource: PlanStatus
PlanStatus enthält Details zu allen Mobilfunkdienstpaketen der obersten Ebene, die ein Nutzer erworben hat.
JSON-Darstellung | |
---|---|
{ "name": string, "plans": [ { object ( |
Felder | |
---|---|
name |
Der Ressourcenname von PlanStatus im folgenden Format: |
plans[] |
Liste der Tarife, die dieser Nutzer besitzt. |
languageCode |
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 |
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: |
updateTime |
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: |
title |
Titel des Vertrags, den der Nutzer mit dem Mobilfunkanbieter hat. Er wird im Header der Benutzeroberfläche angezeigt. |
subscriberId |
Eindeutige, stabile Kennung im System des Mobilfunkanbieters zur Identifizierung des Nutzers. |
accountInfo |
Für Prepaid-Nutzer erforderlich. Informationen zum Nutzerkontostand. |
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[] |
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 |
Informationen zum Datentarif, die für einen bestimmten Google-Client relevant sind. |
cpidState |
Status der CPID, die mit diesem Planstatus verknüpft ist. |
Plan
Details zum Mobilfunkvertrag des Nutzers, dem Mobilfunkpaket der obersten Ebene, das ein Abonnent erwirbt. Der Tarif kann so einfach wie „10 GB mobile Daten für 30 Tage“ sein oder als Sammlung von Komponenten (die wir als Tarifmodule bezeichnen) definiert werden. Das ACME-Abo 199, das als „2 GB Datenvolumen, unbegrenzte Nutzung von WhatsApp und WeChat sowie 1 GB Spotify“ beschrieben wird, enthält beispielsweise drei Abomodule.
JSON-Darstellung | |
---|---|
{ "planName": string, "planId": string, "planCategory": enum ( |
Felder | |
---|---|
planName |
Name des Mobilfunktarifs des Nutzers. |
planId |
Erforderlich. Plan-ID, die verwendet wird, um sich bei Angeboten usw. auf den Plan zu beziehen. |
planCategory |
Prepaid- oder Postpaid-Tarif. |
expirationTime |
Erforderlich. Das Ablaufdatum dieses Plans. Bei den meisten Plänen sollte dies dem Maximum aller ablaufbezogenen Zeiten für die einzelnen Planmodule entsprechen. Bei Abos, bei denen das Modulkontingent regelmäßig aktualisiert wird, sollte dies die Ablaufzeit des gesamten Abos sein, also der Zeitpunkt, zu dem die Aktualisierung der Abomodule endet. Dieses Feld sollte weggelassen werden, wenn das Abo nicht abläuft. Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
planModules[] |
Detaillierte Informationen zu Planmodulen (Unterplänen). |
planState |
Status des Nutzerabos, z. B. „aktiv“ oder „inaktiv“ |
PlanCategory
Mögliche Typen von Plan-Kategorien.
Enums | |
---|---|
PLAN_CATEGORY_UNSPECIFIED |
Nicht angegeben |
PREPAID |
Prepaid-Tarif |
POSTPAID |
Postpaid-Tarif |
PlanModule
Informationen zu jedem Datenplanmodul (oder Unterplan) in einem Plan.
JSON-Darstellung | |
---|---|
{ "coarseBalanceLevel": enum ( |
Felder | ||
---|---|---|
coarseBalanceLevel |
Grobe Informationen zum Guthaben. |
|
trafficCategories[] |
Liste der Traffic-Kategorien, die diesem Tarifmodul in Rechnung gestellt werden. |
|
expirationTime |
Erforderlich. Ablaufzeit für das Planmodul. Bei Planmodulen mit Kontingent, das regelmäßig aktualisiert wird, ist dies der Zeitpunkt der nächsten Modulaktualisierung. Dieses Feld sollte weggelassen werden, wenn das Planmodul nicht abläuft. Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
|
overUsagePolicy |
Die Nutzungsrichtlinie wurde überschritten, z.B. durch Drosselung. |
|
maxRateKbps |
Die maximale Datenrate, die von diesem Tarifmodul in kbit/s zugelassen wird. Die tatsächlich beobachtete Datenrate liegt je nach Netzwerkbedingungen zwischen 0 und maxRateKbps. Wenn Sie „maxRateKbps“ weglassen oder auf 0 setzen, wird für dieses Planmodul keine Drosselung durchgeführt. |
|
description |
Erforderlich. Beschreibung des Planmoduls, die Nutzern angezeigt werden kann und der Marktbeschreibung dieses Planmoduls entsprechen sollte. |
|
moduleName |
Erforderlich. Name des Planmoduls. |
|
usedBytes |
Gesamtzahl der Bytes, die der Nutzer mit diesem Planmodul verwendet hat. |
|
planModuleState |
Status des Planmoduls, z. B. „Aktiv“ oder „Inaktiv“ |
|
refreshPeriod |
Der Aktualisierungszeitraum dieses Planmoduls oder REFRESH_PERIOD_NONE, wenn das Kontingent des Planmoduls nicht aktualisiert wird. Planmodule, die das Kontingent aktualisieren, tun dies einmal pro Aktualisierungszeitraum. |
|
Union-Feld balance . Erforderlich. Informationen zum Guthaben des Planmoduls. Muss einer der folgenden Werte sein: byte_balance, time_balance, coarse_balance_level. Für balance ist nur einer der folgenden Werte zulässig: |
||
byteBalance |
Informationen zum Guthaben des bytebasierten Abo-Moduls. Bei Modulen, die regelmäßig aktualisiert werden, stellt dieses Feld das Byte-Guthaben pro Aktualisierungszeitraum dar. |
|
timeBalance |
Informationen zum Guthaben des zeitbasierten Abo-Moduls. Bei Modulen, die regelmäßig aktualisiert werden, stellt dieses Feld das Zeitguthaben pro Aktualisierungszeitraum dar. |
ByteQuota
Kontingent-/Guthabeninformationen für das Modul „Tarif mit Datenvolumen“.
JSON-Darstellung | |
---|---|
{ "quotaBytes": string, "remainingBytes": string } |
Felder | |
---|---|
quotaBytes |
Modulkontingent in Byte. Bei Tarifen mit unbegrenztem Datenvolumen sollte dieser Wert auf 2^63 – 1 (9223372036854775807) festgelegt werden. |
remainingBytes |
Erforderlich für Benachrichtigungen bei niedrigem Guthaben. Verbleibendes Kontingentguthaben in Byte. |
TimeQuota
Kontingent-/Guthabeninformationen für zeitbasierte Preisplanmodule.
JSON-Darstellung | |
---|---|
{ "quotaMinutes": string, "remainingMinutes": string } |
Felder | |
---|---|
quotaMinutes |
Modulkontingent in Minuten für zeitbasierten Plan, z.B. 180 Minuten. |
remainingMinutes |
Verbleibendes Kontingent in Minuten für zeitbasierte Tarife, z.B.: 40 Minuten. |
BalanceLevel
Informationen zum Ausgleich von Daten für das Modul „Grobe Planung“.
Enums | |
---|---|
BALANCE_LEVEL_UNSPECIFIED |
Nicht angegeben |
NO_PLAN |
Kein Datenvolumen. |
OUT_OF_DATA |
Das Datenguthaben ist null. |
LOW_QUOTA |
Das Datenguthaben (oder die verbleibende Zeit) entspricht 10–25% des ursprünglichen Guthabens (oder der ursprünglichen Zeit) oder ist geringer. Mobilfunkanbieter DÜRFEN den genauen Schwellenwert für jedes Paket nach eigenem Ermessen festlegen. |
HIGH_QUOTA |
Das Datenvolumen (oder die verbleibende Zeit) beträgt mehr als 10–25% des ursprünglichen Paketvolumens (oder der ursprünglichen Zeit). Mobilfunkanbieter DÜRFEN den genauen Schwellenwert für jedes Paket nach eigenem Ermessen festlegen. Das Datenvolumen ist hoch. |
PlanModuleTrafficCategory
Die Traffic-Kategorie des Planmoduls, die die Menge des Anwendungstraffics beschreibt, der in ein bestimmtes Planmodul fällt.
Enums | |
---|---|
PLAN_MODULE_TRAFFIC_CATEGORY_UNSPECIFIED |
Nicht angegeben |
GENERIC |
Allgemein, gilt für den gesamten Traffic. |
VIDEO |
Alle Videoaufrufe. |
VIDEO_BROWSING |
Zugriffe über die Videofunktion (Browsing), die sich auf alle Zugriffe auf Video-Apps mit Ausnahme des Video-/Audio-Streamings beziehen. |
VIDEO_OFFLINE |
Offline-Zugriffe bei Videos, die sich aus VIDEO_BROWSING und Offline-Zugriffen bei Video/Audio (nicht Streaming) zusammensetzen. |
MUSIC |
Datenverkehr der Musik-App |
GAMING |
Traffic von Gaming-Apps. |
SOCIAL |
Traffic über soziale Netzwerke. |
MESSAGING |
Traffic von Messaging-Apps. |
APP_STORE |
App-Store-Traffic, z. B. beim Aktualisieren oder Herunterladen einer neuen App. |
OverUsagePolicy
Richtlinie zur Überschreitung des Kontingents: Was passiert, wenn das Kontingent des Nutzers aufgebraucht ist?
Enums | |
---|---|
OVER_USAGE_POLICY_UNSPECIFIED |
Nicht angegeben |
THROTTLED |
Die Geschwindigkeit wird gedrosselt. |
BLOCKED |
Die Verbindung ist blockiert. |
PAY_AS_YOU_GO |
Nutzungsabhängige Bezahlung |
PlanState
Enum, das die verschiedenen Status des Tarifs/Tarifmoduls eines Nutzers darstellt.
Enums | |
---|---|
ACTIVE |
Plan/PlanModule ist aktiv und der Nutzer kann die im Modul angebotenen Daten verwenden. |
INACTIVE |
Das Abo/Abo-Modul ist inaktiv. Der Nutzer hat zwar noch Zugriff auf das Modul, kann aber nicht auf die darin enthaltenen Daten zugreifen. Das kann passieren, wenn das Modul nur zu bestimmten Tageszeiten Daten liefert oder wenn der Nutzer ein Modul gekauft hat, es aber noch nicht aktiviert ist. |
EXPIRING_SOON |
Der Plan/das PlanModule läuft bald ab. Der Aufrufer sollte ein geeignetes Niveau für die Festlegung dieses Werts auswählen. Das bedeutet automatisch, dass der Tarif aktiv ist. |
NEWLY_ACTIVE |
Ein Plan oder PlanModule, der zuvor inaktiv war oder nicht existierte, wurde gerade aktiviert. Dieser Status sollte nur für einen sehr kurzen Zeitraum nach der Aktivierungszeit verwendet werden. Andernfalls sollte stattdessen der Status „ACTIVE“ verwendet werden. Benachrichtigungen zum Datenvolumenstatus, die mit NEWLY_ACTIVE-Modulen gesendet werden, sollten eine kurze TTL haben, da der Status NEWLY_ACTIVE sehr schnell ungenau wird. |
EXPIRED |
Der Plan oder das PlanModule ist abgelaufen. Wenn Sie diesen Enum-Wert festlegen, wird eine Benachrichtigung über das Ablaufen des Abos ausgelöst. |
RefreshPeriod
Stellt einen Aktualisierungszeitraum dar, das regelmäßige Intervall, in dem ein Planmodul zurückgesetzt wird.
Enums | |
---|---|
REFRESH_PERIOD_NONE |
Kein Aktualisierungszeitraum. Wird verwendet, wenn das Planmodul nicht wiederkehrend ist. |
DAILY |
Das Planmodul wird jeden Tag zurückgesetzt. |
MONTHLY |
Das Planmodul wird jeden Monat zurückgesetzt. |
BIWEEKLY |
Das Planmodul wird alle zwei Wochen zurückgesetzt. |
WEEKLY |
Das Planmodul wird jede Woche zurückgesetzt. |
AccountInfo
Informationen zum Guthaben von Prepaid-Nutzern.
JSON-Darstellung | |
---|---|
{ "accountBalance": { object ( |
Felder | |
---|---|
accountBalance |
Erforderlich. Verbleibendes Kontoguthaben auf dem Nutzerkonto. |
loanBalance |
Erforderlich, falls zutreffend. Das verbleibende Kontoguthaben im Nutzerkonto, das durch ein Darlehen des Mobilfunkanbieters hinzugefügt wurde. Falls vorhanden, ist dieses Guthaben nicht im Feld „accountBalance“ enthalten. |
unpaidLoan |
Geldbetrag, den der Nutzer dem Mobilfunkanbieter aufgrund von Geldleihen schuldet. |
accountBalanceStatus |
Erforderlich. Gibt den Status des Kontostands an. Bei einer Diskrepanz zwischen der „validUntil“-Zeit und dem Feld „accountBalanceStatus“ verwenden wir „accountBalanceStatus“. |
validUntil |
Erforderlich. Die Zeit, bis zu der das Kontoguthaben gültig ist. In diesem Feld wird dem Nutzer der Hinweis „Ungültig in Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
payAsYouGoCharge |
Der Betrag, den der Nutzer durch die Nutzung des Tarifs im nutzungsabhängigen Modus ausgegeben hat. Wenn dieses Feld vom Mobilfunkanbieter ausgefüllt wird, wenn er Kontoinformationen an GTAF weitergibt, versucht GTAF, dem Nutzer eine Benachrichtigung zu senden, dass er Geld im Pay-as-you-go-Modus ausgibt. |
accountTopUp |
Erforderlich für Benachrichtigungen zum Aufladen des Kontos. Der Betrag, den der Nutzer seinem Guthaben hinzugefügt hat. Wenn dieses Feld vom Mobilfunkanbieter ausgefüllt wird, wenn er Kontoinformationen an GTAF weitergibt, versucht GTAF, dem Nutzer eine Benachrichtigung zu senden, dass sein Konto aufgeladen wurde. |
Geld
Stellt einen Geldbetrag mit Währungstyp dar.
JSON-Darstellung | |
---|---|
{ "currencyCode": string, "units": string, "nanos": integer } |
Felder | |
---|---|
currencyCode |
Der aus drei Buchstaben bestehende Währungscode gemäß ISO 4217. |
units |
Die ganzen Einheiten des Betrags. Beispiel: Wenn |
nanos |
Anzahl der Nanoeinheiten (10^-9) des Betrags. Der Wert muss im Bereich von -999.999.999 bis +999.999.999 liegen. Wenn |
AccountBalanceStatus
Status der Nutzer-Wallet.
Enums | |
---|---|
VALID |
Das Guthaben des Nutzerkontos ist gültig und kann für Käufe verwendet werden. |
INVALID |
Das Guthaben des Nutzerkontos ist ungültig und kann nicht verwendet werden, ohne dass Änderungen am Konto vorgenommen werden. |
UiCompatibility
Enum, das angibt, ob der freigegebene PlanStatus dem Nutzer angezeigt werden kann.
Enums | |
---|---|
UI_COMPATIBILITY_UNSPECIFIED |
Standardmäßig gehen wir davon aus, dass der PlanStatus mit der Benutzeroberfläche kompatibel ist. |
UI_COMPATIBLE |
Gibt an, dass der gesamte PlanStatus mit der Benutzeroberfläche kompatibel ist und die Planinformationen dem Nutzer angezeigt werden können. |
UI_INCOMPATIBLE |
Gibt an, dass der PlanStatus nicht mit der Benutzeroberfläche kompatibel ist. Felder können zum Senden von Benachrichtigungen an den Nutzer verwendet werden, aber nicht zum Anzeigen von Tarifinformationen für den Nutzer. |
NotificationType
Die Art der Benachrichtigung, die an den Nutzer der Einstellungen für den Mobilfunktarif gesendet wird.
Enums | |
---|---|
NOTIFICATION_UNDEFINED |
Unbekannter Benachrichtigungstyp |
NOTIFICATION_LOW_BALANCE_WARNING |
Benachrichtigung, die Nutzer vor niedrigem Guthaben warnt |
NOTIFICATION_DATA_EXPIRATION_WARNING |
Benachrichtigung, die Nutzer warnt, dass der Datentarif bald abläuft |
NOTIFICATION_OUT_OF_DATA |
Benachrichtigung, wenn Nutzern die Daten ausgehen |
NOTIFICATION_PLAN_ACTIVATION |
Benachrichtigung, dass der gekaufte Tarif eines Nutzers jetzt aktiv ist |
NOTIFICATION_PAY_AS_YOU_GO |
Eine Benachrichtigung, die den Nutzer darüber informiert, dass er für Daten im Pay-as-you-go-Modus bezahlt. |
NOTIFICATION_ACCOUNT_TOP_UP |
Eine Benachrichtigung, die den Nutzer darüber informiert, dass er sein Kontoguthaben aufgeladen hat. |
NOTIFICATION_DATA_EXPIRED |
Eine Benachrichtigung, die den Nutzer darüber informiert, dass sein Datentarif abgelaufen ist. |
PlanInfoPerClient
Informationen zum Datentarif, die für einen bestimmten Google-Client relevant sind.
JSON-Darstellung | |
---|---|
{ "youtube": { object ( |
Felder | |
---|---|
youtube |
Informationen zu YouTube-Tarifen. |
androidSystemInfo |
Planen von Informationen, die für das Android-System relevant sind. |
YouTube
Informationen zum Datentarif, die für YouTube relevant sind.
JSON-Darstellung | |
---|---|
{
"rateLimitedStreaming": {
object ( |
Felder | |
---|---|
rateLimitedStreaming |
Die Funktion „YouTube Plan Aware Streaming“ (PAS) begrenzt die Bitrate des bereitgestellten Videos. |
RateLimitedStreaming
Informationen zum Datentarif, damit YouTube die Nutzerfreundlichkeit beim Streaming mit Geschwindigkeitsbegrenzung verbessern kann.
JSON-Darstellung | |
---|---|
{ "maxMediaRateKbps": integer } |
Felder | |
---|---|
maxMediaRateKbps |
Die für diesen Nutzer unterstützte YouTube-Bitrate in kBit/s (Tausende von Bits pro Sekunde). |
AndroidSystemInfo
Informationen zum Datentarif, die für das gesamte Android-System relevant sind.
JSON-Darstellung | |
---|---|
{
"cellularInfo": [
{
object ( |
Felder | |
---|---|
cellularInfo[] |
Mobilfunkinformationen nach Verbindungstyp Es gibt beispielsweise eine cellularInfo-Nachricht für jeden Verbindungstyp wie 4G, 5G usw. |
CellularInfo
Informationen zu einer Mobilfunkverbindung, die der Tarif dem Nutzer bietet.
JSON-Darstellung | |
---|---|
{ "connectionType": enum ( |
Felder | |
---|---|
connectionType |
Die Art der Verbindung, die der Mobilfunkanbieter dem Nutzer zur Verfügung stellt. |
meteredness |
Der Abrechnungsstatus des Nutzerabos. |
ConnectionType
Verbindungstyp: 2G, 3G, 4G
Enums | |
---|---|
CONNECTION_TYPE_UNSPECIFIED |
Nicht angegeben |
CONNECTION_2_G |
2G. |
CONNECTION_3_G |
3G. |
CONNECTION_4_G |
4G |
CONNECTION_5_G |
5G |
CONNECTION_ALL |
Alle Arten von Musik. |
Zählerüberwachung
Art des Abos, das der Nutzer hat
Enums | |
---|---|
METEREDNESS_UNSPECIFIED |
GTAF kennt den Abrechnungsstatus des Nutzerabos nicht. |
METEREDNESS_UNMETERED |
Der Nutzer hat einen Tarif mit unbegrenztem Datenvolumen. |
METEREDNESS_METERED |
Der Nutzer hat ein Abo mit nutzungsabhängiger Abrechnung. |
CpidState
Ein Enum für den Mobilfunkanbieter, um den CPID-Status darzustellen.
Enums | |
---|---|
CPID_STATE_UNSPECIFIED |
Der Status der CPID ist nicht angegeben. Dies wird so behandelt, als wäre die CPID gültig. |
CPID_INVALIDATED |
Die CPID wird ungültig und der Client sollte eine neue CPID vom CPID-Endpunkt abrufen. |
Methoden |
|
---|---|
|
Ermöglicht einem Mobilfunkanbieter (identifiziert durch seine eindeutige ASN), einen neuen PlanStatus-Eintrag für einen Nutzer hinzuzufügen, der von einem bestimmten Client verwendet werden soll. |