- Żądanie HTTP
- Parametry ścieżki
- Parametry zapytania
- Treść żądania
- Treść odpowiedzi
- Zakresy uprawnień
- Klaster sugestiiProto
- Kategoria sugestii
- SugestiaProto
- SafeHtmlProto
- SugestiaPriorytet
- RegionProto
- Spróbuj!
Wyświetla listę klastrów dostępności dla danego kroku
Może zwrócić dowolny z następujących kanonicznych kodów błędów:
- PERMISSION_DENIED - jeśli użytkownik nie ma uprawnień do odczytu projektu
- INVALID_ARGUMENT — jeśli żądanie jest źle sformułowane
- FAILED_PRECONDITION - jeśli argument w żądaniu okaże się nieprawidłowy; np. jeśli format ustawień regionalnych jest nieprawidłowy
- NOT_FOUND - jeśli krok zawierający nie istnieje
Żądanie HTTP
GET https://toolresults.googleapis.com/toolresults/v1beta3/{name=projects/*/histories/*/executions/*/steps/*}:accessibilityClusters
Adres URL używa składni transkodowania gRPC .
Parametry ścieżki
Parametry | |
---|---|
name | Pełna nazwa zasobu kroku. Na przykład projekty/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef Wymagany. |
Parametry zapytania
Parametry | |
---|---|
locale | Akceptowanym formatem jest kanoniczny format Unicode z łącznikiem jako ogranicznikiem. Język musi być pisany małymi literami, skrypt językowy – wielkimi literami, region – WIELKIMI LITERAMI. Aby uzyskać szczegółowe informacje, zobacz http://www.unicode.org/reports/tr35/#Unicode_locale_identifier . Wymagany. |
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
Komunikat odpowiedzi dla AccessibilityService.ListStepAccessibilityClusters.
Jeśli się powiedzie, treść odpowiedzi zawiera dane o następującej strukturze:
Reprezentacja JSON |
---|
{
"name": string,
"clusters": [
{
object ( |
Pola | |
---|---|
name | Pełna nazwa zasobu kroku. Na przykład projekty/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef Zawsze prezentuje. |
clusters[] | Sekwencja sugestii dotyczących dostępności pogrupowanych w klastry. W sekwencji klastry należące do tej samej kategorii sugestii powinny sąsiadować ze sobą. W ramach każdej kategorii klastry należy uporządkować według ich priorytetu sugestii (najpierw BŁĘDY). Kategorie należy uporządkować według klastra o najwyższym priorytecie. |
Zakresy uprawnień
Wymaga następującego zakresu OAuth:
-
https://www.googleapis.com/auth/cloud-platform
Aby uzyskać więcej informacji, zobacz Omówienie uwierzytelniania .
Klaster sugestiiProto
Zestaw podobnych sugestii, które, jak podejrzewamy, są ze sobą ściśle powiązane.
To proto i większość zagnieżdżonych proto jest rozgałęzionych z foxandcrown.prelaunchreport.service.SuggestionClusterProto, zastępując zależności PLR FTL.
Reprezentacja JSON |
---|
{ "category": enum ( |
Pola | |
---|---|
category | Kategoria, w której powinny pojawiać się tego typu sugestie. Zawsze ustawione. |
suggestions[] | Sekwencja sugestii. Wszystkie sugestie w klastrze muszą mieć ten sam SuggestionPriority i należeć do tej samej SuggestionCategory. Sugestie z tym samym adresem URL zrzutu ekranu powinny sąsiadować ze sobą. |
Kategoria sugestii
Wyliczenia | |
---|---|
unknownCategory | |
contentLabeling | |
touchTargetSize | |
lowContrast | |
implementation |
SugestiaProto
Reprezentacja JSON |
---|
{ "title": string, "shortMessage": { object ( |
Pola | |
---|---|
title | Ogólny tytuł sugestii, w języku użytkownika, bez znaczników. Zawsze ustawione. |
shortMessage | Zwięzły komunikat w języku użytkownika przedstawiający sugestię, który może zawierać znaczniki. Zawsze ustawione. |
longMessage | Wiadomość w języku użytkownika wyjaśniająca sugestię, która może zawierać znaczniki. Zawsze ustawione. |
priority | Względne znaczenie sugestii. Zawsze ustawione. |
helpUrl | Odniesienie do artykułu w Centrum pomocy dotyczącego tego typu sugestii. Zawsze ustawione. |
region | Region na zrzucie ekranu, który ma związek z tą sugestią. Opcjonalny. |
secondaryPriority | Względne znaczenie sugestii w porównaniu z innymi sugestiami, które mają ten sam priorytet i kategorię. Jest to bezsensowna wartość, której można użyć do uporządkowania sugestii należących do tej samej kategorii i mających ten sam priorytet. Większe wartości mają wyższy priorytet (tzn. są ważniejsze). Opcjonalny. |
screenId | Identyfikator ekranu sugestii. Służy do uzyskania odpowiedniej ścieżki zrzutu ekranu. Na przykład screenId „1” odpowiada plikowi „1.png” w GCS. Zawsze ustawione. |
Pole Unii | |
resourceName | Odwołanie do elementu widoku, identyfikowanego przez nazwę zasobu, jeśli taki posiada. |
pseudoResourceId | W pewnym stopniu czytelny dla człowieka identyfikator widoku źródłowego, jeśli nie ma on nazwy zasobu. Jest to ścieżka w hierarchii dostępności, element o nazwie zasobu; podobny do XPath. |
SafeHtmlProto
WAŻNE: Przyjmowanie tej wiadomości z niezaufanego źródła jest niebezpieczne, ponieważ dla atakującego sfałszowanie serializowanych wiadomości, które nie spełniają umowy bezpieczeństwa danego typu — na przykład może zawierać skrypt kontrolowany przez osobę atakującą. System, który otrzymuje SafeHtmlProto, pośrednio ufa producentowi SafeHtmlProto. Dlatego ogólnie bezpieczne jest zwracanie tej wiadomości w odpowiedziach RPC, ale ogólnie niebezpieczne jest akceptowanie jej w żądaniach RPC.
Reprezentacja JSON |
---|
{ "privateDoNotAccessOrElseSafeHtmlWrappedValue": string } |
Pola | |
---|---|
privateDoNotAccessOrElseSafeHtmlWrappedValue | WAŻNE: Nigdy nie ustawiaj ani nie czytaj tego pola, nawet z testów, jest ono prywatne. Zobacz dokumentację na górze pliku .proto, aby poznać pakiety języków programowania, za pomocą których można utworzyć lub odczytać tę wiadomość. |
SugestiaPriorytet
Wyliczenia | |
---|---|
unknownPriority | |
error | |
warning | |
info |
RegionProto
Region prostokątny.
Reprezentacja JSON |
---|
{ "topPx": integer, "leftPx": integer, "heightPx": integer, "widthPx": integer } |
Pola | |
---|---|
topPx | Góra prostokąta w pikselach. Zawsze ustawione. |
leftPx | Lewa strona prostokąta w pikselach. Zawsze ustawione. |
heightPx | Wysokość w pikselach. Zawsze ustawione. |
widthPx | Szerokość w pikselach. Zawsze ustawione. |