Method: projects.histories.executions.steps.accessibilityClusters

Répertorie les clusters d'accessibilité pour une étape donnée

Peut renvoyer l’un des codes d’erreur canoniques suivants :

  • PERMISSION_DENIED - si l'utilisateur n'est pas autorisé à lire le projet
  • INVALID_ARGUMENT - si la requête est mal formée
  • FAILED_PRECONDITION - si un argument dans la requête s'avère invalide ; par exemple, si le format des paramètres régionaux est incorrect
  • NOT_FOUND - si l'étape contenant n'existe pas

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC .

Paramètres du chemin

Paramètres
name

string

Un nom de ressource complet de l’étape. Par exemple, projets/mon-projet/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

Requis.

Paramètres de requête

Paramètres
locale

string

Le format accepté est le format canonique Unicode avec un trait d'union comme délimiteur. La langue doit être en minuscules, le script de langue en majuscule et la région en majuscules. Voir http://www.unicode.org/reports/tr35/#Unicode_locale_identifier pour plus de détails.

Requis.

Corps de la demande

Le corps de la requête doit être vide.

Corps de réponse

Message de réponse pour AccessibilityService.ListStepAccessibilityClusters.

En cas de succès, le corps de la réponse contient des données avec la structure suivante :

Représentation JSON
{
  "name": string,
  "clusters": [
    {
      object (SuggestionClusterProto)
    }
  ]
}
Des champs
name

string

Un nom de ressource complet de l’étape. Par exemple, projets/mon-projet/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef

Présente toujours.

clusters[]

object ( SuggestionClusterProto )

Une séquence de suggestions d’accessibilité, regroupées en groupes. Dans la séquence, les clusters appartenant à la même SuggestionCategory doivent être adjacents. Au sein de chaque catégorie, les clusters doivent être classés selon leur SuggestionPriority (les ERREURS en premier). Les catégories doivent être classées par cluster de priorité la plus élevée.

Portées des autorisations

Nécessite le champ d'application OAuth suivant :

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

Pour plus d'informations, consultez la Présentation de l'authentification .

SuggestionClusterProto

Un ensemble de suggestions similaires que nous soupçonnons d’être étroitement liées.

Ce proto et la plupart des protos imbriqués sont issus de foxandcrown.prelaunchreport.service.SuggestionClusterProto, remplaçant les dépendances de PLR ​​par celles de FTL.

Représentation JSON
{
  "category": enum (SuggestionCategory),
  "suggestions": [
    {
      object (SuggestionProto)
    }
  ]
}
Des champs
category

enum ( SuggestionCategory )

Catégorie dans laquelle ces types de suggestions doivent apparaître. Toujours réglé.

suggestions[]

object ( SuggestionProto )

Une séquence de suggestions. Toutes les suggestions au sein d'un cluster doivent avoir la même SuggestionPriority et appartenir à la même SuggestionCategory. Les suggestions avec la même URL de capture d'écran doivent être adjacentes.

Catégorie de suggestion

Énumérations
unknownCategory
contentLabeling
touchTargetSize
lowContrast
implementation

SuggestionProto

Représentation 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.
}
Des champs
title

string

Titre général de la suggestion, dans la langue de l'utilisateur, sans balisage. Toujours réglé.

shortMessage

object ( SafeHtmlProto )

Message concis, dans la langue de l'utilisateur, représentant la suggestion, pouvant contenir du balisage. Toujours réglé.

longMessage

object ( SafeHtmlProto )

Message, dans la langue de l'utilisateur, expliquant la suggestion, qui peut contenir du balisage. Toujours réglé.

priority

enum ( SuggestionPriority )

Importance relative d'une suggestion. Toujours réglé.

helpUrl

string

Référence à un article du centre d'aide concernant ce type de suggestion. Toujours réglé.

region

object ( RegionProto )

Région dans la capture d'écran qui est pertinente pour cette suggestion. Facultatif.

secondaryPriority

number

Importance relative d'une suggestion par rapport à d'autres suggestions ayant la même priorité et la même catégorie. Il s'agit d'une valeur dénuée de sens qui peut être utilisée pour classer les suggestions appartenant à la même catégorie et ayant la même priorité. Les valeurs les plus élevées ont une priorité plus élevée (c'est-à-dire qu'elles sont plus importantes). Facultatif.

screenId

string

ID de l'écran de la suggestion. Il est utilisé pour obtenir le chemin de capture d'écran correspondant. Par exemple, screenId "1" correspond au fichier "1.png" dans GCS. Toujours réglé.

Champ d'union resource_id .

resource_id ne peut être qu'un des éléments suivants :

resourceName

string

Référence à un élément de vue, identifié par son nom de ressource, s'il en possède un.

pseudoResourceId

string

Un identifiant quelque peu lisible par l'homme de la vue source, s'il n'a pas de nom de ressource. Il s'agit d'un chemin dans la hiérarchie d'accessibilité, un élément avec un nom de ressource ; similaire à un XPath.

SafeHtmlProto

IMPORTANT : Il n'est pas prudent d'accepter ce message provenant d'une source non fiable, car il est trivial pour un attaquant de falsifier des messages sérialisés qui ne respectent pas le contrat de sécurité du type ; par exemple, ils pourraient contenir un script contrôlé par l'attaquant. Un système qui reçoit un SafeHtmlProto fait implicitement confiance au producteur du SafeHtmlProto. Ainsi, il est généralement sûr de renvoyer ce message dans les réponses RPC, mais généralement dangereux de l'accepter dans les requêtes RPC.

Représentation JSON
{
  "privateDoNotAccessOrElseSafeHtmlWrappedValue": string
}
Des champs
privateDoNotAccessOrElseSafeHtmlWrappedValue

string

IMPORTANT : Ne définissez ni ne lisez jamais ce champ, même à partir de tests, il est privé. Consultez la documentation en haut du fichier .proto pour connaître les packages de langage de programmation avec lesquels créer ou lire ce message.

SuggestionPriorité

Énumérations
unknownPriority
error
warning
info

RégionProto

Une région rectangulaire.

Représentation JSON
{
  "topPx": integer,
  "leftPx": integer,
  "heightPx": integer,
  "widthPx": integer
}
Des champs
topPx

integer

Le haut du rectangle, en pixels. Toujours réglé.

leftPx

integer

Le côté gauche du rectangle, en pixels. Toujours réglé.

heightPx

integer

La hauteur, en pixels. Toujours réglé.

widthPx

integer

La largeur, en pixels. Toujours réglé.