使用サービスイベントリファレンス
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オブジェクト
- AXE_INCLUDE_TEST_RESULTSがtrueに設定されている場合、applicationPropertiesオブジェクト内に含まれるtestResultsオブジェクト
バージョン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
}| 名前 | 説明 |
|---|---|
| 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（イベントをグループ化するため） |
| userId | ユーザーのID |
| userJobRole | ユーザーの職務 |
| userStatus | ユーザーのステータス |
| version | イベントのバージョンを指定する文字列で、常に 'v2' です |
distinctId
distinctId の値は、ユーザーごとに、メトリクスが記録されるたびに設定される UUID です。これは、CLI または API を使用するコードの初回実行時に設定されるため、時間が経っても安定しています。各ユーザーのホームディレクトリにある .deque/distinct_id ファイルに保存されます。
applicationProperties
このapplicationPropertiesオブジェクトには、テスト実行に関するカウント情報が含まれており、以下の例が示しています。
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: {}
},| プロパティ | 説明 |
|---|---|
| engineVersion | テストに使用される axe-core のバージョン |
| failedItemCount | ウェブページ上で見つかったアクセシビリティエラーの総数 |
| failedRuleCount | ページで失敗したルールの数 |
| failedRuleNames | 失敗したルールの名前をカンマで区切った文字列 |
| inapplicableRuleCount | 適用されなかったルールの数 |
| incompleteRuleCount | 不完全だったルールの数 |
| passedRuleCount | 合格したルールの数 |
| target_medium | ターゲットのMIMEタイプ |
| target | テストされたURL |
| testResults | testResultsオブジェクトは、このセクションの次を参照してください。 |
testResults
testResultsオブジェクトは、axe-core によって定義されたaxeResultsオブジェクトとして定義されます。AXE_INCLUDE_TEST_RESULTS 環境変数をtrueに設定した場合のみ設定されます。
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: []
}簡潔にするために、通常結果オブジェクトを含むinapplicable、passes、incomplete、violations配列は含まれていません。
これらのオブジェクトの TypeScript 定義は、axe-core GitHub リポジトリで確認できます。
関連情報
使用サービスの使い方を示すチュートリアルについては、利用サービスと API の始め方 と 利用サービスと CLI の始め方 をご覧ください。
使用サービスに関する一般情報については、Web使用サービス用Axe DevTools をご覧ください。