REST Resource: monetization.subscriptions

リソースのサブスクリプション

1 つのアプリで単一のサブスクリプション。

JSON 表現 
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  }
}
フィールド
packageName

string

不変。親アプリのパッケージ名。
productId

string

不変。商品の一意の商品 ID。親アプリ内で固有です。プロダクト ID は、英小文字（a ～ z）、数字（0 ～ 9）、アンダースコア（_）、ピリオド（.）のみで構成されます。先頭は英小文字または数字にして、1 ～ 40 文字で指定してください。
basePlans[]

object (BasePlan)

この定期購入の基本プランのセット。定期購入の他の料金が適用されない場合の料金と期間を表します。
listings[]

object (SubscriptionListing)

必須。このサブスクリプションのローカライズされたリスティングのリスト。親アプリのデフォルト言語のエントリを少なくとも 1 つ含める必要があります。
archived

boolean

出力のみ。このサブスクリプションがアーカイブされているかどうか。アーカイブされたサブスクリプションは、どのサブスクライバーも使用できなくなり、更新できなくなります。また、アーカイブされた表示フラグが渡されない限り、リスト リクエストで返されることはありません。
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

税金と法令遵守の詳細

基本プラン

定期購入の基本プランです。

JSON 表現 
{
  "basePlanId": string,
  "state": enum (State),
  "regionalConfigs": [
    {
      object (RegionalBasePlanConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsBasePlanConfig)
  },

  // Union field base_plan_type can be only one of the following:
  "autoRenewingBasePlanType": {
    object (AutoRenewingBasePlanType)
  },
  "prepaidBasePlanType": {
    object (PrepaidBasePlanType)
  }
  // End of list of possible types for union field base_plan_type.
}
フィールド
basePlanId

string

必須。不変。この基本プランの一意の識別子。サブスクリプション内で一意で、RFC-1034 に準拠している必要があります。つまり、この ID に使用できる文字は、小文字（a ～ z）、数字（0 ～ 9）、ハイフン（-）のみです。63 文字以下で指定してください。
state

enum (State)

出力のみ。基本プランの状態（有効かどうか）。下書きの基本プランと無効な基本プランは、有効化または削除が可能です。アクティブな基本プランは、無効にすることもできます。無効な基本プランは解約できます。このフィールドは、リソースを更新して変更することはできません。代わりに専用エンドポイントを使用してください。
regionalConfigs[]

object (RegionalBasePlanConfig)

この基本プランの地域固有の情報。
offerTags[]

object (OfferTag)

この基本プランに指定され、Billing Library を介してアプリに返されるカスタムタグ（最大 20 個）のリスト。この基本プランの定期購入の特典も、Billing Library で受け取ります。
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Play で今後リリースされる地域についても料金情報をご確認いただけます。省略した場合、BasePlan は、今後 Play でリリースする新しい地域を自動的に利用できなくなります。
共用体フィールド base_plan_type。この基本プランのタイプ。正確に 1 つ設定する必要があります。base_plan_type は次のいずれかになります。
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

基本プランが一定の間隔で自動的に更新されます。
prepaidBasePlanType

object (PrepaidBasePlanType)

請求対象期間の終了時に基本プランが自動更新されない期間を設定します。

State

基本プランの現在の状態。

列挙型
STATE_UNSPECIFIED 未指定の状態
DRAFT 基本プランは現在下書きの状態にあり、有効化されていません。この時点で安全に削除できます。
ACTIVE 基本プランは有効で、新規の定期購入ユーザーにご利用いただけます。
INACTIVE 基本プランは無効で、既存の定期購入者のみご利用いただけます。

自動更新の基本プランタイプ

定期購入期間の終了時に自動的に更新される基本プランを表します。

JSON 表現 
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}
フィールド
billingPeriodDuration

string

必須。定期購入期間（ISO 8601 形式）。利用可能な請求対象期間のリストについては、ヘルプセンターをご覧ください。
gracePeriodDuration

string

定期購入の猶予期間（ISO 8601 形式で指定します）。有効な値は、P0D（ゼロ日）、P3D（3 日）、P7D（7 日）、P14D（14 日）、P30D（30 日）です。指定しない場合は、定期的な期間に基づいてデフォルト値が使用されます。
resubscribeState

enum (ResubscribeState)

ユーザーが Google Play サーフェスでこの基本プランを再度定期購入できるようにするかどうかを指定します。指定しない場合のデフォルトは RESUBSCRIBE_STATE_ACTIVE です。
prorationMode

enum (SubscriptionProrationMode)

