REST Resource: monetization.subscriptions.basePlans.offers

リソース: SubscriptionOffer

単一の一時的な特典

JSON 表現 
{
  "packageName": string,
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "state": enum (State),
  "phases": [
    {
      object (SubscriptionOfferPhase)
    }
  ],
  "targeting": {
    object (SubscriptionOfferTargeting)
  },
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferConfig)
  },
  "offerTags": [
    {
      object (OfferTag)
    }
  ]
}
フィールド
packageName

string

必須。変更不可。親定期購入が属しているアプリのパッケージ名。
productId

string

必須。変更不可。このオファーが属する親定期購入の ID。
basePlanId

string

必須。変更不可。このオファーが延長される基本プランの ID。
offerId

string

必須。変更不可。この定期購入オファーの一意の ID。基本プラン内で一意である必要があります。
state

enum (State)

出力のみ。このオファーの現在のステータス。[有効化] と [無効化] の操作で変更できます。注: 基本プランのステータスはこの状態より優先されるため、基本プランが有効でない場合は、有効な特典が表示されないことがあります。
phases[]

object (SubscriptionOfferPhase)

必須。この定期購入オファーのフェーズ。少なくとも 1 つのエントリを含める必要があり、最大 5 つのエントリを含めることができます。ユーザーは常にこれらのフェーズをすべて指定された順序で受け取ります。最初の作成後に、フェーズの追加、削除、並べ替えを行うことはできません。
targeting

object (SubscriptionOfferTargeting)

この特典の対象となるためにユーザーが満たすべき要件。特典を返すかどうかを決定するために Google Play が評価する要件を表します。デベロッパーは、これらの特典を自身でフィルタすることもできます。
regionalConfigs[]

object (RegionalSubscriptionOfferConfig)

必須。このオファーのリージョン固有の構成。少なくとも 1 つのエントリを含める必要があります。
otherRegionsConfig

object (OtherRegionsSubscriptionOfferConfig)

新しい地域の設定は Google Play で今後リリースされる可能性があります。
offerTags[]

object (OfferTag)

このオファーに指定された最大 20 個のカスタムタグのリスト。請求ライブラリからアプリに返されます。

状態

定期購入オファーの現在のステータス。

列挙型
STATE_UNSPECIFIED デフォルト値。使用しないでください。
DRAFT 定期購入の特典が、これまでユーザーに提供されていない状態です。
ACTIVE 定期購入の特典は、新規ユーザーと既存のユーザーが利用できます。
INACTIVE 新規ユーザーは定期購入の特典をご利用いただけません。既存のユーザーは引き続きアクセスできます。

SubscriptionOfferPhase

定期購入オファーの単一のフェーズ。

JSON 表現 
{
  "recurrenceCount": integer,
  "duration": string,
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferPhaseConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferPhaseConfig)
  }
}
フィールド
recurrenceCount

integer

必須。このフェーズを繰り返す回数。このオファー フェーズが無料でない場合は、繰り返しのたびにオファー フェーズの価格がユーザーに請求されます。
duration

string

必須。このフェーズの 1 回の繰り返しの期間。ISO 8601 形式で指定します。
regionalConfigs[]

object (RegionalSubscriptionOfferPhaseConfig)

必須。このオファー フェーズのリージョン固有の構成。このリストには、定期購入の特典にリージョン構成があるリージョンごとにエントリを 1 つだけ含める必要があります。
otherRegionsConfig

object (OtherRegionsSubscriptionOfferPhaseConfig)

Google Play が新たにリリースされる地域における価格情報です。

RegionalSubscriptionOfferPhaseConfig

単一リージョンにおける定期購入オファーの 1 フェーズの構成。

JSON 表現 
{
  "regionCode": string,

  // Union field price_override can be only one of the following:
  "price": {
    object (Money)
  },
  "relativeDiscount": number,
  "absoluteDiscount": {
    object (Money)
  },
  "free": {
    object
  }
  // End of list of possible types for union field price_override.
}
フィールド
regionCode

string

