取得訂閱附加功能購買記錄

在 Microsoft 商店分析 API 中使用此方法，來獲取在指定日期範圍和其他可選篩選條件下應用程式附加元件訂閱的匯總擷取數據。

先決條件

若要使用此方法，您必須先執行下列動作：

如果您尚未執行此操作，請完成 Microsoft Store 分析 API 的所有必要條件。
取得 Azure AD 存取權杖以便用於此方法的要求標頭中。取得存取令牌之後，您必須在 60 分鐘内使用它，否則將會失效。令牌到期之後，您可以取得新的令牌。

請求

請求語法

方法	請求網址識別碼 (URI)
獲取	`https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions`

請求標頭

頁首	類型	說明
授權	字符串	必須的。 Azure AD 存取令牌的形式為 Bearer<token>。

要求參數

參數	類型	說明	為必填項目
應用程式ID	字符串	您想要擷取訂用帳戶附加元件下載數據之應用程式的市集標識碼。	是的
訂閱產品ID (subscriptionProductId)	字符串	您想要擷取下載數據之訂用帳戶附加元件市集標識碼。如果您未指定此值，這個方法會傳回指定應用程式之所有訂用帳戶附加元件的下載數據。	否
開始日期	日期	要擷取之訂閱附加元件下載數據之日期範圍的開始日期。預設值為目前的日期。	否
結束日期	日期	要擷取之訂閱附加元件下載數據之日期範圍的結束日期。預設值為目前的日期。	否
返回頁首	整數 (int)	要求中要傳回的數據列數。如果未指定，則最大值和預設值為100。如果查詢中有更多資料列，回應內容會包含下一個連結，您可以使用該連結來請求下一頁的資料。	否
略過	整數 (int)	查詢中要略過的行數目。使用此參數逐頁流覽大型數據集。例如，top=100 和 skip=0 會擷取前 100 個數據列，top=100 且 skip=100 會擷取接下來的 100 個數據列等等。	否
篩選器	字符串	一個或多個用於篩選回應內容的語句。每個語句都可以使用 eq 或 ne 運算符，而語句可以使用和或或結合。您可以在篩選條件中指定下列字串（這些字串對應至回應主體中的值）：日期訂閱產品名稱應用程式名稱庫存單位識別碼市場裝置類型以下是篩選參數範例：filter=date eq '2017-07-08'。	否
聚合層級	字符串	指定要擷取匯總數據的時間範圍。可以是下列其中一個字串：day、week 或 month。如果未指定，則預設值為 day。	否
排序	字符串	排序每個訂閱附加元件下載結果數據值的語句。語法為 orderby=field [order]，field [order],...。 field 參數可以是下列其中一個字符串：日期訂閱產品名稱應用程式名稱庫存單位識別碼市場裝置類型 order 參數是選擇性的，而且可以是 asc 或 desc，以指定每個欄位的遞增或遞減順序。預設為asc。以下是 orderby 字串範例： orderby=date，market	否
按群組分類	字符串	僅將資料彙總套用至指定欄位的陳述式。您可以指定下欄位：日期訂閱產品名稱應用程式名稱庫存單位識別碼市場裝置類型 groupby 參數可以搭配 aggregationLevel 參數使用。例如： groupby=market&aggregationLevel=week	否

範例請求

下列範例示範如何取得訂閱附加元件獲取數據。將 applicationId 值替換為您的應用程式適用的 Store ID。

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions?applicationId=9NBLGGGZ5QDR&startDate=2017-07-07&endDate=2017-07-08 HTTP/1.1
Authorization: Bearer <your access token>

回應

回應主體

價值觀	類型	說明
價值觀	陣列	包含匯總訂閱附加元件獲取數據的物件陣列。如需有關每個物件中資料的更多資訊，請參閱下方的訂閱取得數值這一節。
@nextLink	字符串	如果有額外的數據頁面，此字串會包含可用來要求下一頁數據的 URI。例如，如果要求的頂端參數設定為100，但查詢的訂閱附加功能取得數據超過100列，則會傳回此值。
總計數	整數 (int)	查詢的資料結果中的總列數。

訂閱獲取值

Value 陣列中的元素包含下列值。

