Axe DevTools for Web 使用サービス
Axe DevTools for Web APIとCLIの利用を追跡するRESTサービスである使用サービスの概要
この記事では、使用サービスの概要を提供します。このサービスでは、Axe DevTools APIおよびCLIの使用状況を、使用イベントをDequeの公開サーバーまたは独自のサーバーに送信することで追跡できます。使用状況データをDequeに送信することで、ユーザーが製品とどのようにやり取りしているかを理解し、製品を改善し続けるための手助けとなります。
利用イベントを利用サービスに送信することは、AxeレポートにJSONアクセシビリティ結果を送信することとは別のプロセスです。報告についての詳細は、CLIを使った報告をご覧ください。
使用サービスは次の2つの部分で構成されています：
- 使用サービスに使用イベントを投稿するクライアント（通常はAxe DevTools APIまたはCLIが呼び出すメトリックスライブラリ経由）
- 使用イベントを含むPOSTリクエストに応答する、通常はDequeがホストするRESTサービス
使用イベントには、アクセシビリティスキャンの日時、違反したアクセシビリティルールの数、違反したルール名、その他の情報が含まれています。独自の使用サービスを設定した場合、この情報を使用して、Axe DevTools for Webが組織内でどのように使用されているかを把握することができます。使用イベントの構造に関するリファレンス情報については、使用サービスイベントリファレンスを参照してください。
デフォルトでは、Axe DevToolsは使用情報を記録しません。利用メトリクスの収集を許可するには、使用を有効にする必要があります。有効にしても、個人情報を考慮した設計のため、使用サービスはユーザーのプライベートまたは個人情報を一切収集しません。
クイックスタート
以下の手順に従って、使用の追跡を開始できます：
- 使用状況の追跡を有効にするには、環境変数AXE_TRACK_USAGEをtrueに設定します。これで、CLIやAxe DevTools for Web APIを使用する独自のコードを実行するたびに、使用イベントがDequeのREST使用サービスに投稿されます。
- （オプション）AXE_METRICS_URL環境変数を変更して、使用イベントが報告されるサーバーのURLを変更します（デフォルトURLは
https://usage.deque.comです）。この環境変数を変更する場合は、Dequeが提供する公開使用サービスを模倣する独自の使用サービスを作成する必要があります。エコーサーバーの設定を参照してください。 - （オプション）AXE_INCLUDE_TEST_RESULTSをtrueに設定して、使用サービスに送信されるデータにテスト結果を含めます。この環境変数を設定すると、applicationPropertiesオブジェクト内のtestResultsオブジェクトが埋められます。詳細については使用サービスイベントリファレンスを参照してください。
- （オプション）開発者およびテスターのマシンで環境変数AXE_DEV_INSTANCEをtrueに設定して、開発者およびテスターのアクセシビリティスキャンをフィルタリングします。（通常、開発またはテスト中に発生したAPIの使用を無視したいことがあります。）
- （オプション）その他の環境変数を設定して、使用サービスに報告されるイベントをカスタマイズします。環境変数を介した使用サービスの制御を参照してください。
- アクセシビリティスキャンコードまたはCLIページスキャンを実行して、使用サービスに使用を送信します。DequeのすべてのAPIは、設定どおりに使用サービスにイベントを作成および投稿するためにメトリクスライブラリを使用します。
Axe DevTools APIを使用して使用サービスを利用する方法の詳細なチュートリアルについては、使用サービスとAPIを使い始めるを参照してください。同じチュートリアルで使用サービスを使用してCLIを利用する方法については、使用サービスとCLIを使い始めるを参照してください。これらのチュートリアルには、コンソールに使用サービスイベントをエコーするためのシンプルなサーバーを設定する手順が含まれています。メトリックスライブラリが使用サービスに送信する内容を確認することができます。この設定を使用して使用サービスのトラブルシューティングを行うことができます。
環境変数
環境変数を使用して、使用サービスの動作を制御し、報告するイベントをカスタマイズすることができます。環境変数は2つのカテゴリに分かれています：
- 使用サービスの制御: 使用追跡を有効または無効にし、報告のURLを設定し、イベントデータにテスト結果を含め、ユーザーの個別IDを設定します。
- イベントカスタマイズ: サービスに送信される使用イベントのプロパティを修正します。たとえば、ユーザーの組織、部門、役職、およびその他の識別情報です。
利用可能なすべての環境変数の完全なリファレンスについては、環境変数を介した使用サービスの制御を参照してください。
関連情報
使用イベントに含まれるプロパティについての詳細な情報は、使用サービスイベントリファレンスを参照してください。
使用サービスを制御してイベントをカスタマイズする利用可能な環境変数のリファレンスについては、環境変数を介した使用サービスの制御を参照してください。