REST Resource: monetization.subscriptions.basePlans.offers

{
  "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)
    }
  ]
}

string

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

string

必須。変更不可。このオファーが属する親サブスクリプションの ID。

string

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

string

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

enum (State)

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

object (SubscriptionOfferPhase)

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

object (SubscriptionOfferTargeting)

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

object (RegionalSubscriptionOfferConfig)

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

object (OtherRegionsSubscriptionOfferConfig)

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

object (OfferTag)

このオファーに指定され、Billing ライブラリを介してアプリに返されるカスタムタグのリスト（最大 20 個）。

{
  "recurrenceCount": integer,
  "duration": string,
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferPhaseConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferPhaseConfig)
  }
}

integer

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

string

必須。このフェーズが 1 回繰り返される期間。ISO 8601 形式で指定します。

object (RegionalSubscriptionOfferPhaseConfig)

必須。このオファー フェーズのリージョン固有の構成。このリストには、サブスクリプション オファーにリージョン構成があるリージョンごとに、エントリを 1 つだけ含める必要があります。

object (OtherRegionsSubscriptionOfferPhaseConfig)

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

{
  "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.
}

string

必須。変更不可。この構成が適用されるリージョン。

object (Money)

このオファー フェーズに対してユーザーが支払う絶対価格。価格はこの地域で許可されている最低価格を下回ってはなりません。

number

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

object (Money)

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

object (RegionalSubscriptionOfferPhaseFreePriceOverride)

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

{

  // 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.
}

object (OtherRegionsSubscriptionOfferPhasePrices)

このオファー フェーズに対してユーザーが支払う絶対価格。価格は、Google Play をリリースする新しい地域で許可されている最低価格を下回ってはなりません。

number

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

object (OtherRegionsSubscriptionOfferPhasePrices)

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

object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)

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

{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  }
}

object (Money)

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

object (Money)

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

{

  // 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.
}

object (AcquisitionTargetingRule)

新規ユーザーの獲得に関するオファーのターゲティング ルール。

object (UpgradeTargetingRule)

ユーザーのアップグレードに関する特典のターゲティング ルールできます。

{
  "scope": {
    object (TargetingRuleScope)
  }
}

object (TargetingRuleScope)

必須。このルールで考慮される定期購入の範囲。「この定期購入」のみを許可します「アプリ内のすべての定期購入」です。

{

  // 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.
}

object (TargetingRuleScopeThisSubscription)

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

object (TargetingRuleScopeAnySubscriptionInApp)

現在のターゲティング ルールの適用範囲は、親アプリのすべての定期購入です。

string

現在のターゲティング ルールの適用範囲は、指定した登録 ID の登録です。同じ親アプリ内の定期購入であること。

{
  "oncePerUser": boolean,
  "scope": {
    object (TargetingRuleScope)
  },
  "billingPeriodDuration": string
}

boolean

この特典のご利用は、お 1 人様 1 回限りとさせていただきます。true に設定した場合、ユーザーがこの特典を定期購入したことがある場合、そのユーザーはこの特典の対象にはなりません。

object (TargetingRuleScope)

必須。このルールで考慮される定期購入の範囲。「この定期購入」のみを許可します“アプリ内の特定の定期購入”です

string

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

{
  "regionCode": string,
  "newSubscriberAvailability": boolean
}

string

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

boolean

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

{
  "otherRegionsNewSubscriberAvailability": boolean
}

boolean

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