スキャンを実行する

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

Not for use with personal data

準備、設定、スキャン開始

Appiumサーバーが稼働し、テスト設定が完了したら、モバイルアプリのスキャンを開始する準備が整いました。

アクセシビリティスキャンはテストの任意のタイミングで起動できます。アクセシビリティスキャンを開始する準備が整ったら、 Execute Script APIを呼び出し、 axeScan と settings オブジェクトを渡します。

driver.execute('mobile: axeScan', settings)

パラメータ	タイプ	説明
設定	`Object`	axe DevTools Mobileの認証と設定を含みます。（必要なキーについては、設定内の認証キーを参照してください）。

ドライバーでセッションを初期化していない場合、スキャンを認証するために次のいずれかを settings オブジェクトに提供する必要があります。

キー	タイプ	説明
apiKey	`String`	Dequeによって認証されたユーザーにアクセスを提供するために必要です。axe DevTools Mobile APIキーは axeアカウントポータルでアクセスできます。
licenseKey	`String`	Dequeによって認証されたユーザーにオフラインスキャンのアクセスを提供するために必要です。Dequeの担当者に問い合わせるか、サポートに連絡してライセンスキーの受け取りを調整してください。

テスト設定をカスタマイズしたい場合は、任意のキーを settings オブジェクトに追加できます。これらの属性の詳細については、設定をカスタマイズするを参照してください。

キー	タイプ	説明
scanName	`String`	ダッシュボード内のスキャンを識別しやすくするためのカスタマイズされたスキャン名を指定します。
tags	`[String]`	スキャンに適用する文字列配列を提供します。重要なスキャンを見つけてグループ化するのに役立つタグを使用することをお勧めします。タグ付けされたスキャンは他のチームメンバーにも利用可能です。
ignoreRules	`[String]`	すべてのビューで無視するルールのリストを適用するための文字列配列を提供します。配列の各文字列は有効な `ruleId` - 例えば、 ColorContrastです。詳細は `ruleId`オブジェクト内の `axeConf` スキャンのJSON結果をご確認ください。
ignoreExperimental	`Boolean`	このパラメータをtrueに設定すると、試験的なルールが無視されます。デフォルト値はfalseです。
uploadToDashboard	`Boolean`	このパラメータをfalseに設定すると、スキャンはアップロードされません。デフォルト値はtrueです。

tip

アクセシビリティスキャンを開始するための中央の場所として、テストスクリプトにユーティリティ関数を追加することを検討してください。