REST Resource: monetization.subscriptions

資源：訂閱

單一應用程式訂閱項目。

JSON 表示法 
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  }
}
欄位
packageName

string

不可變動。上層應用程式的套件名稱。
productId

string

不可變動。產品的專屬產品 ID。在父項應用程式中不得重複。產品 ID 必須由小寫英文字母 (a-z)、數字 (0-9)、底線 (_) 和點號 (.) 組成，而且開頭必須為小寫英文字母或數字，長度必須介於 1 到 40 (含) 之間。
basePlans[]

object (BasePlan)

這個訂閱項目的基本方案組合。代表該優惠的價格和訂閱期間 (不含其他優惠)。
listings[]

object (SubscriptionListing)

必要欄位。此訂閱項目的本地化清單。至少必須包含一個父項應用程式預設語言的項目。
archived

boolean

僅供輸出。這個訂閱項目是否已封存。所有訂閱者都無法再存取已封存的訂閱項目，而且無法更新，而且也無法在清單要求中傳回封存，除非已傳遞節目的封存標記。
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

稅務與法規遵循詳細資料。

基本方案

訂閱項目的單一基本方案。

JSON 表示法 
{
  "basePlanId": string,
  "state": enum (State),
  "regionalConfigs": [
    {
      object (RegionalBasePlanConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsBasePlanConfig)
  },

  // Union field base_plan_type can be only one of the following:
  "autoRenewingBasePlanType": {
    object (AutoRenewingBasePlanType)
  },
  "prepaidBasePlanType": {
    object (PrepaidBasePlanType)
  }
  // End of list of possible types for union field base_plan_type.
}
欄位
basePlanId

string

必要欄位。不可變動。這項基本方案的專屬 ID。訂閱中不得重複，且符合 RFC-1034 標準。也就是說，這個 ID 只能包含小寫英文字母 (a 至 z)、數字 (0 至 9) 和連字號 (-)，但不得超過 63 個字元。
state

enum (State)

僅供輸出。基本方案的狀態，例如是否處於有效狀態。您可以選擇啟用或刪除基本方案草稿和停用方案。您可以將有效的基本方案設為停用狀態。可以取消停用的基本方案。這個欄位更新時無法變更這個欄位。請改用專屬端點。
regionalConfigs[]

object (RegionalBasePlanConfig)

這項基本方案的特定地區資訊。
offerTags[]

object (OfferTag)

為這個基本方案指定最多 20 個自訂標記，並透過帳款服務程式庫傳回應用程式。這項基本方案的訂閱優惠也會在帳單庫中收到這些優惠標記。
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Play 日後推出的任何新地區價格資訊，省略後，PlayPlan 將不會在日後推出的任何新地區提供自動方案。
聯集欄位 base_plan_type。這項基本方案的類型。只能設定一個。base_plan_type 只能是下列其中一項：
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

設定基本方案自動定期續訂的時間。
prepaidBasePlanType

object (PrepaidBasePlanType)

設定基本方案未於帳單週期結束時自動續約。

狀態

基本方案的目前狀態。

列舉
STATE_UNSPECIFIED 未指定狀態。
DRAFT 基礎方案目前為草稿狀態，但尚未啟用。此時即可安全刪除。
ACTIVE 基本方案目前可供新訂閱者使用。
INACTIVE 基本方案已停用，且僅適用於現有訂閱者。

自動續訂基礎方案類型

代表的是在訂閱期結束時自動續訂的基本方案。

JSON 表示法 
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}
欄位
billingPeriodDuration

string

必要欄位。訂閱週期，以 ISO 8601 格式指定。如需可接受的帳單週期清單，請參閱說明中心。
gracePeriodDuration

string

訂閱項目的寬限期，以 ISO 8601 格式指定。可接受的值為 P0D（零日）、P3D（3 天）、P7D（7 天）、P14D（14 天）和 P30D（30 天）。如未指定，系統會使用週期性期間的預設值。
resubscribeState

enum (ResubscribeState)

是否允許使用者在 Google Play 平台上重新訂閱這項基本方案。若未指定，預設會使用 RESUBSCRIBE_STATE_ACTIVE。
prorationMode

enum (SubscriptionProrationMode)

