メインコンテンツへスキップ

Browser

ブラウザはBrowserType.launch()を介して作成されます。Browserを使用してPageを作成する例

import com.microsoft.playwright.*;

public class Example {
 public static void main(String[] args) {
   try (Playwright playwright = Playwright.create()) {
     BrowserType firefox = playwright.firefox();
     Browser browser = firefox.launch();
     Page page = browser.newPage();
     page.navigate("https://example.com");
     browser.close();
   }
 }
}

メソッド​

browserType​

追加バージョン: v1.23 browser.browserType

ブラウザが属するブラウザの種類 (chromium、firefox、webkit) を取得します。

使用法

Browser.browserType();

戻り値

close​

v1.9より前に追加 browser.close

このブラウザがBrowserType.launch()を使用して取得された場合、ブラウザとそのすべてのページ（開かれている場合）を閉じます。

このブラウザに接続されている場合、このブラウザに属する作成されたすべてのコンテキストをクリアし、ブラウザサーバーから切断します。

注

これはブラウザを強制終了するのと似ています。ページを正常に閉じ、ページクローズイベントを受け取るには、Browser.close()を呼び出す**前に**、Browser.newContext()を使用して以前に明示的に作成したBrowserContextインスタンスでBrowserContext.close()を呼び出します。

Browserオブジェクト自体は破棄されたと見なされ、これ以上使用することはできません。

使用法

Browser.close();
Browser.close(options);

引数

  • options Browser.CloseOptions (オプション)

    • setReason String (オプション)追加バージョン: v1.40#

      ブラウザのクローズによって中断された操作に報告される理由。

戻り値

contexts​

v1.9より前に追加 browser.contexts

開いているすべてのブラウザコンテキストの配列を返します。新しく作成されたブラウザでは、これはゼロのブラウザコンテキストを返します。

使用法

Browser browser = pw.webkit().launch();
System.out.println(browser.contexts().size()); // prints "0"
BrowserContext context = browser.newContext();
System.out.println(browser.contexts().size()); // prints "1"

戻り値

isConnected​

v1.9より前に追加 browser.isConnected

ブラウザが接続されていることを示します。

使用法

Browser.isConnected();

戻り値

newBrowserCDPSession​

追加バージョン: v1.11 browser.newBrowserCDPSession
注

CDPセッションはChromiumベースのブラウザでのみサポートされています。

新しく作成されたブラウザセッションを返します。

使用法

Browser.newBrowserCDPSession();

戻り値

newContext​

v1.9より前に追加 browser.newContext

新しいブラウザコンテキストを作成します。他のブラウザコンテキストとクッキー/キャッシュを共有しません。

注

このメソッドを直接使用してBrowserContextを作成する場合、コードがBrowserContextの使用を終え、Browser.close()を呼び出す前に、返されたコンテキストをBrowserContext.close()を介して明示的に閉じるのがベストプラクティスです。これにより、`context`が正常に閉じられ、HARやビデオなどの成果物が完全にフラッシュされて保存されます。

使用法

Browser browser = playwright.firefox().launch();  // Or 'chromium' or 'webkit'.
// Create a new incognito browser context.
BrowserContext context = browser.newContext();
// Create a new page in a pristine context.
Page page = context.newPage();
page.navigate("https://example.com");

// Graceful close up everything
context.close();
browser.close();

