Method: projects.histories.executions.steps.accessibilityClusters

Lista os clusters de acessibilidade de uma determinada etapa

Poderá retornar qualquer um dos seguintes códigos de erro canônicos:

  • PERMISSION_DENIED: se o usuário não estiver autorizado a ler o projeto.
  • INVALID_ARGUMENT: se o formato da solicitação estiver incorreto.
  • FAILED_PRECONDITION: se um argumento na solicitação for inválido. Por exemplo: se o formato de localidade estiver incorreto
  • NOT_FOUND: se a etapa que contém não existe.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Um nome completo de recurso da etapa. Por exemplo, projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

Obrigatório.

Parâmetros de consulta

Parâmetros
locale

string

O formato aceito é o Unicode canônico com hífen como delimitador. O idioma deve estar em letras minúsculas, o script de idioma deve estar em letras maiúsculas, a região deve estar em LETRAS MAIÚSCULAS. Consulte http://www.unicode.org/reports/tr35/#Unicode_locale_identifier para mais detalhes.

Obrigatório.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para AccessibilityService.ListStepAccessibilityClusters.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "name": string,
  "clusters": [
    {
      object (SuggestionClusterProto)
    }
  ]
}
Campos
name

string

Um nome completo de recurso da etapa. Por exemplo, projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

Sempre apresenta.
clusters[]

object (SuggestionClusterProto)

Uma sequência de sugestões de acessibilidade agrupadas em clusters. Na sequência, os clusters que pertencem à mesma SuggestionCategory precisam ser adjacentes. Dentro de cada categoria, os clusters devem ser ordenados por SuggestionPreferences (primeiros ERRORs). As categorias devem ser ordenadas pelo cluster de prioridade mais alta.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

SuggestionClusterProto

Um conjunto de sugestões semelhantes que suspeitamos estarem estreitamente relacionadas.

Esse proto e a maioria dos aninhados são ramificados de foxandcrown.prelaunchreport.service.SuggestionClusterProto, substituindo as dependências do PLR por FTLs.

Representação JSON 
{
  "category": enum (SuggestionCategory),
  "suggestions": [
    {
      object (SuggestionProto)
    }
  ]
}
Campos
category

enum (SuggestionCategory)

A categoria em que esses tipos de sugestões devem aparecer. Sempre definido.
suggestions[]

object (SuggestionProto)

Uma sequência de sugestões. Todas as sugestões em um cluster precisam ter o mesmo SuggestionPrior e pertencer à mesma SuggestionCategory. Sugestões com o mesmo URL de captura de tela precisam estar ao lado.

SuggestionCategory

Enums
unknownCategory
contentLabeling
touchTargetSize
lowContrast
implementation

SuggestionProto

Representação 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.
}
Campos
title

string

Título geral da sugestão, no idioma do usuário, sem marcação. Sempre definido.
shortMessage

object (SafeHtmlProto)

Mensagem concisa, na linguagem do usuário, representando a sugestão, que pode conter marcação. Sempre definido.
longMessage

object (SafeHtmlProto)

Mensagem, na linguagem do usuário, explicando a sugestão, que pode conter marcação. Sempre definido.
priority

enum (SuggestionPriority)

Importância relativa de uma sugestão. Sempre definido.
helpUrl

string

Referência a um artigo da Central de Ajuda sobre esse tipo de sugestão. Sempre definido.
region

object (RegionProto)

Região dentro da captura de tela que é relevante para esta sugestão. Opcional.
secondaryPriority

number

Importância relativa de uma sugestão em comparação com outras sugestões que têm a mesma prioridade e categoria. Esse é um valor sem sentido que pode ser usado para ordenar sugestões que estão na mesma categoria e têm a mesma prioridade. Os valores maiores têm prioridade mais alta (ou seja, são mais importantes). Opcional.
screenId

string

ID da tela para a sugestão. Ele é usado para receber o caminho correspondente da captura de tela. Por exemplo, screenId "1" corresponde a "1.png" no GCS. Sempre definido.

Campo de união resource_id.

resource_id pode ser apenas de um dos tipos a seguir:
resourceName

string

Referência a um elemento de visualização, identificado pelo nome de recurso, se houver um.
pseudoResourceId

string

Um identificador legível da visualização de origem, se ela não tiver um resourceName. esse é um caminho na hierarquia de acessibilidade, um elemento com nome de recurso; semelhante a um XPath.

SafeHtmlProto

IMPORTANTE: não é seguro aceitar esta mensagem de uma fonte não confiável, pois é trivial para um invasor forjar mensagens serializadas que não cumprem o contrato de segurança do tipo -- por exemplo, ela pode conter um script controlado pelo atacante. Um sistema que recebe um SafeHTMLProto confia implicitamente no produtor dele. Portanto, em geral, é seguro retornar essa mensagem em respostas RPC, mas geralmente não é seguro aceitá-la em solicitações de RPC.

Representação JSON 
{
  "privateDoNotAccessOrElseSafeHtmlWrappedValue": string
}
Campos
privateDoNotAccessOrElseSafeHtmlWrappedValue

string

IMPORTANTE: nunca configure nem leia esse campo, mesmo em testes, ele é privado. Consulte a documentação na parte superior do arquivo .proto para saber quais pacotes de linguagem de programação podem ser usados para criar ou ler essa mensagem.

SuggestionPrioridade

Enums
unknownPriority
error
warning
info

RegionProto

Uma região retangular.

Representação JSON 
{
  "topPx": integer,
  "leftPx": integer,
  "heightPx": integer,
  "widthPx": integer
}
Campos
topPx

integer

A parte superior do retângulo, em pixels. Sempre definido.
leftPx

integer

O lado esquerdo do retângulo, em pixels. Sempre definido.
heightPx

integer

A altura, em pixels. Sempre definido.
widthPx

integer

A largura, em pixels. Sempre definido.