REST Resource: purchases.subscriptionsv2

リソース: SubscriptionPurchaseV2

ユーザーの定期購入のステータスを示します。

JSON 表現 
{
  "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)
  }
}
フィールド
kind

string

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

string

定期購入付与時のユーザーの ISO 3166-1 alpha-2 請求先住所の国/地域コード。
lineItems[]

object (SubscriptionPurchaseLineItem)

定期購入に関するアイテムレベルの情報。1 回の購入ですべてのアイテムが AutoRenewingPlan に登録されているか、すべて PrepaidPlan が適用されているかのいずれかを選択してください。
startTime

string (Timestamp format)

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

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

enum (SubscriptionState)

定期購入の現在の状態。
latestOrderId

string

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

string

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

object (PausedStateContext)

一時停止中の定期購入に関する追加情報。定期購入に現在 subscriptionState SUBSCRIPTION_STATE_PAUSED がある場合にのみ表示されます。
canceledStateContext

object (CanceledStateContext)

解約された定期購入に関する追加コンテキスト。定期購入に現在 subscriptionState SUBSCRIPTION_STATE_CANCELED または SUBSCRIPTION_STATE_EXPIRED がある場合にのみ表示されます。
testPurchase

object (TestPurchase)

この定期購入がテスト購入の場合のみ表示されます。
acknowledgementState

enum (AcknowledgementState)

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

object (ExternalAccountIdentifiers)

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

object (SubscribeWithGoogleInfo)

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

SubscriptionState

定期購入が取り得るステータス（有効、解約など）。定期購入に含まれるアイテムは、すべての自動更新プランまたはプリペイド プランのいずれかです。

列挙型
SUBSCRIPTION_STATE_UNSPECIFIED 定期購入のステータスが指定されていません。
SUBSCRIPTION_STATE_PENDING サブスクリプションが作成されましたが、登録時の支払いを待機しています。この状態では、すべてのアイテムが支払い待ちの状態です。
SUBSCRIPTION_STATE_ACTIVE サブスクリプションは有効です。-（1）定期購入が自動更新プランの場合、少なくとも 1 つの項目が autoRenewEnabled であり、有効期限が切れていないこと。-（2）定期購入がプリペイド プランの場合、有効期限が切れていないアイテムが 1 つ以上ある。
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

string (Timestamp format)

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

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

CanceledStateContext

SUBSCRIPTION_STATE_CANCELED または SUBSCRIPTION_STATE_EXPIRED の状態の定期購入に固有の情報。

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)

サブスクリプションが新しいサブスクリプションに切り替わりました。

UserInitiatedCancellation

ユーザーが行った解約に固有の情報。

JSON 表現 
{
  "cancelSurveyResult": {
    object (CancelSurveyResult)
  },
  "cancelTime": string
}
フィールド
cancelSurveyResult

object (CancelSurveyResult)

定期購入の解約フロー（解約の理由に関するアンケート）を完了する際にお客様から提供された情報。
cancelTime

string (Timestamp format)

ユーザーが定期購入を解約した時刻。この期間を過ぎても、ユーザーは定期購入を利用できる可能性があります。lineItems.expiry_time を使用して、ユーザーにまだアクセス権があるかどうかを確認します。

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

CancelSurveyResult

ユーザーが定期購入を解約したときの解約アンケートの結果。

JSON 表現 
{
  "reason": enum (CancelSurveyReason),
  "reasonUserInput": string
}
フィールド
reason

enum (CancelSurveyReason)

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

string

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

CancelSurveyReason

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

列挙型
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 システムによって開始されたキャンセルに固有の情報。

DeveloperInitiatedCancellation

この型にはフィールドがありません。

デベロッパーが開始した解約に固有の情報。

ReplacementCancellation

この型にはフィールドがありません。

定期購入の交換による解約に固有の情報。

TestPurchase

この型にはフィールドがありません。

この定期購入がテスト購入かどうか。

AcknowledgementState

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

