REST Resource: purchases.subscriptionsv2

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

资源:SubscriptionPurchaseV2

表示用户的订阅购买的状态。

JSON 表示法
{
  "kind": string,
  "regionCode": string,
  "latestOrderId": string,
  "lineItems": [
    {
      object (SubscriptionPurchaseLineItem)
    }
  ],
  "startTime": string,
  "subscriptionState": enum (SubscriptionState),
  "linkedPurchaseToken": string,
  "pausedStateContext": {
    object (PausedStateContext)
  },
  "canceledStateContext": {
    object (CanceledStateContext)
  },
  "testPurchase": {
    object (TestPurchase)
  },
  "acknowledgementState": enum (AcknowledgementState),
  "externalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "subscribeWithGoogleInfo": {
    object (SubscribeWithGoogleInfo)
  }
}
字段
kind

string

此类型表示 androidpublisherservice 中的 SubscriptionPurchaseV2 对象。

regionCode

string

订阅获得批准的用户的 ISO 3166-1 alpha-2 帐单邮寄地址所在国家/地区代码。

latestOrderId

string

与购买订阅有关的最新订单的订单 ID。对于自动续订型订阅,这是注册订单的订单 ID(如果尚未续订),或最新的周期性订单 ID(成功、待处理或遭拒的订单)。对于预付费订阅,这是与所查询的购买令牌相关联的订单 ID。

lineItems[]

object (SubscriptionPurchaseLineItem)

订阅购买交易的商品级信息。同一笔购买交易中的所有商品都应全部使用 AutoRenewingPlan,或者全都使用 PrepaidPlan。

startTime

string (Timestamp format)

授予订阅的时间。没有为待处理的订阅设置订阅(订阅已创建,但在注册期间正在等待付款)。

时间戳采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,分辨率为纳秒级,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

subscriptionState

enum (SubscriptionState)

订阅的当前状态。

linkedPurchaseToken

string

如果旧订阅的购买令牌是以下任一项,则视为购买令牌:* 已取消但未过期的订阅重新注册 * 升级/降级之前的订阅。* 将预付费订阅转换为自动续订型订阅。* 将自动续订型订阅转换为预付费订阅。* 为预付费订阅充值。

pausedStateContext

object (PausedStateContext)

有关暂停的订阅的其他背景信息。仅当订阅当前具有 subscriptionState SUBSCRIPTION_STATE_PAUSED 时才存在。

canceledStateContext

object (CanceledStateContext)

有关取消订阅的其他背景信息。仅当订阅当前具有 subscriptionState SUBSCRIPTION_STATE_CANCELED 时才存在。

testPurchase

object (TestPurchase)

仅当此订阅购买交易是测试购买交易时,此字段才会显示。

acknowledgementState

enum (AcknowledgementState)

订阅的确认状态。

externalAccountIdentifiers

object (ExternalAccountIdentifiers)

第三方服务中的用户帐号标识符。

subscribeWithGoogleInfo

object (SubscribeWithGoogleInfo)

与通过“通过 Google 订阅”进行的购买交易相关联的用户个人资料。

订阅状态

订阅可能所处的状态,例如订阅是处于有效状态还是已取消。订阅购买的内容可以是所有自动续订型方案,也可以是预付费方案。

枚举
SUBSCRIPTION_STATE_UNSPECIFIED 未指定订阅状态。
SUBSCRIPTION_STATE_PENDING 订阅已创建,但在注册期间正在等待付款。在此状态下,所有商品都正在等待付款。
SUBSCRIPTION_STATE_ACTIVE 订阅处于有效状态。- (1) 如果订阅是自动续订方案,则至少有一个项目已自动续订且未过期。- (2) 如果订阅是预付费方案,至少有一项不会过期。
SUBSCRIPTION_STATE_PAUSED 订阅已暂停。仅当订阅是自动续订方案时,这个状态才可用。在此状态下,所有内容都会处于暂停状态。
SUBSCRIPTION_STATE_IN_GRACE_PERIOD 订阅处于宽限期。仅当订阅是自动续订方案时,这个状态才可用。在此状态下,所有内容都处于宽限期。
SUBSCRIPTION_STATE_ON_HOLD 订阅处于暂停状态(已暂停)。仅当订阅是自动续订方案时,这个状态才可用。在此状态下,所有内容都会处于保全状态。
SUBSCRIPTION_STATE_CANCELED 订阅已取消,但尚未到期。仅当订阅是自动续订方案时,这个状态才可用。所有内容的 autoRenewEnabled 都设为 false。
SUBSCRIPTION_STATE_EXPIRED 订阅已过期。所有项的过期时间均为过去时间。

暂停状态上下文

订阅处于暂停状态的信息。

JSON 表示法
{
  "autoResumeTime": string
}
字段
autoResumeTime

string (Timestamp format)

订阅自动恢复的时间。

时间戳采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,分辨率为纳秒级,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

取消状态上下文

处于已取消状态的订阅专用信息。

JSON 表示法
{

  // Union field cancellation_reason can be only one of the following:
  "userInitiatedCancellation": {
    object (UserInitiatedCancellation)
  },
  "systemInitiatedCancellation": {
    object (SystemInitiatedCancellation)
  },
  "developerInitiatedCancellation": {
    object (DeveloperInitiatedCancellation)
  },
  "replacementCancellation": {
    object (ReplacementCancellation)
  }
  // End of list of possible types for union field cancellation_reason.
}
字段
联合字段 cancellation_reason。订阅被取消的原因。cancellation_reason 只能是下列其中一项:
userInitiatedCancellation

