REST Resource: purchases.subscriptionsv2

リソース: SubscriptionPurchaseV2

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

JSON 表現
{
  "kind": string,
  "regionCode": string,
  "lineItems": [
    {
      object (SubscriptionPurchaseLineItem)
    }
  ],
  "startTime": string,
  "subscriptionState": enum (SubscriptionState),
  "latestOrderId": string,
  "linkedPurchaseToken": string,
  "pausedStateContext": {
    object (PausedStateContext)
  },
  "canceledStateContext": {
    object (CanceledStateContext)
  },
  "testPurchase": {
    object (TestPurchase)
  },
  "acknowledgementState": enum (AcknowledgementState),
  "externalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "subscribeWithGoogleInfo": {
    object (SubscribeWithGoogleInfo)
  }
}
フィールド
kind

string

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

regionCode

string

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

lineItems[]

object (SubscriptionPurchaseLineItem)

定期購入に関するアイテム単位の情報。同じ購入内のアイテムはすべて AutoRenewingPlan を含むか、すべて PrepaidPlan である必要があります。

startTime

string (Timestamp format)

定期購入が付与された時刻。保留中の定期購入には設定されません(定期購入は作成されたが、登録時の支払いを待機中)。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

subscriptionState

enum (SubscriptionState)

定期購入の現在のステータス。

latestOrderId

string

定期購入の購入に関連付けられた最新の注文の注文 ID。自動更新の定期購入の場合、申し込みの注文がまだ更新されていない場合は、注文 ID です。前回の注文 ID(成功、保留中、不承認の注文)です。前払いの定期購入の場合、これはクエリされた購入トークンに関連付けられたオーダー ID です。

linkedPurchaseToken

string

以前の定期購入の購入トークン(この定期購入が次のいずれかである場合)。* 解約済みであるものの失効していない定期購入の再登録 * 以前の定期購入からのアップグレードまたはダウングレード。* 前払いから自動更新の定期購入に変更する。* 自動更新による定期購入から前払いに切り替える。* 前払いの定期購入をチャージする。

pausedStateContext

object (PausedStateContext)

定期購入の一時停止に関するその他のコンテキスト。定期購入に現在 subscriptionState が SUBSCRIPTION_STATE_PAUSED の場合にのみ存在します。

canceledStateContext

object (CanceledStateContext)

解約された定期購入に関するその他のコンテキスト。現在、サブスクリプションに subscriptionState SUBSCRIPTION_STATE_CANCELED の場合にのみ存在します。

testPurchase

object (TestPurchase)

この定期購入がテスト購入の場合にのみ存在します。

acknowledgementState

enum (AcknowledgementState)

定期購入の確認状態。

externalAccountIdentifiers

object (ExternalAccountIdentifiers)

サードパーティ サービスのユーザー アカウント ID。

subscribeWithGoogleInfo

