REST Resource: purchases.subscriptionsv2

リソース: SubscriptionPurchaseV2

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

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

string

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

regionCode

string

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

lineItems[]

object (SubscriptionPurchaseLineItem)

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

startTime

string (Timestamp format)

定期購入が承認された日時。保留中の定期購入(作成されて登録時の支払い待ちの状態)には設定されません。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

subscriptionState

enum (SubscriptionState)

定期購入の現在の状態。

linkedPurchaseToken

string

次の場合、過去の定期購入の購入トークン。* 解約したが失効していない定期購入の再登録。* 以前の定期購入からのアップグレードまたはダウングレード。* 定期購入を前払いから自動更新に切り替える場合。* 定期購入を自動更新から前払いに切り替える場合。* 前払いの定期購入のチャージ。

pausedStateContext

object (PausedStateContext)

一時停止された定期購入に関する追加コンテキスト。subscriptionState が SUBSCRIPTION_STATE_PAUSED になっている定期購入の場合にのみ存在します。

canceledStateContext

object (CanceledStateContext)

解約された定期購入に関する追加コンテキスト。subscriptionState が SUBSCRIPTION_STATE_CANCELED または SUBSCRIPTION_STATE_EXPIRED になっている定期購入の場合にのみ存在します。

testPurchase

object (TestPurchase)

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

acknowledgementState

enum (AcknowledgementState)

定期購入の承認状態。

externalAccountIdentifiers

object (ExternalAccountIdentifiers)

サードパーティ サービス内のユーザー アカウントの識別子。

subscribeWithGoogleInfo

object (SubscribeWithGoogleInfo)

「Google で購読」での購入に関連付けられたユーザー プロファイル。

etag

string

定期購入の現在の状態を表すエンティティ タグ。デベロッパーが定期購入アクションの Etag を提供します。自動更新および前払いによる定期購入には、この Etag が必ず存在します。

outOfAppPurchaseContext

object (OutOfAppPurchaseContext)

アプリ外で行われた購入に関する追加コンテキスト。この情報は、Google Play 定期購入センターを通じて行われた定期購入の再登録(同じプロダクトの以前の定期購入が期限切れになった後に登録された定期購入)の場合にのみ表示されます。このフィールドは、定期購入を承認すると削除されます。

onHoldStateContext

object (OnHoldStateContext)

省略可。ON_HOLD 状態の定期購入に関する追加コンテキスト。subscriptionState が SUBSCRIPTION_STATE_ON_HOLD になっている定期購入の場合にのみ存在します。

inGracePeriodStateContext

object (InGracePeriodStateContext)

省略可。IN_GRACE_PERIOD 状態の定期購入に関する追加コンテキスト。subscriptionState が SUBSCRIPTION_STATE_IN_GRACE_PERIOD になっている定期購入の場合にのみ存在します。

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 が過去の時点になっています。
SUBSCRIPTION_STATE_PENDING_PURCHASE_CANCELED 定期購入の保留中の取引がキャンセルされました。この保留中の購入が既存の定期購入のものである場合、linkedPurchaseToken を使用して、その定期購入の現在の状態を取得します。

PausedStateContext

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

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

string (Timestamp format)

定期購入が自動再開される日時。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

CanceledStateContext

SUBSCRIPTION_STATE_CANCELED または SUBSCRIPTION_STATE_EXPIRED 状態の定期購入に固有の情報。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userInitiatedCancellation": {
    object (UserInitiatedCancellation)
  },
  "systemInitiatedCancellation": {
    object (SystemInitiatedCancellation)
  },
  "developerInitiatedCancellation": {
    object (DeveloperInitiatedCancellation)
  },
  "replacementCancellation": {
    object (ReplacementCancellation)
  }
  // End of mutually exclusive fields.
}
フィールド
定期購入が解約された理由。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
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 に基づいて判断されます。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

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

サードパーティ サービス内のユーザー アカウントの識別子。

