REST Resource: purchases.subscriptionsv2

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

string

この種類は、androidpublisher サービスの SubscriptionPurchaseV2 オブジェクトを表します。

string

定期購入が付与された時点でのユーザーの請求先の国または地域コード（ISO 3166-1 alpha-2）。

object (SubscriptionPurchaseLineItem)

定期購入に関するアイテムレベルの情報。同じ購入に含まれるアイテムは、すべて AutoRenewingPlan またはすべて PrepaidPlan である必要があります。

string (Timestamp format)

サブスクリプションが認められた時刻。保留中の定期購入（定期購入は作成されたが、登録時に支払いを待機している）には設定されません。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

enum (SubscriptionState)

定期購入の現在の状態。

string

定期購入の購入に関連付けられた最新の注文の注文 ID。自動更新の定期購入の場合、これは登録の注文がまだ更新されていない場合はその注文 ID、最後の定期的な注文 ID（成功、保留中、または不承認の注文）です。前払い定期購入の場合、クエリされた購入トークンに関連付けられた注文 ID です。

string

以前の定期購入の購入トークン（この定期購入が次のいずれかである場合）。* 解約されたが失効していない定期購入の再登録 * 以前の定期購入からのアップグレードまたはダウングレード。* 前払いから自動更新の定期購入に変更する。* 自動更新による定期購入から前払いの定期購入に変更する。* 前払いの定期購入をチャージする。

object (PausedStateContext)

定期購入の一時停止に関する補足情報。サブスクリプションに現在 subscriptionState SUBSCRIPTION_STATE_PAUSED がある場合にのみ存在します。

object (CanceledStateContext)

解約された定期購入に関する補足情報。サブスクリプションに現在 subscriptionState SUBSCRIPTION_STATE_CANCELED または SUBSCRIPTION_STATE_EXPIRED がある場合にのみ存在します。

object (TestPurchase)

この定期購入がテスト購入の場合にのみ存在します。

enum (AcknowledgementState)

サブスクリプションの確認応答の状態。

object (ExternalAccountIdentifiers)

サードパーティ サービスのユーザー アカウント ID。

object (SubscribeWithGoogleInfo)

「Google で購読」での購入に関連付けられているユーザー プロフィール。

{
  "autoResumeTime": string
}

string (Timestamp format)

定期購入が自動的に再開される時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

{

  // 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.
}

object (UserInitiatedCancellation)

定期購入がユーザーによって解約されました。

object (SystemInitiatedCancellation)

請求に関する問題などにより、定期購入がシステムによって解約されました。

object (DeveloperInitiatedCancellation)

定期購入はデベロッパーによって解約されました。

object (ReplacementCancellation)

定期購入が新しい定期購入に置き換えられました。

{
  "cancelSurveyResult": {
    object (CancelSurveyResult)
  },
  "cancelTime": string
}

object (CancelSurveyResult)

定期購入の解約フロー（解約の理由に関するアンケート）を完了したときにユーザーが提供した情報。

string (Timestamp format)

ユーザーが定期購入を解約した時刻。この時間が経過した後も、ユーザーは定期購入にアクセスできる場合があります。lineItems.expiry_time を使用して、ユーザーがまだアクセスできるかどうかを判断します。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

{
  "reason": enum (CancelSurveyReason),
  "reasonUserInput": string
}

enum (CancelSurveyReason)

解約のアンケートでユーザーが選択した理由。

string

CANCEL_SURVEY_REASON_OTHERS の場合にのみ設定されます。これは、アンケートに対するユーザーの自由形式の回答です。

{
  "externalAccountId": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}

string

サードパーティ サービスのユーザー アカウント ID。アカウントのリンクが定期購読の購入フローの一部として発生した場合のみ表示されます。

string

アプリ内でユーザーのアカウントに一意に関連付けられた ID の難読化バージョン。次の購入に存在します。* アカウントのリンクが定期購入フローの一部として行われた場合。* 購入時に https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid を使用して指定されていました。

