- 资源:SubscriptionPurchaseV2
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- SubscriptionState
- PausedStateContext
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- CanceledStateContext
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- UserInitiatedCancellation
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- CancelSurveyResult
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- CancelSurveyReason
- SystemInitiatedCancellation
- DeveloperInitiatedCancellation
- ReplacementCancellation
- TestPurchase
- AcknowledgementState
- ExternalAccountIdentifiers
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- SubscribeWithGoogleInfo
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- SubscriptionPurchaseLineItem
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- AutoRenewingPlan
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- SubscriptionItemPriceChangeDetails
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- PriceChangeMode
- PriceChangeState
- InstallmentPlan
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- PendingCancellation
- PrepaidPlan
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- OfferDetails
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- DeferredItemReplacement
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 方法
资源:SubscriptionPurchaseV2
表示用户订阅购买交易的状态。
JSON 表示法 |
---|
{ "kind": string, "regionCode": string, "lineItems": [ { object ( |
字段 | |
---|---|
kind |
此种类表示 androidpublisher 服务中的 SubscriptionPurchaseV2 对象。 |
regionCode |
用户授予订阅时的 ISO 3166-1 alpha-2 账单邮寄地址所在国家/地区代码。 |
lineItems[] |
订阅购买交易的商品级信息。同一购买交易中的所有项目应全部使用 AutoRenewingPlan 或预付费方案。 |
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 的 productId。 |
方法 |
|
---|---|
|
获取订阅的相关元数据 |
|
撤消用户的订阅购买交易。 |