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 个自定义标记的 apks.list,并通过结算库返回到应用。

状态

订阅优惠的当前状态。

枚举
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

用户为优惠期支付的阶段期间按比例计算的基础方案价格所占的比例。例如,如果该区域的基础方案价格为 1 年 12 美元,那么 3 个月的阶段 5 折对应一个 1.50 美元的价格。折扣必须指定为大于 0 且小于 1 的分数。生成的价格会四舍五入为最接近的可结算单位(例如美元的美分)。如果折扣价格最终低于此地区允许的最低价格,则相对折扣会被视为无效。

absoluteDiscount

object (Money)

根据用户在优惠阶段支付的费用,从基础方案价格中减去的绝对金额。例如,如果该地区的基础方案价格为 12 美元,有效期为 1 年,那么 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

用户为优惠期支付的阶段期间按比例计算的基础方案价格所占的比例。例如,如果该区域的基础方案价格为 1 年 12 美元,那么 3 个月的阶段 5 折对应一个 1.50 美元的价格。折扣必须指定为大于 0 且小于 1 的分数。生成的价格会四舍五入为最接近的可结算单位(例如美元的美分)。如果折扣价格最终低于 Google Play 可能会发布的任何新国家/地区允许的最低价格,那么相关折扣会被视为无效。

absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

根据用户在优惠阶段支付的费用,从基础方案价格中减去的绝对金额。例如,如果该地区的基础方案价格为 12 美元,有效期为 1 年,那么 3 个月的阶段中绝对价格折扣为 1 美元,相当于 2 美元的价格。最终价格不得低于 Google Play 发布新价格时所允许的最低价格。

free

object

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

其他区域订阅方案价格

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 格式)。如果未指定,则匹配已订阅任何结算周期的用户。

区域订阅优惠配置

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

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

string

必需,不可变。此配置适用的地区代码,如 ISO 3166-2 定义,例如“US”。

newSubscriberAvailability

boolean

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

其他区域订阅优惠配置

针对订阅优惠中指定的新 Play 新发布地点配置的配置。

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

boolean

Play 将来可能会在任何新国家/地区推出订阅优惠。如果未指定,则默认为 false。

方法

activate

激活订阅优惠。

create

创建新的订阅优惠。

deactivate

停用订阅优惠。

delete

删除订阅优惠。

get

读取单项优惠

list

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

patch

更新现有订阅优惠。