object (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 が過去の日時です。

PausedStateContext

一時停止状態の定期購入に固有の情報。

JSON 表現
{
  "autoResumeTime": string
}
フィールド
autoResumeTime

string (Timestamp format)

定期購入が自動的に再開される時間です。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

CanceledStateContext

解約済みの定期購入に固有の情報。

JSON 表現
{

  // Union field cancellation_reason can be only one of the following:
  "userInitiatedCancellation": {
    object (UserInitiatedCancellation)
  },
  "systemInitiatedCancellation": {
    object (SystemInitiatedCancellation)
  },
  "developerInitiatedCancellation": {
    object (DeveloperInitiatedCancellation)
  },
  "replacementCancellation": {
    object (ReplacementCancellation)
  }
  // End of list of possible types for union field cancellation_reason.
}
フィールド
共用体フィールド cancellation_reason。定期購入を解約した理由。cancellation_reason は次のいずれかになります。
userInitiatedCancellation

object (UserInitiatedCancellation)

定期購入がユーザーによって解約されました。

systemInitiatedCancellation

object (SystemInitiatedCancellation)

請求の問題などにより、定期購入がシステムによって解約された。

developerInitiatedCancellation

object (DeveloperInitiatedCancellation)

定期購入はデベロッパーによって解約されました。

replacementCancellation

object (ReplacementCancellation)

定期購入は新しい定期購入に置き換えられました。

UserInitiatedCancellation

ユーザーが行った解約に固有の情報。

JSON 表現
{
  "cancelSurveyResult": {
    object (CancelSurveyResult)
  },
  "cancelTime": string
}
フィールド
cancelSurveyResult

object (CancelSurveyResult)

ユーザーが定期購入の解約フロー(解約理由に関するアンケート)を完了したときに提供した情報。

cancelTime

string (Timestamp format)

ユーザーが定期購入を解約した時刻。この期間が過ぎた後も、ユーザーは定期購入にアクセスできる可能性があります。lineItems.expiry_time を使用して、ユーザーがまだアクセスできるかどうかを判断します。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

CancelSurveyResult

ユーザーが定期購入を解約したときの解約アンケートの結果。

JSON 表現
{
  "reason": enum (CancelSurveyReason),
  "reasonUserInput": string
}
フィールド
reason

enum (CancelSurveyReason)

ユーザーが解約のアンケートで選択した理由。

reasonUserInput

string

CANCEL_SURVEY_REASON_OTHERS の場合にのみ設定されます。アンケートに対するユーザーの自由形式の回答です。

CancelSurveyReason

ユーザーが解約のアンケートで選択した理由。

列挙型
CANCEL_SURVEY_REASON_UNSPECIFIED アンケートのキャンセル理由が指定されていません。
CANCEL_SURVEY_REASON_NOT_ENOUGH_USAGE サブスクリプションの使用率が十分ではありません。
CANCEL_SURVEY_REASON_TECHNICAL_ISSUES アプリの使用中に発生した技術的な問題。
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

string

サードパーティ サービスのユーザー アカウント ID。アカウントのリンクが定期購入の購入フローの一環として行われた場合にのみ表示されます。

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 を使用して指定した場合にのみ存在します。

SubscribeWithGoogleInfo

「Google で購読」での購入に関する情報。

JSON 表現
{
  "profileId": string,
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string
}
フィールド
profileId

string

定期購入の購入時のユーザーの Google プロフィール ID。

profileName

string

定期購入の購入時のユーザーのプロフィール名。

emailAddress

string

定期購入の購入時のユーザーのメールアドレス。

givenName

string

定期購入の購入時のユーザーの名。

familyName

string

定期購入を購入したユーザーの姓。

SubscriptionPurchaseLineItem

定期購入に関するアイテム単位の情報。

JSON 表現
{
  "productId": string,
  "expiryTime": string,

  // Union field plan_type can be only one of the following:
  "autoRenewingPlan": {
    object (AutoRenewingPlan)
  },
  "prepaidPlan": {
    object (PrepaidPlan)
  }
  // End of list of possible types for union field plan_type.
  "offerDetails": {
    object (OfferDetails)
  },

  // Union field deferred_item_change can be only one of the following:
  "deferredItemReplacement": {
    object (DeferredItemReplacement)
  }
  // End of list of possible types for union field deferred_item_change.
}
フィールド
productId

string

購入した商品 ID(例:monthly001)。

expiryTime

string (Timestamp format)

定期購入の有効期限が切れた時点、またはアクセス権の延長(更新など)を行わない限り有効期限が切れる日時。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

共用体フィールド plan_type。定期購入プランのタイプ。plan_type は次のいずれかになります。
autoRenewingPlan

object (AutoRenewingPlan)

この商品は自動更新されます。

prepaidPlan

object (PrepaidPlan)

このアイテムは前払いです。

offerDetails

object (OfferDetails)

このアイテムのオファーの詳細。

共用体フィールド deferred_item_change。アイテムに遅延変更がある場合、このフィールドが存在します。削除することも、置き換えることもできます。deferred_item_change は次のいずれかになります。
deferredItemReplacement

object (DeferredItemReplacement)

商品の交換の遅延に関する情報。

AutoRenewingPlan

自動更新プランに関する情報。

JSON 表現
{
  "autoRenewEnabled": boolean,
  "priceChangeDetails": {
    object (SubscriptionItemPriceChangeDetails)
  }
}
フィールド
autoRenewEnabled

boolean

定期購入が現在自動更新に設定されている場合(ユーザーが定期購入を解約していない場合など)

priceChangeDetails

object (SubscriptionItemPriceChangeDetails)

購読申し込み以降の、アイテムの最新価格変更の情報。

SubscriptionItemPriceChangeDetails

定期購入アイテムの価格変更に関する情報。

JSON 表現
{
  "newPrice": {
    object (Money)
  },
  "priceChangeMode": enum (PriceChangeMode),
  "priceChangeState": enum (PriceChangeState),
  "expectedNewPriceChargeTime": string
}
フィールド
newPrice

object (Money)

定期購入アイテムの新しい価格です。

priceChangeMode

enum (PriceChangeMode)

価格変更モードでは、定期購入の商品アイテムの価格の変更方法を指定します。

priceChangeState

enum (PriceChangeState)

価格変更が現在行われていることを伝える。

expectedNewPriceChargeTime

string (Timestamp format)

価格変更がユーザーに有効になる更新日時。一時停止など、更新のタイミングが変わった場合は、(今後さらに変更されることもあります)可能性があります。このフィールドに値が入力されるのは、価格変更が有効になっていない場合のみです。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

PriceChangeMode

価格変更のモード。

列挙型
PRICE_CHANGE_MODE_UNSPECIFIED 価格変更モードが指定されていません。この値は設定しないでください。
PRICE_DECREASE 定期購入料金が下がっている場合。
PRICE_INCREASE 定期購入料金が引き上げられ、お客様が同意する必要がある場合。
OPT_OUT_PRICE_INCREASE オプトアウト モードによってサブスクリプション料金が引き上げられる場合。

PriceChangeState

価格変更の状態です。

列挙型
PRICE_CHANGE_STATE_UNSPECIFIED 価格変更ステータスが指定されていません。この値は使用しないでください。
OUTSTANDING 価格変更に対するお客様の同意を待っています。
CONFIRMED 料金の変更がユーザーに適用されることを確認します。
APPLIED 価格の変更が適用されます。つまり、ユーザーへの新しい価格の請求が開始されます。

PrepaidPlan

プリペイド プランに関する情報。

JSON 表現
{
  "allowExtendAfterTime": string
}
フィールド
allowExtendAfterTime

string (Timestamp format)

存在する場合は、この時刻を過ぎてからプリペイド プランでチャージの購入が許可されます。期限切れのプリペイド プランには表示されません。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

OfferDetails

購入項目に関連するオファーの詳細情報。

JSON 表現
{
  "offerTags": [
    string
  ],
  "basePlanId": string,
  "offerId": string
}
フィールド
offerTags[]

string

クーポンに関連付けられている最新のクーポンタグ。基本プランから継承されたタグも含まれます。

basePlanId

string

基本プラン ID。すべての基本プランと特典に存在します。

offerId

string

特典 ID。割引特典にのみ存在します。

DeferredItemReplacement

延期された商品の交換に関する情報。

JSON 表現
{
  "productId": string
}
フィールド
productId

string

既存の productId を置き換える productId。

Methods

get

定期購入に関するメタデータを取得する

revoke

ユーザーの定期購入を取り消します。