Cette page a été traduite par l'API Cloud Translation.

Offer

Représentation JSON

Détails des forfaits de données de l'offre en cours d'extension pour l'utilisateur.

Représentation JSON

Représentation JSON
{ "planName": string, "planId": string, "planDescription": string, "promoMessage": string, "languageCode": string, "overusagePolicy": enum (`OverUsagePolicy`), "maxRateKbps": string, "cost": { object (`Money`) }, "duration": string, "offerContext": string, "trafficCategories": [ enum (`PlanModuleTrafficCategory`) ], "connectionType": enum (`ConnectionType`), "refreshPeriod": enum (`RefreshPeriod`), "offerType": enum (`OfferType`), // Union field `quota` can be only one of the following: "quotaBytes": string, "quotaMinutes": number // End of list of possible types for union field `quota`. }

{
  "planName": string,
  "planId": string,
  "planDescription": string,
  "promoMessage": string,
  "languageCode": string,
  "overusagePolicy": enum (OverUsagePolicy),
  "maxRateKbps": string,
  "cost": {
    object (Money)
  },
  "duration": string,
  "offerContext": string,
  "trafficCategories": [
    enum (PlanModuleTrafficCategory)
  ],
  "connectionType": enum (ConnectionType),
  "refreshPeriod": enum (RefreshPeriod),
  "offerType": enum (OfferType),

  // Union field quota can be only one of the following:
  "quotaBytes": string,
  "quotaMinutes": number
  // End of list of possible types for union field quota.
}

Champs
`planName`	`string` Obligatoire. Chaîne identifiant l'offre pour l'utilisateur.
`planId`	`string` Obligatoire. Chaîne unique permettant d'identifier l'offre de façon unique, puis d'acheter l'article si l'utilisateur le souhaite.
`planDescription`	`string` Obligatoire. Chaîne plus longue décrivant l'offre à l'utilisateur.
`promoMessage`	`string` Chaîne décrivant la promotion.
`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.
`overusagePolicy`	`enum (OverUsagePolicy)` Détermine ce qui se passe si l'utilisateur finit par utiliser plus de données que la quantité proposée. Les options actuellement disponibles sont "limitation", "blocage" et "paiement à l'usage", ce qui permet de déduire le solde du compte utilisateur.
`maxRateKbps`	`string (int64 format)` Bande passante maximale que le forfait propose à l'utilisateur. Les informations peuvent être présentées à l'utilisateur lorsque l'offre est présentée.
`cost`	`object (Money)` Obligatoire. Coût de ce forfait.
`duration`	`string (Duration format)` Nombre de secondes pendant lesquelles le forfait est valide une fois celui-ci activé. Durée en secondes avec neuf chiffres au maximum après la virgule. Se termine par "`s`". Example : `"3.5s"`.
`offerContext`	`string` Contexte de l'offre, utilisé dans le message TransactionRequest.
`trafficCategories[]`	`enum (PlanModuleTrafficCategory)` Liste des catégories de trafic qui seront facturées pour ce module de plan.
`connectionType`	`enum (ConnectionType)` Type de connexion étendu dans le cadre de cette offre.
`refreshPeriod`	`enum (RefreshPeriod)` Période d'actualisation de ce forfait, ou REFRESH_PERIOD_NONE si le forfait n'actualise pas son quota. Les plans qui actualisent les quotas le font une fois par période d'actualisation.
`offerType`	`enum (OfferType)` Identifiez le type d'offre. En fonction du type d'offre, l'expérience d'achat peut être personnalisée par le client.
Champ d'union `quota`. Les informations relatives au quota du plan doivent correspondre à l'un des éléments suivants: quota_bytes, quota_minutes. `quota` ne peut être qu'un des éléments suivants :
`quotaBytes`	`string (int64 format)` Quota de packages en octets.
`quotaMinutes`	`number` Quota de packages en quelques minutes.