Skip to main content

Browser

BrowserType.launch() を使用して Browser は作成されます。Page を作成するために Browser を使用する例

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();
}
}
}

Methods

browserType

Added in: v1.23 browser.browserType

ブラウザーが属するブラウザータイプ (chromium、firefox、または webkit) を取得します。

Usage

Browser.browserType();

Returns


close

Added before v1.9 browser.close

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

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

note

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

Browser オブジェクト自体は破棄されたとみなされ、もう使用できません。

Usage

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

Arguments

  • options Browser.CloseOptions (optional)
    • setReason String (optional)Added in: v1.40#

      ブラウザの終了によって中断された操作に報告される理由。

Returns


contexts

Added before v1.9 browser.contexts

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

Usage

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"

Returns


isConnected

Added before v1.9 browser.isConnected

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

Usage

Browser.isConnected();

Returns


newBrowserCDPSession

Added in: v1.11 browser.newBrowserCDPSession
note

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

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

Usage

Browser.newBrowserCDPSession();

Returns


newContext

Added before v1.9 browser.newContext

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

note

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

Usage

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();

Arguments

  • options Browser.NewContextOptions (optional)
    • setAcceptDownloads boolean (optional)#

      すべてのアタッチメントを自動的にダウンロードするかどうか。デフォルトは true で、すべてのダウンロードが承認されます。

    • setBaseURL String (optional)#

      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 になります。
    • setBypassCSP boolean (optional)#

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

    • setClientCertificates List<ClientCertificates> (optional)Added in: 1.46#

      • setOrigin String

        証明書が有効な正確なオリジン。オリジンには、https プロトコル、ホスト名、およびオプションでポートが含まれます。

      • setCertPath Path (optional)

        PEM 形式の証明書を含むファイルへのパス。

      • setCert byte[] (optional)

        PEM 形式の証明書の直接の値。

      • setKeyPath Path (optional)

        PEM 形式の秘密鍵を含むファイルへのパス。

      • setKey byte[] (optional)

        PEM 形式の秘密鍵の直接の値。

      • setPfxPath Path (optional)

        PFX または PKCS12 エンコードされた秘密鍵と証明書チェーンへのパス。

      • setPfx byte[] (optional)

        PFX または PKCS12 エンコードされた秘密鍵と証明書チェーンの直接の値。

      • setPassphrase String (optional)

        秘密鍵 (PEM または PFX) のパスフレーズ。

      TLSクライアント認証により、サーバーはクライアント証明書を要求して検証できます。

      Details

      使用するクライアント証明書の配列。各証明書オブジェクトは、certPathkeyPath の両方、単一の pfxPath、または対応する直接値の同等物 (certkey、または pfx) のいずれかを持つ必要があります。オプションで、証明書が暗号化されている場合は passphrase プロパティを指定する必要があります。origin プロパティは、証明書が有効なリクエストオリジンと正確に一致するように指定する必要があります。

      note

      macOS で WebKit を使用する場合、localhost にアクセスしてもクライアント証明書は選択されません。localhostlocal.playwright に置き換えることで動作させることができます。

    • setColorScheme null | enum ColorScheme { LIGHT, DARK, NO_PREFERENCE } (optional)#

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

    • setContrast null | enum Contrast { NO_PREFERENCE, MORE } (optional)#

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

    • setDeviceScaleFactor double (optional)#

      デバイススケールファクター (dpr と考えることができます) を指定します。デフォルトは 1 です。デバイススケールファクターを使用したデバイスのエミュレート について詳しく学んでください。

    • setExtraHTTPHeaders Map<String, String> (optional)#

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

    • setForcedColors null | enum ForcedColors { ACTIVE, NONE } (optional)#

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

    • setGeolocation Geolocation (optional)#

      • setLatitude double

        緯度 -90 から 90。

      • setLongitude double

        経度 -180 から 180。

      • setAccuracy double (optional)

        負でない精度値。デフォルトは 0 です。

    • setHasTouch boolean (optional)#

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

    • setHttpCredentials HttpCredentials (optional)#

      • setUsername String

      • setPassword String

      • setOrigin String (optional)

        特定のオリジン (scheme://host:port).

      • setSend enum HttpCredentialsSend { UNAUTHORIZED, ALWAYS } (optional)

        このオプションは、対応する APIRequestContext から送信されたリクエストにのみ適用され、ブラウザから送信されたリクエストには影響しません。'always' - 基本認証資格情報を含む Authorization ヘッダーは、各 API リクエストとともに送信されます。'unauthorized - 資格情報は、WWW-Authenticate ヘッダーを含む 401 (Unauthorized) レスポンスを受信した場合にのみ送信されます。デフォルトは 'unauthorized' です。

      HTTP 認証の資格情報。オリジンが指定されていない場合、ユーザー名とパスワードは、不正な応答時に任意のサーバーに送信されます。

    • setIgnoreHTTPSErrors boolean (optional)#

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

    • setIsMobile boolean (optional)#

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

    • setJavaScriptEnabled boolean (optional)#

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

    • setLocale String (optional)#

      ユーザーロケール (例: en-GBde-DE など) を指定します。ロケールは、navigator.language の値、Accept-Language リクエストヘッダーの値、および数値と日付の書式設定ルールに影響を与えます。デフォルトはシステムデフォルトロケールです。エミュレーションの詳細については、エミュレーションガイドを参照してください。

    • setOffline boolean (optional)#

      ネットワークがオフラインになっている状態をエミュレートするかどうか。デフォルトは false です。ネットワークエミュレーション について詳しく学んでください。

    • setPermissions List<String> (optional)#

      このコンテキスト内のすべてのページに付与する権限のリスト。詳細については、BrowserContext.grantPermissions() を参照してください。デフォルトはなし。

    • setProxy Proxy (optional)#

      • setServer String

        すべてのリクエストに使用するプロキシ。HTTP および SOCKS プロキシがサポートされています。例: http://myproxy.com:3128 または socks5://myproxy.com:3128。短縮形 myproxy.com:3128 は HTTP プロキシとみなされます。

      • setBypass String (optional)

        プロキシをバイパスするオプションのコンマ区切りドメイン。例: ".com, chromium.org, .domain.com"

      • setUsername String (optional)

        HTTP プロキシが認証を必要とする場合に使用するオプションのユーザー名。

      • setPassword String (optional)

        HTTP プロキシが認証を必要とする場合に使用するオプションのパスワード。

      このコンテキストで使用するネットワークプロキシ設定。デフォルトはなし。

    • setRecordHarContent enum HarContentPolicy { OMIT, EMBED, ATTACH } (optional)#

      リソースコンテンツ管理を制御するためのオプション設定。omit が指定された場合、コンテンツは永続化されません。attach が指定された場合、リソースは個別のファイルとして永続化され、これらのファイルはすべて HAR ファイルとともにアーカイブされます。デフォルトは embed で、HAR 仕様に従ってコンテンツを HAR ファイルにインラインで保存します。

    • setRecordHarMode enum HarMode { FULL, MINIMAL } (optional)#

      minimal に設定すると、HAR からのルーティングに必要な情報のみを記録します。これにより、HAR から再生するときに使用されないサイズ、タイミング、ページ、Cookie、セキュリティ、およびその他の種類の HAR 情報は省略されます。デフォルトは full です。

    • setRecordHarOmitContent boolean (optional)#

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

    • setRecordHarPath Path (optional)#

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

    • setRecordHarUrlFilter String | Pattern (optional)#

    • setRecordVideoDir Path (optional)#

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

    • setRecordVideoSize RecordVideoSize (optional)#

      • setWidth int

        ビデオフレームの幅。

      • setHeight int

        ビデオフレームの高さ。

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

    • setReducedMotion null | enum ReducedMotion { REDUCE, NO_PREFERENCE } (optional)#

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

    • setScreenSize ScreenSize (optional)#

      • setWidth int

        ページ幅 (ピクセル単位)。

      • setHeight int

        ページ高さ (ピクセル単位)。

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

    • setServiceWorkers enum ServiceWorkerPolicy { ALLOW, BLOCK } (optional)#

      サイトが Service Worker を登録できるようにするかどうか。デフォルトは 'allow' です。

      • 'allow': Service Worker を登録できます。
      • 'block': Playwright は Service Worker のすべての登録をブロックします。
    • setStorageState String (optional)#

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

    • setStorageStatePath Path (optional)Added in: v1.9#

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

    • setStrictSelectors boolean (optional)#

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

    • setTimezoneId String (optional)#

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

    • setUserAgent String (optional)#

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

    • setViewportSize null | ViewportSize (optional)#

      • setWidth int

        ページ幅 (ピクセル単位)。

      • setHeight int

        ページ高さ (ピクセル単位)。

      各ページの一貫したビューポートをエミュレートします。デフォルトは 1280x720 ビューポートです。一貫したビューポートエミュレーションを無効にするには、null を使用します。ビューポートエミュレーション について詳しく学んでください。

      note

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

Returns


newPage

Added before v1.9 browser.newPage

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

これは、シングルページシナリオや短いスニペットでのみ使用する必要がある便利な API です。実稼働コードとテストフレームワークは、正確なライフタイムを制御するために、Browser.newContext() の後に BrowserContext.newPage() を明示的に作成する必要があります。

Usage

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

Arguments

  • options Browser.NewPageOptions (optional)
    • setAcceptDownloads boolean (optional)#

      すべてのアタッチメントを自動的にダウンロードするかどうか。デフォルトは true で、すべてのダウンロードが承認されます。

    • setBaseURL String (optional)#

      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 になります。
    • setBypassCSP boolean (optional)#

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

    • setClientCertificates List<ClientCertificates> (optional)Added in: 1.46#

      • setOrigin String

        証明書が有効な正確なオリジン。オリジンには、https プロトコル、ホスト名、およびオプションでポートが含まれます。

      • setCertPath Path (optional)

        PEM 形式の証明書を含むファイルへのパス。

      • setCert byte[] (optional)

        PEM 形式の証明書の直接の値。

      • setKeyPath Path (optional)

        PEM 形式の秘密鍵を含むファイルへのパス。

      • setKey byte[] (optional)

        PEM 形式の秘密鍵の直接の値。

      • setPfxPath Path (optional)

        PFX または PKCS12 エンコードされた秘密鍵と証明書チェーンへのパス。

      • setPfx byte[] (optional)

        PFX または PKCS12 エンコードされた秘密鍵と証明書チェーンの直接の値。

      • setPassphrase String (optional)

        秘密鍵 (PEM または PFX) のパスフレーズ。

      TLSクライアント認証により、サーバーはクライアント証明書を要求して検証できます。

      Details

      使用するクライアント証明書の配列。各証明書オブジェクトは、certPathkeyPath の両方、単一の pfxPath、または対応する直接値の同等物 (certkey、または pfx) のいずれかを持つ必要があります。オプションで、証明書が暗号化されている場合は passphrase プロパティを指定する必要があります。origin プロパティは、証明書が有効なリクエストオリジンと正確に一致するように指定する必要があります。

      note

      macOS で WebKit を使用する場合、localhost にアクセスしてもクライアント証明書は選択されません。localhostlocal.playwright に置き換えることで動作させることができます。

    • setColorScheme null | enum ColorScheme { LIGHT, DARK, NO_PREFERENCE } (optional)#

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

    • setContrast null | enum Contrast { NO_PREFERENCE, MORE } (optional)#

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

    • setDeviceScaleFactor double (optional)#

      デバイススケールファクター (dpr と考えることができます) を指定します。デフォルトは 1 です。デバイススケールファクターを使用したデバイスのエミュレート について詳しく学んでください。

    • setExtraHTTPHeaders Map<String, String> (optional)#

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

    • setForcedColors null | enum ForcedColors { ACTIVE, NONE } (optional)#

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

    • setGeolocation Geolocation (optional)#

      • setLatitude double

        緯度 -90 から 90。

      • setLongitude double

        経度 -180 から 180。

      • setAccuracy double (optional)

        負でない精度値。デフォルトは 0 です。

    • setHasTouch boolean (optional)#

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

    • setHttpCredentials HttpCredentials (optional)#

      • setUsername String

      • setPassword String

      • setOrigin String (optional)

        特定のオリジン (scheme://host:port).

      • setSend enum HttpCredentialsSend { UNAUTHORIZED, ALWAYS } (optional)

        このオプションは、対応する APIRequestContext から送信されたリクエストにのみ適用され、ブラウザから送信されたリクエストには影響しません。'always' - 基本認証資格情報を含む Authorization ヘッダーは、各 API リクエストとともに送信されます。'unauthorized - 資格情報は、WWW-Authenticate ヘッダーを含む 401 (Unauthorized) レスポンスを受信した場合にのみ送信されます。デフォルトは 'unauthorized' です。

      HTTP 認証の資格情報。オリジンが指定されていない場合、ユーザー名とパスワードは、不正な応答時に任意のサーバーに送信されます。

    • setIgnoreHTTPSErrors boolean (optional)#

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

    • setIsMobile boolean (optional)#

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

    • setJavaScriptEnabled boolean (optional)#

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

    • setLocale String (optional)#

      ユーザーロケール (例: en-GBde-DE など) を指定します。ロケールは、navigator.language の値、Accept-Language リクエストヘッダーの値、および数値と日付の書式設定ルールに影響を与えます。デフォルトはシステムデフォルトロケールです。エミュレーションの詳細については、エミュレーションガイドを参照してください。

    • setOffline boolean (optional)#

      ネットワークがオフラインになっている状態をエミュレートするかどうか。デフォルトは false です。ネットワークエミュレーション について詳しく学んでください。

    • setPermissions List<String> (optional)#

      このコンテキスト内のすべてのページに付与する権限のリスト。詳細については、BrowserContext.grantPermissions() を参照してください。デフォルトはなし。

    • setProxy Proxy (optional)#

      • setServer String

        すべてのリクエストに使用するプロキシ。HTTP および SOCKS プロキシがサポートされています。例: http://myproxy.com:3128 または socks5://myproxy.com:3128。短縮形 myproxy.com:3128 は HTTP プロキシとみなされます。

      • setBypass String (optional)

        プロキシをバイパスするオプションのコンマ区切りドメイン。例: ".com, chromium.org, .domain.com"

      • setUsername String (optional)

        HTTP プロキシが認証を必要とする場合に使用するオプションのユーザー名。

      • setPassword String (optional)

        HTTP プロキシが認証を必要とする場合に使用するオプションのパスワード。

      このコンテキストで使用するネットワークプロキシ設定。デフォルトはなし。

    • setRecordHarContent enum HarContentPolicy { OMIT, EMBED, ATTACH } (optional)#

      リソースコンテンツ管理を制御するためのオプション設定。omit が指定された場合、コンテンツは永続化されません。attach が指定された場合、リソースは個別のファイルとして永続化され、これらのファイルはすべて HAR ファイルとともにアーカイブされます。デフォルトは embed で、HAR 仕様に従ってコンテンツを HAR ファイルにインラインで保存します。

    • setRecordHarMode enum HarMode { FULL, MINIMAL } (optional)#

      minimal に設定すると、HAR からのルーティングに必要な情報のみを記録します。これにより、HAR から再生するときに使用されないサイズ、タイミング、ページ、Cookie、セキュリティ、およびその他の種類の 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 } (オプション)#

      サイトが Service Worker を登録できるようにするかどうか。デフォルトは 'allow' です。

      • 'allow': Service Worker を登録できます。
      • 'block': Playwright は Service Worker のすべての登録をブロックします。
    • setStorageState String (オプション)#

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

    • setStorageStatePath Path (optional)Added in: 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 を使用します。ビューポートエミュレーション について詳しく学んでください。

      note

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

Returns


startTracing

Added in: v1.11 browser.startTracing
note

このAPIは、低レベルの chromium 固有のデバッグツールである Chromium Tracing を制御します。 Playwright Tracing を制御するAPIは、こちらにあります。

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

Usage

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

Arguments

  • page Page (オプション)#

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

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

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

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

    • setPath Path (オプション)#

      トレースファイルを書き込むパス。

    • setScreenshots boolean (オプション)#

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

Returns


stopTracing

Added in: v1.11 browser.stopTracing
note

このAPIは、低レベルの chromium 固有のデバッグツールである Chromium Tracing を制御します。 Playwright Tracing を制御するAPIは、こちらにあります。

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

Usage

Browser.stopTracing();

Returns


version

Added before v1.9 browser.version

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

Usage

Browser.version();

Returns


Events

onDisconnected(handler)

Added before v1.9 browser.onDisconnected(handler)

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

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

Usage

Browser.onDisconnected(handler)

イベントデータ