REST Resource: monetization.subscriptions

• 資源：Subscription
  • JSON 表示法
• BasePlan
  • JSON 表示法
• 狀態
• AutoRenewingBasePlanType
  • JSON 表示法
• ResubscribeState
• SubscriptionProrationMode
• PrepaidBasePlanType
  • JSON 表示法
• TimeExtension
• RegionalBasePlanConfig
  • JSON 表示法
• OtherRegionsBasePlanConfig
  • JSON 表示法
• SubscriptionListing
  • JSON 表示法
• 方法

資源：Subscription

應用程式的單一訂閱項目。

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

欄位
packageName	string 不可變動。父項應用程式的套件名稱。
productId	string 不可變動。產品的專屬產品 ID。在上層應用程式中，產品 ID 不得重複。產品 ID 必須由小寫英文字母 (a-z)、數字 (0-9)、底線 (_) 和半形句號 (.) 組成，開頭須為小寫英文字母或數字，長度必須介於 1 到 40 個半形字元之間。
basePlans[]	object (BasePlan) 這個訂閱項目的基本方案組合。代表在未適用其他優惠的情況下，訂閱價格和訂閱期間。
listings[]	object (SubscriptionListing) 必要欄位。此訂閱項目的本地化清單清單。至少須有一個父項應用程式預設語言的項目。
archived (deprecated)	boolean 這個項目現已淘汰！ 僅供輸出。已淘汰：系統不支援訂閱項目封存功能。
taxAndComplianceSettings	object (SubscriptionTaxAndComplianceSettings) 稅金與法規遵循詳細資料。

BasePlan

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

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 日後可能會推出所有新地區的定價資訊。如果省略此屬性，系統就不會自動提供 Google Play 未來推出任何新地點的 BasePlan 方案。
聯集欄位 base_plan_type。此基本方案的類型。只能設定一個值。base_plan_type 只能是下列其中一項：
autoRenewingBasePlanType	object (AutoRenewingBasePlanType) 設定基本方案定期自動續訂的時間。
prepaidBasePlanType	object (PrepaidBasePlanType) 設定在帳單週期結束時不要自動續訂基本方案的時間。

狀態

基本方案的目前狀態。

列舉
STATE_UNSPECIFIED	未指定狀態。
DRAFT	基本方案目前為草稿狀態，尚未啟用。此時您可以放心刪除此檔案。
ACTIVE	基本方案有效，可供新訂閱者使用。
INACTIVE	基本方案已停用，僅供現有訂閱者使用。

AutoRenewingBasePlanType

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

JSON 表示法
{ "billingPeriodDuration": string, "gracePeriodDuration": string, "accountHoldDuration": 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 天)。如未指定，系統將根據重複週期長度使用預設值。
accountHoldDuration	string 選用設定。訂閱的帳戶保留期，以 ISO 8601 格式指定。可接受的值必須介於 DAYS 之間，且必須介於 P0D (零 天) 到 P30D (30 天) 之間。如未指定，則預設值為 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() 方法傳回。 針對特定續約基本方案，您只能將一項訂閱優惠標示為與舊版相容。 如果沒有與舊版相容的訂閱優惠，請將這個欄位設為空白字串。

ResubscribeState

基本方案重新訂閱狀態。

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

SubscriptionProrationMode

用於更新基本方案的依比例計費模式。

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

PrepaidBasePlanType

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

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

欄位
billingPeriodDuration	string 必要欄位。以 ISO 8601 格式指定的訂閱期。如需可接受的帳單週期清單，請參閱說明中心。
timeExtension	enum (TimeExtension) 是否應讓使用者在 Google Play 途徑中延長預付基本方案。若未指定，則預設為 TIME_EXTENSION_ACTIVE。

TimeExtension

基本方案的時間延長。

列舉
TIME_EXTENSION_UNSPECIFIED	未指定狀態。
TIME_EXTENSION_ACTIVE	已啟用時段。使用者可以儲值或延長預付方案。
TIME_EXTENSION_INACTIVE	時間範圍已停用。使用者無法儲值或延長預付方案。

RegionalBasePlanConfig

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

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

欄位
regionCode	string 必要欄位。這項設定要套用的區碼 (由 ISO 3166-2 定義，例如「US」)。
newSubscriberAvailability	boolean 指出指定區域的基本方案是否可供新訂閱者使用。如果將這個值設為 False，現有訂閱者就不會取消訂閱。如果未指定，則預設為 false。
price	object (Money) 指定區域中的基本方案價格。如果基本方案適用於新訂閱者，就必須設定。必須使用與指定區域連結的貨幣。

OtherRegionsBasePlanConfig

Google Play 可能推出新地區之定價資訊。

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

欄位
usdPrice	object (Money) 必要欄位。Play 可能在 Google Play 推出新地點時使用的價格 (以美元為單位)。
eurPrice	object (Money) 必要欄位。價格 (歐元)，用於 Google Play 在當地推出的所有新地區。
newSubscriberAvailability	boolean 查看基本方案是否適用於 Google Play 在新推出國家/地區的新訂閱者。如果未指定，則預設為 false。

SubscriptionListing

訂閱項目的消費端中繼資料。

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

欄位
languageCode	string 必要欄位。此商家資訊的語言，由 BCP-47 定義，例如「en-US」。
title	string 必要欄位。這個訂閱項目的標題，採用這則商店資訊的語言。純文字。
benefits[]	string 使用者在平台 (例如 Play 商店) 和還原流程中，以此商店資訊語言顯示的福利清單。純文字。列出最多四項福利的排序清單。
description	string 這項訂閱項目的說明，適用此商店資訊的語言。長度上限為 80 個半形字元。純文字。

方法
archive (deprecated)	已淘汰：系統不支援訂閱項目封存功能。
batchGet	讀取一或多個訂閱項目。
batchUpdate	更新一批訂閱項目。
create	建立新的訂閱項目。
delete	刪除訂閱項目。
get	讀取單一訂閱項目。
list	列出特定應用程式下的所有訂閱項目。
patch	更新現有的訂閱項目。