Method: projects.histories.executions.steps.accessibilityClusters

• HTTP-Anfrage
• Pfadparameter
• Abfrageparameter
• Anforderungstext
• Antwortkörper
  • JSON-Darstellung
• Berechtigungsbereiche
• VorschlagClusterProto
  • JSON-Darstellung
• Vorschlagskategorie
• VorschlagProto
  • JSON-Darstellung
• SafeHtmlProto
  • JSON-Darstellung
• VorschlagPriorität
• RegionProto
  • JSON-Darstellung
• Versuch es!

Listet Barrierefreiheitscluster für einen bestimmten Schritt auf

Kann einen der folgenden kanonischen Fehlercodes zurückgeben:

• PERMISSION_DENIED – wenn der Benutzer nicht berechtigt ist, das Projekt zu lesen
• INVALID_ARGUMENT – wenn die Anfrage fehlerhaft ist
• FAILED_PRECONDITION – wenn ein Argument in der Anfrage ungültig ist; z. B. wenn das Gebietsschemaformat falsch ist
• NOT_FOUND – wenn der enthaltende Schritt nicht existiert

HTTP-Anfrage

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

Die URL verwendet die gRPC-Transcoding -Syntax.

Pfadparameter

Parameter
name	string Ein vollständiger Ressourcenname des Schritts. Zum Beispiel „projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef“. Erforderlich.

Abfrageparameter

Parameter
locale	string Das akzeptierte Format ist das kanonische Unicode-Format mit Bindestrich als Trennzeichen. Die Sprache muss in Kleinbuchstaben geschrieben sein, das Sprachskript muss großgeschrieben werden, die Region muss in GROSSBUCHSTABEN geschrieben werden. Weitere Informationen finden Sie unter http://www.unicode.org/reports/tr35/#Unicode_locale_identifier . Erforderlich.

Anforderungstext

Der Anfragetext muss leer sein.

Antwortkörper

Antwortnachricht für AccessibilityService.ListStepAccessibilityClusters.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung
{ "name": string, "clusters": [ { object (SuggestionClusterProto) } ] }

Felder
name	string Ein vollständiger Ressourcenname des Schritts. Zum Beispiel „projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef“. Immer präsentiert.
clusters[]	object ( SuggestionClusterProto ) Eine Folge von Barrierefreiheitsvorschlägen, gruppiert in Clustern. Innerhalb der Sequenz sollten Cluster, die zur gleichen SuggestionCategory gehören, benachbart sein. Innerhalb jeder Kategorie sollten Cluster nach ihrer SuggestionPriority (FEHLER zuerst) geordnet werden. Die Kategorien sollten nach ihrem Cluster mit der höchsten Priorität geordnet werden.

Berechtigungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht .

VorschlagClusterProto

Eine Reihe ähnlicher Vorschläge, von denen wir vermuten, dass sie eng miteinander verbunden sind.

Dieses Proto und die meisten verschachtelten Protos sind von foxandcrown.prelaunchreport.service.SuggestionClusterProto abgezweigt und ersetzen die PLR-Abhängigkeiten durch FTLs.

JSON-Darstellung
{ "category": enum (SuggestionCategory), "suggestions": [ { object (SuggestionProto) } ] }

Felder
category	enum ( SuggestionCategory ) Kategorie, in der diese Art von Vorschlägen erscheinen sollen. Immer eingestellt.
suggestions[]	object ( SuggestionProto ) Eine Reihe von Vorschlägen. Alle Vorschläge innerhalb eines Clusters müssen dieselbe SuggestionPriority haben und zur selben SuggestionCategory gehören. Vorschläge mit derselben Screenshot-URL sollten nebeneinander stehen.

Vorschlagskategorie

Aufzählungen
unknownCategory
contentLabeling
touchTargetSize
lowContrast
implementation

VorschlagProto

JSON-Darstellung

{ "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. }

Felder
title	string Allgemeiner Titel für den Vorschlag in der Sprache des Benutzers, ohne Markup. Immer eingestellt.
shortMessage	object ( SafeHtmlProto ) Prägnante Nachricht in der Sprache des Benutzers, die den Vorschlag darstellt und möglicherweise Markup enthält. Immer eingestellt.
longMessage	object ( SafeHtmlProto ) Nachricht in der Sprache des Benutzers, die den Vorschlag erläutert und Markup enthalten kann. Immer eingestellt.
priority	enum ( SuggestionPriority ) Relative Wichtigkeit eines Vorschlags. Immer eingestellt.
helpUrl	string Verweis auf einen Hilfeartikel zu dieser Art von Vorschlag. Immer eingestellt.
region	object ( RegionProto ) Region innerhalb des Screenshots, die für diesen Vorschlag relevant ist. Optional.
secondaryPriority	number Relative Wichtigkeit eines Vorschlags im Vergleich zu anderen Vorschlägen mit derselben Priorität und Kategorie. Dies ist ein bedeutungsloser Wert, der zum Ordnen von Vorschlägen verwendet werden kann, die in derselben Kategorie liegen und dieselbe Priorität haben. Die größeren Werte haben eine höhere Priorität (dh sie sind wichtiger). Optional.
screenId	string ID des Bildschirms für den Vorschlag. Es wird verwendet, um den entsprechenden Screenshot-Pfad abzurufen. Beispielsweise entspricht die Bildschirm-ID „1“ der Datei „1.png“ in GCS. Immer eingestellt.
Union-Feld resource_id . resource_id kann nur einer der folgenden Werte sein:
resourceName	string Verweis auf ein Ansichtselement, identifiziert durch seinen Ressourcennamen, sofern vorhanden.
pseudoResourceId	string Eine einigermaßen lesbare Kennung der Quellansicht, wenn sie keinen Ressourcennamen hat. Dies ist ein Pfad innerhalb der Barrierefreiheitshierarchie, ein Element mit dem Ressourcennamen; ähnlich einem XPath.

SafeHtmlProto

WICHTIG: Es ist unsicher, diese Nachricht von einer nicht vertrauenswürdigen Quelle zu akzeptieren, da es für einen Angreifer trivial ist, serialisierte Nachrichten zu fälschen, die den Sicherheitsvertrag des Typs nicht erfüllen – sie könnten beispielsweise ein vom Angreifer gesteuertes Skript enthalten. Ein System, das ein SafeHtmlProto empfängt, vertraut implizit dem Hersteller des SafeHtmlProto. Daher ist es im Allgemeinen sicher, diese Nachricht in RPC-Antworten zurückzugeben, aber im Allgemeinen unsicher, sie in RPC-Anfragen zu akzeptieren.

JSON-Darstellung
{ "privateDoNotAccessOrElseSafeHtmlWrappedValue": string }

Felder
privateDoNotAccessOrElseSafeHtmlWrappedValue	string WICHTIG: Setzen oder lesen Sie dieses Feld niemals, auch nicht aus Tests, es ist privat. In der Dokumentation oben in der .proto-Datei finden Sie Programmiersprachenpakete, mit denen Sie diese Nachricht erstellen oder lesen können.

VorschlagPriorität

Aufzählungen
unknownPriority
error
warning
info

RegionProto

Eine rechteckige Region.

JSON-Darstellung
{ "topPx": integer, "leftPx": integer, "heightPx": integer, "widthPx": integer }

Felder
topPx	integer Der obere Rand des Rechtecks, in Pixel. Immer eingestellt.
leftPx	integer Die linke Seite des Rechtecks, in Pixel. Immer eingestellt.
heightPx	integer Die Höhe in Pixel. Immer eingestellt.
widthPx	integer Die Breite in Pixel. Immer eingestellt.