引数

  • options Browser.NewContextOptions (オプション)

    • setAcceptDownloads boolean (オプション)#

      すべての添付ファイルを自動的にダウンロードするかどうか。デフォルトは`true`で、すべてのダウンロードが許可されます。

    • setBaseURL String (オプション)#

      Page.navigate()、Page.route()、Page.waitForURL()、Page.waitForRequest()、またはPage.waitForResponse()を使用する場合、対応するURLを構築するためにURL()コンストラクタを使用してベースURLを考慮します。デフォルトでは設定されていません。例

      • baseURL: `https://:3000`で`/bar.html`へ移動すると`https://:3000/bar.html`になります
      • baseURL: `https://:3000/foo/`で`./bar.html`へ移動すると`https://:3000/foo/bar.html`になります
      • baseURL: `https://:3000/foo`（末尾スラッシュなし）で`./bar.html`へ移動すると`https://:3000/bar.html`になります

    • setBypassCSP boolean (オプション)#

      ページのContent-Security-Policyをバイパスするかどうかを切り替えます。デフォルトは`false`です。

    • setClientCertificates List<ClientCertificates> (オプション)追加バージョン: 1.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`です。デバイスピクセル比を使用したデバイスのエミュレーションについて詳しくはこちら。

    • setExtraHTTPHeaders Map<String, String> (オプション)#

      すべてのリクエストとともに送信される追加のHTTPヘッダーを含むオブジェクト。デフォルトはなしです。

    • setForcedColors null | enum ForcedColors { ACTIVE, NONE } (オプション)#

      `'forced-colors'`メディア機能をエミュレートし、サポートされる値は`'active'`、`'none'`です。詳細についてはPage.emulateMedia()を参照してください。`null`を渡すと、エミュレーションがシステムデフォルトにリセットされます。デフォルトは`'none'`です。

    • setGeolocation Geolocation (オプション)#

      • setLatitude double

        -90から90までの緯度。

      • setLongitude double

        -180から180までの経度。

      • setAccuracy double (オプション)

        非負の精度値。デフォルトは`0`です。

    • setHasTouch boolean (オプション)#

      ビューポートがタッチイベントをサポートするかどうかを指定します。デフォルトは`false`です。モバイルエミュレーションについて詳しくはこちら。

    • 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認証の資格情報。オリジンが指定されていない場合、ユーザー名とパスワードは不正な応答があった場合にすべてのサーバーに送信されます。

    • setIgnoreHTTPSErrors boolean (オプション)#

      ネットワークリクエストの送信時にHTTPSエラーを無視するかどうか。デフォルトは`false`です。

    • setIsMobile boolean (オプション)#

      `meta viewport`タグが考慮され、タッチイベントが有効になるかどうか。isMobileはデバイスの一部であるため、手動で設定する必要はありません。デフォルトは`false`で、Firefoxではサポートされていません。モバイルエミュレーションについて詳しくはこちら。

    • setJavaScriptEnabled boolean (オプション)#

      コンテキストでJavaScriptを有効にするかどうか。デフォルトは`true`です。JavaScriptの無効化について詳しくはこちら。

    • setLocale String (オプション)#

      ユーザーロケールを指定します（例: `en-GB`、`de-DE`など）。ロケールは`navigator.language`の値、`Accept-Language`リクエストヘッダーの値、および数値と日付のフォーマット規則に影響を与えます。デフォルトはシステムデフォルトのロケールです。エミュレーションガイドでエミュレーションについて詳しくはこちら。

    • setOffline boolean (オプション)#

      ネットワークがオフラインであることをエミュレートするかどうか。デフォルトは`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からリプレイする際に使用されないサイズ、タイミング、ページ、クッキー、セキュリティ、およびその他の種類のHAR情報は省略されます。デフォルトは`full`です。

    • setRecordHarOmitContent boolean (オプション)#

      HARからリクエストコンテンツを省略するかどうかを制御するオプションの設定。デフォルトは`false`です。

    • setRecordHarPath Path (オプション)#

      指定されたファイルシステム上のHARファイルに、すべてのページのHAR記録を有効にします。指定されていない場合、HARは記録されません。HARを保存するには、BrowserContext.close()を呼び出すようにしてください。

    • setRecordHarUrlFilter String | Pattern (オプション)#

    • setRecordVideoDir Path (オプション)#

      指定されたディレクトリにすべてのページのビデオ録画を有効にします。指定されていない場合、ビデオは記録されません。ビデオを保存するには、BrowserContext.close()を呼び出すようにしてください。

    • setRecordVideoSize RecordVideoSize (オプション)#

      • setWidth int

        ビデオフレームの幅。

      • setHeight int

        ビデオフレームの高さ。

      記録されたビデオの寸法。指定されていない場合、サイズは800x800に収まるようにスケーリングされた`viewport`と同じになります。`viewport`が明示的に設定されていない場合、ビデオサイズはデフォルトで800x450になります。各ページの実際の画像は、指定されたサイズに収まるように必要に応じて縮小されます。

    • setReducedMotion null | enum ReducedMotion { REDUCE, NO_PREFERENCE } (オプション)#

      `'prefers-reduced-motion'`メディア機能をエミュレートし、サポートされる値は`'reduce'`、`'no-preference'`です。詳細についてはPage.emulateMedia()を参照してください。`null`を渡すと、エミュレーションがシステムデフォルトにリセットされます。デフォルトは`'no-preference'`です。

    • setScreenSize ScreenSize (オプション)#

      • setWidth int

        ページの幅（ピクセル単位）。

      • setHeight int

        ページの高さ（ピクセル単位）。

      `window.screen`を介してウェブページ内で利用可能な一貫したウィンドウ画面サイズをエミュレートします。setViewportSizeが設定されている場合にのみ使用されます。

    • setServiceWorkers enum ServiceWorkerPolicy { ALLOW, BLOCK } (オプション)#

      サイトがサービスワーカーを登録することを許可するかどうか。デフォルトは`'allow'`です。

      • `'allow'`:Service Workersを登録できます。
      • `'block'`Playwrightはサービスワーカーのすべての登録をブロックします。

    • setStorageState String (オプション)#

      指定されたストレージ状態をコンテキストに設定します。このオプションは、BrowserContext.storageState()を介して取得したログイン情報でコンテキストを初期化するために使用できます。

    • setStorageStatePath Path (オプション)追加バージョン: v1.9#

      指定されたストレージ状態をコンテキストに設定します。このオプションは、BrowserContext.storageState()を介して取得したログイン情報でコンテキストを初期化するために使用できます。保存されたストレージ状態を含むファイルへのパス。

    • setStrictSelectors boolean (オプション)#

      `true`に設定すると、このコンテキストで厳密セレクターモードが有効になります。厳密セレクターモードでは、単一のターゲットDOM要素を意味するセレクターに対するすべての操作は、複数の要素がセレクターに一致する場合に例外をスローします。このオプションはLocator APIには影響しません（Locatorは常に厳密です）。デフォルトは`false`です。厳密モードの詳細については、Locatorを参照してください。

    • setTimezoneId String (オプション)#

      コンテキストのタイムゾーンを変更します。サポートされているタイムゾーンIDのリストについては、ICUのmetaZones.txtを参照してください。デフォルトはシステムのタイムゾーンです。

    • setUserAgent String (オプション)#

      このコンテキストで使用する特定のユーザーエージェント。

    • setViewportSize null | ViewportSize (オプション)#

      • setWidth int

        ページの幅（ピクセル単位）。

      • setHeight int

        ページの高さ（ピクセル単位）。

      各ページで一貫したビューポートをエミュレートします。デフォルトは1280x720のビューポートです。`null`を使用すると、一貫したビューポートエミュレーションが無効になります。ビューポートエミュレーションについて詳しくはこちら。

      注

      `null`値はデフォルトのプリセットを無効にし、ビューポートをオペレーティングシステムで定義されたホストウィンドウサイズに依存させます。これにより、テストの実行が非決定論的になります。

