Method: projects.histories.executions.steps.accessibilityClusters

Enumera los grupos de accesibilidad para un paso determinado

Puede devolver cualquiera de los siguientes códigos de error canónicos:

  • PERMISSION_DENIED: si el usuario no está autorizado a leer el proyecto
  • INVALID_ARGUMENT: si la solicitud tiene un formato incorrecto
  • FAILED_PRECONDITION: si un argumento de la solicitud resulta no válido; por ejemplo, si el formato local es incorrecto
  • NOT_FOUND: si el paso que lo contiene no existe

solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación gRPC .

Parámetros de ruta

Parámetros
name

string

Un nombre de recurso completo del paso. Por ejemplo, proyectos/mi-proyecto/historias/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

Requerido.

Parámetros de consulta

Parámetros
locale

string

El formato aceptado es el formato canónico Unicode con guión como delimitador. El idioma debe estar en minúsculas, el idioma de escritura debe estar en mayúscula y la región en MAYÚSCULAS. Consulte http://www.unicode.org/reports/tr35/#Unicode_locale_identifier para obtener más detalles.

Requerido.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de respuesta

Mensaje de respuesta para AccessibilityService.ListStepAccessibilityClusters.

Si tiene éxito, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON
{
  "name": string,
  "clusters": [
    {
      object (SuggestionClusterProto)
    }
  ]
}
Campos
name

string

Un nombre de recurso completo del paso. Por ejemplo, proyectos/mi-proyecto/historias/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

Siempre presente.

clusters[]

object ( SuggestionClusterProto )

Una secuencia de sugerencias de accesibilidad, agrupadas en grupos. Dentro de la secuencia, los clústeres que pertenecen a la misma SuggestionCategory deben ser adyacentes. Dentro de cada categoría, los grupos deben ordenarse según su prioridad de sugerencia (los ERRORES primero). Las categorías deben ordenarse por su grupo de mayor prioridad.

Ámbitos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulte Descripción general de la autenticación .

SugerenciaClusterProto

Un conjunto de sugerencias similares que sospechamos están estrechamente relacionadas.

Este proto y la mayoría de los protos anidados se ramifican desde foxandcrown.prelaunchreport.service.SuggestionClusterProto, reemplazando las dependencias de PLR ​​con FTL.

Representación JSON
{
  "category": enum (SuggestionCategory),
  "suggestions": [
    {
      object (SuggestionProto)
    }
  ]
}
Campos
category

enum ( SuggestionCategory )

Categoría en la que deben aparecer este tipo de sugerencias. Siempre configurado.

suggestions[]

object ( SuggestionProto )

Una secuencia de sugerencias. Todas las sugerencias dentro de un clúster deben tener la misma SuggestionPriority y pertenecer a la misma SuggestionCategory. Las sugerencias con la misma URL de captura de pantalla deben estar adyacentes.

Categoría de sugerencia

Enumeraciones
unknownCategory
contentLabeling
touchTargetSize
lowContrast
implementation

SugerenciaProto

Representación 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 general de la sugerencia, en el idioma del usuario, sin etiquetas. Siempre configurado.

shortMessage

object ( SafeHtmlProto )

Mensaje conciso, en el idioma del usuario, que representa la sugerencia, que puede contener etiquetas. Siempre configurado.

longMessage

object ( SafeHtmlProto )

Mensaje, en el idioma del usuario, explicando la sugerencia, que puede contener etiquetas. Siempre configurado.

priority

enum ( SuggestionPriority )

Importancia relativa de una sugerencia. Siempre configurado.

helpUrl

string

Referencia a un artículo del centro de ayuda sobre este tipo de sugerencia. Siempre configurado.

region

object ( RegionProto )

Región dentro de la captura de pantalla que es relevante para esta sugerencia. Opcional.

secondaryPriority

number

Importancia relativa de una sugerencia en comparación con otras sugerencias que tienen la misma prioridad y categoría. Este es un valor sin sentido que se puede utilizar para ordenar sugerencias que están en la misma categoría y tienen la misma prioridad. Los valores más grandes tienen mayor prioridad (es decir, son más importantes). Opcional.

screenId

string

ID de la pantalla para la sugerencia. Se utiliza para obtener la ruta de captura de pantalla correspondiente. Por ejemplo, screenId "1" corresponde al archivo "1.png" en GCS. Siempre configurado.

Campo de unión resource_id .

resource_id puede ser solo uno de los siguientes:

resourceName

string

Referencia a un elemento de vista, identificado por su nombre de recurso, si lo tiene.

pseudoResourceId

string

Un identificador algo legible por humanos de la vista de origen, si no tiene un nombre de recurso. Esta es una ruta dentro de la jerarquía de accesibilidad, un elemento con nombre de recurso; similar a un XPath.

SafeHtmlProto

IMPORTANTE: No es seguro aceptar este mensaje de una fuente que no es de confianza, ya que es trivial para un atacante falsificar mensajes serializados que no cumplan con el contrato de seguridad del tipo; por ejemplo, podría contener un script controlado por el atacante. Un sistema que recibe un SafeHtmlProto confía implícitamente en el productor de SafeHtmlProto. Por lo tanto, generalmente es seguro devolver este mensaje en las respuestas RPC, pero generalmente no es seguro aceptarlo en las solicitudes RPC.

Representación JSON
{
  "privateDoNotAccessOrElseSafeHtmlWrappedValue": string
}
Campos
privateDoNotAccessOrElseSafeHtmlWrappedValue

string

IMPORTANTE: Nunca configure ni lea este campo, incluso desde pruebas, es privado. Consulte la documentación en la parte superior del archivo .proto para conocer los paquetes de lenguajes de programación con los que crear o leer este mensaje.

SugerenciaPrioridad

Enumeraciones
unknownPriority
error
warning
info

RegiónProto

Una región rectangular.

Representación JSON
{
  "topPx": integer,
  "leftPx": integer,
  "heightPx": integer,
  "widthPx": integer
}
Campos
topPx

integer

La parte superior del rectángulo, en píxeles. Siempre configurado.

leftPx

integer

El lado izquierdo del rectángulo, en píxeles. Siempre configurado.

heightPx

integer

La altura, en píxeles. Siempre configurado.

widthPx

integer

El ancho, en píxeles. Siempre configurado.