基本プランの比例配分モードにより、ユーザーが別の基本プランからこのプランに切り替えたときの動作が決まります。指定しない場合、デフォルトは CHARGE_ON_NEXT_BILLING_DATE です。
legacyCompatible

boolean

更新の基本プランに下位互換性があるかどうか。

下位互換性のある基本プランは、Google Play Billing Library のサポート終了メソッド querySkuDetailsAsync() から返されます。

以前の定期購入に対応しているとマークできるのは、1 つの更新の基本プランのみです。
legacyCompatibleSubscriptionOfferId

string

以前の対応のある定期購入オファー ID。

下位互換性のある定期購入の特典は、Google Play Billing Library のサポート終了メソッド querySkuDetailsAsync() から返されます。

以前の対応として指定できる更新特典は、1 つの更新の基本プランのみです。

以前の対応と一致する定期購入商品がない場合は、このフィールドを空の文字列に設定します。

再度定期購入状態

基本プランの再登録ステータス。

列挙型
RESUBSCRIBE_STATE_UNSPECIFIED 未指定の状態
RESUBSCRIBE_STATE_ACTIVE 再度定期購入しました。
RESUBSCRIBE_STATE_INACTIVE 再度定期購入は無効です。

SubscriptionProrationMode

基本プランの更新に使用される比例配分モード。

列挙型
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED 不明なモード。
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE ユーザーへの新しい基本プランの請求は、現在の請求対象期間が終了した時点で行われます。
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY ユーザーには新しい基本プランの全額がすぐに請求されます。既存のサブスクリプションの残り期間に基づいて、新しいお支払いプランの期間が延長されます。

前払いの基本プランのタイプ

基本プランの終了時に自動更新されない基本プランです。ユーザーが手動で更新する必要があります。

JSON 表現 
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
フィールド
billingPeriodDuration

string

必須。定期購入期間（ISO 8601 形式）。利用可能な請求対象期間のリストについては、ヘルプセンターをご覧ください。
timeExtension

enum (TimeExtension)

ユーザーがこのプリペイド基本プランを Google Play サーフェスで延長できるかどうか。指定しない場合、デフォルトは TIME_EXTENSION_ACTIVE です。

期間の延長

基本プランの期間延長。

列挙型
TIME_EXTENSION_UNSPECIFIED 未指定の状態
TIME_EXTENSION_ACTIVE 期間の延長が有効です。ユーザーはプリペイド プランにチャージしたり、延長したりできます。
TIME_EXTENSION_INACTIVE 延長期間が無効です。プリペイド プランへのチャージや延長はできません。

リージョン BasePlanConfig

地域に固有の基本プランの設定。

JSON 表現 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}
フィールド
regionCode

string

必須。この設定が適用される地域コード。例: ISO 3166-2（「US」など）。
newSubscriberAvailability

boolean

新しい定期購入ユーザーが指定した地域の基本プランを利用できるかどうか。この値を false に設定した場合、既存の定期購入は解約されません。指定しない場合、デフォルトで false になります。
price

object (Money)

指定したリージョンの基本プランの価格。新規定期購入ユーザーが基本プランを利用できる場合は、設定する必要があります。指定されたリージョンにリンクされている通貨で設定する必要があります。

その他の地域の基本プラン設定

Google Play で新たにリリースできる地域すべての価格情報です。

JSON 表現 
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "newSubscriberAvailability": boolean
}
フィールド
usdPrice

object (Money)

必須。Play がリリースされる可能性のある新しい地域での価格（米ドル）。
eurPrice

object (Money)

必須。Play がリリースする可能性のある新しい地域でのユーロの価格。
newSubscriberAvailability

boolean

Play がリリースされる新しい地域で、新規の定期購入ユーザーに基本プランを利用できるかどうか。指定しない場合、デフォルトで false になります。

サブスクリプションのリスティング

消費者に表示される、サブスクリプションのメタデータ。

JSON 表現 
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
フィールド
languageCode

string

必須。BCP-47 で定義されているこのリスティングの言語（例: 「en-US」）。
title

string

必須。この定期購入のタイトル（このリスティングの言語）。書式なしテキスト。
benefits[]

string

Play ストアなどのプラットフォームでユーザーに提供されるメリットのリストと、このリスティングの言語における復元フロー。書式なしテキスト。 最大 4 つの特典の順序付きリスト。
description

string

このリスティングの説明（このリスティングの言語を使用）。最大文字数 - 80 文字。書式なしテキスト。

Methods

archive

 サブスクリプションをアーカイブします。

create

 新しいサブスクリプションを作成します。

delete

 サブスクリプションを削除します。

get

 単一のサブスクリプションを読み取ります。

list

 特定のアプリのすべてのサブスクリプションを一覧表示します。

patch

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