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)

このオファーの資格要件を満たすためにユーザーが満たすべき要件。特典が返されるかどうかを判断するために Play が評価する要件を表します。デベロッパーは、これらの特典を独自にフィルタできます。
regionalConfigs[]

object (RegionalSubscriptionOfferConfig)

必須。この特典の地域固有の設定。少なくとも 1 つのエントリを含める必要があります。
otherRegionsConfig

object (OtherRegionsSubscriptionOfferConfig)

Play が今後リリースされる可能性がある新しい地域向けの設定。
offerTags[]

object (OfferTag)

このオファーに対して指定され、Billing Library を通じてアプリに返されるカスタムタグの最大 20 個の apks.list。

状態

定期購入オファーの現在の状態。

列挙型
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)

Play が新たにリリースされる地域の価格情報

RegionSubscriptionOfferPhaseConfig

単一リージョンでのサブスクリプション オファーの単一フェーズの構成。

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 か月間の割引額（100 円）は 200 円に相当します。表示される価格は、この地域で認められている最低価格を下回っていません。
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)

この特典のフェーズでユーザーが支払う合計金額。価格は、Play が新たにリリースする国で許可されている最低価格を下回らないようにしてください。
relativeDiscount

number

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

object (OtherRegionsSubscriptionOfferPhasePrices)

ユーザーがこのオファー フェーズに対して支払うフェーズ期間中に、比例配分された基本プラン料金から差し引かれた金額。たとえば、この地域の基本プランの価格が 1 年間 $12 の場合、3 か月間の割引額（100 円）は 200 円に相当します。生成される価格は、Play が新たにリリースする地域で許可されている最低価格を下回ることはありません。
free

object

この特典を無料でご利用いただけます。

その他の地域 - 定期購入 / 特典価格

Play が新たにリリースされる地域の価格情報

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

object (Money)

必須。Play が新たにリリースされる地域で使用される価格（米ドル）。
eurPrice

object (Money)

必須。Play が新たにリリースされる地域で使用されるユーロの価格。

定期購入オファー ターゲティング

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

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)

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

集客ターゲティング ルール

次の形式のターゲティング ルールを表します。ユーザーがこれまで {scope} を使ったことはありません。

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

object (TargetingRuleScope)

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

ターゲティング ルールのスコープ

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

JSON 表現 
{

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

共用体フィールド scope。

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

object

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

object

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

string

現在のターゲティング ルールの適用範囲は、サブスクリプション ID が指定されたサブスクリプションです。同じ親アプリ内の定期購入であること。

UpgradeTargetRule

次の形式のターゲティング ルールを表します。ユーザーは、現在 {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

定期購入の特典で指定した新しい地域で、Play でリリース可能な地域を設定します。

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

boolean

Play が今後新しい地域で定期購入をリリースするかどうか。指定しない場合、デフォルトで false に設定されます。

Methods

activate

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

create

 新しい定期購入の特典を作成します。

deactivate

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

delete

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

get

 単一のオファーを読み取ります

list

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

patch

 既存の定期購入の特典を更新します。