使用此 REST URI 获取有关桌面应用程序阻止 Windows 10 或 Windows 11 升级运行的 Windows 10 和 Windows 11 设备的信息。 您只能将此 URI 用于已添加到 Windows 桌面应用计划中的桌面应用程序。 此信息也可在合作伙伴中心针对桌面应用程序的 应用程序块报告 中获得。
若要获取关于桌面应用程序中特定可执行文件的设备块详细信息,请参阅 获取您的桌面应用程序的升级块详细信息。
先决条件
若要使用此方法,首先需要执行以下操作:
- 完成 Microsoft Store 分析 API 的所有先决条件(如果尚未这样做)。
- 获取 Azure AD 访问令牌,以供在此方法的请求标头中使用。 获取访问令牌后,在它到期前,你有 60 分钟的使用时间。 令牌过期后,可以获取一个新令牌。
请求
请求语法
方法 | 请求 URI |
---|---|
获取 | https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockhits |
请求标头
标题 | 类型 | DESCRIPTION |
---|---|---|
授权 | 字符串 | 必填。 Azure AD 访问令牌,形式为Bearer<token>。 |
请求参数
参数 | 类型 | DESCRIPTION | 必选 |
---|---|---|---|
应用ID | 字符串 | 您想要检索其区块数据的桌面应用程序的产品 ID。 若要获取桌面应用程序的产品 ID,请在合作伙伴中心(如 |
是的 |
开始日期 | 日期 | 要检索的块数据的日期范围内的开始日期。 默认值为当前日期之前的 90 天。 | 否 |
结束日期 | 日期 | 要检索的块数据中日期范围的结束日期。 默认值为当前日期。 | 否 |
顶部 | 整数 (int) | 请求中要返回的数据行数。 如果未指定,则最大值和默认值为 10000。 如果查询中有更多行,响应正文将包含下一个链接,可用于请求下一页的数据。 | 否 |
跳过 | 整数 (int) | 查询中要跳过的行数。 使用此参数可分页浏览大型数据集。 例如,top=10000 和 skip=0 检索前 10000 行数据,top=10000 和 skip=10000 检索接下来的 10000 行数据,依此等。 | 否 |
过滤器 | 字符串 | 一个或多个用于筛选响应中行的语句。 每个语句都包含响应正文中的字段名称和值,这些字段名称与 eq 或 ne 运算符相关联,语句可以使用 和、或进行组合。 字符串值必须用 筛选器 参数中的单引号括起来。 可以从响应正文中指定以下字段:
|
否 |
排序 | 字符串 | 对每个块的结果数据值进行排序的语句。 语法为 orderby=field [order],field [order],...。字段 参数可以是响应正文中的以下字段之一:
顺序参数是可选的,可以是 asc 或 desc 来指定每个字段的升序或降序。 默认值为 asc。 下面是一个 orderby 字符串的示例:orderby=date,market |
否 |
按组分类 | 字符串 | 仅对指定字段应用数据聚合的语句。 可以从响应正文中指定以下字段:
返回的数据行将包含 groupby 参数中指定的字段,如下所示:
|
否 |
请求示例
以下示例演示了获取桌面应用程序块数据的多个请求。 请将 applicationId 的值替换为桌面应用程序的产品识别码。
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockhits?applicationId=5126873772241846776&startDate=2018-05-01&endDate=2018-06-07&skip=0 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/blockhits?applicationId=5126873772241846776&startDate=2018-05-01&endDate=2018-06-07&filter=market eq 'US' and deviceType eq 'PC' HTTP/1.1
Authorization: Bearer <your access token>
响应
响应体
价值 | 类型 | DESCRIPTION |
---|---|---|
价值 | 数组 | 包含聚合块数据的对象数组。 有关每个对象中的数据的详细信息,请参阅下表。 |
@nextLink | 字符串 | 如果有其他数据页,此字符串包含可用于请求下一页数据的 URI。 例如,如果请求的 顶部 参数设置为 10000,但查询的块数据行超过 10000 行,则返回此值。 |
总计数 | 整数 (int) | 查询的数据结果中的行总数。 |
Value 数组中的元素包含以下值。
价值 | 类型 | DESCRIPTION |
---|---|---|
应用ID | 字符串 | 您所检索到块数据的桌面应用程序的产品 ID。 |
日期 | 字符串 | 与区块命中值相关的日期。 |
产品名称 | 字符串 | 桌面应用程序的显示名称是从其关联可执行文件的元数据中派生的。 |
文件名 | 字符串 | 被阻止的可执行文件。 |
应用程序版本 | 字符串 | 被拦截的应用程序可执行文件的版本。 |
osVersion | 字符串 | 以下字符串之一,指定桌面应用程序当前正在运行的 OS 版本:
|
osRelease | 字符串 | 以下字符串之一,用于指定桌面应用程序当前正在其上运行的 OS 版本或测试环(作为 OS 版本中的子集)。 适用于 Windows 11:版本 2110 对于 Windows 10:
对于 Windows Server 1709:
对于 Windows Server 2016:
对于 Windows 8.1:
对于 Windows 7:
如果操作系统版本或飞行环未知,此字段的值为 未知。 |
市场 | 字符串 | 阻止桌面应用程序使用的市场的 ISO 3166 国家/地区代码。 |
设备类型 | 字符串 | 以下字符串中的一个,指定被禁止运行该桌面应用程序的设备类型:
|
区块类型 | 字符串 | 以下字符串之一,指定设备上找到的块类型:
|
建筑 | 字符串 | 设备上块所处位置的体系结构:
|
targetOs | 字符串 | 以下字符串之一,指定阻止桌面应用程序运行的 Windows 10 或 Windows 11 OS 版本:
|
设备数量 | 数字 | 具有指定聚合级别块的不同的设备数量。 |
响应示例
以下示例演示此请求的示例 JSON 响应正文。
{
"Value": [
{
"applicationId": "10238467886765136388",
"date": "2018-06-03",
"productName": "Contoso Demo",
"fileName": "contosodemo.exe",
"applicationVersion": "2.2.2.0",
"osVersion": "Windows 8.1",
"osRelease": "Update 1",
"market": "ZA",
"deviceType": "All",
"blockType": "Runtime Notification",
"architecture": "X86",
"targetOs": "RS4",
"deviceCount": 120
}
],
"@nextLink": "desktop/blockhits?applicationId=123456789&startDate=2018-01-01&endDate=2018-02-01&top=10000&skip=10000&groupby=applicationVersion,deviceType,osVersion,osRelease",
"TotalCount": 23012
}