REST Resource: monetization.subscriptions

资源：订阅

应用的单个订阅。

JSON 表示法 
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  }
}
字段
packageName

string

不可变。父级应用的软件包名称。
productId

string

不可变。商品的唯一商品 ID。在父级应用中是唯一的。商品 ID 必须由小写字母 (a-z)、数字 (0-9)、下划线 (_) 和句点 (.) 组成。必须以小写字母或数字开头，长度介于 1 到 40 个字符之间（含 1 到 40 个字符）。
basePlans[]

object (BasePlan)

此订阅的一组基础方案。表示没有其他优惠时订阅的价格和时长。
listings[]

object (SubscriptionListing)

必需。此订阅的本地化商品详情列表。必须包含至少一个父级应用默认语言的条目。
archived
(deprecated)

boolean

仅供输出。已弃用：不支持订阅归档。
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

关于税费和法规遵从的详细信息。

BasePlan

一项订阅的一个基础方案。

JSON 表示法 
{
  "basePlanId": string,
  "state": enum (State),
  "regionalConfigs": [
    {
      object (RegionalBasePlanConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsBasePlanConfig)
  },

  // Union field base_plan_type can be only one of the following:
  "autoRenewingBasePlanType": {
    object (AutoRenewingBasePlanType)
  },
  "prepaidBasePlanType": {
    object (PrepaidBasePlanType)
  }
  // End of list of possible types for union field base_plan_type.
}
字段
basePlanId

string

必需。不可变。此基础方案的唯一标识符。在订阅中必须是唯一的，并且符合 RFC-1034。也就是说，此 ID 只能包含小写字母 (a-z)、数字 (0-9) 和连字符 (-)，并且不能超过 63 个字符。
state

enum (State)

仅供输出。基础方案的状态，即是否处于有效状态。您可以启用或停用草稿和未启用的基础方案。您可以停用有效的基础方案。您可以取消无效的基础方案。您无法通过更新资源来更改此字段。请改用专用端点。
regionalConfigs[]

object (RegionalBasePlanConfig)

此基础方案在特定国家/地区的相关信息。
offerTags[]

object (OfferTag)

包含为此基础方案指定并通过结算库返回给应用的自定义标签（最多 20 个）的列表。此基础方案的订阅优惠也将在结算库中收到这些优惠标签。
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Play 未来可能会发布的所有新地区的价格信息。如果省略 BasePlan，Play 未来可能会推出任何新地区时，均不会自动提供该 BasePlan。
联合字段 base_plan_type。此基础方案的类型。必须且只能设置一个。base_plan_type 只能是下列其中一项：
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

设置基础方案定期自动续订的时间。
prepaidBasePlanType

object (PrepaidBasePlanType)

当基础方案在结算周期结束时不自动续订时进行设置。

状态

基础方案的当前状态。

枚举
STATE_UNSPECIFIED 未指定状态。
DRAFT 该基础方案目前处于草稿状态，尚未启用。此时可以安全地将其删除。
ACTIVE 该基础方案已生效，可供新订阅者使用。
INACTIVE 该基础方案无效，仅供现有订阅者使用。

AutoRenewingBasePlanType

表示在订阅期结束时自动续订的基础方案。

JSON 表示法 
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}
字段
billingPeriodDuration

string

必需。订阅期限，采用 ISO 8601 格式指定。如需查看可接受的结算周期列表，请参阅帮助中心。
gracePeriodDuration

string

订阅的宽限期，采用 ISO 8601 格式指定。可接受的值包括 P0D（零天）、P3D（3 天）、P7D（7 天）、P14D（14 天）和 P30D（30 天）。如果未指定，将根据重复周期持续时间使用默认值。
accountHoldDuration

string

可选。订阅的帐号保留期，采用 ISO 8601 格式指定。可接受的值必须介于 DAYS 之间，范围为 P0D（零天）到 P30D（30 天）。如果未指定，默认值为 P30D（30 天）。
resubscribeState

enum (ResubscribeState)

用户是否应能够在 Google Play 途径中重新订阅此基础方案。如果未指定，则默认为 RESUBSCRIBE_STATE_ACTIVE。
prorationMode

