- 资源:SubscriptionPurchaseV2
- SubscriptionState
- PausedStateContext
- CanceledStateContext
- UserInitiatedCancellation
- CancelSurveyResult
- CancelSurveyReason
- SystemInitiatedCancellation
- DeveloperInitiatedCancellation
- ReplacementCancellation
- TestPurchase
- AcknowledgementState
- ExternalAccountIdentifiers
- SubscribeWithGoogleInfo
- SubscriptionPurchaseLineItem
- AutoRenewingPlan
- SubscriptionItemPriceChangeDetails
- PriceChangeMode
- PriceChangeState
- InstallmentPlan(分期付款方案)
- PendingCancellation
- PrepaidPlan
- OfferDetails
- DeferredItemReplacement
- 方法
资源: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 或 SUBSCRIPTION_STATE_EXPIRED 时,此字段才会显示。 |
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 均为过去的时间。 |
SUBSCRIPTION_STATE_PENDING_PURCHASE_CANCELED |
针对订阅的待处理交易已取消。如果这笔待处理的购买交易是针对现有订阅的,请使用 linkedPurchaseToken 获取该订阅的当前状态。 |
PausedStateContext
特定于处于暂停状态的订阅的信息。
JSON 表示法 |
---|
{ "autoResumeTime": string } |
字段 | |
---|---|
autoResumeTime |
订阅自动恢复的时间。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
CanceledStateContext
特定于处于 SUBSCRIPTION_STATE_CANCELED 或 SUBSCRIPTION_STATE_EXPIRED 状态的订阅的信息。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 cancellation_reason 。取消订阅的原因。cancellation_reason 只能是下列其中一项: |
|
userInitiatedCancellation |
用户已取消订阅。 |
systemInitiatedCancellation |
系统因结算问题等原因取消了订阅。 |
developerInitiatedCancellation |
开发者已取消订阅。 |
replacementCancellation |
订阅已替换为新订阅。 |
UserInitiatedCancellation
特定于用户发起的取消的信息。
JSON 表示法 |
---|
{
"cancelSurveyResult": {
object ( |
字段 | |
---|---|
cancelSurveyResult |
用户在完成订阅取消流程时提供的信息(取消原因调查问卷)。 |
cancelTime |
用户取消订阅的时间。在此之后,用户或许仍可访问订阅。使用 lineItems.expiry_time 确定用户是否仍具有访问权限。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
CancelSurveyResult
用户取消订阅时取消订阅调查问卷的结果。
JSON 表示法 |
---|
{
"reason": enum ( |
字段 | |
---|---|
reason |
用户在取消订阅调查问卷中选择的原因。 |
reasonUserInput |
仅针对 CANCEL_SURVEY_REASON_OTHERS 设置。这是用户对调查问卷的自由格式回复。 |
CancelSurveyReason
用户在取消订阅调查问卷中选择的原因。
枚举 | |
---|---|
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 |
其他原因。 |
SystemInitiatedCancellation
此类型没有字段。
特定于 Google 系统发起的取消的信息。
DeveloperInitiatedCancellation
此类型没有字段。
特定于开发者发起的取消的信息。
ReplacementCancellation
此类型没有字段。
专门针对订阅替换导致的取消的信息。
TestPurchase
此类型没有字段。
此订阅购买交易是否为测试购买。
AcknowledgementState
订阅的可能确认状态。
枚举 | |
---|---|
ACKNOWLEDGEMENT_STATE_UNSPECIFIED |
未指定的确认状态。 |
ACKNOWLEDGEMENT_STATE_PENDING |
订阅尚未确认。 |
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED |
已确认订阅。 |
ExternalAccountIdentifiers
第三方服务中的用户账号标识符。
JSON 表示法 |
---|
{ "externalAccountId": string, "obfuscatedExternalAccountId": string, "obfuscatedExternalProfileId": string } |
字段 | |
---|---|
externalAccountId |
第三方服务中的用户账号标识符。仅当账号关联是在订阅购买流程中发生时,此字段才会显示。 |
obfuscatedExternalAccountId |
此 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 |
购买订阅时的用户系列名称。 |
SubscriptionPurchaseLineItem
订阅购买交易的商品级信息。
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 |
有关延迟商品更换的信息。 |
AutoRenewingPlan
与自动续订方案相关的信息。
JSON 表示法 |
---|
{ "autoRenewEnabled": boolean, "priceChangeDetails": { object ( |
字段 | |
---|---|
autoRenewEnabled |
如果订阅当前设置为自动续订,例如用户尚未取消订阅 |
priceChangeDetails |
自订阅注册后商品最后一次价格变动的信息。 |
installmentDetails |
自动续订方案的分期付款方案承诺和状态相关信息。 |
SubscriptionItemPriceChangeDetails
订阅项目的价格变动相关信息。
JSON 表示法 |
---|
{ "newPrice": { object ( |
字段 | |
---|---|
newPrice |
订阅项的新周期性价格。 |
priceChangeMode |
价格更改模式用于指定订阅商品价格的变化方式。 |
priceChangeState |
状态:价格变动当前处于哪个阶段。 |
expectedNewPriceChargeTime |
价格变动对用户生效的续订时间。但可能会因为续订时间发生变化(例如暂停)而发生变化(改为未来某个时间)。只有当价格变动未生效时,系统才会填充此字段。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
PriceChangeMode
价格变动的模式。
枚举 | |
---|---|
PRICE_CHANGE_MODE_UNSPECIFIED |
未指定价格变动模式。绝不应设置此值。 |
PRICE_DECREASE |
订阅价格是否下调。 |
PRICE_INCREASE |
如果订阅价格上涨,并且用户需要接受订阅价格, |
OPT_OUT_PRICE_INCREASE |
在停用模式下订阅价格上调时的情况。 |
PriceChangeState
价格变动的状态。
枚举 | |
---|---|
PRICE_CHANGE_STATE_UNSPECIFIED |
未指定价格变动状态。不应使用此值。 |
OUTSTANDING |
等待用户同意价格变动。 |
CONFIRMED |
价格变动已确认发生给用户。 |
APPLIED |
系统会应用价格变动,也就是说,系统已开始按新价格向用户收费。 |
InstallmentPlan
分期付款方案信息。
JSON 表示法 |
---|
{
"initialCommittedPaymentsCount": integer,
"subsequentCommittedPaymentsCount": integer,
"remainingCommittedPaymentsCount": integer,
"pendingCancellation": {
object ( |
字段 | |
---|---|
initialCommittedPaymentsCount |
用户最初承诺支付的总金额。 |
subsequentCommittedPaymentsCount |
每个承诺期过后用户需要支付的总金额。空表示分期付款方案将在初始合约结束后回退到正常的自动续订型订阅。 |
remainingCommittedPaymentsCount |
此续订周期内待支付的承诺付款总额。 |
pendingCancellation |
如果存在,则表示此分期付款方案正在等待取消。只有在用户完成所有承诺付款后,才会取消。 |
PendingCancellation
此类型没有字段。
用于指示虚拟分期付款方案是否有待处理的取消。只有在用户完成所有承诺付款后,才会取消。
PrepaidPlan
与预付费方案相关的信息。
JSON 表示法 |
---|
{ "allowExtendAfterTime": string } |
字段 | |
---|---|
allowExtendAfterTime |
如果存在,在此之后预付费方案可以充值购买。对于已过期的预付费方案,此字段将不会提供。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
OfferDetails
与购买订单项相关的优惠详情。
JSON 表示法 |
---|
{ "offerTags": [ string ], "basePlanId": string, "offerId": string } |
字段 | |
---|---|
offerTags[] |
与优惠相关联的最新优惠标签。其中包含从基础方案继承的代码。 |
basePlanId |
基础方案 ID。适用于所有基础方案和优惠。 |
offerId |
优惠 ID。仅适用于折扣优惠。 |
DeferredItemReplacement
与延迟商品更换相关的信息。
JSON 表示法 |
---|
{ "productId": string } |
字段 | |
---|---|
productId |
要替换现有 productId 的产品 ID。 |
方法 |
|
---|---|
|
获取有关订阅的元数据 |
|
撤消用户的订阅购买。 |