REST Resource: operators.planStatuses

Ressource : PlanStatus

PlanStatus contient des informations sur tous les forfaits de services mobiles de premier niveau qu'un utilisateur a achetés.

Représentation 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)
}
Champs
name

string

Nom de ressource de PlanStatus au format suivant : operators/{asn_id}/planStatuses/{userKey}. Le nom est ignoré lors de la création d'une entrée PlanStatus.

plans[]

object (Plan)

Liste des forfaits appartenant à cet utilisateur.

languageCode

string

Obligatoire. Le code de langue BCP-47, tel que "en-US" ou "sr-Latn". Pour en savoir plus, consultez la page http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

expireTime

string (Timestamp format)

Obligatoire. Heure à laquelle les informations sur le groupe du forfait partagé deviennent obsolètes. PlanStatus ne sera plus diffusé dans les applications après cette date. L'heure d'expiration doit être située dans le futur.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Obligatoire. Heure à laquelle l'agent du forfait de données a récupéré les informations sur l'état du forfait à partir des systèmes de backend. Peut être utilisé pour déterminer la date des informations sur l'état du forfait. L'heure de mise à jour doit être antérieure à la date actuelle, mais ne doit pas remonter à plus de 30 jours.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

title

string

Titre du contrat que l'utilisateur a conclu avec l'opérateur. Il s'affichera dans l'en-tête de l'UI.

subscriberId

string

Identifiant unique et stable dans le système de l'opérateur pour identifier l'utilisateur.

accountInfo

object (AccountInfo)

Obligatoire pour les utilisateurs prépayés. Informations sur le solde du compte utilisateur.

uiCompatibility

enum (UiCompatibility)

Détermine si l'état du forfait peut être affiché à l'utilisateur dans une interface utilisateur. Lorsque la valeur est définie sur UI_INCOMPATIBLE, PlanStatus peut être utilisé pour envoyer des notifications à l'utilisateur, mais pas pour lui afficher les informations sur l'abonnement.

notifications[]

enum (NotificationType)

Contient la liste des types de notifications envoyées à l'utilisateur par GTAF. GTAF ignore ce champ s'il est renseigné par l'appelant.

planInfoPerClient

object (PlanInfoPerClient)

Informations sur le forfait de données pertinentes pour un client Google spécifique.

cpidState

enum (CpidState)

État du CPID associé à cet état du forfait.

Méthodes

create

Permet à un opérateur mobile (identifié par son numéro de système autonome (ASN) unique) d'ajouter une entrée PlanStatus.