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)

必填。這個訂閱項目的 apks.list 本地化產品資訊。至少須包含父項應用程式預設語言的項目。

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)

)。這項基本方案的訂閱優惠也會在帳款服務程式庫中收到這些優惠標記。

otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Play 日後可能推出的任何新地區定價資訊。省略後,PlayPlan 日後將無法自動在所有新地區推出。

聯集欄位 base_plan_type。這項基本方案的類型。只能設定其中一個。base_plan_type 只能是下列其中一項:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

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

prepaidBasePlanType

object (PrepaidBasePlanType)

設定基本方案停止在帳單週期結束時自動續約。

狀態

基礎方案的目前狀態。

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

AutoRenewingBasePlanType

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

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 商店和平台在平台中享有的福利,以相關語言顯示的清單內容。純文字。已排序的最多四項福利清單。

description

string

此訂閱項目以此語言的語言說明。長度上限 - 80 個半形字元。純文字。

方法

archive

封存訂閱項目。

create

建立新的訂閱項目。

delete

刪除訂閱項目。

get

讀取單一訂閱項目。

list

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

patch

更新現有的訂閱。