Route

page.route() または browserContext.route() でネットワークルートが設定されるたびに、Route オブジェクトによってそのルートを処理できます。

ネットワークについて詳しくはこちらをご覧ください。

---

メソッド

abort

v1.9より前に追加 route.abort

ルートのリクエストを中止します。

使用法

await route.abort();
await route.abort(errorCode);

引数

• errorCode string (optional)#

  オプションのエラーコード。デフォルトは failed で、以下のいずれかになります。

  • 'aborted' - 操作が中止されました（ユーザーアクションによる）
  • 'accessdenied' - ネットワーク以外のリソースへのアクセスが拒否されました
  • 'addressunreachable' - IPアドレスに到達できません。これは通常、指定されたホストまたはネットワークへのルートがないことを意味します。
  • 'blockedbyclient' - クライアントがリクエストをブロックすることを選択しました。
  • 'blockedbyresponse' - レスポンスが要件（例：'X-Frame-Options' や 'Content-Security-Policy' の祖先チェック）を満たさなかったため、リクエストが失敗しました。
  • 'connectionaborted' - 送信されたデータのACKを受信しなかった結果、接続がタイムアウトしました。
  • 'connectionclosed' - 接続が閉じられました（TCP FINに相当）。
  • 'connectionfailed' - 接続試行が失敗しました。
  • 'connectionrefused' - 接続試行が拒否されました。
  • 'connectionreset' - 接続がリセットされました（TCP RSTに相当）。
  • 'internetdisconnected' - インターネット接続が失われました。
  • 'namenotresolved' - ホスト名を解決できませんでした。
  • 'timedout' - 操作がタイムアウトしました。
  • 'failed' - 一般的な障害が発生しました。

戻り値

• Promise<void>#

---

continue

v1.9より前に追加 route.continue

オプションの上書きを用いて、ルートのリクエストをネットワークに送信します。

使用法

await page.route('**/*', async (route, request) => {
  // Override headers
  const headers = {
    ...request.headers(),
    foo: 'foo-value', // set "foo" header
    bar: undefined, // remove "bar" header
  };
  await route.continue({ headers });
});

引数

• options Object (optional)

  • headers Object<string, string> (optional)#

    設定されている場合、リクエストHTTPヘッダーを変更します。ヘッダー値は文字列に変換されます。

  • method string (optional)#

    設定されている場合、リクエストメソッド（例：GETまたはPOST）を変更します。

  • postData string | Buffer | Serializable (optional)#

    設定されている場合、リクエストのPOSTデータを変更します。

  • url string (optional)#

    設定されている場合、リクエストURLを変更します。新しいURLは元のURLと同じプロトコルである必要があります。

戻り値

• Promise<void>#

詳細

headers オプションは、ルーティングされたリクエストとそのリクエストが開始するリダイレクトの両方に適用されます。ただし、url、method、および postData は元のリクエストにのみ適用され、リダイレクトされたリクエストには引き継がれません。

route.continue() はリクエストをネットワークにすぐに送信し、他のマッチングハンドラーは呼び出されません。チェーン内の次のマッチングハンドラーを呼び出したい場合は、route.fallback() を使用してください。

警告

このメソッドで Cookie ヘッダーをオーバーライドすることはできません。値が指定されても無視され、クッキーはブラウザのクッキーストアから読み込まれます。カスタムクッキーを設定するには、browserContext.addCookies() を使用してください。

---

fallback

追加日: v1.23 route.fallback

オプションのオーバーライドでルートのリクエストを続行します。このメソッドは route.continue() に似ていますが、リクエストを送信する前に他のマッチングハンドラーが呼び出される点が異なります。

使用法

与えられたパターンに複数のルートが一致する場合、それらは登録とは逆の順序で実行されます。これにより、最後に登録されたルートが常に以前のすべてのルートを上書きできます。以下の例では、リクエストはまず一番下のハンドラーによって処理され、次に前のハンドラーにフォールバックし、最終的には最初に登録されたルートによって中止されます。

await page.route('**/*', async route => {
  // Runs last.
  await route.abort();
});
await page.route('**/*', async route => {
  // Runs second.
  await route.fallback();
});
await page.route('**/*', async route => {
  // Runs first.
  await route.fallback();
});

複数のルートを登録することは、API呼び出しとページリソース、または以下の例のようにGETリクエストとPOSTリクエストなど、異なる種類のリクエストを異なるハンドラーで処理したい場合に役立ちます。

// Handle GET requests.
await page.route('**/*', async route => {
  if (route.request().method() !== 'GET') {
    await route.fallback();
    return;
  }
  // Handling GET only.
  // ...
});

// Handle POST requests.
await page.route('**/*', async route => {
  if (route.request().method() !== 'POST') {
    await route.fallback();
    return;
  }
  // Handling POST only.
  // ...
});

後続のハンドラーにフォールバックしながらリクエストを変更することもできます。これにより、中間ルートハンドラーはリクエストのURL、メソッド、ヘッダー、およびpostDataを変更できます。