基本方案的依比例計費模式會決定使用者從其他基本方案改用該方案後會發生什麼情況。如未指定，則預設為 CHARGE_ON_NEXT_BILLING_DATE。
legacyCompatible

boolean

續約基本方案是否回溯相容。

Google Play 帳款服務程式庫已淘汰的 querySkuDetailsAsync() 方法將傳回回溯相容的基本方案。

您只能將單一續約的基本方案標示為適用於舊版訂閱項目。
legacyCompatibleSubscriptionOfferId

string

與舊版相容的訂閱項目優惠 ID。

Google Play 帳款服務程式庫已淘汰的 querySkuDetailsAsync() 方法將傳回回溯相容的訂閱項目優惠。

針對特定續約方案，您只能將一項訂閱優惠標示為舊版相容。

如果要讓訂閱項目與舊版不相容，請將這個欄位設為空白字串。

重新訂閱狀態

基本方案重新訂閱狀態。

列舉
RESUBSCRIBE_STATE_UNSPECIFIED 未指定狀態。
RESUBSCRIBE_STATE_ACTIVE 目前已啟用重新訂閱功能。
RESUBSCRIBE_STATE_INACTIVE 已停用重新訂閱功能。

訂閱比例

用於續訂基本方案的依比例計費模式。

列舉
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED 未指定模式。
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE 系統將在當前帳單週期結束時向使用者收取新的基本方案費用。
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY 系統會立即向使用者收取新的基本方案費用。現有訂閱方案的剩餘訂閱期將以新計費方案的效期為準。

預付型基本方案類型

代表基本方案結束時不會自動續訂，且必須由使用者手動續訂。

JSON 表示法 
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
欄位
billingPeriodDuration

string

必要欄位。訂閱週期，以 ISO 8601 格式指定。如需可接受的帳單週期清單，請參閱說明中心。
timeExtension

enum (TimeExtension)

使用者是否應可在 Google Play 平台中延長預付型基本方案。若未指定，預設會使用 TIME_EXTENSION_ACTIVE。

時間額外資訊

基礎方案的時間延長。

列舉
TIME_EXTENSION_UNSPECIFIED 未指定狀態。
TIME_EXTENSION_ACTIVE 已啟用擴充功能。使用者可以儲值或延長預付方案。
TIME_EXTENSION_INACTIVE 已停用擴充功能。使用者無法儲值或延長預付方案。

地區基本方案設定

地區特定基本方案的設定。

JSON 表示法 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}
欄位
regionCode

string

必要欄位。這項設定適用的區域代碼 (如 ISO 3166-2 所定義，例如「US」)。
newSubscriberAvailability

boolean

指定地區的基本方案是否適用於新訂閱者。如果這個值設為 false，現有訂閱者將不會取消訂閱。如未指定，則預設為 false。
price

object (Money)

指定區域的基本方案價格。新訂閱者必須採用基本方案。您必須設定與指定區域連結的幣別。

其他地區基礎方案設定

Play 可能推出新地點的定價資訊。

JSON 表示法 
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "newSubscriberAvailability": boolean
}
欄位
usdPrice

object (Money)

必要欄位。Play 推出新地區時一律以美元計價的價格。
eurPrice

object (Money)

必要欄位。Play 推出新地區時一律以歐元計價。
newSubscriberAvailability

boolean

是否可在 Play 新地區的任何新訂閱者提供基本方案。如未指定，則預設為 false。

訂閱清單

訂閱項目的可見使用者中繼資料。

JSON 表示法 
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
欄位
languageCode

string

必要欄位。此商家資訊的語言，如 BCP-47 所定義，例如「en-US」。
title

string

必要欄位。此訂閱項目的名稱 (商家資訊的語言版本)。純文字。
benefits[]

string

使用者使用 Play 平台 (例如 Play 商店) 和還原流程 (以此產品資訊的語言進行) 後所顯示的福利清單。純文字。已排序的最多四項福利清單。
description

string

此訂閱項目說明的語言 (此商家資訊的語言)。長度上限 - 80 個字元。純文字。

方法

archive

 封存訂閱項目。

create

 建立新的訂閱項目。

delete

 刪除訂閱項目。

get

 讀取單一訂閱項目。

list

 列出特定應用程式下的所有訂閱。

patch

 更新現有的訂閱。