このページは Cloud Translation API によって翻訳されました。

REST Resource: monetization.subscriptions

リソースのサブスクリプション
- JSON 表現
BasePlan <ph type="x-smartling-placeholder">
- JSON 表現
州名
AutoRenewingBasePlanType <ph type="x-smartling-placeholder">
- JSON 表現
ResubscribeState
SubscriptionProrationMode
PrepaidBasePlanType <ph type="x-smartling-placeholder">
- JSON 表現
TimeExtension
InstallmentsBasePlanType <ph type="x-smartling-placeholder">
- JSON 表現
RenewalType
RegionalBasePlanConfig <ph type="x-smartling-placeholder">
- JSON 表現
OtherRegionsBasePlanConfig <ph type="x-smartling-placeholder">
- JSON 表現
SubscriptionListing <ph type="x-smartling-placeholder">
- JSON 表現
RestrictedPaymentCountries <ph type="x-smartling-placeholder">
- JSON 表現
メソッド

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

1 つのアプリの 1 つの定期購入。

JSON 表現

JSON 表現
{ "packageName": string, "productId": string, "basePlans": [ { object (`BasePlan`) } ], "listings": [ { object (`SubscriptionListing`) } ], "archived": boolean, "taxAndComplianceSettings": { object (`SubscriptionTaxAndComplianceSettings`) }, "restrictedPaymentCountries": { object (`RestrictedPaymentCountries`) } }

{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  },
  "restrictedPaymentCountries": {
    object (RestrictedPaymentCountries)
  }
}

フィールド
`packageName`	`string` 変更不可。親アプリのパッケージ名。
`productId`	`string` 変更不可。商品の一意の商品 ID。親アプリ内で一意。アイテム ID に使用できるのは、英小文字（a ～ z）、数字（0 ～ 9）、アンダースコア（_）、ドット（.）です。先頭は小文字または数字で、長さは 1 ～ 40 文字にする必要があります。
`basePlans[]`	`object (BasePlan)` この定期購入の基本プランのセット。他に適用されない場合の定期購入の価格と期間を表します。
`listings[]`	`object (SubscriptionListing)` 必須。このサブスクリプションのローカライズされたリスティングのリスト。親アプリのデフォルト言語のエントリを少なくとも 1 つ含める必要があります。
`archived (deprecated)`	`boolean` この項目は非推奨です。出力専用。非推奨: サブスクリプションのアーカイブはサポートされていません。
`taxAndComplianceSettings`	`object (SubscriptionTaxAndComplianceSettings)` 税金と法令遵守についての詳細。
`restrictedPaymentCountries`	`object (RestrictedPaymentCountries)` 省略可。この定期購入のお支払い方法が、同じ国で登録されているお支払い方法に制限されている国。空の場合、支払い場所の制限はありません。

BasePlan

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

JSON 表現

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`) }, "installmentsBasePlanType": { object (`InstallmentsBasePlanType`) } // End of list of possible types for union field `base_plan_type`. }

{
  "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)
  },
  "installmentsBasePlanType": {
    object (InstallmentsBasePlanType)
  }
  // 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)` この基本プランに指定され、請求ライブラリを介してアプリに返される、最大 20 個のカスタムタグのリスト。この基本プランの定期購入の特典には、Billing Library でこれらの特典タグも受け取ります。
`otherRegionsConfig`	`object (OtherRegionsBasePlanConfig)` Google Play が今後リリースされる可能性のある新しい地域での価格情報。省略した場合、今後 Play がリリースされる可能性のある新しい地域でベースプランが自動的に利用可能になることはありません。
共用体フィールド `base_plan_type`。この基本プランのタイプ。1 つのみを設定する必要があります。`base_plan_type` は次のいずれかになります。
`autoRenewingBasePlanType`	`object (AutoRenewingBasePlanType)` 基本プランが定期的に自動更新されるときに設定します。
`prepaidBasePlanType`	`object (PrepaidBasePlanType)` 請求対象期間が終了しても基本プランが自動更新されない場合に設定されます。
`installmentsBasePlanType`	`object (InstallmentsBasePlanType)` ユーザーが指定の回数の支払いを確約する分割払いの基本プランに設定されます。

州

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

列挙型
`STATE_UNSPECIFIED`	未指定の状態
`DRAFT`	基本プランは現在下書きの状態で、有効になっていません。この時点では安全に削除できます。
`ACTIVE`	基本プランは有効で、新規の定期購入者は利用できます。
`INACTIVE`	基本プランは無効で、既存の定期購入者のみが利用できます。