object (UserInitiatedCancellation)

用户已取消订阅。

systemInitiatedCancellation

object (SystemInitiatedCancellation)

由于出现结算问题,系统取消了订阅。

developerInitiatedCancellation

object (DeveloperInitiatedCancellation)

开发者已取消订阅。

replacementCancellation

object (ReplacementCancellation)

订阅已被新订阅所取代。

用户发起的取消

与用户发起取消相关的信息。

JSON 表示法
{
  "cancelSurveyResult": {
    object (CancelSurveyResult)
  },
  "cancelTime": string
}
字段
cancelSurveyResult

object (CancelSurveyResult)

用户在完成取消订阅流程(取消订阅原因调查问卷)时提供的信息。

cancelTime

string (Timestamp format)

用户取消订阅的时间。在此之后,用户可能仍可访问订阅内容。使用 lineItems.expiry_time 来确定用户是否仍具有访问权限。

时间戳采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,分辨率为纳秒级,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

取消问卷调查结果

用户取消订阅后取消调查问卷的结果。

JSON 表示法
{
  "reason": enum (CancelSurveyReason),
  "reasonUserInput": string
}
字段
reason

enum (CancelSurveyReason)

用户在取消调查问卷中选择的原因。

reasonUserInput

string

仅针对 CANCEL_SURVEY_REASON_OTHERS 设置。这是用户在调查问卷中提供的自由格式回复。

取消问卷调查原因

用户在取消调查问卷中选择的原因。

枚举
CANCEL_SURVEY_REASON_UNSPECIFIED 未指定取消调查问卷的原因。
CANCEL_SURVEY_REASON_NOT_ENOUGH_USAGE 订阅的使用情况不足。
CANCEL_SURVEY_REASON_TECHNICAL_ISSUES 使用应用时的技术问题。
CANCEL_SURVEY_REASON_FOUND_BETTER_APP 用户找到更好的应用。
CANCEL_SURVEY_REASON_OTHERS 其他原因。

SystemInitiatedCancellation

与 Google 系统发起的订阅取消相关的信息。

开发者发起的取消

与开发者发起的取消活动相关的信息。

换货取消

与因订阅更换而产生的取消相关的信息。

TestPurchase

这项订阅购买交易是否为测试购买交易。

确认状态

订阅可能的确认状态。

枚举
ACKNOWLEDGEMENT_STATE_UNSPECIFIED 未指定的确认状态。
ACKNOWLEDGEMENT_STATE_PENDING 订阅尚未确认。
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED 订阅已确认。

外部帐号标识符

第三方服务中的用户帐号标识符。

JSON 表示法
{
  "externalAccountId": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
字段
externalAccountId

string

第三方服务中的用户帐号标识符。仅当帐号关联是在订阅购买流程中发生的。

obfuscatedExternalAccountId

string

与用户的用户帐号唯一关联的 ID 的混淆版本。如果存在以下购买交易,则存在该 ID:* 帐号关联是在订阅购买流程中发生的。* 是在购买交易时所用的 https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid 中指定的。

obfuscatedExternalProfileId

string

在应用中与用户个人资料唯一关联的 ID 的混淆版本。仅当进行购买时使用 https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid 指定时才提供此值。

通过 Google 订阅的信息

与通过“通过 Google 订阅”进行的购买交易相关的信息。

JSON 表示法
{
  "profileId": string,
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string
}
字段
profileId

string

购买订阅用户的 Google 个人资料 ID。

profileName

string

购买订阅的用户的个人资料名称。

emailAddress

string

购买订阅时用户的电子邮件地址。

givenName

string

购买订阅时用户的指定名称。

familyName

string

购买订阅用户的姓氏。

SubscriptionPurchaseLineItem

订阅购买交易的商品级信息。

JSON 表示法
{
  "productId": string,
  "expiryTime": string,

  // Union field plan_type can be only one of the following:
  "autoRenewingPlan": {
    object (AutoRenewingPlan)
  },
  "prepaidPlan": {
    object (PrepaidPlan)
  }
  // End of list of possible types for union field plan_type.
}
字段
productId

string

所购产品 ID(例如 'monthly001')。

expiryTime

string (Timestamp format)

订阅到期或到期的时间,除非延长访问权限(例如续订)。

时间戳采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,分辨率为纳秒级,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

联合字段 plan_type。订阅方案类型。plan_type 只能是下列其中一项:
autoRenewingPlan

object (AutoRenewingPlan)

相应内容会自动续订。

prepaidPlan

object (PrepaidPlan)

商品是预付费的。

自动续订方案

与自动续订方案相关的信息。

JSON 表示法
{
  "autoRenewEnabled": boolean
}
字段
autoRenewEnabled

boolean

如果订阅当前设为自动续订,例如用户尚未取消订阅

预付费方案

与预付费方案相关的信息。

JSON 表示法
{
  "allowExtendAfterTime": string
}
字段
allowExtendAfterTime

string (Timestamp format)

在此之后,订阅项目将允许进行新的充值购买交易。如果订阅已由充值交易延长,则不会显示。

时间戳采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,分辨率为纳秒级,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

方法

get

获取有关订阅的元数据