Esta página foi traduzida pela API Cloud Translation.

Offer

Representação JSON

Detalhes dos planos de dados na oferta que estão sendo estendidos ao usuário.

Representação JSON

Representação 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.
}

Campos
`planName`	`string` Obrigatório. Uma string que identifica a oferta para o usuário.
`planId`	`string` Obrigatório. Uma string exclusiva que pode ser usada para identificar a oferta e comprar posteriormente, se o usuário quiser.
`planDescription`	`string` Obrigatório. Uma string mais longa que descreve a oferta para o usuário.
`promoMessage`	`string` String que descreve a promoção.
`languageCode`	`string` Obrigatório. O código de idioma BCP-47, como "en-US" ou "sr-Latn". Para mais informações, consulte http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
`overusagePolicy`	`enum (OverUsagePolicy)` Determina o que acontece quando o usuário acaba usando mais do que a quantidade de dados oferecidos. Atualmente, as opções compatíveis são: limitada, bloqueada e pagamento por utilização, que deduz o saldo da conta de usuário.
`maxRateKbps`	`string (int64 format)` É a largura de banda máxima que o plano oferece ao usuário. As informações podem ser exibidas ao usuário quando a oferta é apresentada.
`cost`	`object (Money)` Obrigatório. Custo deste plano.
`duration`	`string (Duration format)` Quantidade de segundos em que o plano é válido depois da ativação. Uma duração em segundos com até nove dígitos fracionários, encerrada por "`s`". Exemplo: `"3.5s"`.
`offerContext`	`string` Contexto da oferta, usado na mensagem TransactionRequest.
`trafficCategories[]`	`enum (PlanModuleTrafficCategory)` Lista de categorias de tráfego que serão cobradas neste módulo do plano.
`connectionType`	`enum (ConnectionType)` Tipo de conexão estendida como parte desta oferta.
`refreshPeriod`	`enum (RefreshPeriod)` O período de atualização desta oferta do plano ou REFRESH_PERIOD_NONE se o plano não atualizar a cota. Os planos que atualizam a cota vão fazer isso a cada período de atualização.
`offerType`	`enum (OfferType)` Identifique o tipo da oferta. Dependendo do tipo da oferta, a experiência do usuário com a compra pode ser personalizada pelo cliente.
Campo de união `quota`. As informações de cota do plano devem ser uma das seguintes: cota_bytes, cota_minutes. `quota` pode ser apenas de um dos tipos a seguir:
`quotaBytes`	`string (int64 format)` Cota de pacotes em bytes.
`quotaMinutes`	`number` Cota de pacotes em minutos.