Method: projects.histories.executions.steps.accessibilityClusters

列出特定步驟的無障礙叢集

可能會傳回下列任一標準錯誤代碼：

  • PERMISSION_DENIED - 如果使用者未獲授權讀取專案
  • INVALID_src - 如果要求格式錯誤
  • FAILED_PRECONDITION - 如果要求中的引數無效；例如：如果語言代碼格式不正確。
  • NOT_FOUND - 如果內含的步驟不存在

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
name

string

步驟的完整資源名稱。例如：projects/my-project/history/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/history/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

一律展示。
clusters[]

object (SuggestionClusterProto)

按照叢集分組的一系列無障礙功能建議。在序列中，屬於同一 SuggestionCategory 的叢集應相鄰。在每個類別中，叢集應按照建議優先順序 (先錯誤) 排序。類別應按照優先順序最高的叢集排序。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

建議叢集通訊協定

一組我們認為密切相關的類似建議。

此 proto 和大部分的巢狀 proto 都是從 foxandcrown.prelaunchreport.service.suggestionClusterProto 下分支，以 FTL 取代 PLR 的依附元件。

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

enum (SuggestionCategory)

顯示這些類型建議的類別。一律設定。
suggestions[]

object (SuggestionProto)

一組建議。叢集中的所有建議必須具有相同的 SuggestionPriority，且屬於同一個 SuggestionCategory。具有相同螢幕截圖網址的建議應相鄰。

建議類別

列舉
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」對應至「1.png」複製到 GCS 值區一律設定。

聯集欄位 resource_id。

resource_id 只能採用下列其中一種設定：
resourceName

string

參照檢視元素，以其資源名稱識別 (如果有的話)。
pseudoResourceId

string

來源檢視表的一些人類可讀 ID (如果不含 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

寬度 (以像素為單位)。一律設定。