REST Resource: monetization.subscriptions.basePlans.offers

资源：SubscriptionOffer

单个临时优惠

JSON 表示法 
{
  "packageName": string,
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "state": enum (State),
  "phases": [
    {
      object (SubscriptionOfferPhase)
    }
  ],
  "targeting": {
    object (SubscriptionOfferTargeting)
  },
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferConfig)
  },
  "offerTags": [
    {
      object (OfferTag)
    }
  ]
}
字段
packageName

string

必需。不可变。父级订阅所属的应用的软件包名称。
productId

string

必需。不可变。此优惠所属的父级订阅的 ID。
basePlanId

string

必需。不可变。优惠作为基础方案的基础方案 ID。
offerId

string

必需。不可变。此订阅优惠的唯一 ID。在基础方案中必须是唯一的。
state

enum (State)

仅供输出。此优惠的当前状态。可通过启用和停用操作进行更改。注意：基础方案状态会取代此状态，因此如果基础方案处于无效状态，则可能没有可用的有效优惠。
phases[]

object (SubscriptionOfferPhase)

必需。此订阅优惠的各个阶段。必须包含至少一个条目，但最多可以包含五个条目。用户始终会收到指定顺序的所有阶段。初始创建后，不得添加、移除或重新排序阶段。
targeting

object (SubscriptionOfferTargeting)

用户需要满足的要求才有资格享受此优惠。表示 Google Play 为确定是否应返回优惠所需评估的要求。开发者可自行过滤这些商品。
regionalConfigs[]

object (RegionalSubscriptionOfferConfig)

必需。此优惠的地区特定配置。必须包含至少一个条目。
otherRegionsConfig

object (OtherRegionsSubscriptionOfferConfig)

Google Play 将来可能会发布的任何新营业地点的配置。
offerTags[]

object (OfferTag)

此列表最多列出 20 个自定义优惠，这些标记已通过结算库返回给应用。

状态

订阅优惠的当前状态。

枚举
STATE_UNSPECIFIED 默认值，切勿使用。
DRAFT 订阅优惠不是，从未向用户提供。
ACTIVE 订阅优惠可供新用户和现有用户使用。
INACTIVE 新用户无法享受订阅优惠。现有用户会保留访问权限。

订阅优惠阶段

订阅优惠的单个阶段。

JSON 表示法 
{
  "recurrenceCount": integer,
  "duration": string,
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferPhaseConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferPhaseConfig)
  }
}
字段
recurrenceCount

integer

必需。此阶段的重复次数。如果此优惠阶段不是免费的，则每次续订都会向用户收取此优惠阶段的费用。
duration

string

必需。此阶段的单次重复周期的时长。以 ISO 8601 格式指定。
regionalConfigs[]

object (RegionalSubscriptionOfferPhaseConfig)

必需。此优惠阶段特定于地区的配置。对于每个具有订阅配置的区域配置的区域，此列表都必须只包含一个条目。
otherRegionsConfig

object (OtherRegionsSubscriptionOfferPhaseConfig)

Play 可能会在其中发布的所有新营业地点的定价信息。

RegionalSubscriptionOfferPhaseConfig

单个区域中订阅优惠的配置阶段配置。

JSON 表示法 
{
  "regionCode": string,

  // Union field price_override can be only one of the following:
  "price": {
    object (Money)
  },
  "relativeDiscount": number,
  "absoluteDiscount": {
    object (Money)
  },
  "free": {
    object
  }
  // End of list of possible types for union field price_override.
}
字段
regionCode

string

必需。不可变。此配置适用的区域。
联合字段 price_override。此阶段的价格替换。必需。price_override 只能是下列其中一项：
price

object (Money)

用户为此优惠阶段支付的绝对价格。价格不得小于此地区所允许的最低价格。
relativeDiscount

number

用户为此优惠阶段支付的阶段时长按比例计算的基础方案价格所占的比例。例如，如果此地区的基础方案价格为 12 美元（为期 1 年），那么为期 3 个月的阶段享受 5 折优惠，相当于 1.50 美元。折扣的指定值必须严格为大于 0 且小于 1。生成的价格会四舍五入到最接近的结算单位（例如美元）。如果折扣价格最终低于此地区允许的最低价格，则视为相对折扣。
absoluteDiscount

object (Money)

用户为此优惠阶段支付的阶段时长内按比例基础方案价格减去的绝对金额。例如，如果此地区的基础方案价格在 1 年内为 12 美元，那么在 3 个月的阶段内 1 美元的绝对折扣将等于 2 美元。最终价格不得低于此地区所允许的最低价格。
free

object

设置为指定此优惠可免费获取。

OtherRegionSubscriptionOfferPhaseConfig

针对单一优惠阶段，Play 可能会在其中发布的所有新位置配置的配置。

JSON 表示法 
{

  // Union field price_override can be only one of the following:
  "otherRegionsPrices": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "relativeDiscount": number,
  "absoluteDiscounts": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "free": {
    object
  }
  // End of list of possible types for union field price_override.
}
字段
联合字段 price_override。此阶段的价格替换。必需。price_override 只能是下列其中一项：
otherRegionsPrices

