- 資源:SubscriptionPurchaseV2
- SubscriptionState
- PausedStateContext
- CanceledStateContext
- UserInitiatedCancellation
- CancelSurveyResult
- CancelSurveyReason
- SystemInitiatedCancellation
- DeveloperInitiatedCancellation
- ReplacementCancellation
- TestPurchase
- AcknowledgementState
- ExternalAccountIdentifiers
- SubscribeWithGoogleInfo
- SubscriptionPurchaseLineItem
- AutoRenewingPlan
- SubscriptionItemPriceChangeDetails
- PriceChangeMode
- PriceChangeState
- InstallmentPlan
- PendingCancellation
- PrepaidPlan
- OfferDetails
- DeferredItemReplacement
- 方法
資源:SubscriptionPurchaseV2
指出使用者的訂閱購買狀態。
JSON 表示法 |
---|
{ "kind": string, "regionCode": string, "lineItems": [ { object ( |
欄位 | |
---|---|
kind |
這個種類代表 androidpublisher 服務中的 SubscriptionPurchaseV2 物件。 |
regionCode |
使用者取得訂閱項目時的 ISO 3166-1 alpha-2 帳單國家/地區代碼。 |
lineItems[] |
訂閱項目購買交易的商品層級資訊。同一筆購買交易中的商品必須全部使用 AutoRenewingPlan 或預付方案 (PrepaidPlan)。 |
startTime |
訂閱的時間。未設定待處理訂閱項目 (已建立訂閱項目,但在申請過程中等待付款)。 採用 RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度和最多九個小數位數。範例: |
subscriptionState |
訂閱項目的目前狀態, |
latestOrderId |
與購買訂閱相關的最新訂單訂單 ID。針對自動續約,這是指註冊訂單的訂單 ID (如果尚未續訂) 或上次週期性訂單 ID (成功、待處理或遭拒的訂單)。如果是預付型訂閱項目,這是與所查詢購買憑證相關聯的訂單 ID。 |
linkedPurchaseToken |
舊訂閱項目的購買憑證:** 從預付轉換為自動續訂。* 從自動續訂型訂閱方案轉換為預付方案。* 為預付訂閱項目儲值。 |
pausedStateContext |
暫停訂閱項目的其他背景資訊。只有在訂閱項目目前具有 subscriptionState SUBSCRIPTION_STATE_PAUSED 時,才會顯示這項資料。 |
canceledStateContext |
取消訂閱的其他資訊。只有在訂閱項目目前具有 subscriptionState SUBSCRIPTION_STATE_CANCELED 或 SUBSCRIPTION_STATE_EXPIRED 時,才會顯示。 |
testPurchase |
只有在這筆訂閱交易為測試購買交易時才會顯示。 |
acknowledgementState |
訂閱的確認狀態。 |
externalAccountIdentifiers |
第三方服務中的使用者帳戶 ID。 |
subscribeWithGoogleInfo |
與透過「透過 Google 訂閱」交易相關聯的使用者個人資料。 |
SubscriptionState
訂閱項目的潛在狀態,例如訂閱項目是否有效。訂閱購買中的項目可以是自動續訂方案或預付方案。
列舉 | |
---|---|
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。 |
SUBSCRIPTION_STATE_PENDING_PURCHASE_CANCELED |
訂閱項目的待處理交易已取消。如果這筆待處理購買交易適用於現有訂閱項目,請使用 linkPurchaseToken 取得該訂閱項目的目前狀態。 |
PausedStateContext
處於暫停狀態的訂閱項目專屬資訊。
JSON 表示法 |
---|
{ "autoResumeTime": string } |
欄位 | |
---|---|
autoResumeTime |
自動恢復訂閱的時間。 採用 RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度和最多九個小數位數。範例: |
CanceledStateContext
屬於 SUBSCRIPTION_STATE_CANCELED 或 SUBSCRIPTION_STATE_EXPIRED 狀態訂閱項目的相關資訊。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位 cancellation_reason 。取消訂閱的原因。cancellation_reason 只能是下列其中一項: |
|
userInitiatedCancellation |
使用者已取消訂閱。 |
systemInitiatedCancellation |
系統已取消訂閱項目 (例如帳單問題)。 |
developerInitiatedCancellation |
開發人員已取消訂閱。 |
replacementCancellation |
訂閱方案已由新的訂閱方案取代。 |
UserInitiatedCancellation
使用者主動取消訂閱的相關資訊。
JSON 表示法 |
---|
{
"cancelSurveyResult": {
object ( |
欄位 | |
---|---|
cancelSurveyResult |
使用者在完成訂閱取消流程時提供的資訊 (取消訂閱原因問卷調查)。 |
cancelTime |
使用者取消訂閱的時間。超過這段時間後,使用者仍可存取該訂閱項目。使用 lineItems.expiry_time 判斷使用者是否仍具有存取權。 採用 RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度和最多九個小數位數。範例: |
CancelSurveyResult
使用者取消訂閱時取消訂閱的問卷調查結果。
JSON 表示法 |
---|
{
"reason": enum ( |
欄位 | |
---|---|
reason |
使用者在取消訂閱問卷調查中選取的原因。 |
reasonUserInput |
僅為 CANCEL_SURVEY_REASON_OTHERS 設定。這是使用者對問卷調查提供的任意形式回覆。 |
CancelSurveyReason
使用者在取消訂閱問卷調查中選取的原因。
列舉 | |
---|---|
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 |
其他原因。 |
SystemInitiatedCancellation
這個類型沒有任何欄位。
Google 系統發起的取消作業相關資訊。
DeveloperInitiatedCancellation
這個類型沒有任何欄位。
由開發人員啟動的取消訂閱作業相關資訊。
ReplacementCancellation
這個類型沒有任何欄位。
關於更換訂閱方案造成的取消訂閱資訊。
TestPurchase
這個類型沒有任何欄位。
此訂閱項目是否為測試購買。
AcknowledgementState
訂閱項目的可能確認狀態。
列舉 | |
---|---|
ACKNOWLEDGEMENT_STATE_UNSPECIFIED |
未指定的確認狀態。 |
ACKNOWLEDGEMENT_STATE_PENDING |
尚未確認訂閱項目。 |
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED |
已確認訂閱。 |
ExternalAccountIdentifiers
第三方服務中的使用者帳戶 ID。
JSON 表示法 |
---|
{ "externalAccountId": string, "obfuscatedExternalAccountId": string, "obfuscatedExternalProfileId": string } |
欄位 | |
---|---|
externalAccountId |
第三方服務中的使用者帳戶 ID。只有在帳戶連結是在訂閱購買流程時才會顯示。 |
obfuscatedExternalAccountId |
經過模糊處理的 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 進行指定時才會顯示。 |
SubscribeWithGoogleInfo
透過「透過 Google 訂閱」完成的交易相關資訊。
JSON 表示法 |
---|
{ "profileId": string, "profileName": string, "emailAddress": string, "givenName": string, "familyName": string } |
欄位 | |
---|---|
profileId |
購買訂閱項目時使用者的 Google 個人資料 ID。 |
profileName |
購買訂閱項目時使用者的個人資料名稱。 |
emailAddress |
購買訂閱項目的使用者電子郵件地址。 |
givenName |
購買訂閱項目時的使用者名稱, |
familyName |
購買訂閱項目時使用者的姓氏。 |
SubscriptionPurchaseLineItem
訂閱項目購買交易的商品層級資訊。
JSON 表示法 |
---|
{ "productId": string, "expiryTime": string, // Union field |
欄位 | |
---|---|
productId |
購買的產品 ID (例如「monthly001」)。 |
expiryTime |
訂閱到期或即將到期的時間,除非存取權延長 (例如續訂)。 採用 RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度和最多九個小數位數。範例: |
聯集欄位 plan_type 。訂閱方案類型。plan_type 只能是下列其中一項: |
|
autoRenewingPlan |
該項目將自動續約。 |
prepaidPlan |
商品已預付郵資。 |
offerDetails |
這項商品的優惠詳細資料。 |
聯集欄位 deferred_item_change 。該項目有延遲變更時才會顯示。您可以移除或替換名稱。deferred_item_change 只能是下列其中一項: |
|
deferredItemReplacement |
延後商品更換資訊。 |
AutoRenewingPlan
自動續約方案的相關資訊。
JSON 表示法 |
---|
{ "autoRenewEnabled": boolean, "priceChangeDetails": { object ( |
欄位 | |
---|---|
autoRenewEnabled |
如果訂閱項目目前設為自動續約,例如使用者未取消訂閱 |
priceChangeDetails |
訂閱註冊後項目最近一次價格異動的資訊。 |
installmentDetails |
分期付款方案的承諾使用合約,以及自動續訂方案的各州相關資訊。 |
SubscriptionItemPriceChangeDetails
訂閱項目的價格異動相關資訊。
JSON 表示法 |
---|
{ "newPrice": { object ( |
欄位 | |
---|---|
newPrice |
訂閱項目的新週期性價格。 |
priceChangeMode |
價格變更模式可指定訂閱項目價格的變化方式。 |
priceChangeState |
說明價格異動目前的狀況。 |
expectedNewPriceChargeTime |
價格異動生效的續約時間。但因為續約時間改變 (例如暫停),所以這可能有所變動 (未來的時間)。只有在價格異動尚未生效時,系統才會填入這個欄位。 採用 RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度和最多九個小數位數。範例: |
PriceChangeMode
價格異動的模式。
列舉 | |
---|---|
PRICE_CHANGE_MODE_UNSPECIFIED |
未指定價格變更模式。請勿設定這個值。 |
PRICE_DECREASE |
如果訂閱價格調降。 |
PRICE_INCREASE |
如果訂閱價格會調漲,且使用者必須接受價格。 |
OPT_OUT_PRICE_INCREASE |
如果訂閱價格在選擇不採用模式下會調漲。 |
PriceChangeState
價格異動的狀態。
列舉 | |
---|---|
PRICE_CHANGE_STATE_UNSPECIFIED |
未指定價格異動狀態。請勿使用這個值。 |
OUTSTANDING |
正在等待使用者同意價格異動。 |
CONFIRMED |
價格異動已確定對使用者生效。 |
APPLIED |
系統會套用價格異動,也就是說,系統已開始向使用者收取新價格。 |
InstallmentPlan
分期付款方案的資訊。
JSON 表示法 |
---|
{
"initialCommittedPaymentsCount": integer,
"subsequentCommittedPaymentsCount": integer,
"remainingCommittedPaymentsCount": integer,
"pendingCancellation": {
object ( |
欄位 | |
---|---|
initialCommittedPaymentsCount |
使用者最初簽訂的付款總額。 |
subsequentCommittedPaymentsCount |
使用者在各承諾使用期間內,承諾支付的費用總額。空白表示分期付款方案在初次簽約後會改回一般的自動續約訂閱。 |
remainingCommittedPaymentsCount |
此續約週期內剩餘的承諾付款總數。 |
pendingCancellation |
如果顯示這項分期付款方案,表示待取消。只有在使用者完成所有承諾付款後,系統才會取消該帳戶。 |
PendingCancellation
這個類型沒有任何欄位。
這項指標代表虛擬分期付款方案是否有待取消。只有在使用者完成所有承諾付款後,系統才會取消該帳戶。
PrepaidPlan
預付方案相關資訊。
JSON 表示法 |
---|
{ "allowExtendAfterTime": string } |
欄位 | |
---|---|
allowExtendAfterTime |
如有,則預付方案可在這段時間內儲值。過期的預付方案則不會顯示。 採用 RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度和最多九個小數位數。範例: |
OfferDetails
與購買明細項目相關的優惠詳細資料。
JSON 表示法 |
---|
{ "offerTags": [ string ], "basePlanId": string, "offerId": string } |
欄位 | |
---|---|
offerTags[] |
與優惠相關聯的最新優惠標記。包含從基本方案沿用的標記。 |
basePlanId |
基本方案 ID。呈現所有基本方案和優惠。 |
offerId |
優惠 ID。僅適用於提供折扣優惠。 |
DeferredItemReplacement
延遲商品替換的相關資訊。
JSON 表示法 |
---|
{ "productId": string } |
欄位 | |
---|---|
productId |
用來取代現有產品 ID 的 productId。 |
方法 |
|
---|---|
|
取得訂閱項目的中繼資料 |
|
撤銷使用者的訂閱項目購買交易。 |