REST Resource: purchases.subscriptions

リソース: SubscriptionPurchase

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

JSON 表現 
{
  "kind": string,
  "startTimeMillis": string,
  "expiryTimeMillis": string,
  "autoResumeTimeMillis": string,
  "autoRenewing": boolean,
  "priceCurrencyCode": string,
  "priceAmountMicros": string,
  "introductoryPriceInfo": {
    object (IntroductoryPriceInfo)
  },
  "countryCode": string,
  "developerPayload": string,
  "paymentState": integer,
  "cancelReason": integer,
  "userCancellationTimeMillis": string,
  "cancelSurveyResult": {
    object (SubscriptionCancelSurveyResult)
  },
  "orderId": string,
  "linkedPurchaseToken": string,
  "purchaseType": integer,
  "priceChange": {
    object (SubscriptionPriceChange)
  },
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string,
  "profileId": string,
  "acknowledgementState": integer,
  "externalAccountId": string,
  "promotionType": integer,
  "promotionCode": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
フィールド
kind

string

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

string (int64 format)

定期購入が付与された時刻（エポックからのミリ秒単位）。
expiryTimeMillis

string (int64 format)

サブスクリプションが期限切れになる時刻（エポックからのミリ秒単位）。
autoResumeTimeMillis

string (int64 format)

サブスクリプションが自動的に再開される時間（エポックからのミリ秒単位）。ユーザーが定期購入の一時停止をリクエストした場合にのみ表示されます。
autoRenewing

boolean

サブスクリプションが現在の有効期限に達した時点で自動更新されるかどうかを指定します。
priceCurrencyCode

string

定期購入価格の ISO 4217 通貨コード。たとえば、価格が英国ポンドで指定されている場合、priceCurrencyCode は &GBt&GBt" です。
priceAmountMicros

string (int64 format)

定期購入価格。税抜きの国では、価格に税金は含まれていません。税込みの国の場合、価格には税が含まれます。価格はマイクロ単位で表され、1,000,000 マイクロ単位は 1 つの通貨単位を表します。たとえば、定期購入価格が €1.99 の場合、priceAmountMicros は 1990000 です。
introductoryPriceInfo

object (IntroductoryPriceInfo)

定期購入のお試し価格情報。これは、定期購入をお試し価格で購入した場合にのみ表示されます。

このフィールドは、定期購入がお試し価格期間であることを示しています。
countryCode

string

定期購入が付与された時点でのユーザーの ISO 3166-1 alpha-2 請求先住所の国または地域コード。
developerPayload

string

注文に関する補足情報を含む、デベロッパー指定の文字列。
paymentState

integer

定期購入の支払い状態。有効な値は 0 です。保留中のお支払い 1. お支払いの受領 2. 無料試用 3. アップグレード/ダウングレードの保留

解約済み、期限切れのサブスクリプションには存在しません。
cancelReason

integer

定期購入が解約された理由、または自動更新されない理由。有効な値は 0 です。お客様が定期購入を解約しました 1。定期購入はシステムによって請求がキャンセルされました（請求に関する問題 2 など）。サブスクリプションが新しいサブスクリプション 3 に置き換えられました。デベロッパーによって定期購入が解約されました
userCancellationTimeMillis

string (int64 format)

ユーザーが定期購入を解約した時刻。エポックからのミリ秒単位です。cancelReason が 0 の場合にのみ存在します。
cancelSurveyResult

object (SubscriptionCancelSurveyResult)

ユーザーが定期購入の解約フローを完了する際に提供された情報（解約理由に関するアンケート）。
orderId

string

サブスクリプションの購入に関連付けられた最新の定期的な注文のオーダー ID。お支払いが不承認となったために定期購入が解約された場合は、お支払いが不承認となった注文のオーダー ID となります。
linkedPurchaseToken

string

この定期購入が 0 の場合、購入元の購入トークン。解約済みだが継続していない定期購入を再登録する 1. 以前のサブスクリプションからのアップグレードまたはダウングレード

たとえば、あるユーザーが元々登録していて、購入トークン X を受け取ったとします。このユーザーが解約してから、（登録の有効期限が切れる前に）再度申し込みフローを進め、購入トークン Y を受け取ったとします。そして最後に、ユーザーが定期購入をアップグレードして、購入トークン Z を受け取ったとします。購入トークン Z を使用してこの API を呼び出すと、このフィールドは Y に設定されます。購入トークン Y を指定してこの API を呼び出すと、このフィールドは X に設定されます。購入トークン X を使用してこの API を呼び出した場合、このフィールドは設定されません。
purchaseType

integer

定期購入の種類。このフィールドは、通常のアプリ内課金フローを使用せずに購入が行われた場合にのみ設定されます。有効な値は 0 です。テスト（ライセンス テスト アカウントから購入） 1.プロモーション（プロモーション コードを使用して購入など）
priceChange

object (SubscriptionPriceChange)

最新の価格変更に関する情報です。これは、まだ適用されていない定期購入の価格変更がある場合にのみ表示されます。

定期購入が新しい価格で更新されるか、解約されると、価格変更に関する情報は返されなくなります。
profileName

string

定期購入購入時のユーザーのプロフィール名。「Google で購読」での購入にのみ存在します。
emailAddress

string

定期購入購入時に使用したユーザーのメールアドレス。「Google で購読」での購入にのみ存在します。
givenName

string

定期購入を購入されたときのユーザーの氏名。「Google で購読」での購入にのみ存在します。
familyName

string

定期購入を購入したユーザーのファミリー名。「Google で購読」での購入にのみ存在します。
profileId

string

定期購入購入時のユーザーの Google プロフィール ID。「Google で購読」での購入にのみ存在します。
acknowledgementState

integer

定期購入アイテムの確認状態。有効な値は 0 です。未確認 1. 承認済み
externalAccountId

string

サードパーティ サービス内のユーザー アカウント ID。アカウントのリンクが定期購入の購入フローの中で発生した場合のみ表示されます。
promotionType

integer

購入に適用されるプロモーションの種類。このフィールドは、定期購入が購入されたときにプロモーションが適用された場合にのみ設定されます。有効な値は 0 です。1 回限りのコード 1バニティコード
promotionCode

string

この購入に適用されたプロモーション コード。このフィールドは、サブスクリプションの購入時にバニティコード プロモーションが適用された場合にのみ設定されます。
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 を使用して指定した場合のみ存在します。

お試し価格情報

定期購入のお試し価格情報を指定します。

JSON 表現 
{
  "introductoryPriceCurrencyCode": string,
  "introductoryPriceAmountMicros": string,
  "introductoryPricePeriod": string,
  "introductoryPriceCycles": integer
}
フィールド
introductoryPriceCurrencyCode

string

お試し価格の ISO 4217 通貨コードです。たとえば、価格が英国ポンドで指定されている場合、priceCurrencyCode は &GBt&GBt" です。
introductoryPriceAmountMicros

string (int64 format)

定期購入のお試し価格（税抜き）。通貨は priceCurrencyCode と同じです。価格はマイクロ単位で表され、1,000,000 マイクロ単位は 1 つの通貨単位を表します。たとえば、定期購入価格が €1.99 の場合、priceAmountMicros は 1990000 です。
introductoryPricePeriod

string

お試し価格の期間。ISO 8601 形式で指定します。一般的な値は、「P1W」です（1 週間）。P1M は 1 か月、3 か月、6 か月、P1Y、1 年です。
introductoryPriceCycles

integer

お試し価格を提供する請求対象期間の数。

SubscriptionCancelSurveyResult

ユーザーが定期購入の解約フローを完了する際に提供された情報（解約理由に関するアンケート）。

JSON 表現 
{
  "cancelSurveyReason": integer,
  "userInputCancelReason": string
}
フィールド
cancelSurveyReason

integer

ユーザーがアンケートで選択したキャンセルの理由。有効な値は 0 です。その他 1. このサービスを十分に活用していない 2技術的な問題 3. 費用関連の理由 4. もっと良いアプリを見つけた
userInputCancelReason

string

ユーザーが入力した入力キャンセル理由。cancelReason が 0 の場合にのみ存在します。

定期購入の価格変更

アプリの価格変更に対するユーザー ジャーニーを制御するために使用できる、定期購入の価格変更情報です。ユーザーに確認を求める、またはコンバージョンを達成するためにユーザー エクスペリエンスを調整するといった形で利用できます。

JSON 表現 
{
  "newPrice": {
    object (Price)
  },
  "state": integer
}
フィールド
newPrice

object (Price)

価格の変更をユーザーが承認すると、定期購入の更新時に適用される新しい価格になります。
state

integer

価格変更の現在の状態。有効な値は 0 です。未処理: 価格変更の保留中で、ユーザーが同意するのを待っています。この状態では、In-App API を使用して必要に応じてユーザーに確認を求めることができます。1. 承認済み: 承認された価格変更のステータスで、解約しない限り定期購入は更新されます。価格変更は、定期購入の更新時に有効になります。サブスクリプションが次に更新されると、変更されない場合があります。

Methods

acknowledge

 定期購入の購入を承認します。

cancel

 ユーザーの定期購入をキャンセルします。

defer

 ユーザーの定期購入購入を、指定した将来の有効期限まで延期します。

get

 ユーザーの定期購入が有効かどうかを確認し、有効期限を返します。

refund

 ユーザーの定期購入の払い戻し。ただし、その定期購入は期限切れまで有効であり、繰り返し実行されます。

revoke

 ユーザーの定期購入の払い戻しと取り消し。