Method: projects.histories.executions.steps.accessibilityClusters

列出给定步骤的无障碍功能集群

系统可能会返回以下任一规范错误代码：

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

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
name

string

步骤的完整资源名称。例如：projects/my-project/hiages/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/hiages/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

始终存在。
clusters[]

object (SuggestionClusterProto)

一系列无障碍功能建议，按聚类分组。在序列中，属于同一 SuggestionCategory 的聚类应相邻。在每个类别中，集群应按其 SuggestionPriority 排序（错误排在最前面）。这些类别应按优先级最高的集群进行排序。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅身份验证概览。

建议集群协议

一组相似的建议，我们怀疑这些建议密切相关。

此 proto 和大多数嵌套 proto 均从 foxandcrown.prelaunchreport.service.SuggestionClusterProto 进行分支，将 PLR 的依赖项替换为 FTL。

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

enum (SuggestionCategory)

此类建议的显示类别。始终设置。
suggestions[]

object (SuggestionProto)

一系列建议。一个集群中的所有建议都必须具有相同的 SuggestionPriority，并且属于同一个 SuggestionCategory。具有相同屏幕截图网址的建议应相邻。

建议类别

枚举
unknownCategory
contentLabeling
touchTargetSize
lowContrast
implementation

SuggestionProto

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”对应的是“1.png”文件。始终设置。

联合字段 resource_id。

resource_id 只能是下列其中一项：
resourceName

string

对视图元素的引用，由其资源名称（如果有）标识。
pseudoResourceId

string

源视图的某种人类可读的标识符（如果它没有 resourceName）。这是无障碍功能层次结构中的路径，一个具有资源名称的元素；类似于 XPath

SafeHtmlProto

重要提示：接受来自不可信来源的消息是不安全的，因为攻击者很容易伪造不符合类型安全约定的序列化消息，例如，其中可能包含由攻击者控制的脚本。接收 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

宽度（以像素为单位）。始终设置。