使用サービスイベントリファレンス

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

使用サービスイベントのバージョン2のプロパティに関する情報

Not for use with personal data

この記事には以下のリファレンス情報が含まれています:

  • 使用サービスに送信されるイベントデータ(イベントオブジェクトのバージョン2、EventV2)
  • その中に含まれるapplicationPropertiesオブジェクト
  • applicationProperties オブジェクト内に含まれる testResults オブジェクトは、AXE_INCLUDE_TEST_RESULTS が true に設定されているとき

バージョン2イベント

次のTypeScriptインターフェースは、バージョン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
  actor?: 'human' | 'automation'
  teams?: { id: string; name: string }[]
}
名前 説明
アクター 人(human)または自動化されたパイプライン(automation)がテストを実行したかどうか。CLI、Node.js API、およびRuby APIによって設定されます。アクターを参照してください。
application このイベントを作成したアプリケーション
applicationProperties 下で定義されるapplicationProperties
dateTime ISO-8601形式の日時(ミリ秒単位)、UTCタイムゾーン
department ユーザーの所属部門
devInstance この使用が開発者のインスタンスと見なされ、フィルタリングされる可能性があるかどうか
distinctId ユーザーの固有のUUID
event 通常は「analyze」または「uri: analyze」値としてのイベントタイプ
keycloakId ユーザーのKeycloak ID
loggedIn ユーザーがログインしているかどうか
organization ユーザーの所属組織
productComponent Playwrightなどの異なる統合を示すためにAPIによって設定される
productComponentVersion 製品コンポーネントのバージョンを示す文字列
productName 使用している統合を示すためにAPIによって設定される
sessionId セッションを識別するUUID(イベントをグループ化するため)
チーム テストを実行するチームを{ id, name }オブジェクトの配列として示します。CLI、Node.js API、およびRuby APIによって設定されます。チームを参照してください。
userId ユーザーのID
userJobRole ユーザーの職務
userStatus ユーザーのステータス
version イベントのバージョンを指定する文字列で、常に 'v2' です

distinctId

distinctId の値は、ユーザーごとに、メトリクスが記録されるたびに設定される UUID です。これは、CLI または API を使用するコードの初回実行時に設定されるため、時間が経っても安定しています。各ユーザーのホームディレクトリにある .deque/distinct_id ファイルに保存されます。

アクター

CLI、Node.js API、およびRuby APIは、次の環境変数のどれかがfalseまたは0以外の値に設定されているときに、actorをautomationに設定します:CI、BUILD_NUMBER、BUILDKITE、CIRCLECI、CODEBUILD_BUILD_ID、GITHUB_ACTIONS、GITLAB_CI、JENKINS_URL、TEAMCITY_VERSION、TF_BUILD、またはBITBUCKET_BUILD_NUMBER。それ以外の場合、actorはhumanです。検出を上書きするには、AXE_ACTOR環境変数にhumanまたはautomationを設定します。@axe-devtools/browserパッケージはブラウザで実行されるときに環境変数を読み取れないため、そこでhumanを報告します。

チーム

このteams配列は、メンバーがテストを実行したチームを記録します。CLI、Node.js API、およびRuby APIは常に配列を送信し、チームが設定されていない場合は空の配列([])として送信します。チームは、AXE_TEAMS環境変数、CLIの--set-teamsオプション、Node.js APIのsetTeamsメソッド、Ruby APIのfor_teams句またはteams構成プロパティを使用して自分で指定します。各チームは、文字列のidおよびnameプロパティを持つオブジェクトです。

[{ "id": "1", "name": "Web" }]

文字列のidおよびnameがないエントリは削除されます。読み取れないかJSON配列でない値は無視され、イベントは送信され続けます。

applicationProperties

このapplicationPropertiesオブジェクトには、テスト実行に関するカウント情報が含まれており、以下の例が示しています。

  applicationProperties: {
    advancedRules: { enabled: false, value: 'disabled', source: 'unavailable' },
    target: 'https://broken-workshop.dequelabs.com/',
    targetMedium: 'text/html',
    urlCount: 1,
    engineVersion: '4.14.0',
    failedRuleCount: 2,
    failedRuleNames: 'color-contrast,label',
    failedItemCount: 5,
    criticalIssueCount: 3,
    seriousIssueCount: 2,
    moderateIssueCount: 0,
    minorIssueCount: 0,
    needsReviewItemCount: 4,
    inapplicableRuleCount: 39,
    incompleteRuleCount: 2,
    passedRuleCount: 21,
    testResults: {}
  },
プロパティ 説明
アドバンストルール 高度な規則が実行されたかどうか。CLI、Node.js API、およびRuby APIは高度な規則を実行しないため、これは常に{ enabled: false, value: 'disabled', source: 'unavailable' }です。
コマンド スキャンを実行したCLIコマンド。例えばspecやbulk-spec。CLIのみが送信します。
重大な問題の数 重大な影響を持つ失敗した要素の数
engineVersion テストに使用される axe-core のバージョン
failedItemCount ウェブページ上で見つかったアクセシビリティエラーの総数
failedRuleCount ページで失敗したルールの数
failedRuleNames 失敗したルールの名前をカンマで区切った文字列
inapplicableRuleCount 適用されなかったルールの数
小さな問題の数 小さな影響を持つ失敗した要素の数
中程度の問題の数 中程度の影響を持つ失敗した要素の数
レビューが必要な項目の数 レビューが必要な要素の数
incompleteRuleCount 不完全だったルールの数
passedRuleCount 合格したルールの数
重大な問題の数 重大な影響を持つ失敗した要素の数
target テストされたURL
ターゲットメディア ターゲットのMIMEタイプ。バージョン4.14.0以前ではtarget_mediumと呼ばれていました。
testResults testResultsオブジェクトは、このセクションの次を参照してください。
URLの数 分析された個別のURLの数。操作がナビゲートして再分析するCLI仕様ページは1以上を報告します。

testResults

testResults オブジェクトは、axe-core によって定義された axeResults オブジェクトとして定義されます。これは、AXE_INCLUDE_TEST_RESULTS 環境変数を true に設定したときにのみ設定され、CLI および Node.js API でのみサポートされています。

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

以下は、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: []
}

簡潔にするために、通常Resultオブジェクトを含むinapplicable、passes、incomplete、violations配列は含まれていません。

これらのオブジェクトの TypeScript 定義は、axe-core GitHub リポジトリで確認できます。

関連情報

使用サービスの使い方を示すチュートリアルについては、利用サービスと API の始め方 と 利用サービスと CLI の始め方 をご覧ください。

使用サービスに関する一般情報については、Web使用サービス用Axe DevTools をご覧ください。