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

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

寬度，以像素為單位。始終設定。

,

列出給定步驟的可訪問性集群

可能傳回以下任何規範錯誤代碼：

  • 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

寬度，以像素為單位。始終設定。