object (OtherRegionsSubscriptionOfferPhasePrices)

用户为此优惠阶段支付的绝对价格。价格不得低于 Google Play 可能会在其中发布的任何新国家/地区允许的最低价格。
relativeDiscount

number

用户为此优惠阶段支付的阶段时长按比例计算的基础方案价格所占的比例。例如，如果此地区的基础方案价格为 12 美元（为期 1 年），那么为期 3 个月的阶段享受 5 折优惠，相当于 1.50 美元。折扣的指定值必须严格为大于 0 且小于 1。生成的价格会四舍五入到最接近的结算单位（例如美元）。如果折扣价格最终低于 Play 可能会在其中推出的任何新位置允许的最低价格，则视为相对折扣无效。
absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

用户为此优惠阶段支付的阶段时长内按比例基础方案价格减去的绝对金额。例如，如果此地区的基础方案价格在 1 年内为 12 美元，那么在 3 个月的阶段内 1 美元的绝对折扣将等于 2 美元。最终价格不得低于 Google Play 可能会发布的所有新国家/地区所允许的最低价格。
free

object

设置为指定此优惠可免费获取。

OtherRegionSubscriptionOffer 阶段价格

Play 可能会在其中发布的所有新营业地点的定价信息。

JSON 表示法 
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  }
}
字段
usdPrice

object (Money)

必需。Play 可能会在其中推出的任何新位置使用的价格（美元）。
eurPrice

object (Money)

必需。价格（欧元）适用于 Play 可能会在其中发布的任何新国家/地区。

订阅优惠定位

指定用户需要满足哪些规则才能收到此优惠。

JSON 表示法 
{

  // Union field rule can be only one of the following:
  "acquisitionRule": {
    object (AcquisitionTargetingRule)
  },
  "upgradeRule": {
    object (UpgradeTargetingRule)
  }
  // End of list of possible types for union field rule.
}
字段

联合字段 rule。

rule 只能是下列其中一项：
acquisitionRule

object (AcquisitionTargetingRule)

新用户获取优惠的定位规则。
upgradeRule

object (UpgradeTargetingRule)

用于升级用户现有方案的定位规则。

流量获取定位规则

表示以下形式的定位规则：用户以前从未有过 {scope}。

JSON 表示法 
{
  "scope": {
    object (TargetingRuleScope)
  }
}
字段
scope

object (TargetingRuleScope)

必需。此规则考虑的订阅范围。仅允许“此订阅”和“应用内的任何订阅”。

定位规则范围

指定定位范围，使其可以根据过去或当前权限将订阅匹配到用户的优惠范围。

JSON 表示法 
{

  // Union field scope can be only one of the following:
  "thisSubscription": {
    object
  },
  "anySubscriptionInApp": {
    object
  },
  "specificSubscriptionInApp": string
  // End of list of possible types for union field scope.
}
字段

联合字段 scope。

scope 只能是下列其中一项：
thisSubscription

object

当前定位规则的范围是定义此优惠的订阅。
anySubscriptionInApp

object

当前定位规则的范围是父级应用中的任何订阅。
specificSubscriptionInApp

string

当前定位规则的适用范围是具有指定订阅 ID 的订阅。必须是同一父级应用中的订阅。

升级规则

表示以下形式的定位规则：用户当前具有 {scope} [结算周期为 {billing_period}]。

JSON 表示法 
{
  "oncePerUser": boolean,
  "scope": {
    object (TargetingRuleScope)
  },
  "billingPeriodDuration": string
}
字段
oncePerUser

boolean

此优惠仅限每位用户使用一次。如果设置为 true，那么只要用户曾经订阅过此优惠，就永远无法再次享受此优惠。
scope

object (TargetingRuleScope)

必需。此规则考虑的订阅范围。仅允许“此订阅”和“应用内特定订阅”。
billingPeriodDuration

string

用户必须当前订阅的特定结算周期时长（采用 ISO 8601 格式），才符合该规则的条件。如果未指定，系统会匹配已订阅任何结算周期的用户。

RegionalSubscriptionOfferConfig

单个区域中的订阅优惠的配置。

JSON 表示法 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean
}
字段
regionCode

string

必需。不可变。此配置所适用的区域代码（根据 ISO 3166-2 的定义），例如“US”。
newSubscriberAvailability

boolean

指定地区的订阅优惠是否面向新订阅者提供。如果此值设为 false，现有订阅者的订阅将不会取消。如果未指定，则默认为 false。

OtherRegionSubscriptionOfferConfig

为 Play 可以在订阅优惠中指定的新发布地点配置配置。

JSON 表示法 
{
  "otherRegionsNewSubscriberAvailability": boolean
}
字段
otherRegionsNewSubscriberAvailability

boolean

Play 将来是否可能会在任何新位置提供订阅优惠。如果未指定，则默认为 false。

方法

activate

 激活订阅优惠。

create

 创建新的订阅优惠。

deactivate

 停用订阅优惠。

delete

 删除订阅优惠。

get

 读取单项优惠

list

 列出指定订阅下的所有优惠。

patch

 更新现有订阅优惠。