JSON 表現
{
  "externalAccountId": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
フィールド
externalAccountId

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

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,
  "developerTargetedOffers": [
    {
      object (DeveloperTargetedOffer)
    }
  ],
  "latestSuccessfulOrderId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "autoRenewingPlan": {
    object (AutoRenewingPlan)
  },
  "prepaidPlan": {
    object (PrepaidPlan)
  }
  // End of mutually exclusive fields.
  "offerDetails": {
    object (OfferDetails)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "deferredItemReplacement": {
    object (DeferredItemReplacement)
  },
  "deferredItemRemoval": {
    object (DeferredItemRemoval)
  }
  // End of mutually exclusive fields.
  "signupPromotion": {
    object (SignupPromotion)
  },
  "itemReplacement": {
    object (ItemReplacement)
  },
  "offerPhase": {
    object (OfferPhase)
  }
}
フィールド
productId

string

購入したアイテムの ID(例: 「monthly001」)。

expiryTime

string (Timestamp format)

定期購入の期限が切れた日時、またはアクセスが延長されない限り(例: 更新)定期購入の期限が切れる予定の日時。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

developerTargetedOffers[]

object (DeveloperTargetedOffer)

省略可。この広告申込情報に登録されているデベロッパー向け特典の詳細。

latestSuccessfulOrderId

string

このアイテムに関連付けられた最新の正常な注文のオーダー ID。アイテムがまだユーザーによって所有されていない場合(例: アイテムが遅延交換されている場合)は存在しません。

定期購入プランのタイプ。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
autoRenewingPlan

object (AutoRenewingPlan)

アイテムは自動更新します。

prepaidPlan

object (PrepaidPlan)

アイテムは前払いです。

相互に排他的なフィールドの終了。
offerDetails

object (OfferDetails)

このアイテムの特典詳細。

このフィールドは、アイテムの変更が保留されている場合に存在します。削除または置き換えのいずれかです。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
deferredItemReplacement

object (DeferredItemReplacement)

保留されているアイテム置き換えの情報。

deferredItemRemoval

object (DeferredItemRemoval)

保留されているアイテム削除の情報。

相互に排他的なフィールドの終了。
signupPromotion

object (SignupPromotion)

このアイテムのプロモーションの詳細。登録時にプロモーションが適用された場合にのみ設定します。

itemReplacement

object (ItemReplacement)

交換対象のアイテムの詳細。このフィールドは、このアイテムが以前の定期購入で別のアイテムに置き換えられた場合にのみ入力され、購入時から 60 日間のみ利用できます。

offerPhase

object (OfferPhase)

このアイテムの現在の特典フェーズの詳細。

AutoRenewingPlan

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

JSON 表現
{
  "autoRenewEnabled": boolean,
  "recurringPrice": {
    object (Money)
  },
  "priceChangeDetails": {
    object (SubscriptionItemPriceChangeDetails)
  },
  "installmentDetails": {
    object (InstallmentPlan)
  },
  "planTransitionDetails": {
    object (PlanTransitionDetails)
  },
  "priceStepUpConsentDetails": {
    object (PriceStepUpConsentDetails)
  }
}
フィールド
autoRenewEnabled

boolean

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

recurringPrice

object (Money)

自動更新プランの現在の定期購入価格。なお、この料金には割引は適用されておらず、税金は含まれていません。税抜価格の場合、取引明細が必要な場合は、代わりに orders.get API を呼び出してください。

priceChangeDetails

object (SubscriptionItemPriceChangeDetails)

定期購入の登録以降に行われた、アイテムに対する最新の価格変更の情報。

installmentDetails

object (InstallmentPlan)

自動更新プランの分割払いプランの契約および状態に関する情報。

planTransitionDetails

object (PlanTransitionDetails)

関連付けられたプラン移行の情報。このプランに関連付けられた移行プランがある場合にのみ存在します。含まれているのは、アイテムに関連付けられた最新の移行詳細のみです。

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)

価格変更がユーザーに対して有効になる更新日時。一時停止などにより更新日時がずれる場合は、さらに先の日時に変更されます。このフィールドは、価格変更がまだ有効になっていない場合にのみ入力されます。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