enum (SubscriptionProrationMode)

基础方案的按比例计费模式决定了当用户从其他基础方案切换到此方案时会发生什么情况。如果未指定，则默认为 CHARGE_ON_NEXT_BILLING_DATE。
legacyCompatible

boolean

续订基础方案是否向后兼容。

向后兼容的基础方案由 Google Play 结算库已弃用的 querySkuDetailsAsync() 方法返回。

对于给定的订阅，只能将一项续订基础方案标记为与旧版兼容。
legacyCompatibleSubscriptionOfferId

string

与旧版兼容的订阅优惠 ID。

向后兼容的订阅优惠由 Google Play 结算库已弃用的 querySkuDetailsAsync() 方法返回。

对于给定的续订基础方案，只能将一项订阅优惠标记为与旧版兼容。

如果没有与旧版兼容的订阅优惠，请将此字段设为空字符串。

ResubscribeState

基础方案的重新订阅状态。

枚举
RESUBSCRIBE_STATE_UNSPECIFIED 未指定状态。
RESUBSCRIBE_STATE_ACTIVE 重新订阅功能已启用。
RESUBSCRIBE_STATE_INACTIVE 重新订阅功能已停用。

SubscriptionProrationMode

用于续订基础方案的按比例计费模式。

枚举
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED 未指定模式。
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE 当前结算周期结束时，用户需要支付新基础方案的费用。
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY 系统会立即向用户全额收取新基础方案的费用。客户现有订阅的任何剩余期限都将用于延长新结算方案的期限。

PrepaidBasePlanType

表示基础方案结束时不会在基础方案结束时自动续订，并且必须由用户手动续订。

JSON 表示法 
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
字段
billingPeriodDuration

string

必需。订阅期限，采用 ISO 8601 格式指定。如需查看可接受的结算周期列表，请参阅帮助中心。
timeExtension

enum (TimeExtension)

用户是否应能够在 Google Play 途径中延长此预付费基础方案的期限。如果未指定，则默认为 TIME_EXTENSION_ACTIVE。

TimeExtension

基础方案延期。

枚举
TIME_EXTENSION_UNSPECIFIED 未指定状态。
TIME_EXTENSION_ACTIVE 时间扩展已启用。用户可以为其预付费方案充值或延长订阅期。
TIME_EXTENSION_INACTIVE 延时未启用。用户无法为其预付费方案充值或延长其期限。

RegionalBasePlanConfig

针对特定地区的基础方案的配置。

JSON 表示法 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}
字段
regionCode

string

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

boolean

新订阅者是否可使用指定地区的基础方案。如果此值设置为 false，现有订阅者将不会取消订阅。如果未指定，则默认为 false。
price

object (Money)

指定地区的基础方案价格。如果基础方案面向新订阅者提供，则必须设置此字段。必须采用与指定区域相关联的货币进行设置。

OtherRegionsBasePlanConfig

可能会发布 Play 的新地区的价格信息。

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

object (Money)

必需。在可能发布 Play 的任何新国家/地区使用的价格（美元）。
eurPrice

object (Money)

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

boolean

在可能发布 Play 的任何新地区，基础方案是否面向新订阅者提供。如果未指定，则默认为 false。

SubscriptionListing

订阅的使用方可见的元数据。

JSON 表示法 
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
字段
languageCode

string

必需。此商家信息的语言（由 BCP-47 定义），例如“en-US”。
title

string

必需。此订阅的标题（采用此商品详情的语言）。纯文本。
benefits[]

string

在 Play 商店等平台上以及恢复流程中向用户显示的福利列表，均采用此商品详情的语言显示。纯文本。最多包含 4 项福利的有序列表。
description

string

此订阅的说明（采用此商品详情的语言）。长度上限 - 80 个字符。纯文本。

方法

archive
(deprecated)

 已弃用：不支持订阅归档。

batchGet

 读取一个或多个订阅。

batchUpdate

 更新一批订阅。

create

 创建新订阅。

delete

 删除订阅。

get

 读取单个订阅。

list

 列出给定应用下的所有订阅。

patch

 更新现有订阅。