- リソース: SubscriptionPurchaseV2
- SubscriptionState
- PausedStateContext
- CanceledStateContext
- UserInitiatedCancellation
- CancelSurveyResult
- CancelSurveyReason
- SystemInitiatedCancellation
- DeveloperInitiatedCancellation
- ReplacementCancellation
- TestPurchase
- AcknowledgementState
- ExternalAccountIdentifiers
- SubscribeWithGoogleInfo
- SubscriptionPurchaseLineItem
- AutoRenewingPlan
- SubscriptionItemPriceChangeDetails
- PriceChangeMode
- PriceChangeState
- InstallmentPlan
- PendingCancellation
- PrepaidPlan
- OfferDetails
- DeferredItemReplacement
- メソッド
リソース: 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 または SUBSCRIPTION_STATE_EXPIRED がある場合にのみ存在します。 |
testPurchase |
この定期購入がテスト購入の場合にのみ存在します。 |
acknowledgementState |
サブスクリプションの確認応答の状態。 |
externalAccountIdentifiers |
サードパーティ サービスのユーザー アカウント ID。 |
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 |
定期購入が自動的に再開される時刻。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
CanceledStateContext
SUBSCRIPTION_STATE_CANCELED または SUBSCRIPTION_STATE_EXPIRED 状態の定期購入に固有の情報。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド cancellation_reason 。定期購入が解約された理由。cancellation_reason は次のいずれかになります。 |
|
userInitiatedCancellation |
定期購入がユーザーによって解約されました。 |
systemInitiatedCancellation |
請求に関する問題などにより、定期購入がシステムによって解約されました。 |
developerInitiatedCancellation |
定期購入はデベロッパーによって解約されました。 |
replacementCancellation |
定期購入が新しい定期購入に置き換えられました。 |
UserInitiatedCancellation
ユーザーが行った解約に固有の情報。
JSON 表現 |
---|
{
"cancelSurveyResult": {
object ( |
フィールド | |
---|---|
cancelSurveyResult |
定期購入の解約フロー(解約の理由に関するアンケート)を完了したときにユーザーが提供した情報。 |
cancelTime |
ユーザーが定期購入を解約した時刻。この時間が経過した後も、ユーザーは定期購入にアクセスできる場合があります。lineItems.expiry_time を使用して、ユーザーがまだアクセスできるかどうかを判断します。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
CancelSurveyResult
ユーザーが定期購入を解約したときの解約アンケートの結果。
JSON 表現 |
---|
{
"reason": enum ( |
フィールド | |
---|---|
reason |
解約のアンケートでユーザーが選択した理由。 |
reasonUserInput |
CANCEL_SURVEY_REASON_OTHERS の場合にのみ設定されます。これは、アンケートに対するユーザーの自由形式の回答です。 |
CancelSurveyReason
解約のアンケートでユーザーが選択した理由。
列挙型 | |
---|---|
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 |
その他の理由。 |
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 |
サードパーティ サービスのユーザー アカウント 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 |
定期購入を購入したときのユーザーの姓。 |
SubscriptionPurchaseLineItem
定期購入に関するアイテムレベルの情報。
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 |
延期された商品の交換に関する情報。 |
AutoRenewingPlan
自動更新プランに関する情報。
JSON 表現 |
---|
{ "autoRenewEnabled": boolean, "priceChangeDetails": { object ( |
フィールド | |
---|---|
autoRenewEnabled |
定期購入が現在自動更新に設定されている場合(例: ユーザーが定期購入を解約していない場合) |
priceChangeDetails |
定期購入の登録以降、アイテムの最終価格変更に関する情報。 |
installmentDetails |
分割払いプランの契約と、自動更新プランの状態に関する情報。 |
SubscriptionItemPriceChangeDetails
定期購入アイテムの価格変更関連情報。
JSON 表現 |
---|
{ "newPrice": { object ( |
フィールド | |
---|---|
newPrice |
定期購入アイテムの新しい定期価格。 |
priceChangeMode |
価格変更モードでは、定期購入アイテムの価格をどのように変更するかを指定します。 |
priceChangeState |
現在の価格変更を記載します。 |
expectedNewPriceChargeTime |
ユーザーに価格変更が有効になる更新日時。これは、一時停止など、更新時刻が変わった場合に(将来の時期に)変更される可能性があります。このフィールドは、価格の変更が適用されていない場合にのみ入力されます。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
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 ( |
フィールド | |
---|---|
initialCommittedPaymentsCount |
ユーザーが最初に確約したお支払いの合計数。 |
subsequentCommittedPaymentsCount |
各コミットメント期間後にユーザーが確定するお支払いの合計数。空の場合、分割払いプランは最初の契約の後、通常の自動更新サブスクリプションにフォールバックします。 |
remainingCommittedPaymentsCount |
この更新サイクルに支払われる予定の、確約された支払いの合計数。 |
pendingCancellation |
存在する場合、この分割払いプランはキャンセルが保留中です。キャンセルは、ユーザーが確約した支払いをすべて完了した後にのみ行われます。 |
PendingCancellation
この型にはフィールドがありません。
これは、仮想分割払いプランに保留中の解約があるかどうかを示します。キャンセルは、ユーザーが確約した支払いをすべて完了した後にのみ行われます。
PrepaidPlan
プリペイド プランに関する情報。
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 を置き換えるものです。 |
メソッド |
|
---|---|
|
サブスクリプションに関するメタデータを取得する |
|
ユーザーの定期購入を取り消します。 |