PriceChangeMode

価格変更のモード。

列挙型
PRICE_CHANGE_MODE_UNSPECIFIED 価格変更モード未指定。この値は決して設定しないでください。
PRICE_DECREASE 定期購入価格が下がる場合。
PRICE_INCREASE 定期購入価格が上がり、ユーザーが同意する必要がある場合。
OPT_OUT_PRICE_INCREASE 定期購入価格が上がり、オプトアウト モードになっている場合。

PriceChangeState

価格変更の状態。

列挙型
PRICE_CHANGE_STATE_UNSPECIFIED 価格変更状態未指定。この値は使用されるべきではありません。
OUTSTANDING ユーザーによる価格変更への同意を待っています。
CONFIRMED ユーザーに対する価格変更の実施が確定しました。
APPLIED 価格変更が適用され、ユーザーには新しい価格で請求されます。
CANCELED 料金の変更がキャンセルされました。

InstallmentPlan

分割払いプランについての情報。

JSON 表現
{
  "initialCommittedPaymentsCount": integer,
  "subsequentCommittedPaymentsCount": integer,
  "remainingCommittedPaymentsCount": integer,
  "pendingCancellation": {
    object (PendingCancellation)
  }
}
フィールド
initialCommittedPaymentsCount

integer

ユーザーが最初に契約した合計支払い回数。

subsequentCommittedPaymentsCount

integer

各契約期間後にユーザーが契約する合計支払い回数。空欄の場合、最初の契約後に分割払いプランは通常の自動更新定期購入に切り替わります。

remainingCommittedPaymentsCount

integer

この更新サイクル内で契約した支払い回数のうち残っている回数。

pendingCancellation

object (PendingCancellation)

存在する場合、この分割払いプランは解約保留中です。契約されているすべての支払いをユーザーが完了した場合にのみ解約が実施されます。

PendingCancellation

この型にはフィールドがありません。

仮想分割払いプランに保留中の解約があるかどうかの指標です。契約されているすべての支払いをユーザーが完了した場合にのみ解約が実施されます。

PlanTransitionDetails

プラン移行に関連する情報。

JSON 表現
{
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "transitionInfo": {
    object (TransitionInfo)
  }
}
フィールド
productId

string

[必須] このプランが移行するプロダクト ID(例: 「monthly001」)。

basePlanId

string

[必須] このプランが移行した後の基本プラン ID。

offerId

string

オファー ID。割引特典に対してのみ存在します。これは、ターゲット プランが基本プランでない場合にのみ設定されます。

transitionInfo

object (TransitionInfo)

スケジュール済みのプラン移行についての追加情報。プラン移行がスケジュールされている場合にのみ存在します。

TransitionInfo

スケジュール済みのプラン移行に関連する情報。

JSON 表現
{
  "transitionState": enum (TransitionState),
  "price": {
    object (Money)
  },
  "expectedTransitionTime": string
}
フィールド
transitionState

enum (TransitionState)

出力専用。[必須] 移行の現在の状態。

price

object (Money)

プランが移行された後のデフォルトの基本プラン価格。

expectedTransitionTime

string (Timestamp format)

現時点でプランが移行される予定の日時。定期購入の一時停止やアカウントの一時停止などにより更新日時がずれる場合は、さらに先の日時に変更されます。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

TransitionState

移行が取る可能性のある状態。

列挙型
TRANSITION_STATE_UNSPECIFIED 移行状態未指定。
SCHEDULED 移行の開始は将来にスケジュールされています。
IN_PROGRESS 移行プロセスが開始し、最初の移行通知がユーザーに送信されました。
COMPLETED 移行が完了しました。
CANCELED 移行はキャンセルされました。

PriceStepUpConsentDetails

ユーザーの同意が必要な料金の引き上げに関する情報。

JSON 表現
{
  "state": enum (ConsentState),
  "consentDeadlineTime": string,
  "newPrice": {
    object (Money)
  }
}
フィールド
state

