Method: projects.histories.executions.steps.accessibilityClusters

Wyświetla listę klastrów ułatwień dostępu dla danego kroku

Może zwrócić dowolny z tych kanonicznych kodów błędów:

  • PERMISSION_DENIED – jeśli użytkownik nie ma uprawnień do odczytu projektu
  • Błędny_argument – jeśli żądanie ma nieprawidłowy format;
  • FAILED_PREcondition – jeśli argument w żądaniu jest nieprawidłowy; np. jeśli format języka jest nieprawidłowy.
  • NOT_FOUND – jeśli zawierający krok 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

string

Pełna nazwa zasobu kroku. Na przykład: projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

Wymagane.

Parametry zapytania

Parametry
locale

string

Akceptowany format to kanoniczny format Unicode z łącznikiem jako separatorem. Język musi być zapisany małymi literami, Skrypt językowy – wielką literą, region – WIELKIE LITERY. Szczegółowe informacje znajdziesz na stronie http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

Wymagane.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Komunikat z odpowiedzią na temat AccessibilityService.ListStepAccessibilityClusters.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "name": string,
  "clusters": [
    {
      object (SuggestionClusterProto)
    }
  ]
}
Pola
name

string

Pełna nazwa zasobu kroku. Na przykład: projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

Zawsze prezentuje.
clusters[]

object (SuggestionClusterProto)

Sekwencja sugestii ułatwień dostępu pogrupowanych w klastry. W ramach sekwencji klastry należące do tej samej kategorii Sugestie powinny sąsiadują ze sobą. W każdej kategorii klastry powinny być uporządkowane według priorytetu sugestii (najpierw błędy). Kategorie powinny być uporządkowane według klastra o najwyższym priorytecie.

Zakresy autoryzacji

Wymaga następującego zakresu protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).

Klaster sugestii (Proto)

Zestaw podobnych sugestii, które prawdopodobnie są ze sobą powiązane.

To proto i większość zagnieżdżonych protos mają odgałęzienia od foxandcrown.prelaunchreport.service.suggestionClusterProto, zastępując zależności PLR zależnościami FTL.

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

enum (SuggestionCategory)

Kategoria, w której powinny pojawiać się tego typu sugestie. Zawsze ustawiona.
suggestions[]

object (SuggestionProto)

Sekwencja sugestii. Wszystkie sugestie w klastrze muszą mieć ten sam priorytet sugestii i należeć do tej samej kategorii sugestii. Sugestie z tym samym adresem URL zrzutu ekranu powinny znajdować się obok siebie.

Kategoria sugestii

Wartości w polu enum
unknownCategory
contentLabeling
touchTargetSize
lowContrast
implementation

Protokół sugestii

Zapis 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.
}
Pola
title

string

Ogólny tytuł sugestii w języku użytkownika, bez znaczników. Zawsze ustawiona.
shortMessage

object (SafeHtmlProto)

Zwięzły przekaz w języku użytkownika, przedstawiający sugestię i może zawierać znaczniki. Zawsze ustawiona.
longMessage

object (SafeHtmlProto)

Komunikat w języku użytkownika zawierający sugestię, który może zawierać znaczniki. Zawsze ustawiona.
priority

enum (SuggestionPriority)

Względne znaczenie sugestii. Zawsze ustawiona.
helpUrl

string

Odniesienie do artykułu w Centrum pomocy dotyczącego tego typu sugestii. Zawsze ustawiona.
region

object (RegionProto)

Region na zrzucie ekranu związany z tą sugestią. Opcjonalnie.
secondaryPriority

number

Względne znaczenie sugestii w porównaniu z innymi sugestiami, które mają ten sam priorytet i tę samą kategorię. Jest to bezsensowna wartość, której można użyć do uporządkowania sugestii, które należą do tej samej kategorii i mają taki sam priorytet. Większe wartości mają wyższy priorytet (czyli są ważniejsze). Opcjonalnie.
screenId

string

Identyfikator ekranu sugestii. Jest używana do uzyskania odpowiedniej ścieżki zrzutu ekranu. Na przykład screenId „1”. odpowiada „1.png” w GCS. Zawsze ustawiona.

Pole sumy resource_id.

resource_id może mieć tylko jedną z tych wartości:
resourceName

string

Odwołanie do elementu widoku danych określanego za pomocą nazwy zasobu (jeśli taki istnieje).
pseudoResourceId

string

Zrozumiały dla człowieka identyfikator widoku źródłowego, jeśli nie ma on parametru resourceName. To jest ścieżka w hierarchii ułatwień dostępu, element o nazwie zasobu. podobny do XPath.

SafeHtmlProto

WAŻNE: przyjmowanie tej wiadomości z niezaufanego źródła jest niebezpieczne, ponieważ sfałszowanie zserializowanych wiadomości, które nie spełniają warunków określonych w bezpieczeństwie, jest ryzykowne. Na przykład taka wiadomość może zawierać skrypt kontrolowany przez osobę przeprowadzającą atak. System, który odbiera kod SafehtmlProto, domyślnie ufa producentowi SafehtmlProto. Zwracanie tego komunikatu w odpowiedziach RPC jest ogólnie bezpieczne, ale jego akceptacja w żądaniach RPC jest zasadniczo niebezpieczne.

Zapis JSON 
{
  "privateDoNotAccessOrElseSafeHtmlWrappedValue": string
}
Pola
privateDoNotAccessOrElseSafeHtmlWrappedValue

string

WAŻNE: nigdy nie ustawiaj ani nie odczytuj tego pola, nawet podczas testów – jest ono prywatne. Zapoznaj się z dokumentacją na początku pliku .proto zawierającą pakiety językowe do utworzenia lub odczytania tej wiadomości.

Priorytet sugestii

Wartości w polu enum
unknownPriority
error
warning
info

RegionProto

Prostokątny obszar.

Zapis JSON 
{
  "topPx": integer,
  "leftPx": integer,
  "heightPx": integer,
  "widthPx": integer
}
Pola
topPx

integer

Górna część prostokąta w pikselach. Zawsze ustawiona.
leftPx

integer

Lewa strona prostokąta (w pikselach). Zawsze ustawiona.
heightPx

integer

Wysokość w pikselach. Zawsze ustawiona.
widthPx

integer

Szerokość w pikselach. Zawsze ustawiona.