await page.route('**/*', async (route, request) => {
  // Override headers
  const headers = {
    ...request.headers(),
    foo: 'foo-value', // set "foo" header
    bar: undefined, // remove "bar" header
  };
  await route.fallback({ headers });
});

リクエストをネットワークにすぐに送信する場合は route.continue() を使用してください。その場合、他のマッチングハンドラーは呼び出されません。

引数

• options Object (optional)

  • headers Object<string, string> (optional)#

    設定されている場合、リクエストHTTPヘッダーを変更します。ヘッダー値は文字列に変換されます。

  • method string (optional)#

    設定されている場合、リクエストメソッド（例：GETまたはPOST）を変更します。

  • postData string | Buffer | Serializable (optional)#

    設定されている場合、リクエストのPOSTデータを変更します。

  • url string (optional)#

    設定されている場合、リクエストURLを変更します。新しいURLは元のURLと同じプロトコルである必要があります。URLを変更してもルートのマッチングには影響しません。すべてのルートは元のリクエストURLを使用してマッチされます。

戻り値

• Promise<void>#

---

fetch

追加: v1.29 route.fetch

リクエストを実行し、応答を変更して満たすことができるように、応答を満たさずに結果を取得します。

使用法

await page.route('https://dog.ceo/api/breeds/list/all', async route => {
  const response = await route.fetch();
  const json = await response.json();
  json.message['big_red_dog'] = [];
  await route.fulfill({ response, json });
});

引数

• options Object (optional)

  • headers Object<string, string> (optional)#

    設定されている場合、リクエストHTTPヘッダーを変更します。ヘッダー値は文字列に変換されます。

  • maxRedirects number (オプション)追加バージョン: v1.31#

    自動的にフォローされるリクエストのリダイレクトの最大数。この数を超えるとエラーがスローされます。デフォルトは 20 です。リダイレクトをフォローしない場合は 0 を渡します。

  • maxRetries number (optional)追加バージョン: v1.46#

    ネットワークエラーが再試行される最大回数。現在、ECONNRESET エラーのみが再試行されます。HTTP応答コードに基づく再試行は行われません。制限を超えるとエラーがスローされます。デフォルトは 0 (再試行なし) です。

  • method string (optional)#

    設定されている場合、リクエストメソッド（例：GETまたはPOST）を変更します。

  • postData string | Buffer | Serializable (optional)#

    リクエストのPOSTデータを設定できます。データパラメータがオブジェクトの場合、JSON文字列にシリアル化され、明示的に設定されていない限り content-type ヘッダーは application/json に設定されます。それ以外の場合、明示的に設定されていない限り content-type ヘッダーは application/octet-stream に設定されます。

  • timeout number (optional)追加バージョン: v1.33#

    リクエストのタイムアウト（ミリ秒単位）。デフォルトは 30000（30秒）です。タイムアウトを無効にするには 0 を渡します。

  • url string (optional)#

    設定されている場合、リクエストURLを変更します。新しいURLは元のURLと同じプロトコルである必要があります。

戻り値

• Promise<APIResponse>#

詳細

注：headers オプションは、フェッチされたリクエストと、それによって開始されたすべてのリダイレクトに適用されます。headers を元のリクエストにのみ適用し、リダイレクトには適用したくない場合は、代わりに route.continue() を調べてください。

---

fulfill

v1.9より前に追加 route.fulfill

指定された応答でルートのリクエストを満たします。

使用法

すべてのリクエストを404応答で満たす例

await page.route('**/*', async route => {
  await route.fulfill({
    status: 404,
    contentType: 'text/plain',
    body: 'Not Found!'
  });
});

静的ファイルを提供する例

await page.route('**/xhr_endpoint', route => route.fulfill({ path: 'mock_data.json' }));

引数

• options Object (optional)

  • body string | Buffer (optional)#

    レスポンス本文。

  • contentType string (optional)#

    設定されている場合、Content-Type 応答ヘッダーの設定と同じです。

  • headers Object<string, string> (optional)#

    応答ヘッダー。ヘッダー値は文字列に変換されます。

  • json Serializable (optional)追加: v1.29#

    JSON応答。このメソッドは、設定されていない場合、コンテンツタイプを application/json に設定します。

  • path string (optional)#

    応答するファイルのパス。コンテンツタイプはファイル拡張子から推測されます。path が相対パスの場合、現在の作業ディレクトリを基準に解決されます。

  • response APIResponse (optional)追加されたバージョン: v1.15#

    ルートのリクエストを処理するための APIResponse です。レスポンスの個々のフィールド（ヘッダーなど）は、fulfill オプションを使用してオーバーライドできます。

  • status number (optional)#

    応答ステータスコード。デフォルトは 200 です。

戻り値

• Promise<void>#

---

request

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

ルーティングされるリクエスト。

使用法

route.request();

戻り値

• Request#