REST Resource: monetization.subscriptions.basePlans.offers

リソース: SubscriptionOffer

1 つの一時的な特典

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 ～ 2 個のエントリを含める必要があります。ユーザーは常に、指定された順序でこれらのフェーズを受け取ります。
targeting

object (SubscriptionOfferTargeting)

ユーザーがこの特典を受けるために必要な要件。特典を返す必要があるかどうかを判断するために Google Play が評価する要件を表します。デベロッパーは、これらの特典を自身でフィルタできます。
regionalConfigs[]

object (RegionalSubscriptionOfferConfig)

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

object (OtherRegionsSubscriptionOfferConfig)

今後 Play がリリースされる可能性のある新しいロケーションの設定。
offerTags[]

object (OfferTag)

この特典に対して指定され、Billing Library を通してアプリに返されるカスタムタグのリスト（最大 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 (RegionalSubscriptionOfferPhaseFreePriceOverride)
  }
  // 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 より小さくなる分数として指定する必要があります。割引後の価格は、最も近い請求可能な単位に丸められます（例: USD の場合はセント）。割引後の価格が、地域で認められている最低価格よりも低くなった場合は、率での割引は無効とみなされます。
absoluteDiscount

object (Money)

ユーザーがこの特典のフェーズに対して支払ったフェーズの期間に対して案分した、基本プランの価格から差し引かれる金額。たとえば、この地域の基本プランの価格が 1 年間で 12 ドルの場合、3 か月のフェーズで 1 ドルの割引額は 2 ドルに相当します。最終的な価格は、この地域で許可されている最低価格を下回ってはなりません。
free

object (RegionalSubscriptionOfferPhaseFreePriceOverride)

この特典を無料で入手できることを指定します。

RegionalSubscriptionOfferPhaseFreePriceOverride

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

定期購入オファーの 1 つのフェーズに適用される無料価格のオーバーライドの設定を表します

OtherRegionsSubscriptionOfferPhaseConfig

Google Play をリリースする可能性のある新たな地域向けの、単一の特典フェーズに関する設定。

JSON 表現 
{

  // Union field price_override can be only one of the following:
  "otherRegionsPrices": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "relativeDiscount": number,
  "absoluteDiscounts": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "free": {
    object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)
  }
  // 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 より小さくなる分数として指定する必要があります。割引後の価格は、最も近い請求可能な単位に丸められます（例: USD の場合はセント）。割引後の価格が、Google Play をリリースする可能性のある新たな地域で認められている最低価格よりも低くなった場合は、率での割引は無効とみなされます。
absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

この特典フェーズに対してユーザーが支払う、フェーズ期間に応じて按分された基本プラン価格から差し引かれる絶対金額。たとえば、この地域における 1 年間の基本プラン価格が $12 の場合、3 か月間のフェーズに対して割引額 $1 を適用した後の価格は $2 となります。Google Play をリリースする可能性のある新たな地域で認められている最低価格よりも低い価格になってはなりません。
free

object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)

この特典が無料で取得できることを示すために設定します。

OtherRegionsSubscriptionOfferPhasePrices

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

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

object (Money)

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

object (Money)

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

OtherRegionsSubscriptionOfferPhaseFreePriceOverride

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

単一のオファー フェーズで 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

1 つの地域における定期購入特典の設定。

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

string

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

boolean

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

OtherRegionsSubscriptionOfferConfig

Google Play をリリースする可能性のある新たな地域向けに、定期購入特典について指定された設定。

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

boolean

今後 Google Play をリリースする可能性のある新たな地域で、定期購入特典が新規定期購入者に対し利用可能かどうか。指定されていない場合は、デフォルトで false に設定されます。

メソッド

activate

 定期購入特典を有効にします。

batchGet

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

batchUpdate

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

batchUpdateStates

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

create

 新しいサブスクリプションのオファーを作成します。

deactivate

 サブスクリプションのオファーを無効にします。

delete

 サブスクリプションのオファーを削除します。

get

 1 つのオファーを読み取る

list

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

patch

 既存の購読オファーを更新します。