- リソースのサブスクリプション
- BasePlan
- 州名
- AutoRenewingBasePlanType
- ResubscribeState
- SubscriptionProrationMode
- PrepaidBasePlanType
- TimeExtension
- InstallmentsBasePlanType
- RenewalType
- RegionalBasePlanConfig
- OtherRegionsBasePlanConfig
- SubscriptionListing
- RestrictedPaymentCountries
- メソッド
リソースのサブスクリプション
アプリの単一の定期購入。
JSON 表現 |
---|
{ "packageName": string, "productId": string, "basePlans": [ { object ( |
フィールド | |
---|---|
packageName |
変更不可。親アプリのパッケージ名。 |
productId |
変更不可。商品の一意の商品 ID。親アプリ内で一意。プロダクト ID は、小文字(a ~ z)、数字(0 ~ 9)、アンダースコア(_)、ドット(.)で構成する必要があります。先頭は小文字または数字で、長さは 1 ~ 40 文字にする必要があります。 |
basePlans[] |
この定期購入の基本プランのセット。他の特典が適用されない場合、定期購入の価格と期間を表します。 |
listings[] |
必須。このサブスクリプションのローカライズされたリスティングのリスト。親アプリのデフォルト言語のエントリが少なくとも 1 つ含まれている必要があります。 |
archived |
出力専用。非推奨: サブスクリプションのアーカイブはサポートされていません。 |
taxAndComplianceSettings |
税金と法令遵守に関する詳細。 |
restrictedPaymentCountries |
省略可。この定期購入の購入が、同じ国で登録されているお支払い方法に制限されている国。空の場合、支払いロケーションの制限は適用されません。 |
BasePlan
定期購入に 1 つの基本プラン。
JSON 表現 |
---|
{ "basePlanId": string, "state": enum ( |
フィールド | |
---|---|
basePlanId |
必須。変更不可。この基本プランの一意の識別子。サブスクリプション内で一意であり、RFC-1034 に準拠している必要があります。つまり、この ID に使用できるのは、小文字(a ~ z)、数字(0 ~ 9)、ハイフン(-)のみで、63 文字以下にする必要があります。 |
state |
出力専用。基本プランの状態(有効かどうか)。下書きと無効な基本プランは、有効または無効にできます。有効な基本プランは無効にできます。無効な基本プランはキャンセルできます。このフィールドは、リソースを更新しても変更できません。代わりに専用のエンドポイントを使用してください。 |
regionalConfigs[] |
この基本プランの地域固有の情報。 |
offerTags[] |
この基本プランに指定された最大 20 個のカスタムタグのリスト。請求ライブラリからアプリに返されます。この基本プランの定期購入の特典についても、Billing Library で特典タグを受け取ります。 |
otherRegionsConfig |
今後、新しい地域における料金に関する情報が Google Play でリリースされる可能性があります。省略した場合、Google Play が今後新しくリリースする地域では、BasePlan を自動的に利用することはできません。 |
共用体フィールド base_plan_type 。この基本プランのタイプ。1 つのみ設定する必要があります。base_plan_type は次のいずれかになります。 |
|
autoRenewingBasePlanType |
基本プランが一定の間隔で自動更新されるタイミングを設定します。 |
prepaidBasePlanType |
請求対象期間の終了時に基本プランを自動更新しないタイミングを設定します。 |
installmentsBasePlanType |
ユーザーが指定した回数の支払いを確約する分割払いの基本プランに対して設定されます。 |
状態
基本プランの現在の状態。
列挙型 | |
---|---|
STATE_UNSPECIFIED |
未指定の状態 |
DRAFT |
基本プランは現在下書き状態で、有効になっていません。この時点では安全に削除できます。 |
ACTIVE |
基本プランが有効で、新規の定期購入者にご利用いただけます。 |
INACTIVE |
基本プランは無効であり、既存の定期購入者のみが利用できます。 |
AutoRenewingBasePlanType
サブスクリプション期間の終了時に自動更新される基本プランを表します。
JSON 表現 |
---|
{ "billingPeriodDuration": string, "gracePeriodDuration": string, "accountHoldDuration": string, "resubscribeState": enum ( |
フィールド | |
---|---|
billingPeriodDuration |
必須。サブスクリプション期間を ISO 8601 形式で指定します。利用可能な請求対象期間の一覧については、ヘルプセンターを参照してください。 |
gracePeriodDuration |
定期購入の猶予期間。ISO 8601 形式で指定します。指定できる値は、P0D(ゼロ日)、P3D(3 日)、P7D(7 日)、P14D(14 日)、P30D(30 日)です)。指定しない場合は、契約期間に基づいてデフォルト値が使用されます。 |
accountHoldDuration |
省略可。定期購入のアカウントの一時停止期間。ISO 8601 形式で指定します。指定できる値は「DAYS」で、P0D(ゼロ日)から P30D(30 日)の範囲です。指定しない場合、デフォルト値は P30D(30 日)です。 |
resubscribeState |
ユーザーが Google Play サーフェスでこの基本プランを再度定期購入できるようにするかどうか。指定しない場合のデフォルトは、RESUBSCRIBE_STATE_ACTIVE です。 |
prorationMode |
基本プランの比例配分モードによって、ユーザーが別の基本プランからこのプランに切り替えた場合の動作が決まります。指定しない場合のデフォルトは CHARGE_ON_NEXT_BILLING_DATE です。 |
legacyCompatible |
更新の基本プランに下位互換性があるかどうか。 下位互換性のある基本プランは、Google Play Billing Library の非推奨メソッド querySkuDetailsAsync() によって返されます。 特定の定期購入について「以前の対応」としてマークできる更新基本プランは 1 つのみです。 |
legacyCompatibleSubscriptionOfferId |
以前の互換の定期購入オファー ID。 下位互換性のある定期購入の特典は、Google Play Billing Library の非推奨メソッド querySkuDetailsAsync() によって返されます。 1 つの更新基本プランに対して「以前の対応」としてマークできる定期購入の特典は 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 ( |
フィールド | |
---|---|
billingPeriodDuration |
必須。サブスクリプション期間を ISO 8601 形式で指定します。利用可能な請求対象期間の一覧については、ヘルプセンターを参照してください。 |
timeExtension |
ユーザーが Google Play の各種サービスでこの前払い基本プランを延長できるかどうか。指定しない場合のデフォルトは TIME_EXTENSION_ACTIVE です。 |
TimeExtension
基本プランの期間延長。
列挙型 | |
---|---|
TIME_EXTENSION_UNSPECIFIED |
未指定の状態 |
TIME_EXTENSION_ACTIVE |
期間延長が有効です。ユーザーはプリペイド プランをチャージまたは延長できます。 |
TIME_EXTENSION_INACTIVE |
期間延長が無効です。お客様はプリペイド プランへのチャージや延長はできません。 |
InstallmentsBasePlanType
ユーザーが指定回数の支払いを確約する分割払いの基本プランを表します。
JSON 表現 |
---|
{ "billingPeriodDuration": string, "committedPaymentsCount": integer, "renewalType": enum ( |
フィールド | |
---|---|
billingPeriodDuration |
必須。サブスクリプション期間を ISO 8601 形式で指定します。利用可能な請求対象期間の一覧については、ヘルプセンターを参照してください。 |
committedPaymentsCount |
必須。ユーザーが行った支払いの回数。 |
renewalType |
必須。分割払いの基本プランの更新タイプ。最初のコミットメント終了時に動作を決定します。 |
gracePeriodDuration |
定期購入の猶予期間。ISO 8601 形式で指定します。指定できる値は、P0D(ゼロ日)、P3D(3 日)、P7D(7 日)、P14D(14 日)、P30D(30 日)です)。指定しない場合は、契約期間に基づいてデフォルト値が使用されます。 |
accountHoldDuration |
省略可。定期購入のアカウントの一時停止期間。日数のみで指定します。ISO 8601 形式で指定します。指定できる値は P0D(ゼロ日)から P30D(30 日)です。指定しない場合、デフォルト値は P30D(30 日)です。 |
resubscribeState |
ユーザーが Google Play サーフェスでこの基本プランを再度定期購入できるようにするかどうか。指定しない場合のデフォルトは、RESUBSCRIBE_STATE_ACTIVE です。 |
prorationMode |
基本プランの比例配分モードによって、ユーザーが別の基本プランからこのプランに切り替えた場合の動作が決まります。指定しない場合のデフォルトは 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 ( |
フィールド | |
---|---|
regionCode |
必須。この設定が適用される地域コード。ISO 3166-2 で定義されているとおり(「US」など)。 |
newSubscriberAvailability |
指定された地域の基本プランを新規の定期購入者が利用できるかどうか。この値が false に設定されている場合、既存の定期購入者は定期購入が解約されません。指定しない場合のデフォルトは false です。 |
price |
指定された地域での基本プランの価格。新規の定期購入者が基本プランを利用できる場合は、設定する必要があります。指定した地域に関連付けられている通貨で設定する必要があります。 |
OtherRegionsBasePlanConfig
Google Play が新たにリリースされる地域における価格情報です。
JSON 表現 |
---|
{ "usdPrice": { object ( |
フィールド | |
---|---|
usdPrice |
必須。Google Play が新たにリリースされる国や地域で使用する場合の料金(米ドル)。 |
eurPrice |
必須。Google Play がリリースされる可能性のある新しい地域で使用するユーロの価格。 |
newSubscriberAvailability |
Google Play がリリースされる予定の新しい地域で、新規の定期購入者が基本プランを利用できるかどうか。指定しない場合のデフォルトは false です。 |
SubscriptionListing
コンシューマに表示されるサブスクリプションのメタデータ。
JSON 表現 |
---|
{ "languageCode": string, "title": string, "benefits": [ string ], "description": string } |
フィールド | |
---|---|
languageCode |
必須。BCP-47 で定義されているこのリスティングの言語(例: 「en-US」)。 |
title |
必須。このリスティングの言語で表示される、このサブスクリプションのタイトル。書式なしテキスト。 |
benefits[] |
Google Play ストアなどのプラットフォームでユーザーに提示する特典のリストと、復元フローにおいて、この掲載情報の言語でユーザーに提示する特典のリスト。書式なしテキスト。 最大 4 つの特典を順番に並べたリスト。 |
description |
このリスティングの言語での、このサブスクリプションの説明。最大文字数は 80 文字です。書式なしテキスト。 |
RestrictedPaymentCountries
この商品の購入が、同じ国で登録されているお支払い方法に制限されている国。空の場合、支払いロケーションの制限は適用されません。
JSON 表現 |
---|
{ "regionCodes": [ string ] } |
フィールド | |
---|---|
regionCodes[] |
必須。支払い制限を適用する地域コード。ISO 3166-2 で定義されているとおりに指定します(「US」など)。 |
メソッド |
|
---|---|
(deprecated) |
非推奨: サブスクリプションのアーカイブはサポートされていません。 |
|
1 つ以上のサブスクリプションを読み取ります。 |
|
サブスクリプションのバッチを更新します。 |
|
新しいサブスクリプションを作成します。 |
|
サブスクリプションを削除します。 |
|
単一のサブスクリプションを読み取ります。 |
|
特定のアプリのすべてのサブスクリプションを一覧表示します。 |
|
既存のサブスクリプションを更新します。 |