Method: projects.histories.executions.steps.accessibilityClusters

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 estiver malformada
  • FAILED_PRECONDITION - se um argumento na solicitação for inválido; por exemplo, se o formato local estiver incorreto
  • NOT_FOUND - se a etapa que contém não existir

Solicitação HTTP

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

A URL usa sintaxe de transcodificação gRPC .

Parâmetros de caminho

Parâmetros
name

string

Um nome completo do recurso da etapa. Por exemplo, projetos/meu-projeto/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

Obrigatório.

Parâmetros de consulta

Parâmetros
locale

string

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

Obrigatório.

Solicitar corpo

O corpo da solicitação deve estar vazio.

Corpo de resposta

Mensagem de resposta para AccessibilityService.ListStepAccessibilityClusters.

Se for bem-sucedido, o corpo da resposta conterá dados com a seguinte estrutura:

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

string

Um nome completo do recurso da etapa. Por exemplo, projetos/meu-projeto/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

Sempre presentes.

clusters[]

object ( SuggestionClusterProto )

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 pelo seu cluster de maior prioridade.

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 (SuggestionCategory),
  "suggestions": [
    {
      object (SuggestionProto)
    }
  ]
}
Campos
category

enum ( SuggestionCategory )

Categoria em que devem aparecer estes tipos de sugestões. Sempre definido.

suggestions[]

object ( SuggestionProto )

Uma sequência de sugestões. Todas as sugestões dentro de um cluster devem ter o mesmo SuggestionPriority e pertencer à mesma SuggestionCategory. Sugestões com o mesmo URL de captura de tela devem ser adjacentes.

Categoria de sugestão

Enums
unknownCategory
contentLabeling
touchTargetSize
lowContrast
implementation

SugestãoProto

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, no idioma do usuário, representando a sugestão, podendo conter marcação. Sempre definido.

longMessage

object ( SafeHtmlProto )

Mensagem, no idioma 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 na 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 tenham a mesma prioridade e categoria. Este é um valor sem sentido que pode ser usado para ordenar sugestões que estejam na mesma categoria e tenham a mesma prioridade. Os valores maiores têm maior prioridade (ou seja, são mais importantes). Opcional.

screenId

string

ID da tela da sugestão. É usado para obter o caminho da captura de tela correspondente. Por exemplo, screenId "1" corresponde ao arquivo "1.png" no GCS. Sempre definido.

Campo de união resource_id .

resource_id pode ser apenas um dos seguintes:

resourceName

string

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

pseudoResourceId

string

Um identificador legível da visualização de origem, se ela 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 cumpram o contrato de segurança do tipo – por exemplo, pode conter script controlado pelo invasor. Um sistema que recebe um SafeHtmlProto confia implicitamente no produtor do SafeHtmlProto. Portanto, geralmente é seguro retornar esta mensagem em respostas RPC, mas geralmente não é seguro aceitá-la em solicitações RPC.

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

string

IMPORTANTE: Nunca configure ou leia este campo, mesmo de testes, ele é privado. Consulte a documentação na parte superior do arquivo .proto para pacotes de linguagem de programação com os quais criar ou ler esta mensagem.

Prioridade de sugestão

Enums
unknownPriority
error
warning
info

RegiãoProto

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.

,

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 estiver malformada
  • FAILED_PRECONDITION - se um argumento na solicitação for inválido; por exemplo, se o formato local estiver incorreto
  • NOT_FOUND - se a etapa que contém não existir

Solicitação HTTP

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

A URL usa sintaxe de transcodificação gRPC .

Parâmetros de caminho

Parâmetros
name

string

Um nome completo do recurso da etapa. Por exemplo, projetos/meu-projeto/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

Obrigatório.

Parâmetros de consulta

Parâmetros
locale

string

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

Obrigatório.

Solicitar corpo

O corpo da solicitação deve estar vazio.

Corpo de resposta

Mensagem de resposta para AccessibilityService.ListStepAccessibilityClusters.

Se for bem-sucedido, o corpo da resposta conterá dados com a seguinte estrutura:

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

string

Um nome completo do recurso da etapa. Por exemplo, projetos/meu-projeto/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

Sempre presentes.

clusters[]

object ( SuggestionClusterProto )

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 pelo seu cluster de maior prioridade.

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 (SuggestionCategory),
  "suggestions": [
    {
      object (SuggestionProto)
    }
  ]
}
Campos
category

enum ( SuggestionCategory )

Categoria em que devem aparecer estes tipos de sugestões. Sempre definido.

suggestions[]

object ( SuggestionProto )

Uma sequência de sugestões. Todas as sugestões dentro de um cluster devem ter o mesmo SuggestionPriority e pertencer à mesma SuggestionCategory. Sugestões com o mesmo URL de captura de tela devem ser adjacentes.

Categoria de sugestão

Enums
unknownCategory
contentLabeling
touchTargetSize
lowContrast
implementation

SugestãoProto

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, no idioma do usuário, representando a sugestão, podendo conter marcação. Sempre definido.

longMessage

object ( SafeHtmlProto )

Mensagem, no idioma 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 na 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 tenham a mesma prioridade e categoria. Este é um valor sem sentido que pode ser usado para ordenar sugestões que estejam na mesma categoria e tenham a mesma prioridade. Os valores maiores têm maior prioridade (ou seja, são mais importantes). Opcional.

screenId

string

ID da tela da sugestão. É usado para obter o caminho da captura de tela correspondente. Por exemplo, screenId "1" corresponde ao arquivo "1.png" no GCS. Sempre definido.

Campo de união resource_id .

resource_id pode ser apenas um dos seguintes:

resourceName

string

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

pseudoResourceId

string

Um identificador legível da visualização de origem, se ela 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 cumpram o contrato de segurança do tipo – por exemplo, pode conter script controlado pelo invasor. Um sistema que recebe um SafeHtmlProto confia implicitamente no produtor do SafeHtmlProto. Portanto, geralmente é seguro retornar esta mensagem em respostas RPC, mas geralmente não é seguro aceitá-la em solicitações RPC.

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

string

IMPORTANTE: Nunca configure ou leia este campo, mesmo de testes, ele é privado. Consulte a documentação na parte superior do arquivo .proto para pacotes de linguagem de programação com os quais criar ou ler esta mensagem.

Prioridade de sugestão

Enums
unknownPriority
error
warning
info

RegiãoProto

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.