取得傳統型應用程式安裝
使用此 REST URI 來取得您已新增至 Windows 傳統型應用程式計畫之傳統型應用程式的 JSON 格式彙總安裝資料。 此 URI 可讓您在特定日期範圍期間和其他選擇性篩選條件取得安裝資料。 此資訊也可在合作夥伴中心傳統型應用程式的安裝報告中取得。
必要條件
要使用此方法,您需要先執行以下操作:
- 如果您尚未執行此操作,請完成 Microsoft Store 分析 API 的所有必要條件。
- 取得 Azure AD 存取權杖以便用於此方法的要求標頭中。 取得存取權杖之後,您在其到期之前有 60 分鐘的時間可以使用。 權杖到期之後,您可以取得新的權杖。
Request
要求語法
方法 | 要求 URI |
---|---|
GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/installbasedaily |
要求標頭
標題 | 類型 | 描述 |
---|---|---|
授權 | 字串 | 必要。 持有人<權杖>形式的 Azure AD 存取權杖。 |
要求參數
參數 | 類型 | 描述 | 必要 |
---|---|---|---|
applicationId | 字串 | 您想要擷取安裝資料之傳統型應用程式的產品識別碼。 若要取得傳統型應用程式的產品標識符,請在合作夥伴中心開啟傳統型應用程式的任何分析報告(例如安裝報告),然後將滑鼠停留在連結上方以從 URL 擷取產品識別碼,以顯示詳細數據。 | Yes |
startDate | date | 要擷取安裝資料之日期範圍的開始日期。 預設值為目前日期之前的 90 天。 | 否 |
endDate | date | 要擷取安裝資料之日期範圍的結束日期。 預設值是目前的日期。 | 否 |
熱門 | int | 要求中要傳回的資料列數。 如果未指定,則最大值和預設值為 10000。 如果查詢中有更多資料列,回應本文會包含下一個連結,您可以用來要求下一頁的資料。 | 否 |
skip | int | 要在查詢中忽略的列數。 使用此參數逐頁瀏覽大型資料集。 例如,top=10000 和 skip=0 會擷取前 10000 列資料,top=10000 和 skip=10000 會擷取接下來的 10000 列資料,依此類推。 | 否 |
篩選器 | 字串 | 篩選回應中的資料列的一或多個陳述式。 每個陳述式都包含回應本文的功能變數名稱,以及與 eq 或 ne 運算子相關聯的值,而且可以使用 and 或 or 結合陳述式。 字串值必須以 filter 參數中的單引號括住。 您可以從回應本文指定下列功能變數:
|
否 |
orderby | 字串 | 對每個安裝的結果資料值進行排序的陳述式。 語法為 orderby=field [order],field [order],...。field 參數可以是回應本文的下列其中一個功能變數:
order 參數是選擇性的,而且可以是 asc 或 desc,以指定每個欄位的遞增或遞減順序。 預設為asc。 以下是範例 orderby 字串:orderby=date,market |
否 |
groupby | 字串 | 僅將資料彙總套用至指定欄位的陳述式。 您可以從回應本文指定下列功能變數:
傳回的資料列將包含 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 個資料列,則會傳回此值。 |
TotalCount | int | 查詢的資料結果中的總列數。 |
Value 陣列中的元素包含下列值。
值 | 類型 | 描述 |
---|---|---|
date | 字串 | 與安裝基底值相關聯的日期。 |
applicationId | 字串 | 您已擷取安裝資料之傳統型應用程式的產品識別碼。 |
productName | 字串 | 傳統型應用程式的顯示名稱,衍生自其相關聯可執行檔的中繼資料。 |
applicationVersion | 字串 | 已安裝的應用程式可執行檔版本。 |
deviceType | 字串 | 下列其中一個字串,指定安裝傳統型應用程式的裝置類型:
|
market | 字串 | 安裝傳統型應用程式的市場之 ISO 3166 國家/地區代碼。 |
osVersion | 字串 | 下列其中一個字串,指定安裝傳統型應用程式的 OS 版本:
|
osRelease | 字串 | 下列其中一個字串,指定安裝傳統型應用程式之 OS 版本或發行小眾測試版通道 (作為 OS 版本內的子群體)。 若為 Windows 11:2110 版 若為 Windows 10:
若是 Windows Server 1709:
若是 Windows Server 2016:
若為 Windows 8.1:
若為 Windows 7:
如果 OS 版本或發行小眾測試版通道不明,此功能變數的值為 Unknown。 |
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
}