必須。変更不可。この構成が適用されるリージョン。
共用体フィールド price_override。このフェーズの価格のオーバーライド。必須。price_override は次のいずれかになります。
price

object (Money)

この特典フェーズに対してユーザーが支払う絶対価格。この地域で許可されている最低価格より低い価格は設定できません。
relativeDiscount

number

この特典フェーズに対してユーザーが支払う、フェーズ期間に対して日割り計算された基本プランの価格の比率。たとえば、この地域の基本プランの料金が 1 年間で $12 の場合、3 か月間のフェーズでの 50% 割引は $1.50 に相当します。割引は 0 より大きく 1 より小さい値で指定する必要があります。計算結果の価格は、最も近い請求単位に四捨五入されます（例: 米ドルはセント）。割引価格が最終的にこの地域で許可されている最低価格を下回る場合、相対的な割引は無効と見なされます。
absoluteDiscount

object (Money)

特典フェーズに対してユーザーが支払うフェーズ期間に対して、基本プランの価格から日割り計算された金額の絶対額。たとえば、この地域の基本プランの価格が 1 年間で 12 ドルの場合、3 か月間のフェーズでの絶対割引額は 1 ドルで、価格は 2 ドルになります。適用される価格は、この地域で許可されている最低価格より低く設定することはできません。
free

object

このオファーを無料で取得できることを指定します。

OtherRegionsSubscriptionOfferPhaseConfig

単一の特典フェーズで Play がリリースする新しい地域の設定。

JSON 表現 
{

  // Union field price_override can be only one of the following:
  "otherRegionsPrices": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "relativeDiscount": number,
  "absoluteDiscounts": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "free": {
    object
  }
  // End of list of possible types for union field price_override.
}
フィールド
共用体フィールド price_override。このフェーズの価格のオーバーライド。必須。price_override は次のいずれかになります。
otherRegionsPrices

object (OtherRegionsSubscriptionOfferPhasePrices)

この特典フェーズに対してユーザーが支払う絶対価格。価格は、Google Play がリリースされる可能性のある新しい地域で許可される最低価格より低く設定しないでください。
relativeDiscount

number

この特典フェーズに対してユーザーが支払う、フェーズ期間に対して日割り計算された基本プランの価格の比率。たとえば、この地域の基本プランの料金が 1 年間で $12 の場合、3 か月間のフェーズでの 50% 割引は $1.50 に相当します。割引は 0 より大きく 1 より小さい値で指定する必要があります。計算結果の価格は、最も近い請求単位に四捨五入されます（例: 米ドルはセント）。割引後の価格が最終的に Google Play がリリースされる新しい地域で許容される最低価格を下回る場合、相対的な割引は無効と見なされます。
absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

特典フェーズに対してユーザーが支払うフェーズ期間に対して、基本プランの価格から日割り計算された金額の絶対額。たとえば、この地域の基本プランの価格が 1 年間で 12 ドルの場合、3 か月間のフェーズでの絶対割引額は 1 ドルで、価格は 2 ドルになります。最終的な価格は、Google Play がリリースされる可能性のある新しい地域で許可される最低価格より低くなってはなりません。
free

object

このオファーを無料で取得できることを指定します。

OtherRegionsSubscriptionOfferPhasePrices

Google Play が新たにリリースされる地域における価格情報です。

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

object (Money)

必須。Google Play が新たにリリースされる国や地域で使用する場合の料金（米ドル）。
eurPrice

object (Money)

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

SubscriptionOfferTargeting

ユーザーがこのオファーを受け取るために満たす必要があるルールを定義します。

JSON 表現 
{

  // Union field rule can be only one of the following:
  "acquisitionRule": {
    object (AcquisitionTargetingRule)
  },
  "upgradeRule": {
    object (UpgradeTargetingRule)
  }
  // End of list of possible types for union field rule.
}
フィールド
共用体フィールド rule。デベロッパー指定の特典を利用する場合は空欄にします。rule は次のいずれかになります。
acquisitionRule

object (AcquisitionTargetingRule)

新規ユーザーの獲得に関する特典ターゲティング ルール。
upgradeRule

object (UpgradeTargetingRule)

