- 資源:SubscriptionPurchaseV2
- 訂閱狀態
- pauseStateContext
- CanceledStateContext
- UserInitiatedCancel
- CancelSurveyResult
- 取消問卷調查原因
- SystemInitiatedCancel
- 開發人員發起取消
- 取消換貨
- 測試購買
- AcknowledgementState
- ExternalAccountIdentifiers
- SubscriptionWithGoogleInfo
- SubscriptionPurchaseLineItem
- AutoRenewingPlan
- SubscriptionItemPriceChangeDetails
- PriceChangeMode
- PriceChangeState
- PrepaidPlan
- OfferDetails
- DeferredItem 替換
- 方法
資源:SubscriptionPurchaseV2
顯示使用者的訂閱購買狀態。
JSON 表示法 |
---|
{ "kind": string, "regionCode": string, "lineItems": [ { object ( |
欄位 | |
---|---|
kind |
此類型代表 Androidpublisher 服務中的 SubscriptionPurchaseV2 物件。 |
regionCode |
使用者訂閱時的 ISO 3166-1 alpha-2 帳單國家/地區代碼。 |
lineItems[] |
購買訂閱項目的商品層級資訊。在同一筆購買交易中只能購買 AutoRenewingPlan 或所有使用 PrepaidPlan 的商品。 |
startTime |
使用者授予訂閱項目的時間。未設定為待處理的訂閱 (已建立訂閱,但在註冊時正在等待付款)。 RFC3339 世界標準時間「祖魯文」格式的時間戳記,含奈秒解析度,最多九個小數位數。範例: |
subscriptionState |
訂閱項目目前的狀態。 |
latestOrderId |
與訂閱項目購買相關的最新訂單 ID。如果是自動續訂,則為未續訂的註冊訂單訂單 ID,或者最後一個週期性訂單 ID (成功、待處理或遭拒的訂單)。如果是預付型訂閱項目,這是與查詢購買憑證相關聯的訂單 ID。 |
linkedPurchaseToken |
如果訂閱為下列任一項,則舊訂閱項目的購買憑證:* 重新訂閱已取消但尚未失效的訂閱項目 * 升級/降級為先前的訂閱項目。* 從預付訂閱轉換為自動續約。* 從自動續約型訂閱方案轉換為預付方案。* 為預付訂閱方案儲值。 |
pausedStateContext |
有關暫停訂閱的其他背景資訊。只有在訂閱項目目前狀態為 SUBSCRIPTION_STATE_PAUSED 時,才會顯示此項目。 |
canceledStateContext |
關於取消訂閱的其他背景資訊。只有在訂閱項目目前具有 subscriptionState SUBSCRIPTION_STATE_CANCELED 時,才會顯示。 |
testPurchase |
只有在這項訂閱項目為測試購買交易時才會顯示。 |
acknowledgementState |
訂閱項目的確認狀態。 |
externalAccountIdentifiers |
第三方服務中的使用者帳戶 ID。 |
subscribeWithGoogleInfo |
與透過「透過 Google 訂閱」進行交易相關聯的使用者個人資料。 |
訂閱狀態
訂閱項目可能處於的狀態,例如是否有效。訂閱購買交易中的項目可以是所有自動續訂方案或預付方案。
列舉 | |
---|---|
SUBSCRIPTION_STATE_UNSPECIFIED |
未指定的訂閱狀態。 |
SUBSCRIPTION_STATE_PENDING |
已建立訂閱項目,但在註冊期間正在等待付款。在這個狀態中,所有商品正在等待付款。 |
SUBSCRIPTION_STATE_ACTIVE |
訂閱有效。- (1) 如果訂閱項目是自動續約方案,其中至少有一個項目為 autoRenewEnabled 且尚未過期。- (2) 如果訂閱項目為預付方案,至少要有一項商品並未過期。 |
SUBSCRIPTION_STATE_PAUSED |
已暫停訂閱。只有在訂閱項目為自動續約型方案時,系統才會顯示狀態。在這個狀態下,所有項目都會處於暫停狀態。 |
SUBSCRIPTION_STATE_IN_GRACE_PERIOD |
訂閱項目處於寬限期。只有在訂閱項目為自動續約型方案時,系統才會顯示狀態。在這個狀態下,所有項目均處於寬限期。 |
SUBSCRIPTION_STATE_ON_HOLD |
訂閱項目已暫停 (已停權)。只有在訂閱項目為自動續約型方案時,系統才會顯示狀態。以此狀態來說,所有項目均處於保留狀態。 |
SUBSCRIPTION_STATE_CANCELED |
訂閱項目已取消,但尚未到期。只有在訂閱項目為自動續約型方案時,系統才會顯示狀態。所有項目的 autoRenewEnabled 已設為 false。 |
SUBSCRIPTION_STATE_EXPIRED |
訂閱已過期。所有項目皆過去的 expiryTime。 |
已暫停狀態內容
處於暫停狀態的訂閱項目相關資訊。
JSON 表示法 |
---|
{ "autoResumeTime": string } |
欄位 | |
---|---|
autoResumeTime |
自動恢復訂閱的時間。 RFC3339 世界標準時間「祖魯文」格式的時間戳記,含奈秒解析度,最多九個小數位數。範例: |
已取消
處於已取消狀態的訂閱項目相關資訊。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位 cancellation_reason 。取消訂閱的原因。cancellation_reason 只能是下列其中一項: |
|
userInitiatedCancellation |
使用者已取消訂閱。 |
systemInitiatedCancellation |
系統已經取消訂閱項目,例如帳單發生問題。 |
developerInitiatedCancellation |
開發人員已取消訂閱。 |
replacementCancellation |
訂閱方案已由新的訂閱方案取代。 |
使用者啟動取消
使用者主動取消訂閱的相關資訊。
JSON 表示法 |
---|
{
"cancelSurveyResult": {
object ( |
欄位 | |
---|---|
cancelSurveyResult |
使用者在完成訂閱取消流程時提供的資訊 (取消訂閱原因問卷調查)。 |
cancelTime |
使用者取消訂閱項目的時間。這段期間過後,使用者可能仍可存取該訂閱項目。使用 lineItems.expiry_time 判斷使用者是否仍可存取。 RFC3339 世界標準時間「祖魯文」格式的時間戳記,含奈秒解析度,最多九個小數位數。範例: |
取消調查結果
使用者取消訂閱時的取消訂閱問卷調查結果。
JSON 表示法 |
---|
{
"reason": enum ( |
欄位 | |
---|---|
reason |
使用者在取消訂閱問卷調查中選取的原因。 |
reasonUserInput |
僅針對 CANCEL_SURVEY_REASON_OTHERS 設定。這是使用者對於問卷調查所做的任意形式回覆。 |
取消問卷調查原因
使用者在取消訂閱問卷調查中選取的原因。
列舉 | |
---|---|
CANCEL_SURVEY_REASON_UNSPECIFIED |
未指定取消問卷調查原因。 |
CANCEL_SURVEY_REASON_NOT_ENOUGH_USAGE |
訂閱項目使用次數不足。 |
CANCEL_SURVEY_REASON_TECHNICAL_ISSUES |
使用應用程式時的技術問題。 |
CANCEL_SURVEY_REASON_COST_RELATED |
費用相關問題。 |
CANCEL_SURVEY_REASON_FOUND_BETTER_APP |
使用者找到了更好的應用程式。 |
CANCEL_SURVEY_REASON_OTHERS |
其他原因。 |
SystemInated 取消
這個類型沒有任何欄位。
Google 系統主動取消訂閱的相關資訊。
開發人員初始化取消
這個類型沒有任何欄位。
開發人員主動取消訂閱的相關資訊。
取消換貨
這個類型沒有任何欄位。
與取消訂閱方案相關的取消訂閱資訊。
測試購買
這個類型沒有任何欄位。
指出這筆訂閱項目是否為測試購買交易。
確認狀態
訂閱項目的可能確認狀態。
列舉 | |
---|---|
ACKNOWLEDGEMENT_STATE_UNSPECIFIED |
未指定的確認狀態。 |
ACKNOWLEDGEMENT_STATE_PENDING |
訂閱項目尚未確認。 |
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED |
已確認訂閱。 |
外部帳戶識別碼
第三方服務中的使用者帳戶 ID。
JSON 表示法 |
---|
{ "externalAccountId": string, "obfuscatedExternalAccountId": string, "obfuscatedExternalProfileId": string } |
欄位 | |
---|---|
externalAccountId |
第三方服務中的使用者帳戶 ID。只有在訂閱購買流程中進行帳戶連結時才會顯示。 |
obfuscatedExternalAccountId |
經模糊處理的 ID 版本,僅與應用程式中的使用者帳戶相關聯。下列購買交易會顯示:* 如果帳戶連結是在訂閱購買流程中運作,* 此 ID 是在購買交易時透過 https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid 指定。 |
obfuscatedExternalProfileId |
ID 經過模糊處理的版本,只與應用程式中的使用者個人資料建立關聯。只有在購買交易時使用 https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid 指定,才會顯示 ID。 |
SubscriptionWithGoogleInfo
透過「透過 Google 訂閱」進行的購買交易相關資訊。
JSON 表示法 |
---|
{ "profileId": string, "profileName": string, "emailAddress": string, "givenName": string, "familyName": string } |
欄位 | |
---|---|
profileId |
購買訂閱項目的使用者 Google 個人資料 ID。 |
profileName |
購買訂閱項目的使用者設定檔名稱。 |
emailAddress |
購買訂閱項目的使用者電子郵件地址。 |
givenName |
購買訂閱項目時的使用者指定名稱。 |
familyName |
購買訂閱項目時的使用者姓氏。 |
SubscriptionPurchaseLine 項目
購買訂閱項目的商品層級資訊。
JSON 表示法 |
---|
{ "productId": string, "expiryTime": string, // Union field |
欄位 | |
---|---|
productId |
購買的產品 ID (例如「monthly001」)。 |
expiryTime |
訂閱到期或到期前的到期日,除非存取權延長 (例如續訂)。 RFC3339 世界標準時間「祖魯文」格式的時間戳記,含奈秒解析度,最多九個小數位數。範例: |
聯集欄位 plan_type 。訂閱方案類型。plan_type 只能是下列其中一項: |
|
autoRenewingPlan |
這個項目會自動續訂。 |
prepaidPlan |
商品為預付商品。 |
offerDetails |
此商品的優惠詳情。 |
聯集欄位 deferred_item_change 。此欄位會在項目延遲變更時顯示。可以移除或替換。deferred_item_change 只能是下列其中一項: |
|
deferredItemReplacement |
延後換貨相關資訊。 |
自動續約方案
自動續約方案相關資訊。
JSON 表示法 |
---|
{
"autoRenewEnabled": boolean,
"priceChangeDetails": {
object ( |
欄位 | |
---|---|
autoRenewEnabled |
如果訂閱項目目前設為自動續約,例如使用者未取消訂閱 |
priceChangeDetails |
訂閱後最後一次價格異動的資訊。 |
SubscriptionItemPriceChangeDetails
訂閱項目的價格異動資訊。
JSON 表示法 |
---|
{ "newPrice": { object ( |
欄位 | |
---|---|
newPrice |
訂閱項目的新週期性價格。 |
priceChangeMode |
價格變更模式會指定訂閱商品價格的異動方式。 |
priceChangeState |
說明目前的價格異動。 |
expectedNewPriceChargeTime |
價格異動生效時間為使用者生效的續訂時間。由於續約時間因暫停等而產生變化,因此這項決定可能會隨時變動。 RFC3339 世界標準時間「祖魯文」格式的時間戳記,含奈秒解析度,最多九個小數位數。範例: |
價格變更模式
價格變更模式。
列舉 | |
---|---|
PRICE_CHANGE_MODE_UNSPECIFIED |
未指定價格變更模式。請勿設定這個值。 |
PRICE_DECREASE |
如果訂閱價格調降。 |
PRICE_INCREASE |
如果訂閱價格調漲,使用者必須接受訂閱價格。 |
OPT_OUT_PRICE_INCREASE |
如果訂閱價格在選擇停用模式後調漲。 |
價格變更狀態
價格變更的狀態。
列舉 | |
---|---|
PRICE_CHANGE_STATE_UNSPECIFIED |
未指定價格變更狀態。請不要使用這個值。 |
OUTSTANDING |
等待使用者同意價格異動。 |
CONFIRMED |
確認價格異動適用於使用者。 |
APPLIED |
價格異動 (即使用者已開始按照新價格收費)。 |
預付方案
預付方案的相關資訊。
JSON 表示法 |
---|
{ "allowExtendAfterTime": string } |
欄位 | |
---|---|
allowExtendAfterTime |
如果是的話,此為預付方案允許儲值的期限。過期的預付方案不會顯示。 RFC3339 世界標準時間「祖魯文」格式的時間戳記,含奈秒解析度,最多九個小數位數。範例: |
優惠詳情
購買明細項目的相關優惠詳細資料。
JSON 表示法 |
---|
{ "offerTags": [ string ], "basePlanId": string, "offerId": string } |
欄位 | |
---|---|
offerTags[] |
與優惠相關聯的最新優惠代碼。當中包含沿用自基本方案的代碼。 |
basePlanId |
基本方案 ID。所有基本方案和優惠皆可使用。 |
offerId |
優惠 ID。僅適用於折扣優惠。 |
延遲商品替換
延遲換貨相關資訊。
JSON 表示法 |
---|
{ "productId": string } |
欄位 | |
---|---|
productId |
要取代現有產品 ID 的 productId。 |
方法 |
|
---|---|
|
取得訂閱項目的相關中繼資料 |