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)

出力専用。このオファーの現在の状態。Activate と Deactivate アクションを使用して変更できます。注: 基本プランはこのステータスに優先します。そのため、基本プランが有効でない場合、有効な特典は利用できないことがあります。
phases[]

object (SubscriptionOfferPhase)

必須。このサブスクリプション オファーのフェーズ。1 ～ 5 個のエントリを含める必要があり、ユーザーは常に、指定された順序でこれらのフェーズを受け取ります。最初の作成後にフェーズを追加、削除、並べ替えることはできません。
targeting

object (SubscriptionOfferTargeting)

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

object (RegionalSubscriptionOfferConfig)

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

object (OtherRegionsSubscriptionOfferConfig)

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

object (OfferTag)

このオファーに指定され、Billing ライブラリを介してアプリに返されるカスタムタグのリスト（最大 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

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

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 より小さくなる分数として指定する必要があります。最終的な請求額は、最も近い請求単位（米ドルの場合はセントなど）に四捨五入されます。割引価格がその地域で許可されている最低価格より低くなる場合、相対的な割引は無効とみなされます。
absoluteDiscount

object (Money)

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

object (RegionalSubscriptionOfferPhaseFreePriceOverride)

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

RegionalSubscriptionOfferPhaseFreePriceOverride

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

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

OtherRegionsSubscriptionOfferPhaseConfig

1 つの特典フェーズで 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 より小さくなる分数として指定する必要があります。最終的な請求額は、最も近い請求単位（米ドルの場合はセントなど）に四捨五入されます。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

単一リージョンにおけるサブスクリプション オファーの構成。

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

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