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。产品 ID 只能包含小写字母 (a-z)、数字 (0-9)、下划线 (_) 和句点 (.)，并且必须以小写字母或数字开头，并且长度必须介于 1 到 40（含 10-40）个字符之间。
basePlans[]

object (BasePlan)

此订阅项目的一组基础方案。表示在没有其他优惠适用的情况下订阅项目的价格和时长。
listings[]

object (SubscriptionListing)

此订阅的本地化商品详情的 apks.list。必须至少包含父应用默认语言的条目。
archived

boolean

仅供输出。此订阅是否已归档。已归档的订阅不再可供任何订阅者使用，也无法更新，并且除非传入节目归档标志，否则在列表请求中不会返回这些订阅。
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

详细了解税费和法规遵从。

基础方案

订阅的单个基础方案。

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 个自定义标记的 apks.list，并通过结算库返回到应用。此基础方案的订阅优惠也会在结算库中收到这些优惠标签。
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Google Play 日后可能会发布的任何新国家/地区的定价信息。如果省略此参数，则 BasePlay 不会自动提供 Play 日后可能发布的任何新位置。
联合字段 base_plan_type。此基础方案的类型。只能设置其中一个。base_plan_type 只能是下列其中一项：
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

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

object (PrepaidBasePlanType)

在结算周期结束时，自动续订基础方案。

状态

基础方案的当前状态。

枚举
STATE_UNSPECIFIED 未指定状态。
DRAFT 基础方案目前处于草稿状态，尚未激活。此时，您可以放心地将其删除。
ACTIVE 基础方案处于有效状态，适用于新订阅者。
INACTIVE 基础方案无效，仅限现有订阅者使用。

自动续订型基础方案类型

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

JSON 表示法 
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": 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 天）。如果未指定，系统会根据周期性周期时长使用默认值。
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() 方法会返回向后兼容的订阅优惠。

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

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

重新订阅状态

基础方案重新订阅状态。

枚举
RESUBSCRIBE_STATE_UNSPECIFIED 未指定状态。
RESUBSCRIBE_STATE_ACTIVE 已启用重新订阅功能。
RESUBSCRIBE_STATE_INACTIVE 重新订阅处于非活动状态。

订阅协议模式

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

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

预付费基础方案类型

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

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

string

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

enum (TimeExtension)

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

延时

基础方案的时间延伸。

枚举
TIME_EXTENSION_UNSPECIFIED 未指定状态。
TIME_EXTENSION_ACTIVE 启用了附加信息。用户可以充值或延长其预付费方案。
TIME_EXTENSION_INACTIVE 附加信息无效。用户无法充值或延长预付费方案。

区域级 BasePlanConfig

特定于区域的基础方案的配置。

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

string

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

boolean

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

object (Money)

指定地区的基础方案价格。如果基础方案可供新订阅者使用，则必须设置。必须设置与指定区域相关联的币种。

其他区域基本计划配置

Play 可能会在其中发布的所有新国家/地区的定价信息。

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

object (Money)

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

object (Money)

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

boolean

Play 可能会在哪些新国家/地区面向新订阅者推出基础方案。如果未指定，则默认为 false。

订阅列表

订阅的消费者可见元数据。

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

string

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

string

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

string

在 Play 商店等平台上向用户显示的福利列表，以及在恢复流程中向用户显示的商家信息列表。纯文本。最多列出四项优势的有序列表。
description

string

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

方法

archive

 归档订阅。

create

 创建新订阅。

delete

 删除订阅。

get

 读取单个订阅。

list

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

patch

 更新现有订阅。