戻り値

newPage​

v1.9より前に追加 browser.newPage

新しいブラウザコンテキストで新しいページを作成します。このページを閉じると、コンテキストも閉じられます。

これは単一ページのシナリオや短いスニペットにのみ使用すべき便利なAPIです。プロダクションコードやテストフレームワークでは、正確なライフタイムを制御するために、明示的にBrowser.newContext()を作成し、その後にBrowserContext.newPage()を呼び出す必要があります。

使用法

Browser.newPage();
Browser.newPage(options);

引数

  • options Browser.NewPageOptions (オプション)

    • setAcceptDownloads boolean (オプション)#

      すべての添付ファイルを自動的にダウンロードするかどうか。デフォルトは`true`で、すべてのダウンロードが許可されます。

    • setBaseURL String (オプション)#

      Page.navigate()、Page.route()、Page.waitForURL()、Page.waitForRequest()、またはPage.waitForResponse()を使用する場合、対応するURLを構築するためにURL()コンストラクタを使用してベースURLを考慮します。デフォルトでは設定されていません。例

      • baseURL: `https://:3000`で`/bar.html`へ移動すると`https://:3000/bar.html`になります
      • baseURL: `https://:3000/foo/`で`./bar.html`へ移動すると`https://:3000/foo/bar.html`になります
      • baseURL: `https://:3000/foo`（末尾スラッシュなし）で`./bar.html`へ移動すると`https://:3000/bar.html`になります

    • setBypassCSP boolean (オプション)#

      ページのContent-Security-Policyをバイパスするかどうかを切り替えます。デフォルトは`false`です。

    • setClientCertificates List<ClientCertificates> (オプション)追加バージョン: 1.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`です。デバイスピクセル比を使用したデバイスのエミュレーションについて詳しくはこちら。

    • setExtraHTTPHeaders Map<String, String> (オプション)#

      すべてのリクエストとともに送信される追加のHTTPヘッダーを含むオブジェクト。デフォルトはなしです。

    • setForcedColors null | enum ForcedColors { ACTIVE, NONE } (オプション)#

      `'forced-colors'`メディア機能をエミュレートし、サポートされる値は`'active'`、`'none'`です。詳細についてはPage.emulateMedia()を参照してください。`null`を渡すと、エミュレーションがシステムデフォルトにリセットされます。デフォルトは`'none'`です。

    • setGeolocation Geolocation (オプション)#

      • setLatitude double

        -90から90までの緯度。

      • setLongitude double

        -180から180までの経度。

      • setAccuracy double (オプション)

        非負の精度値。デフォルトは`0`です。

    • setHasTouch boolean (オプション)#

      ビューポートがタッチイベントをサポートするかどうかを指定します。デフォルトは`false`です。モバイルエミュレーションについて詳しくはこちら。

    • 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認証の資格情報。オリジンが指定されていない場合、ユーザー名とパスワードは不正な応答があった場合にすべてのサーバーに送信されます。

    • setIgnoreHTTPSErrors boolean (オプション)#

      ネットワークリクエストの送信時にHTTPSエラーを無視するかどうか。デフォルトは`false`です。

    • setIsMobile boolean (オプション)#

      `meta viewport`タグが考慮され、タッチイベントが有効になるかどうか。isMobileはデバイスの一部であるため、手動で設定する必要はありません。デフォルトは`false`で、Firefoxではサポートされていません。モバイルエミュレーションについて詳しくはこちら。

    • setJavaScriptEnabled boolean (オプション)#

      コンテキストでJavaScriptを有効にするかどうか。デフォルトは`true`です。JavaScriptの無効化について詳しくはこちら。

    • setLocale String (オプション)#

      ユーザーロケールを指定します（例: `en-GB`、`de-DE`など）。ロケールは`navigator.language`の値、`Accept-Language`リクエストヘッダーの値、および数値と日付のフォーマット規則に影響を与えます。デフォルトはシステムデフォルトのロケールです。エミュレーションガイドでエミュレーションについて詳しくはこちら。

    • setOffline boolean (オプション)#

      ネットワークがオフラインであることをエミュレートするかどうか。デフォルトは`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からリプレイする際に使用されないサイズ、タイミング、ページ、クッキー、セキュリティ、およびその他の種類のHAR情報は省略されます。デフォルトは`full`です。

    • setRecordHarOmitContent boolean (オプション)#

      HARからリクエストコンテンツを省略するかどうかを制御するオプションの設定。デフォルトは`false`です。

    • setRecordHarPath Path (オプション)#

      指定されたファイルシステム上のHARファイルに、すべてのページのHAR記録を有効にします。指定されていない場合、HARは記録されません。HARを保存するには、BrowserContext.close()を呼び出すようにしてください。

    • setRecordHarUrlFilter String | Pattern (オプション)#

    • setRecordVideoDir Path (オプション)#

      指定されたディレクトリにすべてのページのビデオ録画を有効にします。指定されていない場合、ビデオは記録されません。ビデオを保存するには、BrowserContext.close()を呼び出すようにしてください。

    • setRecordVideoSize RecordVideoSize (オプション)#

      • setWidth int

        ビデオフレームの幅。

      • setHeight int

        ビデオフレームの高さ。

      記録されたビデオの寸法。指定されていない場合、サイズは800x800に収まるようにスケーリングされた`viewport`と同じになります。`viewport`が明示的に設定されていない場合、ビデオサイズはデフォルトで800x450になります。各ページの実際の画像は、指定されたサイズに収まるように必要に応じて縮小されます。

    • setReducedMotion null | enum ReducedMotion { REDUCE, NO_PREFERENCE } (オプション)#

      `'prefers-reduced-motion'`メディア機能をエミュレートし、サポートされる値は`'reduce'`、`'no-preference'`です。詳細についてはPage.emulateMedia()を参照してください。`null`を渡すと、エミュレーションがシステムデフォルトにリセットされます。デフォルトは`'no-preference'`です。

    • setScreenSize ScreenSize (オプション)#

      • setWidth int

        ページの幅（ピクセル単位）。

      • setHeight int

        ページの高さ（ピクセル単位）。

      `window.screen`を介してウェブページ内で利用可能な一貫したウィンドウ画面サイズをエミュレートします。setViewportSizeが設定されている場合にのみ使用されます。

    • setServiceWorkers enum ServiceWorkerPolicy { ALLOW, BLOCK } (オプション)#

      サイトがサービスワーカーを登録することを許可するかどうか。デフォルトは`'allow'`です。

      • `'allow'`:Service Workersを登録できます。
      • `'block'`Playwrightはサービスワーカーのすべての登録をブロックします。

    • setStorageState String (オプション)#

      指定されたストレージ状態をコンテキストに設定します。このオプションは、BrowserContext.storageState()を介して取得したログイン情報でコンテキストを初期化するために使用できます。

    • setStorageStatePath Path (オプション)追加バージョン: v1.9#

      指定されたストレージ状態をコンテキストに設定します。このオプションは、BrowserContext.storageState()を介して取得したログイン情報でコンテキストを初期化するために使用できます。保存されたストレージ状態を含むファイルへのパス。

    • setStrictSelectors boolean (オプション)#

      `true`に設定すると、このコンテキストで厳密セレクターモードが有効になります。厳密セレクターモードでは、単一のターゲットDOM要素を意味するセレクターに対するすべての操作は、複数の要素がセレクターに一致する場合に例外をスローします。このオプションはLocator APIには影響しません（Locatorは常に厳密です）。デフォルトは`false`です。厳密モードの詳細については、Locatorを参照してください。

    • setTimezoneId String (オプション)#

      コンテキストのタイムゾーンを変更します。サポートされているタイムゾーンIDのリストについては、ICUのmetaZones.txtを参照してください。デフォルトはシステムのタイムゾーンです。

    • setUserAgent String (オプション)#

      このコンテキストで使用する特定のユーザーエージェント。

    • setViewportSize null | ViewportSize (オプション)#

      • setWidth int

        ページの幅（ピクセル単位）。

      • setHeight int

        ページの高さ（ピクセル単位）。

      各ページで一貫したビューポートをエミュレートします。デフォルトは1280x720のビューポートです。`null`を使用すると、一貫したビューポートエミュレーションが無効になります。ビューポートエミュレーションについて詳しくはこちら。

      注

      `null`値はデフォルトのプリセットを無効にし、ビューポートをオペレーティングシステムで定義されたホストウィンドウサイズに依存させます。これにより、テストの実行が非決定論的になります。

