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)

必要欄位。這項訂閱優惠的各個階段。必須包含至少一個項目，最多 5 個。使用者將一律按指定順序收到所有階段。初始建立完成後，即無法新增、移除或重新排序階段。
targeting

object (SubscriptionOfferTargeting)

使用者需要滿足哪些條件，才符合此優惠資格。代表 Play 評估優惠是否應退回的條件。開發人員可能會進一步篩選這類優惠。
regionalConfigs[]

object (RegionalSubscriptionOfferConfig)

必要欄位。這項優惠的區域專屬設定，至少須包含一個項目。
otherRegionsConfig

object (OtherRegionsSubscriptionOfferConfig)

Play 日後可能會推出新地區的設定。
offerTags[]

object (OfferTag)

您最多可為這項優惠指定 20 個自訂標記，並透過結帳程式庫傳回應用程式。

州

訂閱優惠目前的狀態。

列舉
STATE_UNSPECIFIED 預設值，一律不得使用。
DRAFT 沒有訂閱優惠，也無法提供給使用者。
ACTIVE 訂閱優惠適用於新使用者和現有使用者。
INACTIVE 新使用者不適用訂閱優惠。現有使用者仍可保有存取權。

SubscriptionOfferPhase

訂閱優惠的單一階段。

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

integer

必要欄位。這個階段重複的次數。如果此優惠階段為免費，則每個週期都會向使用者收取這項優惠階段的價格。
duration

string

必要欄位。這個階段中單次週期性的持續時間。以 ISO 8601 格式指定。
regionalConfigs[]

object (RegionalSubscriptionOfferPhaseConfig)

必要欄位。此優惠階段的區域專屬設定。這份清單必須為訂閱優惠提供區域設定的各個區域，僅包含一個項目。
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

這個類型沒有任何欄位。

代表訂閱項目優惠單一階段的免費價格覆寫設定

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 的分數。最終價格將四捨五入為最接近的可計費單位 (例如美金 $)。如果折扣價格最終低於 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

每位使用者只能兌換這項優惠一次。如果將這項政策設為「是」，即便使用者曾訂閱此優惠，也無法再次享有這項優惠。
scope

object (TargetingRuleScope)

必要欄位。這項規則考量的訂閱範圍。只允許「這個訂閱項目」以及「應用程式中的特定訂閱項目」等主題
billingPeriodDuration

string

此規則適用此規則。如未指定，系統會比對訂閱任何帳單週期的使用者。

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

 讀取一或多個訂閱優惠。

batchUpdate

 更新批次訂閱優惠。

batchUpdateStates

 更新訂閱優惠狀態批次。

create

 建立新的訂閱優惠。

deactivate

 停用訂閱優惠。

delete

 刪除訂閱優惠。

get

 讀取單一方案

list

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

patch

 更新現有的訂閱優惠。