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（承諾済み）: 承認された価格変更のステータス。解約されない限り、この価格で定期購入が更新されます。価格変更は、定期購入が更新される将来の日付に有効になります。次に定期購入を更新するときに、変更が反映されない場合があります。

Methods

acknowledge

 定期購入を承認します。

cancel

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

defer

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

get

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

refund

 ユーザーの定期購入の払い戻しを行いますが、定期購入は有効期限が切れるまで有効であり、定期購入は継続されます。

revoke

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