價值觀	類型	說明
日期	字符串	取得數據之日期範圍中的第一個日期。如果要求指定了單一天，這個值就是該日期。如果要求指定了一周、月或其他日期範圍，這個值就是該日期範圍中的第一個日期。
訂閱產品ID (subscriptionProductId)	字符串	您要擷取購買數據的訂閱附加元件，其市集標識碼為，ID 為。
訂閱產品名稱 subscriptionProductName	字符串	訂閱附加元件的顯示名稱。
應用程式ID	字符串	您要擷取用來獲取訂閱附加元件數據的應用程式之市集識別碼。
應用程式名稱	字符串	應用程式的顯示名稱。
skuId 的	字符串	您要擷取下載數據之訂用帳戶附加元件 SKU 的標識碼。
裝置類型	字符串	下列其中一個字串，指定完成擷取的裝置類型：個人電腦手機 Console-Xbox One Console-Xbox X系列物聯網全像攝影未知
市場	字符串	發生收購之市場的 ISO 3166 國家/地區代碼。
貨幣代碼	字符串	稅前總銷售額的 ISO 4217 格式貨幣代碼。
稅前總銷售額	整數	以currencyCode 值指定的當地貨幣計算的總銷售額。
總活躍計數 (totalActiveCount)	整數	指定時段內使用中訂閱總數。這相當於 goodStandingActiveCount、pendingGraceActiveCount、graceActiveCount和 lockedActiveCount 值的總和。
總流失數量	整數	在指定時段內停用的訂用帳戶總數。這相當於 billingChurnCount總和、nonRenewalChurnCount、refundChurnCount、chargebackChurnCount、earlyChurnCount，以及其他ChurnCount 值。
新計數	整數	指定時段內的新訂用帳戶取得次數，包括試用版。
續訂次數	整數	指定期間內的訂閱續約數目，包括使用者起始的續約和自動更新。
良好狀況活躍計數	整數	在指定時段內的有效訂閱數目，其中到期日為查詢的 >= endDate 值。
等候寬限啟動計數	整數	在指定時段內作用中但發生計費失敗的訂用帳戶，其訂用帳戶到期日為 >，相等於查詢中的 endDate 值。
寬限期活動計數	整數	在指定時段內，發生計費失敗的活躍訂用帳戶數目，且符合以下條件。訂用帳戶到期日是用於查詢的 < 日期值中 endDate 的值。寬限期結束的時間是 >= endDate 的值。
鎖定活動計數	整數	在指定期間內處於催繳狀態的訂用帳戶數目（也就是訂用帳戶接近到期，Microsoft 嘗試取得資金以自動續約），以及以下條件的訂用帳戶：訂用帳戶到期日是用於查詢的 < 日期值中 endDate 的值。寬限期結束的時間是 <= endDate 的值。
billingChurnCount	整數	由於計費失敗，在先前已進入催收程序的訂用帳戶中，在指定時段內被停用的訂用帳戶數目。
未續約流失數量	整數	在指定的時段內停用的訂閱數目，因為它們未更新。
refundChurnCount	整數	在指定時段內因退款而停用的訂閱數量。
chargebackChurnCount	整數	由於退款，在指定時段內停用的訂用帳戶數目。
earlyChurnCount	整數	在指定時段內，正常狀態下被停用的訂閱數目。
其他流失數量	整數	基於其他原因，在指定時段內停用的訂用帳戶數目。

要求和回應範例

下列程式碼片段示範了一些請求的範例，以及這些請求的 JSON 回應內容。

範例要求

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>

範例回應

{
    "Value": [
        {
            "date": "2022-04-18",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "grossSalesBeforeTax": 3460656.260391250,
            "totalActiveCount": 20211321,
            "totalChurnCount": 5605,
            "newCount": 3810366,
            "renewCount": 12102044,
            "goodStandingActiveCount": 17893664,
            "pendingGraceActiveCount": 2255792,
            "graceActiveCount": 61833,
            "lockedActiveCount": 32,
            "billingChurnCount": 4,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 2717,
            "otherChurnCount": 2884
        },
        {
            "date": "2022-04-18",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Unknown",
            "grossSalesBeforeTax": 2342.580615228,
            "totalActiveCount": 50550,
            "totalChurnCount": 7,
            "newCount": 8312,
            "renewCount": 31446,
            "goodStandingActiveCount": 44047,
            "pendingGraceActiveCount": 6503,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 5,
            "otherChurnCount": 2
        }
    ],
    "TotalCount": 2
}

範例要求

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2021&endDate=04/20/2022&top=10&skip=0&orderby=date&groupby=date,subscriptionProductName,applicationName,skuId,market,deviceType&aggregationLevel=week
HTTP/1.1
Authorization: Bearer <your access token>

範例回應

{
    "Value": [
        {
            "date": "2022-04-18",
            "subscriptionProductName": "realms.subscription.monthly.10player.01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "skuId": "0100",
            "market": "IT",
            "deviceType": "Console-Xbox One",
            "grossSalesBeforeTax": 0.0,
            "totalActiveCount": 0,
            "totalChurnCount": 0,
            "newCount": 2,
            "renewCount": 0,
            "goodStandingActiveCount": 0,
            "pendingGraceActiveCount": 0,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 0,
            "otherChurnCount": 0
        },
        {
            "date": "2022-04-18",
            "subscriptionProductName": "realms.subscription.monthly.10player.01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "skuId": "0100",
            "market": "NO",
            "deviceType": "Unknown",
            "grossSalesBeforeTax": 0.0,
            "totalActiveCount": 0,
            "totalChurnCount": 0,
            "newCount": 0,
            "renewCount": 13,
            "goodStandingActiveCount": 0,
            "pendingGraceActiveCount": 0,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 0,
            "otherChurnCount": 0
        },
        {
            "date": "2022-04-18",
            "subscriptionProductName": "realms.subscription.monthly.10player.02",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "skuId": "0100",
            "market": "CA",
            "deviceType": "Unknown",
            "grossSalesBeforeTax": 0.0,
            "totalActiveCount": 152,
            "totalChurnCount": 0,
            "newCount": 0,
            "renewCount": 270,
            "goodStandingActiveCount": 133,
            "pendingGraceActiveCount": 19,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 0,
            "otherChurnCount": 0
        }
    ],
    "TotalCount": 3
}

意見反應

此頁面對您有幫助嗎？

Last updated on 2025-06-20

共用方式為

取得訂閱附加功能購買記錄

先決條件

請求

請求語法

請求標頭

要求參數

範例請求

回應

回應主體

訂閱獲取值

要求和回應範例

範例要求

範例回應

範例要求

範例回應

相關主題

意見反應

其他資源