REST Resource: monetization.subscriptions

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

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

1 つのアプリのための 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)

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

boolean

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

object (SubscriptionTaxAndComplianceSettings)

税金と法律の遵守に関する詳細

基本プラン

定期購入向けの 1 つの基本プラン。

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 個）の apks.list。この基本プランの定期購入の特典は、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（0 日）、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 再度定期購入できません。

サブスクリプション比モード

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

列挙型
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 延長が無効です。前払いプランへのチャージや延長はできません。

リージョン ベースプラン構成

リージョン固有の基本プランの構成。

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

string

必須。この設定が適用される地域コード。ISO 3166-2 で定義されています（例: US"）。
newSubscriberAvailability

boolean

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

object (Money)

指定した地域の基本プランの価格。基本プランを新しい定期購入者が利用できる場合は、設定する必要があります。指定された地域に関連付けられている通貨で設定する必要があります。

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

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

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