戻り値

startTracing​

追加バージョン: v1.11 browser.startTracing
注

このAPIは、低レベルのChromium固有のデバッグツールであるChromium Tracingを制御します。Playwright Tracingを制御するAPIはこちらで見つけることができます。

Browser.startTracing()とBrowser.stopTracing()を使用して、Chrome DevToolsのパフォーマンスパネルで開くことができるトレースファイルを作成できます。

使用法

browser.startTracing(page, new Browser.StartTracingOptions()
  .setPath(Paths.get("trace.json")));
page.navigate("https://www.google.com");
browser.stopTracing();

引数

  • page Page (オプション)#

    オプション。指定された場合、トレースには指定されたページのスクリーンショットが含まれます。

  • options Browser.StartTracingOptions (オプション)

    • setCategories List<String> (オプション)#

      デフォルトの代わりにカスタムカテゴリを指定します。

    • setPath Path (オプション)#

      トレースファイルの書き込み先パス。

    • setScreenshots boolean (オプション)#

      トレース内でスクリーンショットをキャプチャします。

戻り値

stopTracing​

追加バージョン: v1.11 browser.stopTracing
注

このAPIは、低レベルのChromium固有のデバッグツールであるChromium Tracingを制御します。Playwright Tracingを制御するAPIはこちらで見つけることができます。

トレースデータを含むバッファを返します。

使用法

Browser.stopTracing();

戻り値

version​

v1.9より前に追加 browser.version

ブラウザのバージョンを返します。

使用法

Browser.version();

戻り値

イベント​

onDisconnected(handler)​

v1.9より前に追加 browser.onDisconnected(handler)

ブラウザがブラウザアプリケーションから切断されたときに発行されます。これは以下のいずれかの理由で発生する可能性があります

  • ブラウザアプリケーションが閉じられたか、クラッシュしました。
  • Browser.close()メソッドが呼び出されました。

使用法

Browser.onDisconnected(handler)

イベントデータ