string

アプリ内でユーザーのプロフィールに一意に関連付けられた ID の難読化バージョン。購入時に https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid を使用して指定された場合にのみ存在します。

{
  "profileId": string,
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string
}

string

定期購入が購入された時点のユーザーの Google プロフィール ID。

string

定期購入が購入された際のユーザーのプロフィール名。

string

定期購入が購入された際のユーザーのメールアドレス。

string

定期購入が購入された時点でのユーザーの名前。

string

定期購入を購入したときのユーザーの姓。

{
  "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.
  "offerDetails": {
    object (OfferDetails)
  },

  // Union field deferred_item_change can be only one of the following:
  "deferredItemReplacement": {
    object (DeferredItemReplacement)
  }
  // End of list of possible types for union field deferred_item_change.
}

string

購入された商品の ID（例:monthly001）。

string (Timestamp format)

定期購入の有効期限が切れる時点、またはアクセスが延長（更新など）されない限り期限切れになる日時。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

object (AutoRenewingPlan)

アイテムは自動更新されます。

object (PrepaidPlan)

アイテムは前払い式です。

object (OfferDetails)

このアイテムの特典の詳細です。

object (DeferredItemReplacement)

延期された商品の交換に関する情報。

{
  "autoRenewEnabled": boolean,
  "priceChangeDetails": {
    object (SubscriptionItemPriceChangeDetails)
  },
  "installmentDetails": {
    object (InstallmentPlan)
  }
}

boolean

定期購入が現在自動更新に設定されている場合（例: ユーザーが定期購入を解約していない場合）

object (SubscriptionItemPriceChangeDetails)

定期購入の登録以降、アイテムの最終価格変更に関する情報。

object (InstallmentPlan)

分割払いプランの契約と、自動更新プランの状態に関する情報。

{
  "newPrice": {
    object (Money)
  },
  "priceChangeMode": enum (PriceChangeMode),
  "priceChangeState": enum (PriceChangeState),
  "expectedNewPriceChargeTime": string
}

object (Money)

定期購入アイテムの新しい定期価格。

enum (PriceChangeMode)

価格変更モードでは、定期購入アイテムの価格をどのように変更するかを指定します。

enum (PriceChangeState)

現在の価格変更を記載します。

string (Timestamp format)

ユーザーに価格変更が有効になる更新日時。これは、一時停止など、更新時刻が変わった場合に（将来の時期に）変更される可能性があります。このフィールドは、価格の変更が適用されていない場合にのみ入力されます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

{
  "initialCommittedPaymentsCount": integer,
  "subsequentCommittedPaymentsCount": integer,
  "remainingCommittedPaymentsCount": integer,
  "pendingCancellation": {
    object (PendingCancellation)
  }
}

integer

ユーザーが最初に確約したお支払いの合計数。

integer

各コミットメント期間後にユーザーが確定するお支払いの合計数。空の場合、分割払いプランは最初の契約の後、通常の自動更新サブスクリプションにフォールバックします。

integer

この更新サイクルに支払われる予定の、確約された支払いの合計数。

object (PendingCancellation)

存在する場合、この分割払いプランはキャンセルが保留中です。キャンセルは、ユーザーが確約した支払いをすべて完了した後にのみ行われます。

{
  "allowExtendAfterTime": string
}

string (Timestamp format)

存在する場合は、この期間を過ぎるとプリペイド プランでチャージ購入が許可されます。期限切れのプリペイド プランには表示されません。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

{
  "offerTags": [
    string
  ],
  "basePlanId": string,
  "offerId": string
}

string

クーポンに関連付けられている最新のクーポンタグ。基本プランから継承されたタグも含まれます。

string

基本プランの ID。すべての基本プランと特典に表示されます。

string

オファー ID。割引オファーの場合のみ表示されます。

{
  "productId": string
}

string

productId は既存の productId を置き換えるものです。