Référence de l'événement du service d'utilisation

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

Informations sur les propriétés de la version 2 de l'événement du service d'utilisation

Not for use with personal data

Cet article contient des informations de référence sur

  • Les données d'événement qui sont envoyées au service d'utilisation (version 2 de l'objet événement, EventV2)
  • Son objet applicationProperties contenu
  • L’objet testResults (contenu dans l’objet applicationProperties) lorsque AXE_INCLUDE_TEST_RESULTS est défini sur true

Événement de version 2

L'interface TypeScript suivante définit un événement de version 2 :

interface EventV2 {
  version: 'v2'
  productName: string
  productComponent: string
  productComponentVersion: string
  event: string
  dateTime: Date
  keycloakId?: string
  distinctId: string
  userId?: string
  organization?: string
  department?: string
  application?: string
  devInstance?: boolean
  sessionId?: string
  userStatus?: string
  loggedIn?: boolean
  applicationProperties?: Record<string, any>
  userJobRole?: string
}
Nom Description
application L'application qui a créé cet événement
propriétésDeL'application propriétésDeL'application défini ci-dessous
dateTime Date et heure (au milliseconde) au format ISO-8601, fuseau horaire UTC
department Le département de l'utilisateur au sein de l'organisation
devInstance Si cette utilisation est considérée comme une instance de développeur et doit probablement être filtrée
distinctId Le uuid distinct de l'utilisateur
event Type d'événement sous forme de chaîne, généralement "analyze" ou "uri: analyze"
keycloakId Le ID Keycloak de l'utilisateur
loggedIn Si l'utilisateur est connecté
organization L'organisation de l'utilisateur
productComponent Défini par les API pour indiquer différentes intégrations telles que Playwright
productComponentVersion Une chaîne indiquant la version du composant produit
productName Défini par les API pour indiquer l'intégration que vous utilisez
sessionId Un uuid identifiant la session (pour permettre de regrouper les événements)
userId L'ID de l'utilisateur
userJobRole Le rôle de l'utilisateur
userStatus Le statut de l'utilisateur
version Une chaîne spécifiant la version de l'événement, toujours 'v2'

distinctId

La valeur distinctId est un uuid qui est défini par utilisateur chaque fois que les métriques sont enregistrées. Elle doit être stable dans le temps car elle est définie lors de la première exécution de l'interface CLI ou du code qui utilise les API. Elle est stockée dans le fichier .deque/distinct_id dans le répertoire personnel de chaque utilisateur.

propriétésDeL'application

L'objet applicationProperties contient des informations sur le nombre de tests effectués, comme le montre l'exemple ci-dessous :

  applicationProperties: {
    target: 'https://broken-workshop.dequelabs.com/',
    target_medium: 'text/html',
    engineVersion: '4.5.2',
    failedRuleCount: 2,
    failedRuleNames: 'color-contrast,label',
    failedItemCount: 5,
    inapplicableRuleCount: 39,
    incompleteRuleCount: 2,
    passedRuleCount: 21,
    testResults: {}
  },
Propriété Description
versionDuMoteur La version de axe-core utilisée pour les tests
nombreD'articlesÉchoués Nombre total d'erreurs d'accessibilité trouvées sur la page web
nombreDeRèglesÉchouées Nombre de règles qui ont échoué sur la page
nomsDesRèglesÉchouées Chaîne séparée par des virgules des noms des règles qui ont échoué
nombreDeRèglesInapplicables Nombre de règles qui n'ont pas été appliquées
nombreDeRèglesIncomplètes Nombre de règles incomplètes
nombreDeRèglesRéussies Nombre de règles réussies
cible_mime Type Mime de la cible
cible URL testée
résultatsDesTests L'objet testResults, voir la section suivante pour plus d'informations

résultatsDesTests

L'objet testResults est défini comme un objet axeResults (défini par axe-core). Il n'est défini que lorsque vous avez défini la variable d'environnement AXE_INCLUDE_TEST_RESULTS sur true, ce qui est pris en charge uniquement par la CLI et les API Node.js.

interface AxeResults extends EnvironmentData {
  toolOptions: RunOptions;
  passes: Result[];
  violations: Result[];
  incomplete: Result[];
  inapplicable: Result[];
}

L'exemple suivant montre un objet testResults :

{
  testEngine: {
    name: "axe-core",
    version: "4.4.1"
  },
  testRunner: {
    name: "axe"
  },
  testEnvironment: {
    userAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML,like Gecko) Version/16.0 Safari/605.1.15",
    windowWidth: 1280,
    windowHeight: 720
  },
  timestamp: "2023-02-02T20:09:04.785Z",
  url: "https://broken-workshop.dequelabs.com/",
  toolOptions: {
    reporter: "v1"
  },
  inapplicable: [],
  passes: [],
  incomplete: [],
  violations: []
}

Pour plus de concision, les tableaux inapplicable, passes, incomplete et violations, qui contiennent normalement des objets Result, n'ont pas été inclus.

Vous pouvez voir les définitions TypeScript pour ces objets dans le dépôt GitHub axe-core.

Voir aussi

Pour des tutoriels démontrant comment utiliser le service d'utilisation, voir Premiers pas avec le service d'utilisation et les API et Premiers pas avec le service d'utilisation et l'interface CLI.

Pour des informations générales sur le service d'utilisation, voir Le service d'utilisation Axe DevTools pour le web.

Is this page helpful?

Help us improve this page

Still need help?