BrowserType
BrowserType は、特定のブラウザインスタンスを起動したり、既存のブラウザインスタンスに接続したりするためのメソッドを提供します。以下は、Playwright を使用して自動化を駆動する典型的な例です。
import com.microsoft.playwright.*;
public class Example {
public static void main(String[] args) {
try (Playwright playwright = Playwright.create()) {
BrowserType chromium = playwright.chromium();
Browser browser = chromium.launch();
Page page = browser.newPage();
page.navigate("https://example.com");
// other actions...
browser.close();
}
}
}
メソッド
connect
v1.9より前に追加このメソッドは、Node.js で BrowserType.launchServer
を介して作成された既存のブラウザインスタンスに Playwright をアタッチします。
接続する Playwright インスタンスのメジャーバージョンとマイナーバージョンは、ブラウザを起動する Playwright のバージョンと一致する必要があります (1.2.3 → 1.2.x と互換性があります)。
使用方法
BrowserType.connect(wsEndpoint);
BrowserType.connect(wsEndpoint, options);
引数
-
接続先の Playwright ブラウザの WebSocket エンドポイント。このエンドポイントは、
BrowserServer.wsEndpoint
を介して取得します。 -
options
BrowserType.ConnectOptions
(任意)-
setExposeNetwork
String (任意)v1.37で追加#このオプションは、接続元のクライアントで利用可能なネットワークを、接続先のブラウザに公開します。カンマ区切りのルールのリストで構成されます。
利用可能なルール
- ホスト名パターン。例:
example.com
、*.org:99
、x.*.y.com
、*foo.org
。 - IP リテラル。例:
127.0.0.1
、0.0.0.0:99
、[::1]
、[0:0::1]:99
。 - ローカルループバックインターフェースに一致する
<loopback>
:localhost
、*.localhost
、127.0.0.1
、[::1]
。
一般的な例
- すべてのネットワークを公開するには
"*"
。 - localhost ネットワークを公開するには
"<loopback>"
。 - テスト/ステージング環境と localhost を公開するには
"*.test.internal-domain,*.staging.internal-domain,<loopback>"
。
- ホスト名パターン。例:
-
setHeaders
Map<String, String> (任意)v1.11で追加#WebSocket 接続リクエストと共に送信される追加の HTTP ヘッダー。任意。
-
setSlowMo
double (任意)v1.10で追加#指定されたミリ秒数だけ Playwright の操作を遅くします。何が起こっているかを確認するのに役立ちます。デフォルトは 0 です。
-
setTimeout
double (任意)v1.10で追加#接続が確立されるまで待機する最大時間(ミリ秒単位)。デフォルトは
0
(タイムアウトなし) です。
-
戻り値
connectOverCDP
v1.9で追加このメソッドは、Chrome DevTools Protocol を使用して既存のブラウザインスタンスに Playwright をアタッチします。
デフォルトのブラウザコンテキストには、Browser.contexts() を介してアクセスできます。
Chrome DevTools Protocol 経由の接続は、Chromium ベースのブラウザでのみサポートされています。
この接続は、BrowserType.connect() による Playwright プロトコル接続よりも忠実度が大幅に低くなります。問題が発生している場合、または高度な機能を使用しようとしている場合は、BrowserType.connect() を使用することをお勧めします。
使用方法
Browser browser = playwright.chromium().connectOverCDP("http://localhost:9222");
BrowserContext defaultContext = browser.contexts().get(0);
Page page = defaultContext.pages().get(0);
引数
-
接続先の CDP WebSocket エンドポイントまたは HTTP URL。例:
http://localhost:9222/
またはws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4
。 -
options
BrowserType.ConnectOverCDPOptions
(任意)
戻り値
executablePath
v1.9より前に追加Playwright がバンドルされたブラウザ実行ファイルを見つけると予想するパス。
使用方法
BrowserType.executablePath();
戻り値
launch
v1.9より前に追加ブラウザインスタンスを返します。
使用方法
setIgnoreDefaultArgs を使用して、デフォルト引数から --mute-audio
を除外できます。
// Or "firefox" or "webkit".
Browser browser = chromium.launch(new BrowserType.LaunchOptions()
.setIgnoreDefaultArgs(Arrays.asList("--mute-audio")));
Chromium のみ Playwright は Google Chrome または Microsoft Edge ブラウザを制御するためにも使用できますが、バンドルされている Chromium のバージョンで最適に動作します。他のバージョンで動作する保証はありません。setExecutablePath オプションは、細心の注意を払って使用してください。
(Chromium ではなく)Google Chrome が推奨される場合は、Chrome Canary または Dev Channel ビルドが推奨されます。
Google Chrome や Microsoft Edge などのストックブラウザは、ビデオ再生に独自のメディアコーデックが必要なテストに適しています。Chromium と Chrome のその他の違いについては、この記事 を参照してください。Linux ユーザー向けの違いについては、この記事 で説明されています。
引数
options
BrowserType.LaunchOptions
(任意)-
警告
カスタムブラウザ引数を使用する場合は、Playwright の機能が損なわれる可能性があるため、ご自身の責任で使用してください。
ブラウザインスタンスに渡す追加の引数。Chromium フラグのリストは こちら にあります。
-
ブラウザの配布チャネル。
新しいヘッドレスモードをオプトインするには、"chromium" を使用してください(Chromium の新しいヘッドレスモード)。
ブランド版の Google Chrome および Microsoft Edge を使用するには、"chrome"、"chrome-beta"、"chrome-dev"、"chrome-canary"、"msedge"、"msedge-beta"、"msedge-dev"、または "msedge-canary" を使用してください。
-
setChromiumSandbox
boolean (任意)#Chromium サンドボックスを有効にします。デフォルトは
false
です。 -
非推奨
代わりにデバッグツールを使用してください。
Chromium のみ 各タブに対して開発者ツールパネルを自動的に開くかどうか。このオプションが
true
の場合、setHeadless オプションはfalse
に設定されます。 -
指定した場合、ダウンロードが許可されると、このディレクトリにダウンロードされます。指定しない場合、一時ディレクトリが作成され、ブラウザが閉じられると削除されます。いずれの場合も、ダウンロードは、作成されたブラウザコンテキストが閉じられると削除されます。
-
setEnv
Map<String, String> (任意)#ブラウザに表示される環境変数を指定します。デフォルトは
process.env
です。 -
バンドルされているブラウザの代わりに実行するブラウザ実行ファイルへのパス。setExecutablePath が相対パスの場合、現在の作業ディレクトリからの相対パスとして解決されます。Playwright はバンドルされている Chromium、Firefox、WebKit でのみ動作することに注意してください。ご自身の責任で使用してください。
-
setFirefoxUserPrefs
Map<String, Object> (任意)#Firefox ユーザー設定。Firefox ユーザー設定の詳細については、
about:config
を参照してください。 -
SIGHUP でブラウザプロセスを閉じます。デフォルトは
true
です。 -
Ctrl+C でブラウザプロセスを閉じます。デフォルトは
true
です。 -
setHandleSIGTERM
boolean (任意)#SIGTERM でブラウザプロセスを閉じます。デフォルトは
true
です。 -
ブラウザをヘッドレスモードで実行するかどうか。Chromium および Firefox の詳細を参照してください。デフォルトは、setDevtools オプションが
true
でない限り、true
です。 -
setIgnoreAllDefaultArgs
boolean (任意)v1.9で追加#true
の場合、Playwright は独自の設定引数を渡さず、setArgs の引数のみを使用します。危険なオプションです。注意して使用してください。デフォルトはfalse
です。 -
setIgnoreDefaultArgs
List<String> (任意)#true
の場合、Playwright は独自の設定引数を渡さず、setArgs の引数のみを使用します。危険なオプションです。注意して使用してください。 -
setProxy
Proxy (任意)#-
setServer
Stringすべてのリクエストに使用されるプロキシ。HTTP および SOCKS プロキシがサポートされています。例:
http://myproxy.com:3128
またはsocks5://myproxy.com:3128
。短縮形のmyproxy.com:3128
は HTTP プロキシと見なされます。 -
setBypass
String (任意)プロキシをバイパスするオプションのカンマ区切りドメイン。例:
".com, chromium.org, .domain.com"
。 -
setUsername
String (任意)HTTP プロキシが認証を必要とする場合に使用するオプションのユーザー名。
-
setPassword
String (任意)HTTP プロキシが認証を必要とする場合に使用するオプションのパスワード。
ネットワークプロキシ設定。
-
-
指定されたミリ秒数だけ Playwright の操作を遅くします。何が起こっているかを確認するのに役立ちます。
-
ブラウザインスタンスの起動を待機する最大時間(ミリ秒単位)。デフォルトは
30000
(30秒) です。タイムアウトを無効にするには0
を渡します。 -
指定した場合、トレースはこのディレクトリに保存されます。
-
戻り値
launchPersistentContext
v1.9より前に追加永続的なブラウザコンテキストインスタンスを返します。
userDataDir にある永続ストレージを使用するブラウザを起動し、唯一のコンテキストを返します。このコンテキストを閉じると、ブラウザも自動的に閉じられます。
使用方法
BrowserType.launchPersistentContext(userDataDir);
BrowserType.launchPersistentContext(userDataDir, options);
引数
-
Cookie やローカルストレージなどのブラウザセッションデータを保存するユーザーデータディレクトリへのパス。Chromium および Firefox の詳細を参照してください。Chromium のユーザーデータディレクトリは、
chrome://version
に表示される「プロファイルパス」の親ディレクトリであることに注意してください。一時ディレクトリを使用するには、空の文字列を渡します。 -
options
BrowserType.LaunchPersistentContextOptions
(任意)-
setAcceptDownloads
boolean (任意)#すべてのアタッチメントを自動的にダウンロードするかどうか。デフォルトは、すべてのダウンロードが許可される
true
です。 -
警告
カスタムブラウザ引数を使用する場合は、Playwright の機能が損なわれる可能性があるため、ご自身の責任で使用してください。
ブラウザインスタンスに渡す追加の引数。Chromium フラグのリストは こちら にあります。
-
Page.navigate()、Page.route()、Page.waitForURL()、Page.waitForRequest()、または Page.waitForResponse() を使用する場合、対応する URL を構築するために
URL()
コンストラクターを使用することにより、ベース URL が考慮されます。デフォルトでは設定されていません。例- baseURL:
http://localhost:3000
で/bar.html
に移動すると、http://localhost:3000/bar.html
になります - baseURL:
http://localhost:3000/foo/
で./bar.html
に移動すると、http://localhost:3000/foo/bar.html
になります - baseURL:
http://localhost:3000/foo
(末尾のスラッシュなし) で./bar.html
に移動すると、http://localhost:3000/bar.html
になります
- baseURL:
-
ページの Content-Security-Policy のバイパスを切り替えます。デフォルトは
false
です。 -
ブラウザの配布チャネル。
新しいヘッドレスモードをオプトインするには、"chromium" を使用してください(Chromium の新しいヘッドレスモード)。
ブランド版の Google Chrome および Microsoft Edge を使用するには、"chrome"、"chrome-beta"、"chrome-dev"、"chrome-canary"、"msedge"、"msedge-beta"、"msedge-dev"、または "msedge-canary" を使用してください。
-
setChromiumSandbox
boolean (任意)#Chromium サンドボックスを有効にします。デフォルトは
false
です。 -
setClientCertificates
List<ClientCertificates> (任意)v1.46で追加#-
setOrigin
String証明書が有効な正確なオリジン。オリジンには、
https
プロトコル、ホスト名、およびオプションでポートが含まれます。 -
setCertPath
Path (任意)PEM 形式の証明書を含むファイルへのパス。
-
setCert
byte[] (任意)PEM 形式の証明書の直接値。
-
setKeyPath
Path (任意)PEM 形式の秘密鍵を含むファイルへのパス。
-
setKey
byte[] (任意)PEM 形式の秘密鍵の直接値。
-
setPfxPath
Path (任意)PFX または PKCS12 エンコードされた秘密鍵と証明書チェーンへのパス。
-
setPfx
byte[] (任意)PFX または PKCS12 エンコードされた秘密鍵と証明書チェーンの直接値。
-
setPassphrase
String (任意)秘密鍵 (PEM または PFX) のパスフレーズ。
TLS クライアント認証により、サーバーはクライアント証明書を要求して検証できます。
詳細
使用するクライアント証明書の配列。各証明書オブジェクトは、
certPath
とkeyPath
の両方、単一のpfxPath
、または対応する直接値の同等物 (cert
とkey
、またはpfx
) のいずれかを持つ必要があります。オプションで、証明書が暗号化されている場合は、passphrase
プロパティを指定する必要があります。origin
プロパティは、証明書が有効なリクエストオリジンに正確に一致するように指定する必要があります。注記macOS で WebKit を使用する場合、
localhost
にアクセスしてもクライアント証明書は選択されません。localhost
をlocal.playwright
に置き換えることで動作させることができます。 -
-
setColorScheme
null |enum ColorScheme { LIGHT, DARK, NO_PREFERENCE }
(任意)#prefers-colors-scheme メディア機能をエミュレートします。サポートされている値は
'light'
と'dark'
です。詳細については、Page.emulateMedia() を参照してください。null
を渡すと、エミュレーションがシステムデフォルトにリセットされます。デフォルトは'light'
です。 -
setContrast
null |enum Contrast { NO_PREFERENCE, MORE }
(任意)#'prefers-contrast'
メディア機能をエミュレートします。サポートされている値は'no-preference'
、'more'
です。詳細については、Page.emulateMedia() を参照してください。null
を渡すと、エミュレーションがシステムデフォルトにリセットされます。デフォルトは'no-preference'
です。 -
setDeviceScaleFactor
double (任意)#デバイススケールファクター(dpr と考えることができます)を指定します。デフォルトは
1
です。デバイススケールファクターを使用したデバイスのエミュレートの詳細を参照してください。 -
非推奨
代わりにデバッグツールを使用してください。
Chromium のみ 各タブに対して開発者ツールパネルを自動的に開くかどうか。このオプションが
true
の場合、setHeadless オプションはfalse
に設定されます。 -
指定した場合、ダウンロードが許可されると、このディレクトリにダウンロードされます。指定しない場合、一時ディレクトリが作成され、ブラウザが閉じられると削除されます。いずれの場合も、ダウンロードは、作成されたブラウザコンテキストが閉じられると削除されます。
-
setEnv
Map<String, String> (任意)#ブラウザに表示される環境変数を指定します。デフォルトは
process.env
です。 -
バンドルされているブラウザの代わりに実行するブラウザ実行ファイルへのパス。setExecutablePath が相対パスの場合、現在の作業ディレクトリからの相対パスとして解決されます。Playwright はバンドルされている Chromium、Firefox、WebKit でのみ動作することに注意してください。ご自身の責任で使用してください。
-
setExtraHTTPHeaders
Map<String, String> (任意)#すべてのリクエストと共に送信される追加の HTTP ヘッダーを含むオブジェクト。デフォルトはなし。
-
setFirefoxUserPrefs
Map<String, Object> (任意)v1.40で追加#Firefox ユーザー設定。Firefox ユーザー設定の詳細については、
about:config
を参照してください。 -
setForcedColors
null |enum ForcedColors { ACTIVE, NONE }
(任意)#'forced-colors'
メディア機能をエミュレートします。サポートされている値は'active'
、'none'
です。詳細については、Page.emulateMedia() を参照してください。null
を渡すと、エミュレーションがシステムデフォルトにリセットされます。デフォルトは'none'
です。 -
setGeolocation
Geolocation (任意)# -
SIGHUP でブラウザプロセスを閉じます。デフォルトは
true
です。 -
Ctrl+C でブラウザプロセスを閉じます。デフォルトは
true
です。 -
setHandleSIGTERM
boolean (任意)#SIGTERM でブラウザプロセスを閉じます。デフォルトは
true
です。 -
ビューポートがタッチイベントをサポートするかどうかを指定します。デフォルトは false です。モバイルエミュレーションの詳細をご覧ください。
-
ブラウザをヘッドレスモードで実行するかどうか。Chromium および Firefox の詳細を参照してください。デフォルトは、setDevtools オプションが
true
でない限り、true
です。 -
setHttpCredentials
HttpCredentials (任意)#-
setUsername
String -
setPassword
String -
setOrigin
String (任意)特定のオリジン (scheme://host:port).
-
setSend
enum HttpCredentialsSend { UNAUTHORIZED, ALWAYS }
(任意)このオプションは、対応する APIRequestContext から送信されたリクエストにのみ適用され、ブラウザから送信されたリクエストには影響しません。
'always'
- ベーシック認証クレデンシャルを含むAuthorization
ヘッダーが、API リクエストごとに送信されます。'unauthorized'
- クレデンシャルは、WWW-Authenticate
ヘッダーを含む 401 (Unauthorized) レスポンスを受信した場合にのみ送信されます。デフォルトは'unauthorized'
です。
HTTP 認証のクレデンシャル。オリジンが指定されていない場合、ユーザー名とパスワードは、認証が必要なレスポンスを返すすべてのサーバーに送信されます。
-
-
setIgnoreAllDefaultArgs
boolean (任意)v1.9で追加#true
の場合、Playwright は独自の設定引数を渡さず、setArgs からの引数のみを使用します。危険なオプションです。注意して使用してください。デフォルトはfalse
です。 -
setIgnoreDefaultArgs
List<String> (任意)#true
の場合、Playwright は独自の設定引数を渡さず、setArgs からの引数のみを使用します。危険なオプションです。注意して使用してください。 -
setIgnoreHTTPSErrors
boolean (任意)#ネットワークリクエスト送信時に HTTPS エラーを無視するかどうか。デフォルトは
false
です。 -
meta viewport
タグを考慮し、タッチイベントを有効にするかどうか。isMobile はデバイスの一部であるため、手動で設定する必要はありません。デフォルトはfalse
で、Firefox ではサポートされていません。モバイルエミュレーションの詳細をご覧ください。 -
setJavaScriptEnabled
boolean (任意)#コンテキストで JavaScript を有効にするかどうか。デフォルトは
true
です。JavaScript の無効化の詳細をご覧ください。 -
ユーザーロケールを指定します。例:
en-GB
、de-DE
など。ロケールは、navigator.language
の値、Accept-Language
リクエストヘッダーの値、および数値と日付の書式設定ルールに影響します。デフォルトはシステムデフォルトロケールです。エミュレーションの詳細については、エミュレーションガイドをご覧ください。 -
ネットワークをオフラインにするかどうかをエミュレートします。デフォルトは
false
です。ネットワークエミュレーションの詳細をご覧ください。 -
setPermissions
List<String> (任意)#このコンテキスト内のすべてのページに付与する権限のリスト。BrowserContext.grantPermissions() の詳細をご覧ください。デフォルトはなし。
-
setProxy
Proxy (任意)#-
setServer
Stringすべてのリクエストに使用されるプロキシ。HTTP および SOCKS プロキシがサポートされています。例:
http://myproxy.com:3128
またはsocks5://myproxy.com:3128
。短縮形のmyproxy.com:3128
は HTTP プロキシと見なされます。 -
setBypass
String (任意)プロキシをバイパスするオプションのカンマ区切りドメイン。例:
".com, chromium.org, .domain.com"
。 -
setUsername
String (任意)HTTP プロキシが認証を必要とする場合に使用するオプションのユーザー名。
-
setPassword
String (任意)HTTP プロキシが認証を必要とする場合に使用するオプションのパスワード。
ネットワークプロキシ設定。
-
-
setRecordHarContent
enum HarContentPolicy { OMIT, EMBED, ATTACH }
(任意)#リソースコンテンツ管理を制御するためのオプション設定。
omit
が指定された場合、コンテンツは永続化されません。attach
が指定された場合、リソースは個別のファイルとして永続化され、これらのファイルはすべて HAR ファイルとともにアーカイブされます。デフォルトはembed
で、HAR 仕様に従ってコンテンツを HAR ファイルにインラインで保存します。 -
setRecordHarMode
enum HarMode { FULL, MINIMAL }
(任意)#minimal
に設定すると、HAR からのルーティングに必要な情報のみを記録します。これにより、HAR からの再生時に使用されないサイズ、タイミング、ページ、Cookie、セキュリティ、その他のタイプの HAR 情報が省略されます。デフォルトはfull
です。 -
setRecordHarOmitContent
boolean (任意)#HAR からリクエストコンテンツを省略するかどうかを制御するためのオプション設定。デフォルトは
false
です。 -
ファイルシステムの指定された HAR ファイルにすべてのページの HAR 記録を有効にします。指定しない場合、HAR は記録されません。HAR を保存するには、必ず BrowserContext.close() を呼び出してください。
-
指定されたディレクトリにすべてのページのビデオ記録を有効にします。指定しない場合、ビデオは記録されません。ビデオを保存するには、必ず BrowserContext.close() を呼び出してください。
-
setRecordVideoSize
RecordVideoSize (任意)#記録されたビデオの寸法。指定しない場合、サイズは 800x800 に収まるように縮小された
viewport
と同じになります。viewport
が明示的に設定されていない場合、ビデオサイズはデフォルトで 800x450 になります。各ページの実際の画像は、指定されたサイズに収まるように必要に応じて縮小されます。 -
setReducedMotion
null |enum ReducedMotion { REDUCE, NO_PREFERENCE }
(任意)#'prefers-reduced-motion'
メディア機能をエミュレートします。サポートされている値は'reduce'
、'no-preference'
です。詳細については、Page.emulateMedia() を参照してください。null
を渡すと、エミュレーションがシステムデフォルトにリセットされます。デフォルトは'no-preference'
です。 -
setScreenSize
ScreenSize (任意)#window.screen
を介して Web ページ内で利用可能な一貫したウィンドウ画面サイズをエミュレートします。setViewportSize が設定されている場合にのみ使用されます。 -
setServiceWorkers
enum ServiceWorkerPolicy { ALLOW, BLOCK }
(任意)#サイトが Service Worker を登録できるようにするかどうか。デフォルトは
'allow'
です。'allow'
: Service Worker を登録できます。'block'
: Playwright は Service Worker のすべての登録をブロックします。
-
指定されたミリ秒数だけ Playwright の操作を遅くします。何が起こっているかを確認するのに役立ちます。
-
setStrictSelectors
boolean (任意)#true に設定すると、このコンテキストで厳密なセレクターモードが有効になります。厳密なセレクターモードでは、単一のターゲット DOM 要素を意味するセレクターに対するすべての操作は、複数の要素がセレクターに一致する場合に例外をスローします。このオプションは、Locator API には影響しません(Locator は常に厳密です)。デフォルトは
false
です。厳密モードの詳細については、Locator を参照してください。 -
ブラウザインスタンスの起動を待機する最大時間(ミリ秒単位)。デフォルトは
30000
(30秒) です。タイムアウトを無効にするには0
を渡します。 -
コンテキストのタイムゾーンを変更します。サポートされているタイムゾーン ID のリストについては、ICU's metaZones.txt を参照してください。デフォルトはシステムタイムゾーンです。
-
指定した場合、トレースはこのディレクトリに保存されます。
-
このコンテキストで使用する特定のユーザーエージェント。
-
setViewportSize
null | ViewportSize (任意)#各ページの一貫したビューポートをエミュレートします。デフォルトは 1280x720 ビューポートです。一貫したビューポートエミュレーションを無効にするには、
null
を使用します。ビューポートエミュレーションの詳細をご覧ください。注記null
値は、デフォルトのプリセットからオプトアウトし、ビューポートをオペレーティングシステムによって定義されたホストウィンドウサイズに依存させます。これにより、テストの実行が非決定的になります。
-
戻り値
name
v1.9より前に追加ブラウザ名を返します。例:'chromium'
、'webkit'
、'firefox'
。
使用方法
BrowserType.name();
戻り値