enum (ConsentState)

出力専用。価格引き上げの同意ステータス。

consentDeadlineTime

string (Timestamp format)

ユーザーが同意する必要がある期限。この期限までに同意が得られなかった場合、定期購入は解約されます。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

newPrice

object (Money)

ユーザーの同意が必要な新しい価格。

ConsentState

価格引き上げの同意ステータス。

列挙型
CONSENT_STATE_UNSPECIFIED 同意ステータスが指定されていません。
PENDING ユーザーがまだ同意していない。
CONFIRMED ユーザーが同意し、新しい価格が有効になるのを待っています。
COMPLETED ユーザーが同意し、新しい価格が有効になりました。

PrepaidPlan

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

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

string (Timestamp format)

存在する場合、この日時より後にプリペイド プランのチャージ購入が可能になります。プリペイド プランの期限が切れている場合は存在しません。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

OfferDetails

購入項目に関する特典の詳細情報。

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

string

特典に関連付けられた最新の特典タグ。基本プランから継承されたタグを含みます。

basePlanId

string

基本プラン ID。すべての基本プランおよび特典に対して存在します。

offerId

string

オファー ID。割引特典に対してのみ存在します。

DeferredItemReplacement

保留されているアイテム置き換えに関する情報。

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

string

既存の productId に置き換わる productId。

DeferredItemRemoval

この型にはフィールドがありません。

保留されているアイテム置き換えに関する情報。

SignupPromotion

購入時にこの商品アイテムに適用されたプロモーション。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "oneTimeCode": {
    object (OneTimeCode)
  },
  "vanityCode": {
    object (VanityCode)
  }
  // End of mutually exclusive fields.
}
フィールド
商品アイテムに適用されたプロモーションのタイプ。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
oneTimeCode

object (OneTimeCode)

1 回限りのコードが適用されました。

vanityCode

object (VanityCode)

バニティコードが適用された。

相互に排他的なフィールドの終了。

OneTimeCode

この型にはフィールドがありません。

1 回限りのプロモーション コード。

VanityCode

複数回使用できる、事前定義されたプロモーション コード。

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

string

プロモーション コード。

ItemReplacement

置き換えられる定期購入明細項目の詳細。

JSON 表現
{
  "productId": string,
  "replacementMode": enum (ReplacementMode),
  "basePlanId": string,
  "offerId": string
}
フィールド
productId

string

置き換えられる定期購入の広告申込情報のプロダクト ID。

replacementMode

enum (ReplacementMode)

購入時に適用された交換モード。

basePlanId

string

置き換えられる定期購入の広告申込情報の基本プラン ID。

offerId

string

置き換えられるサブスクリプションの広告申込情報のオファー ID(該当する場合)。

ReplacementMode

定期購入の交換モード。

列挙型
REPLACEMENT_MODE_UNSPECIFIED 交換モードが指定されていません。
WITH_TIME_PRORATION 新しいプランは日割り計算され、古いプランからクレジットが適用されます。
CHARGE_PRORATED_PRICE ユーザーには、新しいプランの日割り計算された料金が請求されます。
WITHOUT_PRORATION 新しいプランは、期間を日割り計算することなく、古いプランに置き換わります。
CHARGE_FULL_PRICE お客様には、新しいプランの価格の全額が請求されます。
DEFERRED 古いプランは解約され、古いプランの有効期限が切れた後に新しいプランが有効になります。
KEEP_EXISTING この交換によってプランが変更されることはありません。

OfferPhase

特典フェーズの詳細。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "prorationPeriod": {
    object (ProrationPeriodOfferPhase)
  },
  "freeTrial": {
    object (FreeTrialOfferPhase)
  },
  "introductoryPrice": {
    object (IntroductoryPriceOfferPhase)
  },
  "basePrice": {
    object (BasePriceOfferPhase)
  }
  // End of mutually exclusive fields.
}
フィールド
特典フェーズの詳細。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
prorationPeriod

object (ProrationPeriodOfferPhase)

