Request

ページがネットワークリソースのリクエストを送信するたびに、Page によって以下のイベントシーケンスが発行されます。

• Page.onRequest(handler) は、ページによってリクエストが発行されたときに発行されます。
• Page.onResponse(handler) は、リクエストの応答ステータスとヘッダーが受信されたときに (受信された場合) 発行されます。
• Page.onRequestFinished(handler) は、応答本文がダウンロードされ、リクエストが完了したときに発行されます。

リクエストが途中で失敗した場合、'requestfinished' イベント (場合によっては 'response' イベントも) の代わりに、Page.onRequestFailed(handler) イベントが発行されます。

注

404や503のようなHTTPエラー応答は、HTTPの観点からは依然として成功した応答であるため、リクエストは`'requestfinished'`イベントで完了します。

リクエストが「リダイレクト」応答を受け取ると、リクエストは`requestfinished`イベントで正常に完了し、リダイレクトされたURLに新しいリクエストが発行されます。

---

メソッド

allHeaders

追加されたバージョン: v1.15 request.allHeaders

このリクエストに関連付けられたすべてのリクエストHTTPヘッダーを含むオブジェクトです。ヘッダー名は小文字に変換されます。

使用法

Request.allHeaders();

戻り値

• Map<String, String>#

---

failure

v1.9より前に追加 request.failure

`requestfailed`イベントで報告されたように、このリクエストが失敗していない限り、このメソッドは`null`を返します。

使用法

失敗したすべてのリクエストのログ記録の例

page.onRequestFailed(request -> {
  System.out.println(request.url() + " " + request.failure());
});

戻り値

• null | String#

---

frame

v1.9より前に追加 request.frame

このリクエストを開始した Frame を返します。

使用法

String frameUrl = request.frame().url();

戻り値

• Frame#

詳細

場合によってはフレームが利用できない場合があり、このメソッドはエラーをスローします。

• Service Workerでリクエストが発生した場合。`request.serviceWorker()`を使って確認できます。
• 対応するフレームが作成される前にナビゲーションリクエストが発行された場合。これは Request.isNavigationRequest() を使用して確認できます。

すべてのケースを処理する例を以下に示します

---

headerValue

追加されたバージョン: v1.15 request.headerValue

名前に一致するヘッダーの値を返します。名前は大文字と小文字を区別しません。

使用法

Request.headerValue(name);

引数

• name String#

  ヘッダー名。

戻り値

• null | String#

---

headers

v1.9より前に追加 request.headers

リクエストの HTTP ヘッダーを持つオブジェクト。ヘッダー名は小文字化されています。このメソッドは、Cookie 関連のヘッダーを含むセキュリティ関連のヘッダーを返さないことに注意してください。cookie 情報を含むヘッダーの完全なリストについては、Request.allHeaders() を使用できます。

使用法

Request.headers();

戻り値

• Map<String, String>#

---

headersArray

追加されたバージョン: v1.15 request.headersArray

このリクエストに関連付けられたすべてのリクエスト HTTP ヘッダーの配列です。Request.allHeaders() とは異なり、ヘッダー名は大文字小文字を区別します。Set-Cookie のように複数のエントリを持つヘッダーは、配列に複数回表示されます。

使用法

Request.headersArray();

戻り値

• List<HttpHeader>#

  • name String

    ヘッダー名。

  • value String

    ヘッダー値。

---

isNavigationRequest

v1.9より前に追加 request.isNavigationRequest

このリクエストがフレームのナビゲーションを駆動しているかどうか。

一部のナビゲーションリクエストは、対応するフレームが作成される前に発行されるため、Request.frame() を利用できません。

使用法

Request.isNavigationRequest();

戻り値

• boolean#

---

method

v1.9より前に追加 request.method

リクエストのメソッド (GET、POSTなど)

使用法

Request.method();

戻り値

• String#

---

postData

v1.9より前に追加 request.postData

リクエストのPOSTボディ (存在する場合)。

使用法

Request.postData();

戻り値

• null | String#

---

postDataBuffer

v1.9より前に追加 request.postDataBuffer

リクエストのPOSTボディをバイナリ形式で (存在する場合)。

使用法

Request.postDataBuffer();

戻り値

• null | byte[]#

---

redirectedFrom

v1.9より前に追加 request.redirectedFrom

サーバーによってこのリクエストにリダイレクトされたリクエスト (存在する場合)。

サーバーがリダイレクトで応答すると、Playwright は新しい Request オブジェクトを作成します。2 つのリクエストは redirectedFrom() および redirectedTo() メソッドによって接続されます。複数のサーバーリダイレクトが発生した場合、redirectedFrom() を繰り返し呼び出すことで、リダイレクトチェーン全体を構築できます。

