- リソース: SubscriptionPurchaseV2
- SubscriptionState
- PausedStateContext
- CanceledStateContext
- UserInitiatedCancel
- CancelSurveyResult
- CancelSurveyReason
- SystemInitiatedCancel
- DeveloperInitiatedCancel
- ReplacementCancel(交換のキャンセル)
- テスト購入
- 確認応答の状態
- ExternalAccountIdentifiers
- SubscribeWithGoogleInfo
- SubscriptionPurchasePlacement
- AutoRenewingPlan
- SubscriptionItemPriceChangeDetails
- PriceChangeMode
- PriceChangeState
- PrepaidPlan
- OfferDetails
- DeferredItemReplacement
- Methods
リソース: SubscriptionPurchaseV2
ユーザーの定期購入ステータスを示します。
JSON 表現 |
---|
{ "kind": string, "regionCode": string, "lineItems": [ { object ( |
フィールド | |
---|---|
kind |
この種類は、androidpublisher サービスの SubscriptionPurchaseV2 オブジェクトを表します。 |
regionCode |
定期購入が付与された時点でのユーザーの請求先の国または地域コード(ISO 3166-1 alpha-2)。 |
lineItems[] |
定期購入についてアイテム単位の情報。同じ購入に含まれるアイテムは、すべて AutoRenewingPlan またはすべて PrepaidPlan の対象である必要があります。 |
startTime |
定期購入が付与された時刻。保留中の定期購入には設定されません(定期購入は作成されたが、登録中に支払いを待機している)。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
subscriptionState |
定期購入の現在のステータス。 |
latestOrderId |
定期購入に関連付けられた最新の注文のオーダー ID。自動更新による定期購入の場合、登録注文の注文 ID(まだ更新されていない場合)、または最後に繰り返し行われる注文 ID(成功、保留中、不承認の注文)です。前払いの定期購入の場合、クエリされた購入トークンに関連付けられている注文 ID です。 |
linkedPurchaseToken |
以前の定期購入の購入トークン(この定期購入が次のいずれかである場合)。 * 解約済みで失効していない定期購入の再登録 * 以前の定期購入からのアップグレードまたはダウングレード。* 前払いから自動更新の定期購入に切り替えます。* 自動更新による定期購入からプリペイド プランに移行します。* 前払いの定期購入をチャージする。 |
pausedStateContext |
定期購入の一時停止に関する追加情報。サブスクリプションに現在 subscriptionState の SUBSCRIPTION_STATE_PAUSED がある場合にのみ存在します。 |
canceledStateContext |
解約された定期購入に関するその他のコンテキスト。サブスクリプションに現在 subscriptionState SUBSCRIPTION_STATE_CANCELED がある場合にのみ存在します。 |
testPurchase |
この定期購入がテスト購入である場合にのみ表示されます。 |
acknowledgementState |
定期購入の承認状態。 |
externalAccountIdentifiers |
サードパーティ サービスのユーザー アカウント ID。 |
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 |
サブスクリプションの有効期限が切れています。すべてのアイテムに過去の expiryTime が設定されています。 |
PausedStateContext
一時停止状態の定期購入に固有の情報。
JSON 表現 |
---|
{ "autoResumeTime": string } |
フィールド | |
---|---|
autoResumeTime |
定期購入が自動的に再開される時刻です。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
CanceledStateContext
解約された状態の定期購入に固有の情報。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド cancellation_reason 。定期購入が解約された理由。cancellation_reason は次のいずれかになります。 |
|
userInitiatedCancellation |
サブスクリプションはユーザーによって解約されました。 |
systemInitiatedCancellation |
定期購入がシステムによって解約された(請求の問題など)。 |
developerInitiatedCancellation |
定期購入はデベロッパーによって解約されました。 |
replacementCancellation |
サブスクリプションが新しいサブスクリプションに置き換えられました。 |
ユーザーが開始したキャンセル
ユーザーが行った解約に固有の情報。
JSON 表現 |
---|
{
"cancelSurveyResult": {
object ( |
フィールド | |
---|---|
cancelSurveyResult |
定期購入の解約フロー(解約の理由に関するアンケート)を完了したときにユーザーから提供された情報。 |
cancelTime |
ユーザーが定期購入を解約した時刻。この期間が過ぎた後も、ユーザーは定期購入にアクセスできる可能性があります。lineItems.expiry_time を使用して、ユーザーにまだアクセス権があるかどうかを判断します。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
キャンセル アンケート結果
ユーザーが定期購入を解約したときの解約アンケートの結果。
JSON 表現 |
---|
{
"reason": enum ( |
フィールド | |
---|---|
reason |
ユーザーがキャンセルのアンケートで選択した理由。 |
reasonUserInput |
CANCEL_SURVEY_REASON_OTHERS に対してのみ設定されます。アンケートに対するユーザーの自由形式の回答です。 |
キャンセル アンケート理由
ユーザーがキャンセルのアンケートで選択した理由。
列挙型 | |
---|---|
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 |
その他の理由。 |
システムが開始したキャンセル
このタイプにはフィールドがありません。
Google のシステムによって開始されたキャンセルに固有の情報。
デベロッパーが開始したキャンセル
このタイプにはフィールドがありません。
デベロッパーが開始した解約に固有の情報。
交換キャンセル
このタイプにはフィールドがありません。
定期購入の交換に起因する解約に関する情報。
テスト購入
このタイプにはフィールドがありません。
この定期購入がテスト購入かどうか。
確認応答ステータス
定期購入の承認ステータスを示します。
列挙型 | |
---|---|
ACKNOWLEDGEMENT_STATE_UNSPECIFIED |
確認応答の状態が指定されていません。 |
ACKNOWLEDGEMENT_STATE_PENDING |
サブスクリプションはまだ確認応答されていません。 |
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED |
サブスクリプションは承認されました。 |
ExternalAccountIdentifiers
サードパーティ サービスのユーザー アカウント ID。
JSON 表現 |
---|
{ "externalAccountId": string, "obfuscatedExternalAccountId": string, "obfuscatedExternalProfileId": string } |
フィールド | |
---|---|
externalAccountId |
サードパーティ サービスのユーザー アカウント ID。アカウントのリンクが定期購入の購入フローの中で行われた場合にのみ表示されます。 |
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 |
定期購入を購入したユーザーの姓。 |
SubscriptionPurchase AutoML
定期購入についてアイテム単位の情報。
JSON 表現 |
---|
{ "productId": string, "expiryTime": string, // Union field |
フィールド | |
---|---|
productId |
購入された商品 ID(例: monthly001)。 |
expiryTime |
定期購入の有効期限が切れる時刻、またはアクセスが延長(更新など)されない限り、定期購入が期限切れになる時刻。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
共用体フィールド plan_type 。定期購入プランのタイプ。plan_type は次のいずれかになります。 |
|
autoRenewingPlan |
このアイテムは自動更新されます。 |
prepaidPlan |
このアイテムは前払いです。 |
offerDetails |
このアイテムのオファーの詳細。 |
共用体フィールド deferred_item_change 。アイテムに遅延変更がある場合、このフィールドが存在します。削除または置換できます。deferred_item_change は次のいずれかになります。 |
|
deferredItemReplacement |
延期されたアイテムの交換に関する情報。 |
自動更新プラン
自動更新プランに関する情報。
JSON 表現 |
---|
{
"autoRenewEnabled": boolean,
"priceChangeDetails": {
object ( |
フィールド | |
---|---|
autoRenewEnabled |
定期購入が現在自動更新に設定されている場合(例: ユーザーが定期購入を解約していない場合) |
priceChangeDetails |
定期購入登録後のアイテムに対する最終価格変更の情報。 |
SubscriptionItemPriceChangeDetails
定期購入アイテムの価格変更に関する情報。
JSON 表現 |
---|
{ "newPrice": { object ( |
フィールド | |
---|---|
newPrice |
定期購入アイテムの新しい繰り返し価格。 |
priceChangeMode |
価格変更モードは、定期購入の商品アイテムの価格を変更する方法を指定します。 |
priceChangeState |
価格変更が現在起きている状態を示します。 |
expectedNewPriceChargeTime |
ユーザーに対して価格変更が有効になる更新日時。このスケジュールは、一時停止など、更新の時期が変わる場合に(将来の時間で)変更される可能性があります。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
価格変更モード
価格変更のモード。
列挙型 | |
---|---|
PRICE_CHANGE_MODE_UNSPECIFIED |
価格変更モードが指定されていません。この値は設定しないでください。 |
PRICE_DECREASE |
定期購入の料金が下がっている場合。 |
PRICE_INCREASE |
定期購入の料金が値上げされており、お客様が同意する必要がある場合。 |
OPT_OUT_PRICE_INCREASE |
オプトアウト モードでサブスクリプション料金が引き上げられる場合。 |
PriceChangeState
価格変更の状態。
列挙型 | |
---|---|
PRICE_CHANGE_STATE_UNSPECIFIED |
価格変更のステータスが指定されていません。この値は使用できません。 |
OUTSTANDING |
価格変更に対するお客様の同意を待っています。 |
CONFIRMED |
ユーザーに対して価格変更が適用されることを確認しました。 |
APPLIED |
価格の変更が適用されます。つまり、新しい価格がユーザーに請求されるようになります。 |
プリペイド プラン
プリペイド プランに関する情報。
JSON 表現 |
---|
{ "allowExtendAfterTime": string } |
フィールド | |
---|---|
allowExtendAfterTime |
指定されている場合、この時刻を過ぎると、プリペイド プランでチャージ購入が可能になります。期限切れのプリペイド プランには表示されません。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
OfferDetails
購入項目に関連するオファーの詳細情報です。
JSON 表現 |
---|
{ "offerTags": [ string ], "basePlanId": string, "offerId": string } |
フィールド | |
---|---|
offerTags[] |
クーポンに関連付けられている最新のクーポンタグ。基本プランから継承されたタグも含まれます。 |
basePlanId |
基本プランの ID。すべての基本プランと特典に存在します。 |
offerId |
特典 ID。割引特典の場合のみ表示されます。 |
DeferredItemReplacement
延期されたアイテムの交換に関する情報。
JSON 表現 |
---|
{ "productId": string } |
フィールド | |
---|---|
productId |
productId は既存の productId を置き換えるものです。 |
Methods |
|
---|---|
|
サブスクリプションに関するメタデータを取得する |