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

この種類は、androidpublisher サービスの 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「Zulu」形式のタイムスタンプ。ナノ秒の解像度と小数第 9 位以下までとなります。（例: "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)

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

object (SubscribeWithGoogleInfo)

「Google で購読」での購入に関連するユーザー プロフィール。

サブスクリプションの状態

定期購入の状態は、たとえば「有効」か「解約済み」かなどです。定期購入に含まれるアイテムは、すべて自動更新プランまたはプリペイド プランのいずれかです。

列挙型
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 登録の有効期限が切れています。すべてのアイテムに有効期限は以前にあります。

PausedStateContext

一時停止状態の定期購入に固有の情報。

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

string (Timestamp format)

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

RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の解像度と小数第 9 位以下までとなります。（例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"）。

CanceledStateContext

解約済み定期購入に固有の情報。

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

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

交換のキャンセル

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

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

定期購入を購入したユーザーのファミリー名。

SubscriptionPurchase 広告申込情報

定期購入における商品アイテムレベルの情報。

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

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

自動更新プラン

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

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

boolean

サブスクリプションが現在自動更新に設定されている場合（ユーザーが定期購入を解約していない場合など）
priceChangeDetails

object (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"）。

価格変更モード

価格変更のモード。

列挙型
PRICE_CHANGE_MODE_UNSPECIFIED 価格変更モードが指定されていません。この値は設定しないでください。
PRICE_DECREASE 定期購入の価格が下がっているかどうか。
PRICE_INCREASE 定期購入価格が値上げされ、ユーザーがこの定期購入を承認する必要がある場合。

PriceChangeState

価格変更のステータス。

列挙型
PRICE_CHANGE_STATE_UNSPECIFIED 価格変更のステータスが指定されていません。この値は使用できません。
OUTSTANDING 価格変更に対するユーザーの同意を待っています。
CONFIRMED 価格変更が発生することが確認されました。
APPLIED 価格変更が適用され、つまり、ユーザーに新しい価格の請求が開始されました。

前払いプラン

前払いプランに関する情報。

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。割引特典の場合のみ表示されます。

Methods

get

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