- リソース: SubscriptionOffer
- ステータス
- SubscriptionOfferPhase
- RegionalSubscriptionOfferPhaseConfig
- OtherRegionsSubscriptionOfferPhaseConfig
- OtherRegionsSubscriptionOfferPhasePrices
- SubscriptionOfferTargeting
- AcquisitionTargetingRule
- TargetingRuleScope
- UpgradeTargetingRule
- RegionalSubscriptionOfferConfig
- OtherRegionsSubscriptionOfferConfig
- メソッド
リソース: SubscriptionOffer
単一の一時的な特典
JSON 表現 |
---|
{ "packageName": string, "productId": string, "basePlanId": string, "offerId": string, "state": enum ( |
フィールド | |
---|---|
packageName |
必須。変更不可。親定期購入が属するアプリのパッケージ名。 |
productId |
必須。変更不可。このオファーが属する親定期購入の ID。 |
basePlanId |
必須。変更不可。この特典の適用先の基本プランの ID です。 |
offerId |
必須。変更不可。この定期購入オファーの一意の ID。基本プラン内で一意である必要があります。 |
state |
出力のみ。このオファーの現在のステータス。有効化と無効化の操作で変更できます。注: このステータスよりも基本プランのステータスが優先されます。基本プランが有効でない場合、有効な特典は利用できない場合があります。 |
phases[] |
必須。この定期購入特典のフェーズです。少なくとも 1 つのエントリを含める必要があります。最大 5 つのエントリを指定できます。ユーザーは常にこれらのフェーズを指定された順序で受け取ります。最初の作成後に、フェーズの追加、削除、並べ替えを行うことはできません。 |
targeting |
ユーザーがこのオファーを利用するために満たす必要がある要件。特典を返すかどうかを判断するために Play が評価する要件を表します。デベロッパーは、これらの特典を自身でさらにフィルタできます。 |
regionalConfigs[] |
必須。このオファーのリージョン固有の構成。少なくとも 1 つのエントリを含める必要があります。 |
otherRegionsConfig |
Google Play が今後リリースする新しい地域の設定です。 |
offerTags[] |
このオファーに指定されたカスタムタグ(最大 20 個)のリスト。請求ライブラリからアプリに返されます。 |
状態
購読オファーの現在のステータス。
列挙型 | |
---|---|
STATE_UNSPECIFIED |
デフォルト値。使用しないでください。 |
DRAFT |
ユーザーが定期購入または特典を利用することはできません。 |
ACTIVE |
定期購入の特典は、新規ユーザーと既存ユーザーが利用できます。 |
INACTIVE |
定期購入の特典は、新規ユーザーにはご利用いただけません。既存のユーザーは引き続きアクセスできます。 |
SubscriptionOfferPhase
定期購入の特典の 1 つのフェーズです。
JSON 表現 |
---|
{ "recurrenceCount": integer, "duration": string, "regionalConfigs": [ { object ( |
フィールド | |
---|---|
recurrenceCount |
必須。このフェーズが繰り返される回数。この特典フェーズが無料ではない場合、繰り返しのたびにこの特典フェーズの価格が請求されます。 |
duration |
必須。このフェーズの 1 回の繰り返しの期間。ISO 8601 形式で指定。 |
regionalConfigs[] |
必須。このオファー フェーズのリージョン固有の構成。このリストには、サブスクリプションの特典にリージョン構成があるリージョンごとにエントリを 1 つだけ含める必要があります。 |
otherRegionsConfig |
Play がリリースされる可能性のある新しい地域における価格情報。 |
RegionalSubscriptionOfferPhaseConfig
単一リージョンにおける定期購入オファーの 1 フェーズの構成。
JSON 表現 |
---|
{ "regionCode": string, // Union field |
フィールド | |
---|---|
regionCode |
必須。変更不可。この構成が適用されるリージョン。 |
共用体フィールド price_override 。このフェーズでの価格のオーバーライド。必須。price_override は次のいずれかになります。 |
|
price |
このオファーのフェーズに対してユーザーが支払う絶対価格。価格は、この地域で許可されている最低価格より低くすることはできません。 |
relativeDiscount |
このオファーのフェーズに対してユーザーが支払う、フェーズ期間で按分した基本プランの料金の割合。たとえば、この地域の基本プランの価格が 1 年間で $12 の場合、3 か月間のフェーズでの 50% 割引は 1.50 ドルに相当します。割引率は 0 より大きく 1 より小さい割合で指定する必要があります。最終的な料金は、最も近い請求可能単位に四捨五入されます(例: 米ドルはセント)。割引価格が最終的にこの地域で許容される最低価格を下回る場合、相対的な割引は無効と見なされます。 |
absoluteDiscount |
この特典フェーズに対してユーザーが支払うフェーズ期間で按分した基本プランの料金から差し引かれた絶対金額。たとえば、この地域の基本プランの価格が 1 年間で $12 の場合、3 か月間のフェーズでの絶対的な割引が $1 であれば、価格は $2 になります。最終的な価格は、この地域で許可されている最低価格より低く設定することはできません。 |
free |
このオファーを無料で取得可能であることを指定します。 |
OtherRegionsSubscriptionOfferPhaseConfig
単一の特典フェーズで Google Play がリリースする可能性のある新しい地域の設定。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド price_override 。このフェーズでの価格のオーバーライド。必須。price_override は次のいずれかになります。 |
|
otherRegionsPrices |
このオファーのフェーズに対してユーザーが支払う絶対価格。価格は、Google Play がリリースされる可能性のある新しい地域で許容される最低価格より低くすることはできません。 |
relativeDiscount |
このオファーのフェーズに対してユーザーが支払う、フェーズ期間で按分した基本プランの料金の割合。たとえば、この地域の基本プランの価格が 1 年間で $12 の場合、3 か月間のフェーズでの 50% 割引は 1.50 ドルに相当します。割引率は 0 より大きく 1 より小さい割合で指定する必要があります。最終的な料金は、最も近い請求可能単位に四捨五入されます(例: 米ドルはセント)。割引価格が最終的に Google Play がリリースされる可能性のあるすべての新しい地域で許容される最低価格を下回る場合、相対的な割引は無効と見なされます。 |
absoluteDiscounts |
この特典フェーズに対してユーザーが支払うフェーズ期間で按分した基本プランの料金から差し引かれた絶対金額。たとえば、この地域の基本プランの価格が 1 年間で $12 の場合、3 か月間のフェーズでの絶対的な割引が $1 であれば、価格は $2 になります。この価格が、Google Play がリリースされる可能性のある新しい地域で許容される最低価格を下回らないようにしてください。 |
free |
このオファーを無料で取得可能であることを指定します。 |
OtherRegionsSubscriptionOfferPhasePrices
Play がリリースされる可能性のある新しい地域における価格情報。
JSON 表現 |
---|
{ "usdPrice": { object ( |
フィールド | |
---|---|
usdPrice |
必須。Google Play がリリースされる可能性のある新しい地域での価格(米ドル)。 |
eurPrice |
必須。Google Play がリリースされる可能性のある新しい地域で使用するユーロでの価格。 |
SubscriptionOfferTargeting
ユーザーがこのオファーを受け取るために満たす必要があるルールを定義します。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド rule 。デベロッパー指定の特典を利用する場合は空欄にします。rule は次のいずれかになります。 |
|
acquisitionRule |
新規ユーザーの獲得に関する特典のターゲティング ルール。 |
upgradeRule |
ユーザーの既存のプランをアップグレードするための特典ターゲティング ルール。 |
AcquisitionTargetingRule
ユーザーが以前に {scope} を利用したことがない形式のターゲティング ルールを表します。
JSON 表現 |
---|
{
"scope": {
object ( |
フィールド | |
---|---|
scope |
必須。このルールで考慮されるサブスクリプションの範囲。「この定期購入」と「アプリ内の任意の定期購入」のみを許可できます。 |
TargetingRuleScope
過去または現在の利用資格に基づいて、ターゲティング ルールで対象ユーザーを特典にマッチングできる定期購入の範囲を定義します。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド
|
|
thisSubscription |
現在のターゲティング ルールの範囲は、この特典が定義されている定期購入です。 |
anySubscriptionInApp |
現在のターゲティング ルールの範囲は、親アプリのサブスクリプションです。 |
specificSubscriptionInApp |
現在のターゲティング ルールの適用範囲は、指定されたサブスクリプション ID を持つサブスクリプションです。同じ親アプリ内の定期購入である必要があります。 |
UpgradeTargetingRule
次の形式のターゲティング ルールを表します: ユーザーの現在のスコープ: {scope}(請求対象期間 {billing_period})
JSON 表現 |
---|
{
"oncePerUser": boolean,
"scope": {
object ( |
フィールド | |
---|---|
oncePerUser |
この特典のご利用は 1 ユーザーにつき 1 回のみとなります。true に設定した場合、ユーザーがこのオファーに登録したことがあるユーザーは、今後このオファーの対象とはならないことになります。 |
scope |
必須。このルールで考慮されるサブスクリプションの範囲。「この定期購入」と「アプリ内の特定の定期購入」のみを許可します。 |
billingPeriodDuration |
このルールの対象となるには、その時点でユーザーが登録されている必要がある特定の請求対象期間(ISO 8601 形式で指定)。指定しなかった場合、任意の請求対象期間に登録しているユーザーが照合されます。 |
RegionalSubscriptionOfferConfig
単一リージョンにおける定期購入オファーの設定。
JSON 表現 |
---|
{ "regionCode": string, "newSubscriberAvailability": boolean } |
フィールド | |
---|---|
regionCode |
必須。変更不可。この設定が適用される地域コードです。ISO 3166-2 で定義されています(「US」など)。 |
newSubscriberAvailability |
指定された地域の定期購入特典を新規定期購入者が利用するかどうかを指定します。この値が false に設定されている場合、既存の定期購入者は定期購入は解約されません。指定しない場合のデフォルトは false です。 |
OtherRegionsSubscriptionOfferConfig
定期購入の特典に指定された新しい地域で Google Play がリリースされる際の設定。
JSON 表現 |
---|
{ "otherRegionsNewSubscriberAvailability": boolean } |
フィールド | |
---|---|
otherRegionsNewSubscriberAvailability |
Google Play が新しい地域で定期購入特典を今後提供するかどうか。指定しない場合のデフォルトは false です。 |
Methods |
|
---|---|
|
購読オファーを有効にします。 |
|
1 つ以上の購読オファーを読み取ります。 |
|
購読オファーのバッチを更新します。 |
|
定期購読のオファーの状態をバッチで更新します。 |
|
新しい定期購入オファーを作成します。 |
|
購読オファーを無効にします。 |
|
購読オファーを削除します。 |
|
単一の特典を読み取る |
|
特定の購読のすべてのオファーを一覧表示します。 |
|
既存の定期購入オファーを更新します。 |