Offer

优惠中向用户提供的流量套餐的详细信息。

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

必需。BCP-47 语言代码,例如“en-US”或“sr-Latn”。如需了解详情,请参阅 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier

overusagePolicy

enum (OverUsagePolicy)

确定如果用户最终使用的数据量超出所提供的数据量,会发生什么情况。目前支持的选项包括:受限、被屏蔽和随用随付(可从用户帐号中扣除余额)。

maxRateKbps

string (int64 format)

套餐向用户提供的最大带宽。这些信息可在展示优惠信息时向用户显示。

cost

object (Money)

必需。此方案的费用。

duration

string (Duration format)

方案激活后,方案在多少秒内有效。

该持续时间以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

offerContext

string

优惠上下文,用于 TransactionRequest 消息。

trafficCategories[]

enum (PlanModuleTrafficCategory)

根据此计划模块付费的流量类别列表。

connectionType

enum (ConnectionType)

作为此优惠的一部分,扩展的连接类型。

refreshPeriod

enum (RefreshPeriod)

此套餐的刷新周期,如果方案未刷新其配额,则为 REFRESH_PERIOD_NONE。计划刷新配额会在每个刷新周期执行一次。

offerType

enum (OfferType)

确定优惠类型。客户可以根据优惠类型定制优惠购买交易的用户体验。

联合字段 quota。套餐配额信息应为以下任一值:quota_bytes、quota_minutes。quota 只能是下列其中一项:
quotaBytes

string (int64 format)

软件包配额(字节)。

quotaMinutes

number

软件包配额(分钟)。