Method: projects.histories.executions.steps.accessibilityClusters

• HTTP请求
• 路径参数
• 查询参数
• 请求正文
• 响应体
  • JSON 表示
• 授权范围
• 建议集群原型
  • JSON 表示
• 建议类别
• 建议原型
  • JSON 表示
• 安全HTML协议
  • JSON 表示
• 建议优先
• 区域原型
  • JSON 表示
• 尝试一下！

列出给定步骤的可访问性集群

可能返回以下任何规范错误代码：

• PERMISSION_DENIED - 如果用户无权读取项目
• INVALID_ARGUMENT - 如果请求格式错误
• FAILED_PRECONDITION - 如果请求中的参数碰巧无效；例如，如果区域设置格式不正确
• NOT_FOUND - 如果包含的步骤不存在

HTTP请求

GET https://toolresults.googleapis.com/toolresults/v1beta3/{name=projects/*/histories/*/executions/*/steps/*}:accessibilityClusters

URL 使用gRPC 转码语法。

路径参数

参数
name	string 步骤的完整资源名称。例如，projects/my-project/histories/bh.1234567890abcdef/executions/1234567890123456789/steps/bs.1234567890abcdef 必需的。

查询参数

参数
locale	string 接受的格式是规范的 Unicode 格式，以连字符作为分隔符。语言必须小写，语言脚本 - 大写，区域 - 大写。有关详细信息，请参阅http://www.unicode.org/reports/tr35/#Unicode_locale_identifier 。 必需的。

请求正文

请求正文必须为空。

响应体

AccessibilityService.ListStepAccessibilityClusters 的响应消息。

如果成功，响应正文包含具有以下结构的数据：

JSON 表示
{ "name": string, "clusters": [ { object (SuggestionClusterProto) } ] }

领域
name	string 步骤的完整资源名称。例如，projects/my-project/histories/bh.1234567890abcdef/executions/1234567890123456789/steps/bs.1234567890abcdef 总是呈现。
clusters[]	object ( SuggestionClusterProto ) 一系列可访问性建议，分组为集群。在序列中，属于同一 SuggestionCategory 的簇应该是相邻的。在每个类别中，簇应按其 SuggestionPriority（错误优先）排序。类别应按其最高优先级集群排序。

授权范围

需要以下 OAuth 范围：

• https://www.googleapis.com/auth/cloud-platform

有关详细信息，请参阅身份验证概述。

建议集群原型

我们怀疑一系列类似的建议密切相关。

该原型和大多数嵌套原型均从foxandcrown.prelaunchreport.service.SuggestionClusterProto 分支，用FTL 替换PLR 的依赖项。

JSON 表示
{ "category": enum (SuggestionCategory), "suggestions": [ { object (SuggestionProto) } ] }

领域
category	enum ( SuggestionCategory ) 这些类型的建议应出现在的类别中。始终设置。
suggestions[]	object ( SuggestionProto ) 一系列建议。集群内的所有建议必须具有相同的 SuggestionPriority 并属于相同的 SuggestionCategory。具有相同屏幕截图 URL 的建议应相邻。

建议类别

枚举
unknownCategory
contentLabeling
touchTargetSize
lowContrast
implementation

建议原型

JSON 表示

{ "title": string, "shortMessage": { object (SafeHtmlProto) }, "longMessage": { object (SafeHtmlProto) }, "priority": enum (SuggestionPriority), "helpUrl": string, "region": { object (RegionProto) }, "secondaryPriority": number, "screenId": string, // Union field resource_id can be only one of the following: "resourceName": string, "pseudoResourceId": string // End of list of possible types for union field resource_id. }

领域
title	string 建议的一般标题，采用用户语言，无标记。始终设置。
shortMessage	object ( SafeHtmlProto ) 以用户语言表示的简洁消息，代表建议，可能包含标记。始终设置。
longMessage	object ( SafeHtmlProto ) 使用用户语言的消息，解释建议，其中可能包含标记。始终设置。
priority	enum ( SuggestionPriority ) 建议的相对重要性。始终设置。
helpUrl	string 参考有关此类建议的帮助中心文章。始终设置。
region	object ( RegionProto ) 屏幕截图中与此建议相关的区域。选修的。
secondaryPriority	number 与具有相同优先级和类别的其他建议相比，建议的相对重要性。这是一个无意义的值，可用于对同一类别且具有相同优先级的建议进行排序。值越大，优先级越高（即越重要）。选修的。
screenId	string 建议的屏幕 ID。用于获取对应的截图路径。例如，screenId“1”对应GCS中的“1.png”文件。始终设置。
联合字段resource_id 。 resource_id只能是以下之一：
resourceName	string 对视图元素的引用，由其资源名称标识（如果有）。
pseudoResourceId	string 源视图的人类可读标识符（如果它没有资源名称）。这是可访问性层次结构中的一条路径，是一个带有资源名称的元素；类似于 XPath。

安全HTML协议

重要提示：从不受信任的来源接受此消息是不安全的，因为攻击者很容易伪造不满足类型安全契约的序列化消息，例如，它可能包含攻击者控制的脚本。接收 SafeHtmlProto 的系统隐式信任 SafeHtmlProto 的生产者。因此，在 RPC 响应中返回此消息通常是安全的，但在 RPC 请求中接受它通常是不安全的。

JSON 表示
{ "privateDoNotAccessOrElseSafeHtmlWrappedValue": string }

领域
privateDoNotAccessOrElseSafeHtmlWrappedValue	string 重要提示：切勿设置或读取此字段，即使是在测试中，它也是私有的。请参阅 .proto 文件顶部的文档，了解用于创建或读取此消息的编程语言包。

建议优先

枚举
unknownPriority
error
warning
info

区域原型

一个矩形区域。

JSON 表示
{ "topPx": integer, "leftPx": integer, "heightPx": integer, "widthPx": integer }

领域
topPx	integer 矩形的顶部（以像素为单位）。始终设置。
leftPx	integer 矩形的左侧，以像素为单位。始终设置。
heightPx	integer 高度，以像素为单位。始终设置。
widthPx	integer 宽度，以像素为单位。始终设置。