获取桌面应用程序安装

  • 项目

使用此 REST URI 获取已添加到 Windows 桌面应用程序计划的桌面应用程序的 JSON 格式的聚合安装数据。 通过此 URI，可以获取给定日期范围内和其他可选筛选条件下的安装数据。 还可以在合作伙伴中心的桌面应用程序的安装报告中获取此信息。

先决条件

若要使用此方法，首先需要执行以下操作：

  • 完成 Microsoft Store 分析 API 的所有先决条件（如果尚未这样做）。
  • 获取 Azure AD 访问令牌，以供在此方法的请求标头中使用。 获取访问令牌后，在它到期前，你有 60 分钟的使用时间。 该令牌到期后，可以获取新的令牌。

请求

请求语法

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

请求头

标头 类型 说明
授权 字符串 必需。 Azure AD 访问令牌的格式为 Bearertoken<>。

请求参数

参数 类型 描述 必需
applicationId string 要为其检索安装数据的桌面应用程序的产品 ID。 若要获取桌面应用程序的产品 ID，请在合作伙伴中心打开桌面应用程序的任何分析报告（例如安装报告），并将鼠标悬停在链接上以显示详细信息，以便从 URL 中检索产品 ID。 是
startDate date 要检索的安装数据日期范围中的开始日期。 默认值为当前日期之前 90 天。 否
endDate date 要检索的安装数据日期范围中的结束日期。 默认是当前日期。 否
top int 要在请求中返回的数据行数。 如果未指定，最大值和默认值为 10000。 当查询中存在多行数据时，响应正文中包含的下一个链接可用于请求下一页数据。 否
skip int 要在查询中跳过的行数。 使用此参数可以浏览较大的数据集。 例如，top=10000 和 skip=0，将检索前 10000 行数据；top=10000 和 skip=10000，将检索之后的 10000 行数据，依此类推。 否
filter string 在响应中筛选行的一条或多条语句。 每条语句包含的响应正文中的字段名称和值使用 eq 或 ne 运算符进行关联，并且语句可以使用 and 或 or 进行组合。 filter 参数中的字符串值必须使用单引号引起来。 可以指定响应正文中的以下字段：

  • applicationVersion
  • deviceType
  • market
  • osVersion
  • osRelease
 否
orderby string 一个用来对每次安装的结果数据值进行排序的语句。 语法为 orderby=field [order],field [order],...。field 参数可以是响应正文中的以下字段之一：

  • productName
  • date
  • applicationVersion
  • deviceType
  • market
  • osVersion
  • osRelease
  • installBase

order 参数是可选的，可以是 asc 或 desc，用于指定每个字段的升序或降序排列。 默认值为 asc。

下面是一个 orderby 字符串的示例：orderby=date,market

 否
groupby string 仅将数据聚合应用于指定字段的语句。 可以指定响应正文中的以下字段：

  • applicationVersion
  • deviceType
  • market
  • osVersion
  • osRelease

返回的数据行将包含 groupby 参数中指定的字段以及以下字段：

  • applicationId
  • date
  • productName
  • installBase

 否

请求示例

下面的示例演示了一些用于获取桌面应用程序安装数据的请求。 将 applicationId 值替换为桌面应用程序的产品 ID。

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>

响应

响应正文

值 类型 说明
Value 数组 一组包含聚合安装数据的对象。 有关每个对象中的数据的详细信息，请参阅下表。
@nextLink string 如果存在其他数据页，则此字符串包含一个你可用来请求下一页数据的 URI。 例如，当请求的 top 参数设置为 10000，但查询的安装数据超过 10000 行时，将会返回此值。
TotalCount int 查询的数据结果中的行总数。

Value 数组中的元素包含以下值。

Value 类型 说明
date string 与安装基本值关联的日期。
applicationId string 要为其检索安装数据的桌面应用程序的产品 ID。
productName string 从其关联的可执行文件的元数据派生的桌面应用程序的显示名称。
applicationVersion string 已安装的应用程序可执行文件的版本。
deviceType string 用于指定在其上安装桌面应用程序的设备的类型的以下字符串之一：

  • 电脑
  • 服务器
  • 平板电脑
  • Unknown
market string 安装桌面应用程序的市场的 ISO 3166 国家/地区代码。
osVersion string 用于指定在其上安装桌面应用程序的操作系统版本的以下字符串之一：

  • Windows 7
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Windows Server 2016
  • Windows Server 1709
  • Unknown
osRelease string 以下字符串之一，指定安装桌面应用程序的操作系统版本或外部测试版环（作为操作系统版本中的子集）。

对于 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：

  • 服务包 1

如果 OS 版本或外部测试圈未知，则此字段具有“未知”值。
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
}