Method: projects.histories.executions.steps.accessibilityClusters

Elenca i cluster di accessibilità per un determinato passaggio

Può restituire uno dei seguenti codici di errore canonici:

  • PERMISSION_DENIED - se l'utente non è autorizzato a leggere il progetto
  • INVALID_ARGUMENT - se la richiesta non è valida
  • FAILED_PRECONDITION - se un argomento nella richiesta sembra non essere valido; ad esempio se il formato locale non è corretto
  • NOT_FOUND - se il passo che lo contiene non esiste

Richiesta HTTP

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

L'URL usa la sintassi di transcodifica gRPC .

Parametri del percorso

Parametri
name

string

Un nome completo della risorsa del passaggio. Ad esempio, progetti/mio-progetto/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

Necessario.

Parametri di query

Parametri
locale

string

Il formato accettato è il formato canonico Unicode con il trattino come delimitatore. La lingua deve essere minuscola, Linguaggio - Maiuscolo, Regione - MAIUSCOLO. Vedi http://www.unicode.org/reports/tr35/#Unicode_locale_identifier per i dettagli.

Necessario.

Richiedi corpo

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Messaggio di risposta per AccessibilityService.ListStepAccessibilityClusters.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "name": string,
  "clusters": [
    {
      object (SuggestionClusterProto)
    }
  ]
}
Campi
name

string

Un nome completo della risorsa del passaggio. Ad esempio, progetti/mio-progetto/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

Presenta sempre.

clusters[]

object ( SuggestionClusterProto )

Una sequenza di suggerimenti per l'accessibilità, raggruppati in cluster. All'interno della sequenza, i cluster che appartengono alla stessa SuggestionCategory devono essere adiacenti. All'interno di ciascuna categoria, i cluster devono essere ordinati in base alla loro SuggestionPriority (prima gli ERROR). Le categorie devono essere ordinate in base al cluster con la priorità più alta.

Ambiti autorizzativi

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, vedere la panoramica sull'autenticazione .

SuggerimentoClusterProto

Una serie di suggerimenti simili che sospettiamo siano strettamente correlati.

Questo prototipo e la maggior parte dei prototipi nidificati sono ramificati da foxandcrown.prelaunchreport.service.SuggestionClusterProto, sostituendo le dipendenze di PLR con quelle FTL.

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

enum ( SuggestionCategory )

Categoria in cui dovrebbero apparire questi tipi di suggerimenti. Sempre impostato.

suggestions[]

object ( SuggestionProto )

Una sequenza di suggestioni. Tutti i suggerimenti all'interno di un cluster devono avere la stessa SuggestionPriority e appartenere alla stessa SuggestionCategory. I suggerimenti con lo stesso URL dello screenshot devono essere adiacenti.

Categoria suggerimento

Enumerazioni
unknownCategory
contentLabeling
touchTargetSize
lowContrast
implementation

SuggerimentoProto

Rappresentazione 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.
}
Campi
title

string

Titolo generale del suggerimento, nella lingua dell'utente, senza markup. Sempre impostato.

shortMessage

object ( SafeHtmlProto )

Messaggio conciso, nella lingua dell'utente, che rappresenta il suggerimento, che può contenere markup. Sempre impostato.

longMessage

object ( SafeHtmlProto )

Messaggio, nella lingua dell'utente, che spiega il suggerimento, che può contenere markup. Sempre impostato.

priority

enum ( SuggestionPriority )

Importanza relativa di un suggerimento. Sempre impostato.

helpUrl

string

Riferimento a un articolo del Centro assistenza relativo a questo tipo di suggerimento. Sempre impostato.

region

object ( RegionProto )

Area all'interno dello screenshot pertinente a questo suggerimento. Opzionale.

secondaryPriority

number

Importanza relativa di un suggerimento rispetto ad altri suggerimenti che hanno la stessa priorità e categoria. Si tratta di un valore privo di significato che può essere utilizzato per ordinare suggerimenti che si trovano nella stessa categoria e hanno la stessa priorità. I valori più grandi hanno una priorità più alta (cioè sono più importanti). Opzionale.

screenId

string

ID della schermata per il suggerimento. Viene utilizzato per ottenere il percorso dello screenshot corrispondente. Ad esempio, screenId "1" corrisponde al file "1.png" in GCS. Sempre impostato.

Campo dell'unione resource_id .

resource_id può essere solo uno dei seguenti:

resourceName

string

Riferimento a un elemento della vista, identificato dal nome della risorsa, se ne ha uno.

pseudoResourceId

string

Un identificatore in qualche modo leggibile dall'uomo della vista di origine, se non ha un nomerisorsa. Questo è un percorso all'interno della gerarchia dell'accessibilità, un elemento con il nome della risorsa; simile a un XPath.

SafeHtmlProto

IMPORTANTE: non è sicuro accettare questo messaggio da una fonte non attendibile, poiché è banale per un utente malintenzionato creare messaggi serializzati che non soddisfano il contratto di sicurezza del tipo, ad esempio potrebbe contenere script controllati dall'utente malintenzionato. Un sistema che riceve un SafeHtmlProto si fida implicitamente del produttore di SafeHtmlProto. Pertanto, in genere è sicuro restituire questo messaggio nelle risposte RPC, ma generalmente non è sicuro accettarlo nelle richieste RPC.

Rappresentazione JSON
{
  "privateDoNotAccessOrElseSafeHtmlWrappedValue": string
}
Campi
privateDoNotAccessOrElseSafeHtmlWrappedValue

string

IMPORTANTE: non impostare o leggere mai questo campo, nemmeno dai test, è privato. Consulta la documentazione nella parte superiore del file .proto per i pacchetti di linguaggi di programmazione con cui creare o leggere questo messaggio.

SuggerimentoPriorità

Enumerazioni
unknownPriority
error
warning
info

RegioneProto

Una regione rettangolare.

Rappresentazione JSON
{
  "topPx": integer,
  "leftPx": integer,
  "heightPx": integer,
  "widthPx": integer
}
Campi
topPx

integer

La parte superiore del rettangolo, in pixel. Sempre impostato.

leftPx

integer

Il lato sinistro del rettangolo, in pixel. Sempre impostato.

heightPx

integer

L'altezza, in pixel. Sempre impostato.

widthPx

integer

La larghezza, in pixel. Sempre impostato.