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 によって順序付けされる必要があります (ERROR が最初)。カテゴリは、最も優先度の高いクラスタ順に並べる必要があります。

認可範囲

次の OAuth スコープが必要です。

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

詳細については、 「認証の概要」を参照してください。

提案クラスタープロト

密接に関連していると思われる一連の同様の提案。

このプロトとほとんどのネストされたプロトは foxandcrown.prelaunchreport.service.SuggestionClusterProto から分岐しており、PLR の依存関係を FTL の依存関係に置き換えています。

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次のいずれか 1 つだけです。

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

幅 (ピクセル単位)。常に設定します。