- 资源:SubscriptionPurchaseV2
- SubscriptionState
- PauseStateContext
- CanceledStateContext
- UserInitiatedCancellation
- CancelSurveyResult
- CancelSurveyReason
- SystemInitiatedCancellation
- DeveloperInitiatedCancellation
- 替换取消
- TestPurchase
- AcknowledgementState
- ExternalAccountIdentifiers
- SubscribeWithGoogleInfo
- SubscriptionPurchase 订单项
- AutoRenewingPlan
- SubscriptionItemPriceChangeDetails
- PriceChangeMode
- PriceChangeState
- PrepaidPlan
- 优惠详细信息
- DeferredItemReplace
- 方法
资源:SubscriptionPurchaseV2
指示用户订阅购买的状态。
JSON 表示法 |
---|
{ "kind": string, "regionCode": string, "lineItems": [ { object ( |
字段 | |
---|---|
kind |
此种类表示 androidpublisher 服务中的 SubscriptionPurchaseV2 对象。 |
regionCode |
授予订阅时用户的 ISO 3166-1 alpha-2 账单邮寄地址所在国家/地区代码。 |
lineItems[] |
订阅购买交易的商品级信息。同一笔购买交易中的商品应全部使用 AutoRenewingPlan 或全部使用 PrepaidPlan。 |
startTime |
订阅授予时间。不为待处理的订阅设置(订阅已创建,但在注册期间正在等待付款)。 时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,分辨率为纳秒,最多包含九个小数位。示例: |
subscriptionState |
订阅的当前状态。 |
latestOrderId |
与订阅的购买相关联的最新订单的订单 ID。对于自动续订型订阅,此字段是注册订单的订单 ID(如果尚未续订),或上一个周期性订单 ID(成功、待处理或遭拒订单)。对于预付费订阅,这是与查询的购买令牌相关联的订单 ID。 |
linkedPurchaseToken |
旧订阅的购买令牌(如果此订阅属于以下任一服务):* 重新注册已取消但未失效的订阅 * 从以前的订阅升级/降级。* 从预付费订阅转换为自动续订型订阅。* 从自动续订型订阅转换为预付费订阅。* 为预付费订阅充值。 |
pausedStateContext |
关于已暂停订阅的其他背景信息。仅当订阅当前具有 subscriptionState SUBSCRIPTION_STATE_PAUSED 时,此字段才会显示。 |
canceledStateContext |
有关已取消订阅的其他背景信息。仅当订阅当前具有 subscriptionState SUBSCRIPTION_STATE_CANCELED 时,此字段才会显示。 |
testPurchase |
仅当此订阅购买交易为测试购买时,此字段才会显示。 |
acknowledgementState |
订阅的确认状态。 |
externalAccountIdentifiers |
第三方服务中的用户帐号标识符。 |
subscribeWithGoogleInfo |
与通过“通过 Google 订阅”进行的购买交易相关联的用户个人资料。 |
SubscriptionState
订阅可能所处的状态,例如是有效还是已取消。订阅购买交易中的项目可以是所有自动续订型方案,也可以是预付费方案。
枚举 | |
---|---|
SUBSCRIPTION_STATE_UNSPECIFIED |
未指定的订阅状态。 |
SUBSCRIPTION_STATE_PENDING |
订阅已创建,但在注册期间正在等待付款。在此状态下,所有商品都在等待付款。 |
SUBSCRIPTION_STATE_ACTIVE |
订阅有效。- (1) 如果订阅是自动续订型方案,至少有一项是 autoRenewEnabled 且未过期。- (2) 如果订阅是预付费方案,则至少有一件商品未过期。 |
SUBSCRIPTION_STATE_PAUSED |
订阅已暂停。只有当订阅为自动续订型方案时,此状态才可用。在此状态下,所有项都处于暂停状态。 |
SUBSCRIPTION_STATE_IN_GRACE_PERIOD |
订阅处于宽限期。只有当订阅为自动续订型方案时,此状态才可用。在此状态下,所有项目都处于宽限期。 |
SUBSCRIPTION_STATE_ON_HOLD |
订阅处于暂停状态(已暂停)。只有当订阅为自动续订型方案时,此状态才可用。在此状态下,所有项目均处于暂停状态。 |
SUBSCRIPTION_STATE_CANCELED |
订阅已取消,但尚未到期。只有当订阅为自动续订型方案时,此状态才可用。所有项的 autoRenewEnabled 均设置为 false。 |
SUBSCRIPTION_STATE_EXPIRED |
订阅已过期。所有项的 expiryTime 都在过去。 |
已暂停状态上下文
特定于处于暂停状态的订阅的信息。
JSON 表示法 |
---|
{ "autoResumeTime": string } |
字段 | |
---|---|
autoResumeTime |
订阅自动恢复的时间。 时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,分辨率为纳秒,最多包含九个小数位。示例: |
CanceledStateContext 状态
特定于处于已取消状态的订阅的信息。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 cancellation_reason 。订阅被取消的原因。cancellation_reason 只能是下列其中一项: |
|
userInitiatedCancellation |
用户已取消订阅。 |
systemInitiatedCancellation |
系统因结算问题等原因而取消了订阅。 |
developerInitiatedCancellation |
开发者已取消订阅。 |
replacementCancellation |
订阅已替换为新的订阅。 |
UserInitiated 取消
特定于用户发起的取消的信息。
JSON 表示法 |
---|
{
"cancelSurveyResult": {
object ( |
字段 | |
---|---|
cancelSurveyResult |
用户在完成订阅取消流程(取消原因调查问卷)时提供的信息。 |
cancelTime |
用户取消订阅的时间。在此之后,用户或许仍可使用相应订阅内容。使用 lineItems.expiry_time 确定用户是否仍有权访问。 时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,分辨率为纳秒,最多包含九个小数位。示例: |
取消问卷调查结果
用户取消订阅时取消订阅调查问卷的结果。
JSON 表示法 |
---|
{
"reason": enum ( |
字段 | |
---|---|
reason |
用户在取消订阅调查问卷中选择的原因。 |
reasonUserInput |
仅针对 CANCEL_SURVEY_REASON_OTHERS 进行设置。此为用户对调查问卷的自由格式回复。 |
取消问卷调查原因
用户在取消订阅调查问卷中选择的原因。
枚举 | |
---|---|
CANCEL_SURVEY_REASON_UNSPECIFIED |
未指定调查问卷取消原因。 |
CANCEL_SURVEY_REASON_NOT_ENOUGH_USAGE |
订阅的使用量不足。 |
CANCEL_SURVEY_REASON_TECHNICAL_ISSUES |
使用应用时出现的技术问题。 |
CANCEL_SURVEY_REASON_COST_RELATED |
费用相关问题。 |
CANCEL_SURVEY_REASON_FOUND_BETTER_APP |
用户找到了更好的应用。 |
CANCEL_SURVEY_REASON_OTHERS |
其他原因。 |
SystemInitiated 取消
此类型没有任何字段。
特定于 Google 系统发起的取消的信息。
DeveloperInitiatedCancellation
此类型没有任何字段。
特定于开发者发起的取消的信息。
替换取消
此类型没有任何字段。
针对因订阅替换导致的取消操作提供的信息。
测试购买
此类型没有任何字段。
此订阅购买交易是否为测试购买。
确认状态
订阅可能的确认状态。
枚举 | |
---|---|
ACKNOWLEDGEMENT_STATE_UNSPECIFIED |
未指定的确认状态。 |
ACKNOWLEDGEMENT_STATE_PENDING |
订阅尚未得到确认。 |
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED |
确认订阅。 |
外部帐号标识符
第三方服务中的用户帐号标识符。
JSON 表示法 |
---|
{ "externalAccountId": string, "obfuscatedExternalAccountId": string, "obfuscatedExternalProfileId": string } |
字段 | |
---|---|
externalAccountId |
第三方服务中的用户帐号标识符。仅当帐号关联是在订阅购买流程中发生的时,此字段才会显示。 |
obfuscatedExternalAccountId |
此 ID 的混淆版本,与您应用中的用户帐号唯一关联。此 ID 针对以下购买交易显示:* 如果帐号关联是在订阅购买流程中发生的。* 是在购买时使用 https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid 指定的。 |
obfuscatedExternalProfileId |
与应用中的用户个人资料唯一关联的 ID 的混淆版本。仅当您购买商品时使用 https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid 指定时,此字段才会显示。 |
SubscribeWithGoogleInfo
与通过“通过 Google 订阅”进行的购买交易相关的信息。
JSON 表示法 |
---|
{ "profileId": string, "profileName": string, "emailAddress": string, "givenName": string, "familyName": string } |
字段 | |
---|---|
profileId |
购买订阅的用户的 Google 个人资料 ID。 |
profileName |
购买订阅时用户的个人资料名称。 |
emailAddress |
购买订阅的用户的电子邮件地址。 |
givenName |
购买订阅时用户的特定名称。 |
familyName |
购买订阅的用户的系列名称。 |
SubscriptionPurchase 订单项
订阅购买交易的商品级信息。
JSON 表示法 |
---|
{ "productId": string, "expiryTime": string, // Union field |
字段 | |
---|---|
productId |
所购买产品的 ID(例如“monthly001”)。 |
expiryTime |
订阅到期或到期日期(除非访问权限延长(例如续订)。 时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,分辨率为纳秒,最多包含九个小数位。示例: |
联合字段 plan_type 。订阅方案类型。plan_type 只能是下列其中一项: |
|
autoRenewingPlan |
产品正在自动续订。 |
prepaidPlan |
此商品是预付款的。 |
offerDetails |
此商品的优惠详情。 |
联合字段 deferred_item_change 。如果某项内容被延迟更改,系统会显示该字段。可以将其移除或替换。deferred_item_change 只能是下列其中一项: |
|
deferredItemReplacement |
关于延迟商品换货的信息。 |
自动续订方案
与自动续订型方案相关的信息。
JSON 表示法 |
---|
{
"autoRenewEnabled": boolean,
"priceChangeDetails": {
object ( |
字段 | |
---|---|
autoRenewEnabled |
如果订阅当前设置为自动续订,例如用户未取消订阅 |
priceChangeDetails |
自订阅注册以来商品最后一次价格变动的信息。 |
SubscriptionItemPriceChangeDetails
订阅商品的价格变动相关信息。
JSON 表示法 |
---|
{ "newPrice": { object ( |
字段 | |
---|---|
newPrice |
订阅项的新周期性价格。 |
priceChangeMode |
价格变动模式用于指定订阅商品价格的变化方式。 |
priceChangeState |
说明当前的价格变动状态。 |
expectedNewPriceChargeTime |
价格变动对用户生效的续订时间。因续订时间调整(如暂停)等情况,此期限可能会发生变化(到未来的时间)。只有在价格变动未生效时,系统才会填充此字段。 时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,分辨率为纳秒,最多包含九个小数位。示例: |
价格更改模式
价格变动的模式。
枚举 | |
---|---|
PRICE_CHANGE_MODE_UNSPECIFIED |
未指定价格变动模式。绝不应设置此值。 |
PRICE_DECREASE |
订阅价格下调时。 |
PRICE_INCREASE |
订阅价格上调且需要用户接受时。 |
OPT_OUT_PRICE_INCREASE |
订阅价格在停用模式下上调时是否上涨。 |
PriceChangeState
价格变动的状态。
枚举 | |
---|---|
PRICE_CHANGE_STATE_UNSPECIFIED |
未指定价格变动状态。不应使用此值。 |
OUTSTANDING |
等待用户同意价格变动。 |
CONFIRMED |
确认价格变动对用户生效。 |
APPLIED |
应用价格变动,也就是说,系统已开始按新价格向用户收费。 |
预付费方案
与预付费方案相关的信息。
JSON 表示法 |
---|
{ "allowExtendAfterTime": string } |
字段 | |
---|---|
allowExtendAfterTime |
如果存在,则为预付费方案提供充值服务的时间。对于已过期的预付费方案,此字段不会显示。 时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,分辨率为纳秒,最多包含九个小数位。示例: |
优惠详情
与购买订单项相关的优惠详情。
JSON 表示法 |
---|
{ "offerTags": [ string ], "basePlanId": string, "offerId": string } |
字段 | |
---|---|
offerTags[] |
与优惠相关联的最新优惠标签。其中包含继承自基础方案的代码。 |
basePlanId |
基础方案 ID。适用于所有基础方案和优惠。 |
offerId |
优惠 ID。仅适用于折扣优惠。 |
DeferredItemReplace 替换
与延迟商品换货相关的信息。
JSON 表示法 |
---|
{ "productId": string } |
字段 | |
---|---|
productId |
用于替换现有 productId 的 productId。 |
方法 |
|
---|---|
|
获取有关订阅的元数据 |