REST Resource: operators.planStatuses

Ressource: PlanStatus

L'état du forfait contient des informations sur tous les forfaits 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 l'état du plan 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 du groupe du forfait partagé deviennent obsolètes. L'état "PlanStatus" ne sera plus transmis aux 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 nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Obligatoire. Heure à laquelle l'agent de forfait de données (DPA) a récupéré les informations concernant l'état du forfait à partir des systèmes backend. Permet de déterminer la date de l'état du plan. L'heure de mise à jour doit être antérieure à la date du jour, mais ne doit pas dater de plus de 30 jours.

Horodatage au format RFC3339 UTC "Zulu" avec une résolution de nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

title

string

Titre du contrat conclu entre l'utilisateur et l'opérateur. Cette information sera affichée dans l'en-tête de l'interface utilisateur.

subscriberId

string

Identifiant stable unique du 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'élément PlanStatus peut être affiché dans l'interface utilisateur. Lorsqu'elle est définie sur UI_INCOMPATIBLE, l'état du plan est utilisé pour envoyer des notifications à l'utilisateur, mais pas pour l'affichage des informations sur le forfait.

notifications[]

enum (NotificationType)

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

planInfoPerClient

object (PlanInfoPerClient)

Informations sur les forfaits de données pertinentes pour un client Google particulier.

cpidState

enum (CpidState)

État du CPID associé à cet état de plan.

Méthodes

create

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