- solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- corpo da resposta
- Escopos de autorização
- SugestãoClusterProto
- SugestãoCategoria
- SugestãoProto
- SafeHtmlProto
- SugestãoPrioridade
- RegiãoProto
- Tente!
Lista clusters de acessibilidade para uma determinada etapa
Pode 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 a solicitação for malformada
- 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 o contém não existir
solicitação HTTP
GET https://toolresults.googleapis.com/toolresults/v1beta3/{name=projects/*/histories/*/executions/*/steps/*}:accessibilityClusters
A URL usa a sintaxe de transcodificação gRPC .
Parâmetros de caminho
Parâmetros | |
---|---|
name | Um nome de recurso completo da etapa. Por exemplo, projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef Obrigatório. |
Parâmetros de consulta
Parâmetros | |
---|---|
locale | O formato aceito é o formato Unicode canônico com hífen como delimitador. O idioma deve ser minúsculo, Script de idioma - maiúsculas, região - MAIÚSCULAS. Consulte http://www.unicode.org/reports/tr35/#Unicode_locale_identifier para obter detalhes. Obrigatório. |
Corpo da solicitação
O corpo da solicitação deve estar vazio.
corpo da resposta
Mensagem de resposta para AccessibilityService.ListStepAccessibilityClusters.
Se for bem-sucedido, o corpo da resposta contém dados com a seguinte estrutura:
representação JSON |
---|
{
"name": string,
"clusters": [
{
object ( |
Campos | |
---|---|
name | Um nome de recurso completo da etapa. Por exemplo, projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef Sempre apresenta. |
clusters[] | Uma sequência de sugestões de acessibilidade, agrupadas em clusters. Dentro da sequência, os clusters que pertencem à mesma SuggestionCategory devem ser adjacentes. Dentro de cada categoria, os clusters devem ser ordenados por sua SuggestionPriority (ERRORs primeiro). As categorias devem ser ordenadas por seu cluster de prioridade mais alta. |
Escopos de autorização
Requer o seguinte escopo OAuth:
-
https://www.googleapis.com/auth/cloud-platform
Para obter mais informações, consulte Visão geral da autenticação .
SugestãoClusterProto
Um conjunto de sugestões semelhantes que suspeitamos estarem intimamente relacionadas.
Este proto e a maioria dos protos aninhados são ramificados de foxandcrown.prelaunchreport.service.SuggestionClusterProto, substituindo as dependências de PLR por FTL.
representação JSON |
---|
{ "category": enum ( |
Campos | |
---|---|
category | Categoria na qual esses tipos de sugestões devem aparecer. Sempre definido. |
suggestions[] | Uma sequência de sugestões. Todas as sugestões dentro de um cluster devem ter a mesma SuggestionPriority e pertencer à mesma SuggestionCategory. Sugestões com o mesmo URL de captura de tela devem ser adjacentes. |
SugestãoCategoria
Enums | |
---|---|
unknownCategory | |
contentLabeling | |
touchTargetSize | |
lowContrast | |
implementation |
SugestãoProto
representação JSON |
---|
{ "title": string, "shortMessage": { object ( |
Campos | |
---|---|
title | Título geral da sugestão, no idioma do usuário, sem marcação. Sempre definido. |
shortMessage | Mensagem concisa, na linguagem do usuário, representando a sugestão, podendo conter marcação. Sempre definido. |
longMessage | Mensagem, na linguagem do usuário, explicando a sugestão, que pode conter marcação. Sempre definido. |
priority | Importância relativa de uma sugestão. Sempre definido. |
helpUrl | Referência a um artigo da central de ajuda sobre esse tipo de sugestão. Sempre definido. |
region | Região dentro da captura de tela que é relevante para esta sugestão. Opcional. |
secondaryPriority | Importância relativa de uma sugestão em comparação com outras sugestões que têm a mesma prioridade e categoria. Este é 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 maior prioridade (ou seja, são mais importantes). Opcional. |
screenId | ID da tela da sugestão. Ele é usado para obter o caminho de captura de tela correspondente. Por exemplo, screenId "1" corresponde ao arquivo "1.png" no GCS. Sempre definido. |
Campo de união | |
resourceName | Referência a um elemento de exibição, identificado por seu nome de recurso, se houver. |
pseudoResourceId | Um identificador um pouco legível por humanos da exibição de origem, se não tiver um resourceName. Este é um caminho dentro da 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, pode conter um script controlado pelo invasor. Um sistema que recebe um SafeHtmlProto confia implicitamente no produtor do SafeHtmlProto. Portanto, geralmente é seguro retornar essa mensagem em respostas RPC, mas geralmente não é seguro aceitá-la em solicitações RPC.
representação JSON |
---|
{ "privateDoNotAccessOrElseSafeHtmlWrappedValue": string } |
Campos | |
---|---|
privateDoNotAccessOrElseSafeHtmlWrappedValue | IMPORTANTE: Nunca configure ou leia este campo, mesmo em testes, ele é privado. Consulte a documentação na parte superior do arquivo .proto para obter os pacotes de linguagem de programação com os quais criar ou ler esta mensagem. |
SugestãoPrioridade
Enums | |
---|---|
unknownPriority | |
error | |
warning | |
info |
RegiãoProto
Uma região retangular.
representação JSON |
---|
{ "topPx": integer, "leftPx": integer, "heightPx": integer, "widthPx": integer } |
Campos | |
---|---|
topPx | A parte superior do retângulo, em pixels. Sempre definido. |
leftPx | O lado esquerdo do retângulo, em pixels. Sempre definido. |
heightPx | A altura, em pixels. Sempre definido. |
widthPx | A largura, em pixels. Sempre definido. |