特典フェーズが日割り計算期間の場合に設定します。

freeTrial

object (FreeTrialOfferPhase)

特典フェーズが無料トライアルの場合に設定します。

introductoryPrice

object (IntroductoryPriceOfferPhase)

特典フェーズがお試し価格の特典フェーズである場合に設定します。

basePrice

object (BasePriceOfferPhase)

特典フェーズが基本プランの価格フェーズである場合に設定します。

相互に排他的なフィールドの終了。

ProrationPeriodOfferPhase

日割り計算期間の特典フェーズの詳細。

JSON 表現
{
  "originalOfferPhaseType": enum (OriginalOfferPhaseType)
}
フィールド
originalOfferPhaseType

enum (OriginalOfferPhaseType)

日割り計算期間前の元の特典フェーズのタイプ。既存の特典フェーズから比例配分期間が更新された場合にのみ設定されます。

OriginalOfferPhaseType

特典の支払いが日割り計算による支払いの場合、特典の支払いの元の特典フェーズ。

列挙型
ORIGINAL_OFFER_PHASE_TYPE_UNSPECIFIED 未指定の元の特典フェーズタイプ。
BASE 定期購入が基本価格フェーズ(正規料金など)である。
INTRODUCTORY 定期購入がお試し価格期間中である。
FREE_TRIAL サブスクリプションが無料試用期間中である。

FreeTrialOfferPhase

この型にはフィールドがありません。

無料トライアル特典フェーズの詳細。

IntroductoryPriceOfferPhase

この型にはフィールドがありません。

お試し価格の特典フェーズに関する詳細。

BasePriceOfferPhase

この型にはフィールドがありません。

基本価格の提案フェーズの詳細。

DeveloperTargetedOffer

定期購入の広告申込情報に関するデベロッパー向けの特典の情報。

JSON 表現
{
  "offerId": string,
  "activateTime": string
}
フィールド
offerId

string

省略可。定期購入を対象とする、デベロッパーが作成したオファー ID。

activateTime

string (Timestamp format)

省略可。オファー ターゲティングが有効になった時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

OutOfAppPurchaseContext

アプリ外で行われた購入に固有の情報。

JSON 表現
{
  "expiredExternalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "expiredPurchaseToken": string
}
フィールド
expiredExternalAccountIdentifiers

object (ExternalAccountIdentifiers)

この SKU の最後に期限切れになった定期購入のユーザー アカウント ID。

expiredPurchaseToken

string

最後に期限切れになった定期購入の購入トークン。この購入トークンは、purchaseToken とユーザーのリンクがデータベースに保存されている場合に、ユーザーを識別するためにのみ使用する必要があります。有効期限が切れてから 60 日以上経過している場合、Google Developer API の呼び出しには使用できません。

OnHoldStateContext

ON_HOLD 状態の定期購入に関する追加コンテキスト。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "renewalDeclined": {
    object (RenewalDeclinedContext)
  }
  // End of mutually exclusive fields.
}
フィールド
定期購入が ON_HOLD 状態になっている理由。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
renewalDeclined

object (RenewalDeclinedContext)

省略可。更新のお支払いが承認されませんでした。

相互に排他的なフィールドの終了。

RenewalDeclinedContext

更新が不承認となったシナリオに関連するコンテキスト。

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

string

必須。この状態の原因となっている保留中または失敗した注文の ID。

InGracePeriodStateContext

IN_GRACE_PERIOD 状態の定期購入に関する追加コンテキスト。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "renewalDeclined": {
    object (RenewalDeclinedContext)
  }
  // End of mutually exclusive fields.
}
フィールド
定期購入が IN_GRACE_PERIOD 状態になっている理由。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
renewalDeclined

object (RenewalDeclinedContext)

省略可。更新のお支払いが承認されませんでした。

相互に排他的なフィールドの終了。

メソッド

activateoffertargeting

特定の特典のターゲティングを有効にします。

cancel

ユーザーの定期購入を解約します。

cancelplantransition