ユーザーの既存のプランをアップグレードするための特典ターゲティング ルール。

AcquisitionTargetingRule

ユーザーに以前に {scope} がなかったという形式のターゲティング ルールを表します。

JSON 表現 
{
  "scope": {
    object (TargetingRuleScope)
  }
}
フィールド
scope

object (TargetingRuleScope)

必須。このルールで考慮されるサブスクリプションの範囲。「この定期購入」と「アプリ内の任意の定期購入」のみ許可できます。

TargetingRuleScope

過去または現在の利用資格に基づいて、ターゲティング ルールでユーザーに特典をターゲット設定できる定期購入の範囲を定義します。

JSON 表現 
{

  // Union field scope can be only one of the following:
  "thisSubscription": {
    object (TargetingRuleScopeThisSubscription)
  },
  "anySubscriptionInApp": {
    object (TargetingRuleScopeAnySubscriptionInApp)
  },
  "specificSubscriptionInApp": string
  // End of list of possible types for union field scope.
}
フィールド

共用体フィールド scope。

scope は次のいずれかになります。
thisSubscription

object (TargetingRuleScopeThisSubscription)

現在のターゲティング ルールの範囲は、この特典が定義されている定期購入です。
anySubscriptionInApp

object (TargetingRuleScopeAnySubscriptionInApp)

現在のターゲティング ルールのスコープは、親アプリのサブスクリプションです。
specificSubscriptionInApp

string

現在のターゲティング ルールのスコープは、指定されたサブスクリプション ID を持つサブスクリプションです。同じ親アプリ内の定期購入である必要があります。

TargetingRuleScopeThisSubscription

このタイプにはフィールドがありません。

この特典が定義されている定期購入に対応するターゲティング ルールの範囲を表します。

TargetingRuleScopeAnySubscriptionInApp

このタイプにはフィールドがありません。

親アプリのサブスクリプションに対応するターゲティング ルールのスコープを表します。

UpgradeTargetingRule

ユーザーの現在のスコープ: {scope}（請求対象期間が {billing_period}）のターゲティング ルールを表します。

JSON 表現 
{
  "oncePerUser": boolean,
  "scope": {
    object (TargetingRuleScope)
  },
  "billingPeriodDuration": string
}
フィールド
oncePerUser

boolean

この特典のご利用はユーザー 1 人につき 1 回のみとなります。true に設定すると、ユーザーがこのクーポンを定期購入したことがある場合、このクーポンの利用資格は二度となくなります。
scope

object (TargetingRuleScope)

必須。このルールで考慮されるサブスクリプションの範囲。「この定期購入」と「アプリ内の特定の定期購入」のみが許可されます。
billingPeriodDuration

string

ISO 8601 形式で指定される特定の請求対象期間で、ユーザーが現在このルールの対象となっている必要がある期間。指定しない場合、任意の請求対象期間に登録済みのユーザーが照合されます。

RegionalSubscriptionOfferConfig

単一地域における定期購入オファーの構成。

JSON 表現 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean
}
フィールド
regionCode

string

必須。変更不可。この設定が適用される地域コード。ISO 3166-2 で定義されているとおり（「US」など）。
newSubscriberAvailability

boolean

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

OtherRegionsSubscriptionOfferConfig

定期購入の特典で指定された地域で Google Play がリリースできる新しい地域の設定。

JSON 表現 
{
  "otherRegionsNewSubscriberAvailability": boolean
}
フィールド
otherRegionsNewSubscriberAvailability

boolean

Play の新しい地域で定期購入特典が今後リリースされる可能性があるかどうか。指定しない場合のデフォルトは false です。

Methods

activate

 購読オファーを有効にします。

batchGet

 1 つ以上の購読オファーを読み取ります。

batchUpdate

 定期購入のオファーのバッチを更新します。

batchUpdateStates

 定期購入のオファーの状態を一括で更新します。

create

 新しい定期購入のオファーを作成します。

deactivate

 定期購入のオファーを無効にします。

delete

 定期購入のオファーを削除します。

get

 単一のオファーを読み取る

list

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

patch

 既存の定期購入のオファーを更新します。