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)

Google Play 日後可能會推出任何新位置。

offerTags[]

object (OfferTag)

)。

狀態

訂閱優惠的目前狀態,

列舉
STATE_UNSPECIFIED 預設值為預設值。
DRAFT 使用者無法取得訂閱項目,而且從未訂閱。
ACTIVE 新使用者和現有使用者都能使用訂閱優惠。
INACTIVE 新使用者無法使用訂閱優惠。現有使用者會保留存取權。

訂閱優惠階段

訂閱優惠的單一階段。

JSON 表示法
{
  "recurrenceCount": integer,
  "duration": string,
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferPhaseConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferPhaseConfig)
  }
}
欄位
recurrenceCount

integer

必要,這個階段的重複次數。如果這項優惠階段不是免費,每個週期都會向使用者收取優惠階段的價格。

duration

string

必要,這個階段的單一週期持續時間。採用 ISO 8601 格式。

regionalConfigs[]

object (RegionalSubscriptionOfferPhaseConfig)

必要,這項優惠階段的區域專屬設定。這份清單中必須包含訂閱項目所屬區域設定的區域。

otherRegionsConfig

object (OtherRegionsSubscriptionOfferPhaseConfig)

Play 推出的所有新地點價格資訊。

區域訂閱項目優惠方案

單一區域中訂閱項目層級的單一階段設定。

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 美元,效期為 1 年,則為期 3 個月的 50% 折扣價格適用 1.50 美元的價格。折扣必須指定為大於 0 且小於 1 的分數。產生的價格會四捨五入至最接近的可計費單位 (例如美元為美元)。如果折扣價格最終低於此地區的最低價格,系統就會判定相對折扣無效。

absoluteDiscount

object (Money)

針對使用者在這個方案階段支付的費用,從基本方案價格中扣除的絕對金額。舉例來說,如果這個區域的基本方案價格是 1 年,效期為 $12 美元,那麼為期 3 個月的階段定價 $1 美元的絕對折扣等同於 $2 美元。產生的價格不得低於這個區域的最低價格。

free

object

設為指定這項優惠即可免費取得。

其他區域訂閱優惠方案

凡是在 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 美元,效期為 1 年,則為期 3 個月的 50% 折扣價格適用 1.50 美元的價格。折扣必須指定為大於 0 且小於 1 的分數。產生的價格會四捨五入至最接近的可計費單位 (例如美元為美元)。如果折扣價格最終低於 Google Play 可能推出新地區的最低價格,系統就會判定相對折扣無效。

absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

針對使用者在這個方案階段支付的費用,從基本方案價格中扣除的絕對金額。舉例來說,如果這個區域的基本方案價格是 1 年,效期為 $12 美元,那麼為期 3 個月的階段定價 $1 美元的絕對折扣等同於 $2 美元。產生的價格不得低於 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 的訂閱項目。必須屬於同一父項應用程式中的訂閱項目。

升級指定目標規則

代表表單的指定規則:使用者目前為「{scope}」[含帳單週期為 {billing_period}]。

JSON 表示法
{
  "oncePerUser": boolean,
  "scope": {
    object (TargetingRuleScope)
  },
  "billingPeriodDuration": string
}
欄位
oncePerUser

boolean

每位使用者只能享有一次優惠。如果設為 true,使用者只要訂閱了這項優惠,就無法再次享有這項優惠。

scope

object (TargetingRuleScope)

必要,這項規則的訂閱範圍。僅允許「應用程式中的訂閱」和「特定訂閱項目」。

billingPeriodDuration

string

使用者必須先訂閱特定的帳單週期 (以 ISO 8601 格式指定),才能享有這項規則的適用資格。如未指定,系統會比對所有訂閱週期的使用者。

區域性訂閱項目優惠設定

單一區域的訂閱項目優惠設定。

JSON 表示法
{
  "regionCode": string,
  "newSubscriberAvailability": boolean
}
欄位
regionCode

string

必要,不可變動。這項設定適用的區域代碼,如 ISO 3166-2 所定義,例如「US」。

newSubscriberAvailability

boolean

是否可在指定訂閱者中使用指定區域的訂閱優惠。如果將這個值設為 false,現有訂閱者將不會取消訂閱。如未指定,則預設為 false。

其他區域訂閱優惠設定

Play 針對訂閱優惠指定的所有新地區設定。

JSON 表示法
{
  "otherRegionsNewSubscriberAvailability": boolean
}
欄位
otherRegionsNewSubscriberAvailability

boolean

Play 日後可能會在所有新地區推出訂閱項目優惠。如未指定,則預設為 false。

方法

activate

啟用訂閱優惠。

create

建立新的訂閱優惠。

deactivate

停用訂閱優惠。

delete

刪除訂閱優惠。

get

讀取單一優惠

list

列出特定訂閱項目的所有優惠。

patch

更新現有的訂閱優惠。