定期購入のプラン移行をキャンセルします。

deactivateoffertargeting

特定の特典のターゲティングを無効にします。

defer

定期購入の更新を延期します。

get

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

revoke

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

scheduleplantransition

定期購入のプラン移行スケジュールを設定します。

エラーコード

このリソースのオペレーションは、次の HTTP エラーコードを返します。

エラーコード 理由 説明 解決策
400 / 410 subscriptionExpired サブスクリプションの有効期限が切れているため、リクエストされたオペレーションを実行できません。 サブスクリプションの有効期限を確認します。この操作は、期限切れのサブスクリプションでは許可されていません。
400 subscriptionInvalidArgument サブスクリプションのリクエストに無効な引数が指定されました。 API ドキュメントを確認し、必要なフィールドがすべて指定され、正しくフォーマットされていることを確認します。
400 invalidPurchaseState 購入が、リクエストされたオペレーションを実行できる状態ではありません。たとえば、すでに消費された購入を承認しようとしている場合や、有効でない定期購入を解約しようとしている場合などです。 オペレーションを試行する前に、対応する Get API を使用してリソースの現在の状態を確認してください。リソースがアクションに適した状態であることを確認します。
400 invalidValue リクエストに無効な値が指定されました。これは多くの場合、形式が正しくないか無効な購入トークンに対して返されます。 API リファレンスに基づいて、リクエスト本文またはパラメータの無効なフィールド値を修正します。
400 prepaidSubscriptionNotSupported リクエストされたオペレーションは、プリペイド定期購入ではサポートされていません。 オペレーションがサブスクリプション タイプに適用可能であることを確認します。このエラーは、Cancel などのメソッドに固有のものです。
400 productNotOwnedByUser 指定された購入トークンは有効ですが、ユーザーは現在そのアイテムを所有していません。これは、承認前に購入が払い戻し、取り消し、または期限切れになった場合に発生することがあります。 オペレーションを試行する前に、対応する Get API を使用してリソースの現在の状態を確認してください。リソースがアクションに適した状態であることを確認します。
400 purchaseTokenMismatch 指定された購入トークンが、購入、パッケージ名、定期購入 ID、商品 ID と一致しません。 リクエストの詳細がすべて正しく、相互に対応していることを確認します。
400 required リクエストに必須のフィールドまたはパラメータがありません。 API ドキュメントを参照して、すべての必須フィールドとパラメータが含まれていることを確認します。
400 unsupportedIabType 指定されたアプリ内課金タイプでは、このオペレーションはサポートされていません。 API メソッドが、管理対象のアイテムタイプと互換性があることを確認します。
403 userInsufficientPermission リクエストされたオペレーションを実行するための十分な権限がユーザーにありません。 認証済みユーザーに Google Play Console で必要な権限が付与されていることを確認します。詳細については、サービス アカウントの使用をご覧ください。
404 notFound リクエストされたリソースは見つかりませんでした。 ID(購入トークン、パッケージ名、商品 ID、定期購入 ID など)が正しいことを確認します。
409 concurrentUpdate 同時に更新されているオブジェクトを更新しようとしました。 指数バックオフを使用してリクエストを再試行します。同じリソースを同時に変更しないようにします。
410 purchaseTokenNoLongerValid 関連付けられているユーザー アカウントが削除されたか、購入レコードが存在しないため、購入トークンは完全に無効です。 この購入トークンの使用を中止します。
410 subscriptionNoLongerAvailable 定期購入の有効期限が切れてから長期間が経過しているため、クエリできなくなりました。 このエラーは、サブスクリプションの有効期限が切れてから 60 日以上経過していることを示します。これらのサブスクリプションに対してクエリを実行しないでください。
5xx Generic error Google Play サーバーの一般的なエラー。 リクエストを再試行します。

問題が解決しない場合は、Google Play アカウント マネージャーにお問い合わせいただくか、サポート リクエストを送信してください。Google Play ステータス ダッシュボードで既知のサービス停止がないか確認することをおすすめします。