列挙型
ACKNOWLEDGEMENT_STATE_UNSPECIFIED 確認応答の状態が指定されていません。
ACKNOWLEDGEMENT_STATE_PENDING サブスクリプションはまだ承認されていません。
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED サブスクリプションが確認されました。

ExternalAccountIdentifiers

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

JSON 表現 
{
  "externalAccountId": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
フィールド
externalAccountId

string

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

string

アプリ内のユーザー アカウントと一意に関連付けられた 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 を使って指定した場合のみ表示されます。

SubscribeWithGoogleInfo

「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.
  "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.
}
フィールド
productId

string

購入された商品の ID（「monthly001」など）。
expiryTime

string (Timestamp format)

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

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
共用体フィールド plan_type。サブスクリプション プランのタイプ。plan_type は次のいずれかになります。
autoRenewingPlan

object (AutoRenewingPlan)

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

object (PrepaidPlan)

この商品は前払いです。
offerDetails

object (OfferDetails)

このアイテムのオファーの詳細。
共用体フィールド deferred_item_change。アイテムに遅延変更がある場合、このフィールドが表示されます。削除することも、置き換えることもできます。deferred_item_change は次のいずれかになります。
deferredItemReplacement

object (DeferredItemReplacement)

延期されたアイテム交換に関する情報。

AutoRenewingPlan

自動更新プランに関する情報。

JSON 表現 
{
  "autoRenewEnabled": boolean,
  "priceChangeDetails": {
    object (SubscriptionItemPriceChangeDetails)
  },
  "installmentDetails": {
    object (InstallmentPlan)
  }
}
フィールド
autoRenewEnabled

boolean

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

object (SubscriptionItemPriceChangeDetails)

定期購入の登録以降の商品アイテムの価格変更の情報です。
installmentDetails

object (InstallmentPlan)

分割払いプランのコミットメントと自動更新プランの状態関連情報。

SubscriptionItemPriceChangeDetails

定期購入アイテムの価格変更関連情報。

JSON 表現 
{
  "newPrice": {
    object (Money)
  },
  "priceChangeMode": enum (PriceChangeMode),
  "priceChangeState": enum (PriceChangeState),
  "expectedNewPriceChargeTime": string
}
フィールド
newPrice

object (Money)

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

enum (PriceChangeMode)

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

enum (PriceChangeState)

現在の価格変更のステータス。
expectedNewPriceChargeTime

string (Timestamp format)

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

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

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 (PendingCancellation)
  }
}
フィールド
initialCommittedPaymentsCount

integer

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

integer

各契約期間の終了後にユーザーが支払う合計支払い回数。空の場合、分割払いプランは、最初の契約の後、通常の自動更新定期購入にフォールバックします。
remainingCommittedPaymentsCount

integer

この更新サイクルで残りのお支払いが確約された合計回数。
pendingCancellation

object (PendingCancellation)

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

PendingCancellation

この型にはフィールドがありません。

これは、仮想分割払いプランの解約が保留中かどうかを示すインジケーターです。キャンセルは、ユーザーがすべてのコミットされた支払いを完了した後にのみ行われます。

PrepaidPlan

プリペイド プランに関する情報。

JSON 表現 
{
  "allowExtendAfterTime": string
}
フィールド
allowExtendAfterTime

string (Timestamp format)

プリペイド プランがある場合、この日以降にプリペイド プランでチャージ購入できるようになります。期限切れのプリペイド プランにはありません。

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

OfferDetails

購入項目に関連するオファーの詳細情報。

JSON 表現 
{
  "offerTags": [
    string
  ],
  "basePlanId": string,
  "offerId": string
}
フィールド
offerTags[]

string

オファーに関連付けられている最新のオファータグ。基本プランから継承されたタグが含まれます。
basePlanId

string

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

string

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

DeferredItemReplacement

延期されたアイテム交換に関する情報。

JSON 表現 
{
  "productId": string
}
フィールド
productId

string

既存の productId を置き換える productId

メソッド

get

 サブスクリプションに関するメタデータを取得する

revoke

 ユーザーの定期購入を取り消します。