- リソース: SubscriptionPurchase
- IntroductoryPriceInfo
- SubscriptionCancelSurveyResult
- SubscriptionPriceChange
- メソッド
リソース: SubscriptionPurchase
SubscriptionPurchase リソースは、ユーザーの定期購入のステータスを示します。
JSON 表現 |
---|
{ "kind": string, "startTimeMillis": string, "expiryTimeMillis": string, "autoResumeTimeMillis": string, "autoRenewing": boolean, "priceCurrencyCode": string, "priceAmountMicros": string, "introductoryPriceInfo": { object ( |
フィールド | |
---|---|
kind |
この kind は、androidpublisher サービスの subscriptionPurchase オブジェクトを示します。 |
start |
定期購入が承認された日時をエポックからの経過時間(ミリ秒単位)で示します。 |
expiry |
定期購入の期限が切れる日時をエポックからの経過時間(ミリ秒単位)で示します。 |
auto |
定期購入が自動再開される日時をエポックからの経過時間(ミリ秒単位)で示します。ユーザーが定期購入の一時停止をリクエストした場合にのみ存在します。 |
auto |
現在の有効期限に達した場合に定期購入を自動で更新するかどうか。 |
price |
定期購入価格の ISO 4217 通貨コード。たとえば、価格がイギリスポンドで指定されている場合、priceCurrencyCode は「GBP」になります。 |
price |
定期購入の価格。外税表示する国の場合、価格に税金は含みません。内税表示する国の場合、価格に税金を含みます。価格は、マイクロ単位で表示します。1,000,000 マイクロ単位が実際の通貨の 1 単位に相当します。たとえば、定期購入価格が €1.99 の場合、priceAmountMicros は「1990000」になります。 |
introductory |
定期購入のお試し価格の情報。定期購入がお試し価格で購入された場合にのみ存在します。 このフィールドは、定期購入が現在お試し価格期間にあることを示すものではありません。 |
country |
定期購入が承認された時点でのユーザーの請求先住所の国/地域コード(ISO 3166-1 alpha-2 形式)。 |
developer |
注文に関する補足情報が含まれる文字列で、デベロッパーが指定します。 |
payment |
定期購入の支払いの状態。値は次のいずれかです。0. 支払いが保留中、1. 支払いを受領済み、2. 無料試用、3. アップグレード/ダウングレードが保留中 解約、期限切れの定期購入の場合は存在しません。 |
cancel |
定期購入が解約された理由、または自動更新されない理由。値は次のいずれかです。0. ユーザーが定期購入を解約したため、1. 請求に関する問題などにより、システムによって定期購入が解約されたため、2. 定期購入が新たな定期購入に置き換えられたため、3. 定期購入がデベロッパーによって解約されたため |
user |
ユーザーが定期購入を解約した日時をエポックからの経過時間(ミリ秒単位)で示します。cancelReason が 0 の場合にのみ存在します。 |
cancel |
ユーザーが定期購入解約フロー完了時に提供した情報(解約理由アンケート)。 |
order |
定期購入に関連付けられた最新の継続注文のオーダー ID。支払いの不承認により定期購入が解約された場合、支払いが不承認だった注文のオーダー ID になります。 |
linked |
この定期購入が、0. 解約したが失効していない定期購入の再登録、または 1. 以前の定期購入からのアップグレードまたはダウングレードのいずれかに該当する場合は、元の定期購入の購入トークン。 たとえば、ユーザーが初めて定期購入に登録したときにデベロッパーが購入トークン X を受け取ったとします。その定期購入が解約されてから失効する前に再登録フローが行われ、デベロッパーは購入トークン Y を受け取り、さらに定期購入がアップグレードされて購入トークン Z を受け取りました。このシナリオで、この API を購入トークン Z で呼び出すと、このフィールドは Y に設定されます。この API を購入トークン Y で呼び出すと、このフィールドは X に設定されます。この API を購入トークン X で呼び出すと、このフィールドは設定されません。 |
purchase |
定期購入の購入タイプ。このフィールドは、標準のアプリ内課金フローを使用して処理された定期購入ではない場合にのみ設定します。値は次のいずれかです。0. テスト(ライセンス テスト用アカウントでの購入)、1. プロモーション(プロモーション コードを使用した購入) |
price |
利用可能な最新の価格変更情報。定期購入の価格変更が予定されており、まだ適用されていない場合にのみ存在します。 定期購入が新規価格に更新されるか、定期購入が解約されると、価格変更情報は返されなくなります。 |
profile |
定期購入が購入された際のユーザーのプロフィール名。「Google で購読」で購入された場合にのみ存在します。 |
email |
定期購入が購入された際のユーザーのメールアドレス。「Google で購読」で購入された場合にのみ存在します。 |
given |
定期購入が購入された際のユーザーの名前(名)。「Google で購読」で購入された場合にのみ存在します。 |
family |
定期購入が購入された際のユーザーの名前(姓)。「Google で購読」で購入された場合にのみ存在します。 |
profile |
定期購入が購入された際のユーザーの Google プロフィール ID。「Google で購読」で購入された場合にのみ存在します。 |
acknowledgement |
定期購入商品の承認状態。値は次のいずれかです。0. 未承認、1. 確認済み |
external |
サードパーティ サービス内のユーザー アカウントの識別子。定期購入フローの一環としてアカウントが連携された場合にのみ存在します。 |
promotion |
この購入に適用されたプロモーションのタイプ。このフィールドは、定期購入時にプロモーションが適用された場合にのみ設定します。値は次のいずれかです。0. 1 回限りのコード 1. バニティコード |
promotion |
この購入に適用されたプロモーション コード。このフィールドは、定期購入時にバニティコードが適用された場合にのみ設定します。 |
obfuscated |
アプリのユーザー アカウントに一意に関連付けられている難読化されたバージョンの ID。次の購入の場合に存在します。* 定期購入フローの一環としてアカウントが連携された場合。* 購入時に https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid を使用して指定された場合。 |
obfuscated |
アプリのユーザー プロファイルに一意に関連付けられている難読化されたバージョンの ID。購入時に https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid を使用して指定された場合にのみ存在します。 |
IntroductoryPriceInfo
定期購入のお試し価格情報を含みます。
JSON 表現 |
---|
{ "introductoryPriceCurrencyCode": string, "introductoryPriceAmountMicros": string, "introductoryPricePeriod": string, "introductoryPriceCycles": integer } |
フィールド | |
---|---|
introductory |
定期購入のお試し価格の ISO 4217 形式通貨コード。たとえば、価格がイギリスポンドで指定されている場合、priceCurrencyCode は「GBP」になります。 |
introductory |
定期購入のお試し価格(税抜き)。通貨は priceCurrencyCode と同じです。価格は、マイクロ単位で表示します。1,000,000 マイクロ単位が実際の通貨の 1 単位に相当します。たとえば、定期購入価格が €1.99 の場合、priceAmountMicros は「1990000」になります。 |
introductory |
お試し価格の期間。ISO 8601 形式で指定します。「P1W」(1 週間)、「P1M」(1 か月間)、「P3M」(3 か月間)、「P6M」(6 か月間)、「P1Y」(1 年間)といった値が一般的ですが、これらに限定されません。 |
introductory |
お試し価格を提供する請求対象期間の数。 |
SubscriptionCancelSurveyResult
ユーザーが定期購入解約フロー完了時に提供した情報(解約理由アンケート)。
JSON 表現 |
---|
{ "cancelSurveyReason": integer, "userInputCancelReason": string } |
フィールド | |
---|---|
cancel |
アンケートでユーザーが選択した解約理由。値は次のいずれかです。0. その他 1. このサービスを十分に活用していない、2. 技術的な問題、3. 料金上の理由、4. もっと良いアプリを見つけた |
user |
ユーザーが入力したその他の解約理由。cancelReason が 0 の場合にのみ存在します。 |
SubscriptionPriceChange
定期購入の価格変更情報を含みます。ユーザーに確認を求めたり、問題なく変更できるようにエクスペリエンスを調整したりするなど、アプリ内で価格変更に関わるユーザー ジャーニーをコントロールするために使用できます。
JSON 表現 |
---|
{
"newPrice": {
object ( |
フィールド | |
---|---|
new |
ユーザーが価格変更に同意した場合に定期購入が更新されて適用される新たな価格。 |
state |
価格変更の現在の状態。値は次のいずれかです。0. 未処理: ユーザーの同意を待っており価格変更が保留中の状態。この状態では、アプリ内 API を使用してユーザーの確認を求めることもできます。1. 同意済み: 価格変更が同意された状態。解約されない限り定期購入が更新されて価格変更が適用されます。価格変更は、定期購入が更新される将来の日付から有効になります。定期購入の次回の更新時に価格変更が行われるとは限りません。 |
メソッド |
|
---|---|
|
定期購入を承認します。 |
|
ユーザーの定期購入をキャンセルします。 |
|
指定された将来の有効期限までユーザーの定期購入を保留します。 |
|
ユーザーの定期購入が有効かどうかを確認し、有効期限を返します。 |
|
ユーザーの定期購入の払い戻しを行いますが、定期購入は有効期限まで有効で、その期間中は継続(再開)可能です。 |
|
ユーザーの定期購入を払い戻し、直ちに取り消します。 |