AutoRenewingBasePlanType

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

JSON 表現

JSON 表現
{ "billingPeriodDuration": string, "gracePeriodDuration": string, "accountHoldDuration": string, "resubscribeState": enum (`ResubscribeState`), "prorationMode": enum (`SubscriptionProrationMode`), "legacyCompatible": boolean, "legacyCompatibleSubscriptionOfferId": string }

{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "accountHoldDuration": 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 日）です。指定しない場合は、繰り返し期間に基づくデフォルト値が使用されます。
`accountHoldDuration`	`string` 省略可。定期購入のアカウントの一時停止期間。ISO 8601 形式で示されます。有効な値は DAYS で、P0D（0 日）～ P30D（30 日）の範囲である必要があります。指定しない場合、デフォルト値は 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 つのみです。定期購入の特典を以前の互換として指定しない場合は、このフィールドに空の文字列を設定します。

ResubscribeState

基本プランの再度定期購入のステータス。

列挙型
`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`	新しい基本プランの料金が直ちに全額請求されます。既存の定期購入の残りの期間は、新しいお支払いプランの期間が延長されます。

PrepaidBasePlanType

基本プランの終了時に自動更新されず、ユーザーが手動で更新する必要がある基本プランを表します。

JSON 表現
{ "billingPeriodDuration": string, "timeExtension": enum (`TimeExtension`) }

フィールド

billingPeriodDuration

string

必須。定期購入期間。ISO 8601 形式で示されます。使用可能な請求対象期間の一覧については、ヘルプセンターをご覧ください。

timeExtension

enum (TimeExtension)

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

TimeExtension

基本プランの期間の延長。

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

InstallmentsBasePlanType

ユーザーが指定された回数の支払いを確約する分割払いの基本プランを表します。

JSON 表現

JSON 表現
{ "billingPeriodDuration": string, "committedPaymentsCount": integer, "renewalType": enum (`RenewalType`), "gracePeriodDuration": string, "accountHoldDuration": string, "resubscribeState": enum (`ResubscribeState`), "prorationMode": enum (`SubscriptionProrationMode`) }

{
  "billingPeriodDuration": string,
  "committedPaymentsCount": integer,
  "renewalType": enum (RenewalType),
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode)
}

フィールド
`billingPeriodDuration`	`string` 必須。定期購入期間。ISO 8601 形式で示されます。使用可能な請求対象期間の一覧については、ヘルプセンターをご覧ください。
`committedPaymentsCount`	`integer` 必須。ユーザーが確約している支払い回数。
`renewalType`	`enum (RenewalType)` 必須。分割払いの基本プランの更新タイプ。最初のコミットメント終了時の動作を指定します。
`gracePeriodDuration`	`string` サブスクリプションの猶予期間。ISO 8601 形式で示されます。有効な値は、P0D（0 日）、P3D（3 日）、P7D（7 日）、P14D（14 日）、P30D（30 日）です。指定しない場合は、繰り返し期間に基づくデフォルト値が使用されます。
`accountHoldDuration`	`string` 省略可。定期購入のアカウントの一時停止期間。日数と ISO 8601 形式でのみ指定されます。指定できる値は、P0D（ゼロ日）～ P30D（30 日）です。指定しない場合、デフォルト値は P30D（30 日）です。
`resubscribeState`	`enum (ResubscribeState)` ユーザーが Google Play サーフェスでこの基本プランを再度定期購入できるようにするかどうかを指定します。指定しない場合のデフォルトは RESUBSCRIBE_STATE_ACTIVE です。
`prorationMode`	`enum (SubscriptionProrationMode)` 基本プランの比例配分モードにより、ユーザーが別の基本プランからこのプランに切り替えた場合の動作が決まります。指定しない場合のデフォルトは CHARGE_ON_NEXT_BILLING_DATE です。

RenewalType

分割払いの基本プランの更新タイプ。最初のコミットメント終了時の動作を指定します。

列挙型
`RENEWAL_TYPE_UNSPECIFIED`	未指定の状態
`RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT`	契約なしで請求対象期間の間は定期的に更新されます。
`RENEWAL_TYPE_RENEWS_WITH_COMMITMENT`	最初のコミットメントと同じ期間のコミットメントで更新されます。

RegionalBasePlanConfig

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

