取得傳統型應用程式安裝

  • 發行項

使用此 REST URI 來取得您已新增至 Windows 傳統型應用程式程式之傳統型應用程式的 JSON 格式匯總安裝數據。 此 URI 可讓您在指定的日期範圍和其他選擇性篩選期間取得安裝資料。 此資訊也可在 合作夥伴中心的桌面應用程式的 [安裝] 報告中 取得。

必要條件

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

  • 如果您尚未這麼做，請完成 Microsoft Store 分析 API 的所有 必要條件 。
  • 取得 Azure AD 存取令牌 ，以用於此方法的要求標頭中。 取得存取權杖之後，您在其到期之前有 60 分鐘的時間可以使用。 權杖到期之後，您可以取得新的權杖。

要求

要求語法

方法 要求 URI
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/installbasedaily

要求標頭

標題 類型 描述
授權 string 必要。 持有人<權杖>形式的Azure AD 存取權杖。

要求參數

參數 類型 描述 必要
applicationId string 您想要擷取安裝資料之傳統型應用程式的產品標識碼。 若要取得傳統型應用程式的產品標識符，請在合作夥伴中心開啟傳統型應用程式的任何分析報告（例如安裝報告），然後將滑鼠停留在連結上方以從 URL 擷取產品識別碼，以顯示詳細數據。 Yes
startDate date 要擷取之安裝數據之日期範圍的開始日期。 預設值為目前日期之前的 90 天。 No
endDate date 要擷取之安裝數據之日期範圍的結束日期。 預設值為目前的日期。 No
熱門 int 要求中要傳回的數據列數。 如果未指定，則最大值和預設值為10000。 如果查詢中有更多數據列，響應主體會包含下一個連結，您可以用來要求下一頁的數據。 No
skip int 查詢中要略過的數據列數目。 使用此參數逐頁流覽大型數據集。 例如，top=10000 和 skip=0 會擷取前 10000 個數據列、top=10000 和 skip=10000 會擷取接下來的 10000 個數據列等等。 No
篩選器 string 篩選回應中數據列的一或多個語句。 每個語句都包含回應本文的功能變數名稱，以及與 eq 或 ne 運算符相關聯的值，而且語句可以使用 和 或結合。 字串值必須以篩選參數中的單引弧括住。 您可以從回應本文指定下列欄位：

  • applicationVersion
  • deviceType
  • 市場
  • osVersion
  • osRelease
 No
orderby string 語句，排序每個安裝的結果數據值。 語法為 orderby=field [order]，field [order],...。 field 參數可以是回應本文的下列其中一個字段：

  • productName
  • date
  • applicationVersion
  • deviceType
  • 市場
  • osVersion
  • osRelease
  • installBase

order 參數是選擇性的，而且可以是 asc 或 desc，以指定每個欄位的遞增或遞減順序。 預設值為 asc。

以下是 orderby 字串範例：orderby=date，market

 No
groupby string 語句，僅將數據匯總套用至指定的欄位。 您可以從回應本文指定下列欄位：

  • applicationVersion
  • deviceType
  • 市場
  • osVersion
  • osRelease

傳回的數據列將包含 groupby 參數中指定的欄位，以及下列專案：

  • applicationId
  • date
  • productName
  • installBase

 No

要求範例

下列範例示範數個取得傳統型應用程式安裝數據的要求。 以 傳統型應用程式的產品標識碼取代 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 string 如果有額外的數據頁面，此字串會包含可用來要求下一頁數據的 URI。 例如，如果 要求的 top 參數設定為 10000，但查詢的安裝數據列超過 10000 個數據列，則會傳回此值。
TotalCount int 查詢數據結果中的數據列總數。

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

值 類型 描述
date string 與安裝基底值相關聯的日期。
applicationId string 您擷取安裝資料之傳統型應用程式的產品識別碼。
productName string 桌面應用程式的顯示名稱，衍生自其相關聯可執行檔的元數據。
applicationVersion string 已安裝的應用程式可執行檔案版本。
deviceType string 下列其中一個字串，指定安裝傳統型應用程式的裝置類型：

  • Pc
  • Server
  • 平板電腦
  • Unknown
市場 string 安裝傳統型應用程式的市場的 ISO 3166 國家/地區代碼。
osVersion string 下列其中一個字串，指定安裝傳統型應用程式的作業系統版本：

  • Windows 7
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Windows Server 2016
  • Windows Server 1709
  • Unknown
osRelease string 下列其中一個字串，指定安裝傳統型應用程式之操作系統版本或正式發行前小眾測試版的 OS 版本或正式發行前小眾測試版。

針對 Windows 11： 版本 2110

針對 Windows 10：

  • 版本 1507
  • 版本 1511
  • 版本 1607
  • 版本 1703
  • 版本 1709
  • 發行預覽
  • 測試人員快速
  • 測試人員緩慢

針對 Windows Server 1709：

  • RTM

若是 Windows Server 2016：

  • 版本 1607

針對 Windows 8.1：

  • Update 1

針對 Windows 7：

  • Service Pack 1

如果 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
}