使用法

例えば、ウェブサイト`http://example.com`が`https://example.com`にリダイレクトする場合

Response response = page.navigate("http://example.com");
System.out.println(response.request().redirectedFrom().url()); // "http://example.com"

ウェブサイト`https://google.com`にリダイレクトがない場合

Response response = page.navigate("https://google.com");
System.out.println(response.request().redirectedFrom()); // null

戻り値

• null | Request#

---

redirectedTo

v1.9より前に追加 request.redirectedTo

サーバーがリダイレクトで応答した場合にブラウザによって発行された新しいリクエスト。

使用法

このメソッドは Request.redirectedFrom() の反対です。

System.out.println(request.redirectedFrom().redirectedTo() == request); // true

戻り値

• null | Request#

---

resourceType

v1.9より前に追加 request.resourceType

レンダリングエンジンが認識したリクエストのリソースタイプが含まれています。ResourceTypeは以下のいずれかになります: `document`、`stylesheet`、`image`、`media`、`font`、`script`、`texttrack`、`xhr`、`fetch`、`eventsource`、`websocket`、`manifest`、`other`。

使用法

Request.resourceType();

戻り値

• String#

---

response

v1.9より前に追加 request.response

対応する Response オブジェクトを返します。エラーのために応答が受信されなかった場合は null を返します。

使用法

Request.response();

戻り値

• null | Response#

---

sizes

追加されたバージョン: v1.15 request.sizes

指定されたリクエストのリソースサイズ情報を返します。

使用法

Request.sizes();

戻り値

• サイズ#

  • requestBodySize int

    リクエストボディ (POSTデータペイロード) のサイズ (バイト単位)。ボディがない場合は0に設定されます。

  • requestHeadersSize int

    HTTPリクエストメッセージの先頭からボディの前の二重CRLFまで (含む) の合計バイト数。

  • responseBodySize int

    受信した応答ボディ (エンコード済み) のサイズ (バイト単位)。

  • responseHeadersSize int

    HTTP応答メッセージの先頭からボディの前の二重CRLFまで (含む) の合計バイト数。

---

timing

v1.9より前に追加 request.timing

指定されたリクエストのリソースタイミング情報を返します。ほとんどのタイミング値は応答時に利用可能になり、`responseEnd`はリクエストが終了したときに利用可能になります。Resource Timing APIで詳細を確認してください。

使用法

page.onRequestFinished(request -> {
  Timing timing = request.timing();
  System.out.println(timing.responseEnd - timing.startTime);
});
page.navigate("http://example.com");

戻り値

• タイミング#

  • startTime double

    1970年1月1日00:00:00 UTCからの経過ミリ秒単位のリクエスト開始時刻

  • domainLookupStart double

    ブラウザがリソースのドメイン名ルックアップを開始する直前の時間。値は`startTime`からの相対ミリ秒単位で与えられます。利用できない場合は-1。

  • domainLookupEnd double

    ブラウザがリソースのドメイン名ルックアップを開始した直後の時間。値は`startTime`からの相対ミリ秒単位で与えられます。利用できない場合は-1。

  • connectStart double

    ユーザーエージェントがリソースを取得するためにサーバーへの接続を確立し始める直前の時間。値は`startTime`からの相対ミリ秒単位で与えられます。利用できない場合は-1。

  • secureConnectionStart double

    ブラウザが現在の接続を保護するためにハンドシェイクプロセスを開始する直前の時間。値は`startTime`からの相対ミリ秒単位で与えられます。利用できない場合は-1。

  • connectEnd double

    ユーザーエージェントがリソースを取得するためにサーバーへの接続を確立し始める直前の時間。値は`startTime`からの相対ミリ秒単位で与えられます。利用できない場合は-1。

  • requestStart double

    ブラウザがサーバー、キャッシュ、またはローカルリソースからリソースをリクエストし始める直前の時間。値は`startTime`からの相対ミリ秒単位で与えられます。利用できない場合は-1。

  • responseStart double

    ブラウザがサーバー、キャッシュ、またはローカルリソースから応答の最初のバイトを受信した直後の時間。値は`startTime`からの相対ミリ秒単位で与えられます。利用できない場合は-1。

  • responseEnd double

    ブラウザがリソースの最後のバイトを受信した直後、またはトランスポート接続が閉じる直前の時間のいずれか早い方。値は`startTime`からの相対ミリ秒単位で与えられます。利用できない場合は-1。

---

url

v1.9より前に追加 request.url

リクエストのURL。

使用法

Request.url();

戻り値

• String#