JSON 表現
{ "regionCode": string, "newSubscriberAvailability": boolean, "price": { object (`Money`) } }

フィールド

フィールド
`regionCode`	`string` 必須。この設定が適用される地域コード。ISO 3166-2 で定義されています。例:「US」。
`newSubscriberAvailability`	`boolean` 指定した地域の基本プランを新規の定期購入者が利用できるかどうか。この値が false に設定されている場合、既存の定期購入者の定期購入は解約されません。指定しない場合のデフォルトは false です。
`price`	`object (Money)` 指定した地域での基本プランの価格。新規の定期購入者が基本プランを利用できる場合は、設定する必要があります。指定した地域に対応する通貨で設定する必要があります。

regionCode

string

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

newSubscriberAvailability

boolean

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

price

object (Money)

指定した地域での基本プランの価格。新規の定期購入者が基本プランを利用できる場合は、設定する必要があります。指定した地域に対応する通貨で設定する必要があります。

OtherRegionsBasePlanConfig

Google Play がリリースされる可能性のある新しい地域での価格情報。

JSON 表現
{ "usdPrice": { object (`Money`) }, "eurPrice": { object (`Money`) }, "newSubscriberAvailability": boolean }

フィールド

フィールド
`usdPrice`	`object (Money)` 必須。Google Play がリリースされる可能性のある新しい地域で使用する米ドルの価格。
`eurPrice`	`object (Money)` 必須。Google Play がリリースされる可能性のある新しい地域で使用するユーロ単位の価格。
`newSubscriberAvailability`	`boolean` Google Play がリリースされる可能性のある新しい地域の新規定期購入者が基本プランを利用できるかどうか。指定しない場合のデフォルトは false です。

usdPrice

object (Money)

必須。Google Play がリリースされる可能性のある新しい地域で使用する米ドルの価格。

eurPrice

object (Money)

必須。Google Play がリリースされる可能性のある新しい地域で使用するユーロ単位の価格。

newSubscriberAvailability

boolean

Google Play がリリースされる可能性のある新しい地域の新規定期購入者が基本プランを利用できるかどうか。指定しない場合のデフォルトは false です。

SubscriptionListing

コンシューマに表示されるサブスクリプションのメタデータ。

JSON 表現
{ "languageCode": string, "title": string, "benefits": [ string ], "description": string }

フィールド
`languageCode`	`string` 必須。BCP-47 で定義されているこのリスティングの言語。例:「en-US」。
`title`	`string` 必須。このリスティングの言語でのこのサブスクリプションのタイトル。書式なしテキスト。
`benefits[]`	`string` Google Play ストアなどのプラットフォームや復元フローでユーザーに表示される特典のリスト。この掲載情報の言語で記載されます。書式なしテキスト。最大 4 つの特典の順序付きリスト。
`description`	`string` このリスティングの言語でのこのサブスクリプションの説明。最大文字数 - 80 文字。書式なしテキスト。

RestrictedPaymentCountries

本商品を購入できる国は、同じ国で登録されているお支払い方法に限られます。空の場合、支払い場所の制限はありません。

JSON 表現
{ "regionCodes": [ string ] }

フィールド

フィールド
`regionCodes[]`	`string` 必須。支払い制限を適用する地域コード（ISO 3166-2 で定義）。例:「US」。

regionCodes[]

string

必須。支払い制限を適用する地域コード（ISO 3166-2 で定義）。例:「US」。

メソッド
`archive (deprecated)`	非推奨: サブスクリプションのアーカイブはサポートされていません。
`batchGet`	1 つ以上のサブスクリプションを読み取ります。
`batchUpdate`	一連のサブスクリプションを更新します。
`create`	新しいサブスクリプションを作成します。
`delete`	サブスクリプションを削除します。
`get`	1 つのサブスクリプションを読み取ります。
`list`	指定したアプリのすべてのサブスクリプションを一覧表示します。
`patch`	既存のサブスクリプションを更新します。

REST Resource: monetization.subscriptions

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

BasePlan

州

AutoRenewingBasePlanType

ResubscribeState

SubscriptionProrationMode

PrepaidBasePlanType

TimeExtension

InstallmentsBasePlanType

RenewalType

RegionalBasePlanConfig

OtherRegionsBasePlanConfig

SubscriptionListing

RestrictedPaymentCountries

メソッド

`archive (deprecated)`

`batchGet`

`batchUpdate`

`create`

`delete`

`get`

`list`

`patch`