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 Transcoding 構文を使用します。

パスパラメータ

パラメータ
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

詳細については、認証の概要をご覧ください。

提案クラスタプロトコル

密接に関連していると思われる、類似する一連の提案です。

この proto とネストされた proto のほとんどは、foxandcrown.prelaunchreport.service.SuggestionClusterProto から分岐され、PLR の依存関係が FTL に置き換わります。

JSON 表現 
{
  "category": enum (SuggestionCategory),
  "suggestions": [
    {
      object (SuggestionProto)
    }
  ]
}
フィールド
category

enum (SuggestionCategory)

これらのタイプの提案が表示されるカテゴリ。常に設定。
suggestions[]

object (SuggestionProto)

提案のシーケンス。クラスタ内のすべての提案は、同じ SuggestionPriority を持ち、同じ SuggestionCategory に属している必要があります。同じスクリーンショット URL の候補は、隣接する場所に配置する必要があります。

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

RegionProto

長方形の領域。

JSON 表現 
{
  "topPx": integer,
  "leftPx": integer,
  "heightPx": integer,
  "widthPx": integer
}
フィールド
topPx

integer

長方形の上部（ピクセル単位）。常に設定。
leftPx

integer

長方形の左端（ピクセル単位）。常に設定。
heightPx

integer

高さ（ピクセル単位）。常に設定。
widthPx

integer

幅（ピクセル単位）。常に設定。