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 サービスの subscriptionPurchase オブジェクトを表します。
startTimeMillis

string (int64 format)

サブスクリプションが付与された時刻（エポックからのミリ秒）。
expiryTimeMillis

string (int64 format)

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

string (int64 format)

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

boolean

定期購入が現在の有効期限に達したときに自動更新するかどうか。
priceCurrencyCode

string

定期購入価格の ISO 4217 通貨コード。たとえば、価格が英ポンドで指定されている場合、priceCurrencyCode は「GBP」になります。
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。バニティコード
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 を使って指定した場合のみ表示されます。

IntroductoryPriceInfo

定期購入のお試し価格情報が含まれます。

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

string

定期購入のお試し価格を表す ISO 4217 の通貨コード。たとえば、価格が英ポンドで指定されている場合、priceCurrencyCode は「GBP」になります。
introductoryPriceAmountMicros

string (int64 format)

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

string

お試し価格の期間（ISO 8601 形式）。一般的な値は「P1W」です（ただし、これらに限定されません）。（1 週間）、「P1M」（1 か月）、「P3M」（3 か月）、「P6M」（6 か月）、および「P1Y」（1 年間）。
introductoryPriceCycles

integer

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

SubscriptionCancelSurveyResult

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

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

integer

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

string

ユーザーからのカスタマイズされた入力キャンセル理由。cancelReason が 0 の場合にのみ存在します。

SubscriptionPriceChange

定期購入の価格変更情報を格納します。アプリでの価格変更に関するユーザー ジャーニーの管理に使用できます。これには、ユーザーに確認を求めることや、コンバージョンを成功に導くためのエクスペリエンスをカスタマイズすることが含まれます。

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

object (Price)

価格変更をユーザーが同意した場合に、定期購入を更新する新しい価格。
state

integer

価格変更の現在の状態。有効な値は 0 です。未処理: ユーザーの同意を待っている、保留中の価格変更のステータス。この状態では、必要に応じて In-App API を使用してユーザーに確認を求めることができます。1. Accepted（承諾済み）: 定期購入を解約しない限り、定期購入の更新に適用される、承諾済みの価格変更に関する状態。価格変更は、定期購入の更新日以降に有効になります。なお、次回の定期購入更新時には変更が反映されない場合があります。

メソッド

acknowledge

 定期購入を承認します。

cancel

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

defer

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

get

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

refund

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

revoke

 ユーザーの定期購入を払い戻し、直ちに取り消します。