使用此 REST URI 來取得已新增至 Windows 桌面應用程式程序的桌面應用程式之 JSON 格式彙總安裝數據。 此 URI 可讓您在指定的日期範圍和其他選擇性篩選期間取得安裝資料。 合作夥伴中心桌面應用程式的安裝報告 中也提供這項資訊。
先決條件
若要使用此方法,您必須先執行下列動作:
- 如果您尚未執行此操作,請完成 Microsoft Store 分析 API 的所有必要條件。
- 取得 Azure AD 存取權杖以便用於此方法的要求標頭中。 取得存取令牌之後,您必須在 60 分鐘内使用它,否則將會失效。 令牌到期之後,您可以取得新的令牌。
請求
請求語法
| 方法 | 請求網址識別碼 (URI) |
|---|---|
| 獲取 | https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/installbasedaily |
請求標頭
| 頁首 | 類型 | 說明 |
|---|---|---|
| 授權 | 字符串 | 必須的。 Azure AD 存取令牌的形式為 Bearer<token>。 |
要求參數
| 參數 | 類型 | 說明 | 為必填項目 |
|---|---|---|---|
| 應用程式ID | 字符串 | 您想要擷取安裝資料的桌面應用程式產品 ID。 若要取得傳統型應用程式的產品標識符,請在 合作夥伴中心開啟傳統型應用程式的任何分析報告 (例如 安裝報告),然後將滑鼠停留在連結上方以從 URL 擷取產品識別碼,以顯示詳細數據。 | 是的 |
| 開始日期 | 日期 | 要擷取的安裝資料日期範圍中的開始日期。 預設值為目前日期之前的 90 天。 | 否 |
| 結束日期 | 日期 | 要擷取之安裝數據之日期範圍的結束日期。 預設值為目前的日期。 | 否 |
| 返回頁首 | 整數 (int) | 要求中要傳回的數據列數。 如果未指定,則最大值和預設值為10000。 如果查詢中有更多資料列,回應內容會包含下一個連結,您可以使用該連結來請求下一頁的資料。 | 否 |
| 略過 | 整數 (int) | 查詢中要略過的行數目。 使用此參數逐頁流覽大型數據集。 例如,top=10000 和 skip=0 會擷取前 10000 個數據列、top=10000 和 skip=10000 會擷取接下來的 10000 個數據列等等。 | 否 |
| 篩選器 | 字符串 | 一或多個語句用於篩選回應中的數據列。 每個敘述都包含回應主體中的欄位名稱及與 eq 或 ne 運算子相關的值,而且敘述可以使用 和 或 或 結合。 字串值必須以 篩選 參數中的單引弧括住。 您可以從回應的主體中指定以下欄位:
|
否 |
| 排序 | 字符串 | 一項指令,用於排序每個安裝的結果數據值。 語法為 orderby=field [order],field [order],...。 field 參數可以是回應內容中的下列欄位之一:
order 參數是選擇性的,而且可以是 asc 或 desc,以指定每個欄位的遞增或遞減順序。 預設為asc。 以下是 orderby 字串範例: orderby=date,market |
否 |
| 按群組分類 | 字符串 | 僅將資料彙總套用至指定欄位的陳述式。 您可以從回應的主體中指定以下欄位:
傳回的數據列將包含 groupby 參數中指定的欄位,以及以下內容:
|
否 |
範例請求
下列範例示範幾個取得桌面應用程式安裝數據的請求。 將 applicationId 值替換為桌面應用程式的產品識別符。
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/installbasedaily?applicationId=1234567890&startDate=2018-01-01&endDate=2018-02-01&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/installbasedaily?applicationId=1234567890&startDate=2018-01-01&endDate=2018-02-01&filter=market eq 'US' and deviceType eq 'PC' HTTP/1.1
Authorization: Bearer <your access token>
回應
回應主體
| 價值觀 | 類型 | 說明 |
|---|---|---|
| 價值觀 | 陣列 | 包含匯總安裝數據的物件陣列。 如需每個物件中數據的詳細資訊,請參閱下表。 |
| @nextLink | 字符串 | 如果有額外的數據頁面,此字串會包含可用來要求下一頁數據的 URI。 例如,如果要求的 top 參數設定為 10000,但查詢的安裝數據列超過 10000 個數據列,則會傳回此值。 |
| 總計數 | 整數 (int) | 查詢的資料結果中的總列數。 |
Value 陣列中的元素包含下列值。
| 價值觀 | 類型 | 說明 |
|---|---|---|
| 日期 | 字符串 | 與安裝基底值相關聯的日期。 |
| 應用程式ID | 字符串 | 您擷取安裝資料的桌面應用程式的產品識別碼。 |
| 產品名稱 | 字符串 | 桌面應用程式的顯示名稱,衍生自其相關聯可執行檔的元數據。 |
| 應用程式版本 | 字符串 | 已安裝的應用程式可執行檔案版本。 |
| 裝置類型 | 字符串 | 下列字串之一,指定安裝桌面應用程式的裝置類型:
|
| 市場 | 字符串 | 安裝桌面應用程式的市場所使用的 ISO 3166 國家/地區代碼。 |
| 作業系統版本 | 字符串 | 下列其中一個字串,指定安裝在桌面應用程式上的作業系統版本:
|
| osRelease作系統 | 字符串 | 下列其中一個字串,指定安裝桌面應用程式的作業系統發行版本或測試版本中的小眾分級。 針對 Windows 11: 版本 2110 針對 Windows 10:
適用於 Windows Server 1709:
適用於 Windows Server 2016:
若為 Windows 8.1:
針對 Windows 7:
如果作業系統的發行版本或測試環未知,這個欄位的值將為 未知。 |
| installBase | 數字 | 在指定的匯總層級安裝產品的相異裝置數目。 |
回應範例
下列範例顯示這個請求的 JSON 回應示例內容。
{
"Value": [
{
"date": "2018-01-24",
"applicationId": "123456789",
"productName": "Contoso Demo",
"applicationVersion": "1.0.0.0",
"deviceType": "PC",
"market": "All",
"osVersion": "Windows 10",
"osRelease": "Version 1709",
"installBase": 348218.0
}
],
"@nextLink": "desktop/installbasedaily?applicationId=123456789&startDate=2018-01-01&endDate=2018-02-01&top=10000&skip=10000&groupby=applicationVersion,deviceType,osVersion,osRelease",
"TotalCount": 23012
}