获取桌面应用程序的升级块

项目
07/05/2024

使用此 REST URI 获取有关桌面应用程序阻止 Windows 10 或 Windows 11 升级运行的 Windows 10 和 Windows 11 设备的信息。你只能将此 URI 用于已添加到 Windows 桌面应用程序的桌面应用程序。还可以在合作伙伴中心的桌面应用程序的应用程序阻止报告中获取此信息。

要获取有关桌面应用程序中特定可执行文件的设备阻止的详细信息，请参阅获取桌面应用程序的升级阻止详细信息。

先决条件

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

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

请求

请求语法

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

请求头

标头	类型	说明
授权	字符串	必需。 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 architecture blockType deviceType fileName market osRelease osVersion productName targetOs	否
orderby	string	对每次阻止的结果数据值进行排序的语句。语法为 orderby=field [order]，field [order],...。字段参数可以是响应正文中的以下字段之一： applicationVersion architecture blockType date deviceType fileName market osRelease osVersion productName targetOs deviceCount order 参数是可选的，可以是 asc 或 desc，用于指定每个字段的升序或降序排列。默认值为 asc。下面是一个 orderby 字符串的示例：orderby=date,market	否
groupby	string	仅将数据聚合应用于指定字段的语句。可以指定响应正文中的以下字段： applicationVersion architecture blockType deviceType fileName market osRelease osVersion targetOs 返回的数据行将包含 groupby 参数中指定的字段以及以下字段： applicationId date productName deviceCount	否

请求示例

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

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>

响应

响应正文

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

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

Value	类型	说明
applicationId	string	要为其检索阻止数据的桌面应用程序的产品 ID。
date	string	与阻止命中率值关联的日期。
productName	string	从其关联的可执行文件的元数据派生的桌面应用程序的显示名称。
fileName	string	已阻止的可执行文件。
applicationVersion	string	已阻止的应用程序可执行文件的版本。
osVersion	string	用于指定在其上正在运行桌面应用程序的操作系统版本的以下字符串之一： Windows 7 Windows 8.1 Windows 10 Windows 11 Windows Server 2016 Windows Server 1709 Unknown
osRelease	string	用于指定当前正在运行桌面应用程序的操作系统版本或外部测试 Ring（作为操作系统版本内的亚组）的以下字符串之一。对于 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 版本或外部测试圈未知，则此字段具有“未知”值。
market	string	阻止桌面应用程序的市场的 ISO 3166 国家/地区代码。
deviceType	string	用于指定在其上阻止桌面应用程序的设备的类型的以下字符串之一：电脑服务器平板电脑 Unknown
blockType	string	以下字符串之一，指定在设备上找到的阻止类型：潜在 Sediment 临时 Sediment 运行时通知有关这些阻止类型以及它们对开发人员和用户的意义的更多信息，请参阅应用程序阻止报告的描述。
architecture	string	块所在的设备的体系结构： ARM64 X86
targetOs	string	以下字符串之一，指定阻止桌面应用程序运行的 Windows 10 或 Windows 11 OS 版本：版本 1709 版本 1803
deviceCount	数字	在指定聚合级别具有阻止的不同设备的数量。

响应示例

以下示例举例说明此请求的 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
}

通过

获取桌面应用程序的升级块

先决条件

请求

请求语法

请求头

请求参数

请求示例

响应

响应正文

响应示例

反馈

其他资源

通过

获取桌面应用程序的升级块

先决条件

请求

请求语法

请求头

请求参数

请求示例

响应

响应正文

响应示例

相关主题

反馈

其他资源