Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

chrome.declarativeNetRequest

説明

chrome.declarativeNetRequest API を使用してルールを宣言することで、ネットワークリクエストをブロックまたは変更できます。これにより、拡張機能はネットワークリクエストをインターセプトしてコンテンツを表示することなく変更できるため、プライバシーが強化されます。

権限

declarativeNetRequest
declarativeNetRequestWithHostAccess

「declarativeNetRequest」と「declarativeNetRequestWithHostAccess」の権限は同じ機能を提供します。これらの違いは、権限がリクエストまたは付与されるタイミングです。

"declarativeNetRequest": インストール時に権限に関する警告をトリガーしますが、allow、allowAllRequests、block のルールへの暗黙的なアクセスを提供します。可能な場合は、ホストへの完全なアクセス権をリクエストする必要がないように、これを使用します。
"declarativeNetRequestFeedback": パッケージ化されていない拡張機能のデバッグ機能を有効にします。具体的には、getMatchedRules() と onRuleMatchedDebug です。
"declarativeNetRequestWithHostAccess": インストール時に権限の警告は表示されませんが、ホストでアクションを実行する前にホスト権限をリクエストする必要があります。これは、追加の警告を生成せずに、ホスト権限をすでに持っている拡張機能で宣言型ネットリクエストルールを使用する場合に適しています。

対象

Chrome 84 以降

マニフェスト

前述の権限に加えて、特定の種類のルールセット（特に静的ルールセット）では、"declarative_net_request" マニフェストキーを宣言する必要があります。これは、"rule_resources" という単一のキーを含む辞書である必要があります。このキーは、次の例に示すように、Ruleset 型の辞書を含む配列です。（「Ruleset」という名前は単なる配列であるため、マニフェストの JSON には表示されません）。静的ルールセットについては、このドキュメントの後半で説明します。

{
  "name": "My extension",
  ...

  "declarative_net_request" : {
    "rule_resources" : [{
      "id": "ruleset_1",
      "enabled": true,
      "path": "rules_1.json"
    }, {
      "id": "ruleset_2",
      "enabled": false,
      "path": "rules_2.json"
    }]
  },
  "permissions": [
    "declarativeNetRequest",
    "declarativeNetRequestFeedback"
  ],
  "host_permissions": [
    "http://www.blogger.com/*",
    "http://*.google.com/*"
  ],
  ...
}

ルールとルールセット

この API を使用するには、1 つ以上のルールセットを指定します。ルールセットにはルールの配列が含まれています。単一のルールは次のいずれかを行います。

ネットワークリクエストをブロックします。
スキーマをアップグレードします（http から https）。
一致するブロックルールを否定して、リクエストがブロックされないようにします。
ネットワークリクエストをリダイレクトします。
リクエストヘッダーまたはレスポンスヘッダーを変更します。

ルールセットには 3 種類あり、管理方法が若干異なります。

ダイナミック: ブラウザセッションと拡張機能のアップグレード全体で保持され、拡張機能の使用中に JavaScript を使用して管理されます。
セッション: ブラウザがシャットダウンしたとき、および拡張機能の新しいバージョンがインストールされたときにクリアされます。セッションルールは、拡張機能の使用中に JavaScript を使用して管理されます。
静的: 拡張機能のインストールまたはアップグレード時にパッケージ化、インストール、更新されます。静的ルールは JSON 形式のルールファイルに保存され、マニフェストファイルにリストされます。

動的ルールセットとセッションスコープのルールセット

拡張機能の使用中は、JavaScript を使用して動的ルールセットとセッションルールセットが管理されます。

動的ルールは、ブラウザセッションと拡張機能のアップグレードにまたがって保持されます。
セッションルールは、ブラウザがシャットダウンしたときと、新しいバージョンの拡張機能がインストールされたときにクリアされます。

これらのルールセットタイプはそれぞれ 1 つだけです。拡張機能は、ルールの上限を超えない限り、updateDynamicRules() と updateSessionRules() を呼び出すことで、ルールを動的に追加または削除できます。ルールの上限については、ルールの上限をご覧ください。コード例でこの例を確認できます。

静的ルールセット

動的ルールやセッションルールとは異なり、静的ルールは拡張機能のインストールまたはアップグレード時にパッケージ化、インストール、更新されます。これらは JSON 形式のルールファイルに保存され、Ruleset 辞書 1 つ以上とともに、前述のとおり "declarative_net_request" キーと "rule_resources" キーを使用して拡張機能に示されます。Ruleset 辞書には、ルールファイルへのパス、ファイルに含まれるルールセットの ID、ルールセットが有効か無効かが含まれます。最後の 2 つは、ルールセットをプログラムで有効または無効にする場合に重要です。

{
  ...
  "declarative_net_request" : {
    "rule_resources" : [{
      "id": "ruleset_1",
      "enabled": true,
      "path": "rules_1.json"
    },
    ...
    ]
  }
  ...
}

ルールファイルをテストするには、拡張機能をパッケージ化されていない状態で読み込みます。無効な静的ルールに関するエラーと警告は、パッケージ化されていない拡張機能に対してのみ表示されます。パッケージ化された拡張機能内の無効な静的ルールは無視されます。

迅速な審査

静的ルールセットの変更は、迅速な審査の対象となる場合があります。対象となる変更の迅速な審査をご覧ください。

静的ルールとルールセットを有効または無効にする

個々の静的ルールと完全な静的ルールセットの両方を実行時に有効または無効にできます。

有効な静的ルールとルールセットのセットは、ブラウザセッション間で保持されます。どちらも拡張機能の更新時に保持されないため、更新後に使用できるのは、ルールファイルに残すことを選択したルールのみです。

パフォーマンス上の理由から、一度に有効にできるルールとルールセットの数にも上限があります。getAvailableStaticRuleCount() を呼び出して、有効にできる追加ルールの数を確認します。ルールの上限については、ルールの上限をご覧ください。

静的ルールを有効または無効にするには、updateStaticRules() を呼び出します。このメソッドは、有効または無効にするルールの ID の配列を含む UpdateStaticRulesOptions オブジェクトを受け取ります。ID は、Ruleset 辞書の "id" キーを使用して定義されます。無効な静的ルールの最大数は 5,000 です。

静的ルールセットを有効または無効にするには、updateEnabledRulesets() を呼び出します。このメソッドは、有効または無効にするルールセットの ID の配列を含む UpdateRulesetOptions オブジェクトを受け取ります。ID は、Ruleset 辞書の "id" キーを使用して定義されます。

ビルドルール

タイプに関係なく、ルールは次の図に示すように 4 つのフィールドで始まります。"id" キーと "priority" キーは数値を指定しますが、"action" キーと "condition" キーは複数のブロック条件とリダイレクト条件を指定できます。次のルールは、"foo.com" から送信され、"abc" を部分文字列として含む URL へのすべてのスクリプトリクエストをブロックします。

{
  "id" : 1,
  "priority": 1,
  "action" : { "type" : "block" },
  "condition" : {
    "urlFilter" : "abc",
    "initiatorDomains" : ["foo.com"],
    "resourceTypes" : ["script"]
  }
}

URL の照合

Declarative Net Request では、パターンマッチング構文または正規表現を使用して URL を照合できます。

URL フィルタの構文

ルールの "condition" キーは、指定されたドメインの URL に対してアクションを実行するための "urlFilter" キーを許可します。パターンは、パターンマッチングトークンを使用して作成します。いくつか例を挙げます。

`urlFilter`	一致	一致しない
`"abc"`	https://abcd.com https://example.com/abcd	https://ab.com
`"abc*d"`	https://abcd.com https://example.com/abcxyzd	https://abc.com
`"\|\|a.example.com"`	https://a.example.com/ https://b.a.example.com/xyz https://a.example.company	https://example.com/
`"\|https*"`	https://example.com	http://example.com/ http://https.com
`"example*^123\|"`	https://example.com/123 http://abc.com/example?123	https://example.com/1234 https://abc.com/example0123

正規表現

条件では正規表現も使用できます。"regexFilter" キーをご覧ください。これらの条件に適用される上限については、正規表現を使用するルールをご覧ください。

適切な URL 条件を記述する

ルールを作成する際は、常にドメイン全体が一致するように注意してください。そうしないと、ルールが予期しない状況で一致する可能性があります。たとえば、パターンマッチング構文を使用する場合:

google.com が https://example.com/?param=google.com に誤って一致する
||google.com が https://google.company に誤って一致する
https://www.google.com が https://example.com/?param=https://www.google.com に誤って一致する

使用を検討してください。

||google.com/: すべてのパスとすべてのサブドメインに一致します。
|https://www.google.com/。すべてのパスに一致し、サブドメインには一致しません。

同様に、^ 文字と / 文字を使用して正規表現をアンカーします。たとえば、^https:\/\/www\.google\.com\/ は https://www.google.com の任意のパスと一致します。

ルールの評価

DNR ルールは、ネットワークリクエストライフサイクルのさまざまな段階でブラウザによって適用されます。

リクエスト前

リクエストが行われる前に、拡張機能は一致するルールを使用して、リクエストをブロックまたはリダイレクト（HTTP から HTTPS へのスキームのアップグレードを含む）できます。

ブラウザは、拡張機能ごとに一致するルールのリストを決定します。modifyHeaders アクションを含むルールは、後で処理されるため、ここには含まれません。また、responseHeaders 条件を含むルールは後で（レスポンスヘッダーが使用可能になったとき）考慮されるため、含まれません。

その後、Chrome はリクエストごとに最大 1 つの候補を拡張機能ごとに選択します。Chrome は、一致するすべてのルールを優先度順に並べ替えて、一致するルールを見つけます。優先度が同じルールは、アクション（allow または allowAllRequests > block > upgradeScheme > redirect）で順序付けされます。

候補が allow ルールまたは allowAllRequests ルールである場合、またはリクエストが行われているフレームがこの拡張機能の優先度が同等以上の allowAllRequests ルールと以前に一致した場合、リクエストは「許可」され、拡張機能はリクエストに影響しません。

複数の拡張機能がこのリクエストをブロックまたはリダイレクトしようとしている場合は、実行するアクションが 1 つ選択されます。Chrome では、ルールを block > redirect または upgradeScheme > allow または allowAllRequests の順に並べ替えることで、この処理を行います。2 つのルールが同じタイプの場合、Chrome は最後にインストールされた拡張機能のルールを選択します。

リクエストヘッダーが送信される前

Chrome がリクエストヘッダーをサーバーに送信する前に、一致する modifyHeaders ルールに基づいてヘッダーが更新されます。

Chrome は、単一の拡張機能内で、一致するすべての modifyHeaders ルールを見つけて、実行する変更のリストを作成します。以前と同様に、一致する allow ルールまたは allowAllRequests ルールよりも優先度の高いルールのみが含まれます。

これらのルールは、Chrome によって、最近インストールされた拡張機能のルールが古い拡張機能のルールよりも常に先に評価される順序で適用されます。また、1 つの拡張機能の優先度の高いルールは、同じ拡張機能の優先度の低いルールよりも常に先に適用されます。特に、拡張機能間でも次のようになります。

ルールでヘッダーに追加した場合、優先度の低いルールではそのヘッダーにのみ追加できます。設定と削除のオペレーションは許可されていません。
ルールでヘッダーが設定されている場合、同じ拡張機能の優先度の低いルールのみがそのヘッダーに追加できます。その他の変更は許可されていません。
ルールでヘッダーが削除された場合、優先度の低いルールでヘッダーをさらに変更することはできません。

回答を受け取ったら

レスポンスヘッダーが受信されると、Chrome は responseHeaders 条件を含むルールを評価します。

これらのルールを action と priority で並べ替え、一致する allow または allowAllRequests ルールによって冗長になったルールを除外した後（これは「リクエスト前」の手順と同じように行われます）、Chrome は拡張機能の代わりにリクエストをブロックまたはリダイレクトすることがあります。

リクエストがこの段階に達した場合、リクエストはすでにサーバーに送信されており、サーバーはリクエスト本文などのデータを受信しています。レスポンスヘッダー条件を含むブロックまたはリダイレクトルールは実行されますが、リクエストを実際にブロックまたはリダイレクトすることはできません。

ブロックルールの場合は、リクエストを行ったページがブロックされたレスポンスを受け取り、Chrome がリクエストを早期に終了することで処理されます。リダイレクトルールの場合、Chrome はリダイレクトされた URL に新しいリクエストを行います。これらの動作が拡張機能のプライバシーに関する期待を満たしているかどうかを検討してください。

リクエストがブロックまたはリダイレクトされない場合、Chrome は modifyHeaders ルールを適用します。レスポンスヘッダーへの変更の適用は、「リクエストヘッダーが送信される前」で説明した方法と同じです。リクエストはすでに送信されているため、リクエストヘッダーに変更を適用しても何も起こりません。

安全なルール

安全なルールは、block、allow、allowAllRequests、upgradeScheme のアクションを含むルールとして定義されます。これらのルールには、動的ルールの割り当ての増加が適用されます。

ルールの制限事項

ブラウザでルールを読み込んで評価するとパフォーマンスのオーバーヘッドが発生するため、API を使用する際にはいくつかの制限が適用されます。上限は、使用するルールの種類によって異なります。

静的ルール

静的ルールは、マニフェストファイルで宣言されたルールファイルで指定されたルールです。拡張機能は、"rule_resources" マニフェストキーの一部として最大 100 個の静的ルールセットを指定できますが、一度に有効にできるのは 50 個のみです。後者は MAX_NUMBER_OF_ENABLED_STATIC_RULESETS と呼ばれます。これらのルールセットは、合計で少なくとも 30,000 個のルールが保証されています。これは GUARANTEED_MINIMUM_STATIC_RULES と呼ばれます。

その後利用できるルールの数は、ユーザーのブラウザにインストールされているすべての拡張機能で有効になっているルールの数によって異なります。この番号は、ランタイムに getAvailableStaticRuleCount() を呼び出すことで取得できます。コード例でこの例を確認できます。

セッションルール

拡張機能には最大 5,000 個のセッションルールを設定できます。これは MAX_NUMBER_OF_SESSION_RULES として公開されます。

Chrome 120 より前は、動的ルールとセッションルールの合計が 5, 000 個に制限されていました。

ダイナミックルール

拡張機能には少なくとも 5,000 個の動的ルールを設定できます。これは MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES として公開されます。

Chrome 121 以降では、安全な動的ルールの上限が 30,000 ルールに引き上げられ、MAX_NUMBER_OF_DYNAMIC_RULES として公開されます。上限の 5,000 個以内で追加された安全でないルールも、この上限にカウントされます。

Chrome 120 より前は、動的ルールとセッションルールの合計が 5, 000 個という上限がありました。

正規表現を使用するルール

すべてのタイプのルールで正規表現を使用できますが、各タイプの正規表現ルールの合計数は 1, 000 を超えることはできません。これは MAX_NUMBER_OF_REGEX_RULES と呼ばれます。

また、コンパイル後の各ルールは 2 KB 未満にする必要があります。これは、ルールの複雑さとほぼ相関関係があります。この上限を超えるルールを読み込もうとすると、次のような警告が表示され、ルールは無視されます。

rules_1.json: Rule with id 1 specified a more complex regex than allowed
as part of the "regexFilter" key.

Service Worker とのインタラクション

declarativeNetRequest は、ネットワークスタックに到達するリクエストにのみ適用されます。これには HTTP キャッシュからのレスポンスが含まれますが、Service Worker の onfetch ハンドラを通過するレスポンスは含まれない場合があります。declarativeNetRequest は、Service Worker によって生成されたレスポンスや CacheStorage から取得されたレスポンスには影響しませんが、Service Worker で行われた fetch() の呼び出しには影響します。

ウェブアクセス可能なリソース

declarativeNetRequest ルールでは、公開リソースリクエストからウェブアクセスできないリソースにリダイレクトすることはできません。このような操作を行うと、エラーが発生します。これは、指定されたウェブアクセス可能なリソースがリダイレクト元の拡張機能によって所有されている場合でも同様です。declarativeNetRequest のリソースを宣言するには、マニフェストの "web_accessible_resources" 配列を使用します。

ヘッダーの変更

追加オペレーションは、次のリクエストヘッダーでのみサポートされています。accept、accept-encoding、accept-language、access-control-request-headers、cache-control、connection、content-language、cookie、forwarded、if-match、if-none-match、keep-alive、range、te、trailer、transfer-encoding、upgrade、user-agent、via、want-digest、x-forwarded-for。この許可リストでは大文字と小文字が区別されます（バグ 449152902）。

リクエストヘッダーまたはレスポンスヘッダーに追加する場合、ブラウザは可能な限り適切な区切り文字を使用します。

例

コードの例

ダイナミックルールを更新する

次の例は、updateDynamicRules() を呼び出す方法を示しています。updateSessionRules() の手順も同じです。

// Get arrays containing new and old rules
const newRules = await getNewRules();
const oldRules = await chrome.declarativeNetRequest.getDynamicRules();
const oldRuleIds = oldRules.map(rule => rule.id);

// Use the arrays to update the dynamic rules
await chrome.declarativeNetRequest.updateDynamicRules({
  removeRuleIds: oldRuleIds,
  addRules: newRules
});

静的ルールセットを更新する

次の例は、使用可能な静的ルールセットの数と有効な静的ルールセットの最大数を考慮して、ルールセットを有効または無効にする方法を示しています。これは、必要な静的ルールの数が許容される数を超える場合に行います。これを行うには、ルールセットの一部を無効にして（マニフェストファイル内で "Enabled" を false に設定）、ルールセットの一部をインストールする必要があります。

async function updateStaticRules(enableRulesetIds, disableCandidateIds) {
  // Create the options structure for the call to updateEnabledRulesets()
  let options = { enableRulesetIds: enableRulesetIds }
  // Get the number of enabled static rules
  const enabledStaticCount = await chrome.declarativeNetRequest.getEnabledRulesets();
  // Compare rule counts to determine if anything needs to be disabled so that
  // new rules can be enabled
  const proposedCount = enableRulesetIds.length;
  if (enabledStaticCount + proposedCount > chrome.declarativeNetRequest.MAX_NUMBER_OF_ENABLED_STATIC_RULESETS) {
    options.disableRulesetIds = disableCandidateIds
  }
  // Update the enabled static rules
  await chrome.declarativeNetRequest.updateEnabledRulesets(options);
}

ルールの例

次の例は、Chrome が拡張機能のルールをどのように優先するかを示しています。確認する際は、優先順位付けルールを別のウィンドウで開くことをおすすめします。

「priority」キー

これらの例では、*://*.example.com/* へのホスト権限が必要です。

特定の URL の優先度を計算するには、（デベロッパーが定義した）"priority" キー、"action" キー、"urlFilter" キーを確認します。これらの例は、その下に示されているルールファイルの例を参照しています。

https://google.com へのナビゲーション: この URL には、ID が 1 と 4 の 2 つのルールが適用されます。"block" アクションは "redirect" アクションよりも優先度が高いため、ID 1 のルールが適用されます。残りのルールは、URL が長すぎるため適用されません。
https://google.com/1234 へのナビゲーション: URL が長くなったため、ID 1 と 4 のルールに加えて、ID 2 のルールも一致するようになりました。"allow" は "block" と "redirect" よりも優先度が高いため、ID 2 のルールが適用されます。
https://google.com/12345 へのナビゲーション: 4 つのルールすべてがこの URL と一致します。ID 3 のルールは、デベロッパーが定義した優先度がグループ内で最も高いため、適用されます。

[
  {
    "id": 1,
    "priority": 1,
    "action": { "type": "block" },
    "condition": {"urlFilter": "||google.com/", "resourceTypes": ["main_frame"] }
  },
  {
    "id": 2,
    "priority": 1,
    "action": { "type": "allow" },
    "condition": { "urlFilter": "||google.com/123", "resourceTypes": ["main_frame"] }
  },
  {
    "id": 3,
    "priority": 2,
    "action": { "type": "block" },
    "condition": { "urlFilter": "||google.com/12345", "resourceTypes": ["main_frame"] }
  },
  {
    "id": 4,
    "priority": 1,
    "action": { "type": "redirect", "redirect": { "url": "https://example.com" } },
    "condition": { "urlFilter": "||google.com/", "resourceTypes": ["main_frame"] }
  },
]

リダイレクト

次の例では、*://*.example.com/* に対するホスト権限が必要です。

次の例は、example.com から拡張機能内のページにリクエストをリダイレクトする方法を示しています。拡張機能のパス /a.jpg は chrome-extension://EXTENSION_ID/a.jpg に解決されます。ここで、EXTENSION_ID は拡張機能の ID です。この機能を動作させるには、マニフェストで /a.jpg をウェブアクセス可能なリソースとして宣言する必要があります。

{
  "id": 1,
  "priority": 1,
  "action": { "type": "redirect", "redirect": { "extensionPath": "/a.jpg" } },
  "condition": {
    "urlFilter": "||https://www.example.com/",
    "resourceTypes": ["main_frame"]
  }
}

次の例では、"transform" キーを使用して example.com のサブドメインにリダイレクトしています。ドメイン名アンカー（「||」）を使用して、example.com からのスキームを含むリクエストをインターセプトしています。"transform" の "scheme" キーは、サブドメインへのリダイレクトで常に「https」を使用することを指定しています。

{
  "id": 1,
  "priority": 1,
  "action": {
    "type": "redirect",
    "redirect": {
      "transform": { "scheme": "https", "host": "new.example.com" }
    }
  },
  "condition": {
    "urlFilter": "||example.com/",
    "resourceTypes": ["main_frame"]
  }
}

次の例では、正規表現を使用して https://www.abc.xyz.com/path から https://abc.xyz.com/path にリダイレクトします。"regexFilter" キーで、期間がエスケープされ、キャプチャグループが「abc」または「def」のいずれかを選択していることを確認します。"regexSubstitution" キーは、正規表現の最初の一致を「\1」を使用して指定します。この場合、リダイレクトされた URL から「abc」がキャプチャされ、置換に配置されます。

{
  "id": 1,
  "priority": 1,
  "action": {
    "type": "redirect",
    "redirect": {
      "regexSubstitution": "https://\\1.xyz.com/"
    }
  },
  "condition": {
    "regexFilter": "^https://www\\.(abc|def)\\.xyz\\.com/",
    "resourceTypes": [
      "main_frame"
    ]
  }
}

ヘッダー

次の例では、メインフレームとサブフレームの両方からすべての Cookie を削除します。

{
  "id": 1,
  "priority": 1,
  "action": {
    "type": "modifyHeaders",
    "requestHeaders": [{ "header": "cookie", "operation": "remove" }]
  },
  "condition": { "resourceTypes": ["main_frame", "sub_frame"] }
}

型

DomainType

これは、リクエストが送信元のフレームに対してファーストパーティかサードパーティかを示します。リクエストが送信されたフレームと同じドメイン（eTLD+1）を持つ場合、そのリクエストはファーストパーティリクエストと見なされます。

列挙型

「firstParty」
ネットワークリクエストは、そのリクエストが開始されたフレームのファーストパーティです。

「thirdParty」
ネットワークリクエストは、そのリクエストが開始されたフレームのサードパーティです。

ExtensionActionOptions

Chrome 88 以降

プロパティ

displayActionCountAsBadgeText

boolean 省略可

ページの操作数を拡張機能のバッジテキストとして自動的に表示するかどうか。この設定はセッションをまたいで保持されます。
tabUpdate

TabActionCountUpdate 省略可

Chrome 89 以降

タブのアクション数を調整する方法の詳細。

GetDisabledRuleIdsOptions

Chrome 111 以降

プロパティ

rulesetId

文字列

静的 Ruleset に対応する ID。

GetRulesFilter

Chrome 111 以降

プロパティ

ruleIds

number[] 省略可

指定した場合、一致する ID を持つルールのみが含まれます。

HeaderInfo

Chrome 128 以降

プロパティ

excludedValues

string[] 省略可

指定した場合、ヘッダーが存在し、その値にこのリストの要素が 1 つ以上含まれていると、この条件は一致しません。これは values と同じ一致パターンの構文を使用します。
header

文字列

ヘッダーの名前。この条件は、values と excludedValues の両方が指定されていない場合にのみ、名前に一致します。
values

string[] 省略可

指定した場合、ヘッダーの値がこのリスト内の少なくとも 1 つのパターンと一致すると、この条件は一致します。これにより、大文字と小文字を区別しないヘッダー値の一致と、次の構造がサポートされます。

'*' : 任意の数の文字に一致します。

「?」 : 0 個または 1 個の文字に一致します。

'*' と '?' はバックスラッシュでエスケープできます（例: '\*'、'\?'）。

HeaderOperation

Chrome 86 以降

ここでは、modifyHeaders ルールの可能なオペレーションについて説明します。

列挙型

「append」
指定されたヘッダーの新しいエントリを追加します。リクエストのヘッダーを変更する場合、このオペレーションは特定のヘッダーでのみサポートされます。

「set」
指定されたヘッダーの新しい値を設定し、同じ名前の既存のヘッダーを削除します。

「remove」
指定されたヘッダーのすべてのエントリを削除します。

IsRegexSupportedResult

Chrome 87 以降

プロパティ

isSupported

ブール値
reason

UnsupportedRegexReason 省略可

正規表現が対象外である理由を指定します。isSupported が false の場合にのみ指定されます。

MatchedRule

プロパティ

ruleId

数値

一致するルールの ID。
rulesetId

文字列

このルールが属する Ruleset の ID。動的ルールのセットから発信されたルールの場合、これは DYNAMIC_RULESET_ID と同じになります。

MatchedRuleInfo

プロパティ

ルール

MatchedRule
tabId

数値

リクエストの送信元となったタブの tabId（タブがまだアクティブな場合）。それ以外の場合は -1。
timeStamp

数値

ルールが一致した時刻。タイムスタンプは、時刻の JavaScript 規則（エポックからの経過ミリ秒数）に対応します。

MatchedRuleInfoDebug

プロパティ

リクエスト

RequestDetails

ルールが一致したリクエストの詳細。
ルール

MatchedRule

MatchedRulesFilter

プロパティ

minTimeStamp

number 省略可

指定した場合、指定されたタイムスタンプ以降のルールのみが一致します。
tabId

number 省略可

指定した場合、指定したタブのルールのみが一致します。-1 に設定されている場合、アクティブなタブに関連付けられていないルールに一致します。

ModifyHeaderInfo

Chrome 86 以降

プロパティ

header

文字列

変更するヘッダーの名前。
オペレーション

HeaderOperation

ヘッダーに対して実行するオペレーション。
値

文字列省略可

ヘッダーの新しい値。append オペレーションと set オペレーションで指定する必要があります。

QueryKeyValue

プロパティ

key

文字列
replaceOnly

boolean 省略可

Chrome 94 以降

true の場合、クエリキーがすでに存在する場合にのみ置き換えられます。それ以外の場合は、キーがない場合に追加されます。デフォルトは false です。
値

文字列

QueryTransform

プロパティ

addOrReplaceParams

QueryKeyValue[] 省略可

追加または置換するクエリ Key-Value ペアのリスト。
removeParams

string[] 省略可

削除するクエリキーのリスト。

Redirect

プロパティ

extensionPath

文字列省略可

拡張機能ディレクトリからの相対パス。「/」で始める必要があります。
regexSubstitution

文字列省略可

regexFilter を指定するルールの置換パターン。URL 内で最初に見つかった regexFilter がこのパターンに置き換えられます。regexSubstitution 内では、バックスラッシュでエスケープされた数字（\1 ～\9）を使用して、対応するキャプチャグループを挿入できます。\0 は、一致するテキスト全体を参照します。
変換

URLTransform 省略可

実行する URL 変換。
URL

文字列省略可

リダイレクト URL。JavaScript URL へのリダイレクトは許可されていません。

RegexOptions

Chrome 87 以降

プロパティ

isCaseSensitive

boolean 省略可

指定された regex で大文字と小文字が区別されるかどうか。デフォルトは true です。
regex

文字列

チェックする正規表現。
requireCapturing

boolean 省略可

指定された regex にキャプチャが必要かどうか。キャプチャが必要なのは、regexSubstition アクションを指定するリダイレクトルールのみです。デフォルトは false です。

RequestDetails

プロパティ

documentId

文字列省略可

Chrome 106 以降

このリクエストがフレームに対するものである場合、フレームのドキュメントの一意の識別子。
documentLifecycle

DocumentLifecycle 省略可

Chrome 106 以降

このリクエストがフレームに対するものである場合、フレームのドキュメントのライフサイクル。
frameId

数値

値 0 は、リクエストがメインフレームで発生したことを示します。正の値は、リクエストが発生したサブフレームの ID を示します。（サブ）フレームのドキュメントが読み込まれると（type が main_frame または sub_frame）、frameId は外側のフレームの ID ではなく、このフレームの ID を示します。フレーム ID はタブ内で一意です。
frameType

FrameType 省略可

Chrome 106 以降

このリクエストがフレームに対するものである場合、フレームのタイプ。
イニシエータ

文字列省略可

リクエストが開始されたオリジン。これはリダイレクトによって変更されません。これが不透明なオリジンである場合は、文字列「null」が使用されます。
method

文字列

標準の HTTP メソッド。
parentDocumentId

文字列省略可

Chrome 106 以降

このリクエストがフレームに対するもので、親がある場合、フレームの親ドキュメントの一意の識別子。
parentFrameId

数値

リクエストを送信したフレームをラップするフレームの ID。親フレームが存在しない場合は -1 に設定します。
requestId

文字列

リクエストの ID。リクエスト ID はブラウザセッション内で一意です。
tabId

数値

リクエストが行われるタブの ID。リクエストがタブに関連付けられていない場合は -1 に設定します。
type

ResourceType

リクエストのリソースタイプ。
URL

文字列

リクエストの URL。

RequestMethod

Chrome 91 以降

ネットワークリクエストの HTTP リクエストメソッドを表します。

列挙型

"connect"

"delete"

"get"

"head"

"options"

"patch"

"post"

"put"

"other"

ResourceType

ネットワークリクエストのリソースタイプを表します。

列挙型

"main_frame"

"sub_frame"

"stylesheet"

"script"

"image"

"font"

"object"

"xmlhttprequest"

"ping"

"csp_report"

"media"

"websocket"

"webtransport"

"webbundle"

"other"

Rule

プロパティ

アクション

RuleAction

このルールが一致した場合に実行するアクション。
状態

RuleCondition

このルールがトリガーされる条件。
id

数値

ルールを一意に識別する ID。必須で、1 以上にする必要があります。
priority

number 省略可

ルールの優先度。デフォルトは 1 です。指定する場合は、1 以上にする必要があります。

RuleAction

プロパティ

リダイレクト

Redirect 省略可

リダイレクトの実行方法を記述します。リダイレクトルールでのみ有効です。
requestHeaders

ModifyHeaderInfo[] 省略可

Chrome 86 以降

リクエストで変更するリクエストヘッダー。RuleActionType が "modifyHeaders" の場合にのみ有効です。
responseHeaders

ModifyHeaderInfo[] 省略可

Chrome 86 以降

リクエストで変更するレスポンスヘッダー。RuleActionType が "modifyHeaders" の場合にのみ有効です。
type

RuleActionType

実行するアクションのタイプ。

RuleActionType

指定された RuleCondition が一致した場合に実行するアクションの種類を記述します。

列挙型

「block」
ネットワークリクエストをブロックします。

「redirect」
ネットワークリクエストをリダイレクトします。

「allow」
ネットワークリクエストを許可します。リクエストに一致する許可ルールがある場合、リクエストはインターセプトされません。

「upgradeScheme」
リクエストが http または ftp の場合、ネットワークリクエスト URL のスキームを https にアップグレードします。

「modifyHeaders」
ネットワークリクエストからリクエスト/レスポンスヘッダーを変更します。

allowAllRequests
フレームリクエスト自体を含む、フレーム階層内のすべてのリクエストを許可します。

RuleCondition

プロパティ

domainType

DomainType 省略可

ネットワークリクエストが、そのリクエストの送信元ドメインに対してファーストパーティかサードパーティかを指定します。省略すると、すべてのリクエストが承認されます。
ドメイン

string[] 省略可

Chrome 101 以降で非推奨

代わりに initiatorDomains を使用する
このルールは、domains のリストから発信されたネットワークリクエストにのみ一致します。
excludedDomains

string[] 省略可

Chrome 101 以降で非推奨

代わりに excludedInitiatorDomains を使用する
このルールは、excludedDomains のリストから送信されたネットワークリクエストには一致しません。
excludedInitiatorDomains

string[] 省略可

Chrome 101 以降

このルールは、excludedInitiatorDomains のリストから送信されたネットワークリクエストには一致しません。リストが空の場合や省略されている場合は、除外されるドメインはありません。これは initiatorDomains よりも優先されます。

注:
- 「a.example.com」などのサブドメインも使用できます。
- エントリは ASCII 文字のみで構成する必要があります。
- 国際化ドメイン名には Punycode エンコードを使用します。
- これは、リクエスト URL ではなく、リクエストイニシエータと照合されます。
- リストに記載されているドメインのサブドメインも除外されます。
excludedRequestDomains

string[] 省略可

Chrome 101 以降

ドメインが excludedRequestDomains のリストのいずれかに一致する場合、ルールはネットワークリクエストと一致しません。リストが空の場合や省略されている場合は、除外されるドメインはありません。これは requestDomains よりも優先されます。

注:
- 「a.example.com」などのサブドメインも使用できます。
- エントリは ASCII 文字のみで構成する必要があります。
- 国際化ドメイン名には Punycode エンコードを使用します。
- リストに記載されているドメインのサブドメインも除外されます。
excludedRequestMethods

RequestMethod[] 省略可

Chrome 91 以降

ルールが一致しないリクエストメソッドのリスト。requestMethods と excludedRequestMethods のどちらか 1 つのみを指定する必要があります。どちらも指定されていない場合、すべてのリクエストメソッドが一致します。
excludedResourceTypes

ResourceType[] 省略可

ルールが一致しないリソースタイプのリスト。resourceTypes と excludedResourceTypes のどちらか 1 つのみを指定する必要があります。どちらも指定されていない場合は、「main_frame」を除くすべてのリソースタイプがブロックされます。
excludedResponseHeaders

HeaderInfo[] 省略可

Chrome 128 以降

リクエストがこのリストのレスポンスヘッダー条件（指定されている場合）のいずれかに一致する場合、ルールは一致しません。excludedResponseHeaders と responseHeaders の両方が指定されている場合は、excludedResponseHeaders プロパティが優先されます。
excludedTabIds

number[] 省略可

Chrome 92 以降

ルールが一致しない tabs.Tab.id のリスト。tabs.TAB_ID_NONE の ID は、タブから発生していないリクエストを除外します。セッションスコープのルールでのみサポートされます。
excludedTopDomains

string[] 省略可

Chrome 145 以降

関連付けられたトップレベルフレームのドメインが excludedTopDomains のリストのいずれかと一致する場合、このルールはネットワークリクエストと一致しません。リストが空の場合や省略されている場合は、除外されるドメインはありません。これは topDomains よりも優先されます。

注:
- 「a.example.com」などのサブドメインも使用できます。
- エントリは ASCII 文字のみで構成する必要があります。
- 国際化ドメイン名には Punycode エンコードを使用します。
- リストに記載されているドメインのサブドメインも除外されます。
- 関連付けられたトップレベルフレームがないリクエスト（ServiceWorker が開始したリクエストなど）の場合、リクエストイニシエータのドメインが代わりに考慮されます。
initiatorDomains

string[] 省略可

Chrome 101 以降

このルールは、initiatorDomains のリストから発信されたネットワークリクエストにのみ一致します。リストが省略されている場合、ルールはすべてのドメインからのリクエストに適用されます。空のリストは使用できません。

注:
- 「a.example.com」などのサブドメインも使用できます。
- エントリは ASCII 文字のみで構成する必要があります。
- 国際化ドメイン名には Punycode エンコードを使用します。
- これは、リクエスト URL ではなく、リクエストイニシエータと照合されます。
- リストに登録されているドメインのサブドメインも一致します。
isUrlFilterCaseSensitive

boolean 省略可

urlFilter または regexFilter（指定された方）で大文字と小文字が区別されるかどうか。デフォルトは false です。
regexFilter

文字列省略可

ネットワークリクエストの URL と照合する正規表現。これは RE2 構文に従います。

注: 指定できるのは urlFilter または regexFilter のいずれか 1 つのみです。

注: regexFilter は ASCII 文字のみで構成する必要があります。これは、ホストが punycode 形式でエンコードされ（国際化ドメインの場合）、他の ASCII 以外の文字が utf-8 で URL エンコードされている URL と照合されます。
requestDomains

string[] 省略可

Chrome 101 以降

このルールは、ドメインが requestDomains のリストのいずれかと一致する場合にのみ、ネットワークリクエストと一致します。リストが省略されている場合、ルールはすべてのドメインからのリクエストに適用されます。空のリストは使用できません。

注:
- 「a.example.com」などのサブドメインも使用できます。
- エントリは ASCII 文字のみで構成する必要があります。
- 国際化ドメイン名には Punycode エンコードを使用します。
- リストに登録されているドメインのサブドメインも一致します。
requestMethods

RequestMethod[] 省略可

Chrome 91 以降

ルールが照合できる HTTP リクエストメソッドのリスト。空のリストは使用できません。

注: requestMethods ルール条件を指定すると、HTTP(s) 以外のリクエストも除外されますが、excludedRequestMethods を指定しても除外されません。
resourceTypes

ResourceType[] 省略可

ルールが一致するリソースタイプのリスト。空のリストは使用できません。

注: これは allowAllRequests ルールで指定する必要があり、sub_frame リソースタイプと main_frame リソースタイプのみを含めることができます。
responseHeaders

HeaderInfo[] 省略可

Chrome 128 以降

リクエストがこのリストのレスポンスヘッダー条件のいずれかに一致する場合、ルールが一致します（指定されている場合）。
tabIds

number[] 省略可

Chrome 92 以降

ルールが一致する必要がある tabs.Tab.id のリスト。tabs.TAB_ID_NONE の ID は、タブから送信されていないリクエストと一致します。空のリストは使用できません。セッションスコープのルールでのみサポートされます。
topDomains

string[] 省略可

Chrome 145 以降

このルールは、関連付けられたトップレベルフレームのドメインが topDomains のリストのいずれかと一致する場合にのみ、ネットワークリクエストと一致します。リストが省略されている場合、ルールはすべてのトップレベルフレームドメインに関連付けられたリクエストに適用されます。空のリストは使用できません。

注:
- 「a.example.com」などのサブドメインも使用できます。
- エントリは ASCII 文字のみで構成する必要があります。
- 国際化ドメイン名には Punycode エンコードを使用します。
- リストに登録されているドメインのサブドメインも一致します。
- 関連付けられたトップレベルフレームがないリクエスト（ServiceWorker が開始したリクエストなど）の場合、リクエストイニシエータのドメインが代わりに考慮されます。
urlFilter

文字列省略可

ネットワークリクエストの URL と照合されるパターン。サポートされているコンストラクト:

「*」 : ワイルドカード: 任意の数の文字に一致します。

'|' : 左/右アンカー: パターンのいずれかの端で使用すると、それぞれ URL の先頭/末尾を指定します。

'||' : ドメイン名アンカー: パターンの先頭で使用すると、URL の（サブ）ドメインの開始を指定します。

'^': 区切り文字: 文字、数字、_、-、.、% 以外のものに一致します。これは URL の末尾にも一致します。

したがって、urlFilter は、（オプションの左/ドメイン名アンカー）+ パターン +（オプションの右アンカー）で構成されます。

省略すると、すべての URL が照合されます。空の文字列は使用できません。

||* で始まるパターンは許可されていません。代わりに * を使用してください。

注: 指定できるのは urlFilter または regexFilter のいずれか 1 つのみです。

注: urlFilter は ASCII 文字のみで構成する必要があります。これは、ホストが punycode 形式でエンコードされ（国際化ドメインの場合）、他の ASCII 以外の文字が utf-8 で URL エンコードされている URL と照合されます。たとえば、リクエスト URL が http://abc.рф?q=ф の場合、urlFilter は URL http://abc.xn--p1ai/?q=%D1%84 と照合されます。

RuleConditionKeys

Chrome 145 以降

列挙型

"urlFilter"

"regexFilter"

"isUrlFilterCaseSensitive"

"initiatorDomains"

"excludedInitiatorDomains"

"requestDomains"

"excludedRequestDomains"

「topDomains」

"excludedTopDomains"

"domains"

"excludedDomains"

"resourceTypes"

"excludedResourceTypes"

"requestMethods"

"excludedRequestMethods"

"domainType"

"tabIds"

"excludedTabIds"

"responseHeaders"

"excludedResponseHeaders"

Ruleset

プロパティ

有効

ブール値

ルールセットがデフォルトで有効になっているかどうか。
id

文字列

ルールセットを一意に識別する空でない文字列。「_」で始まる ID は内部使用のために予約されています。
パス

文字列

拡張機能ディレクトリを基準とする JSON ルールセットのパス。

RulesMatchedDetails

プロパティ

rulesMatchedInfo

MatchedRuleInfo[]

指定されたフィルタに一致するルール。

TabActionCountUpdate

Chrome 89 以降

プロパティ

インクリメント

数値

タブのアクションカウントを増やす量。負の値はカウントを減らします。
tabId

数値

アクション数を更新するタブ。

TestMatchOutcomeResult

Chrome 103 以降

プロパティ

matchedRules

MatchedRule[]

仮説リクエストに一致するルール（存在する場合）。

TestMatchRequestDetails

Chrome 103 以降

プロパティ

イニシエータ

文字列省略可

仮説リクエストのイニシエータ URL（存在する場合）。
method

RequestMethod 省略可

仮説リクエストの標準 HTTP メソッド。HTTP リクエストの場合はデフォルトで「get」になり、HTTP 以外のリクエストの場合は無視されます。
responseHeaders

オブジェクト省略可

Chrome 129 以降

リクエストが送信される前にブロックまたはリダイレクトされない場合に、仮説的なレスポンスによって提供されるヘッダー。ヘッダー名を文字列値のリストにマッピングするオブジェクトとして表されます。指定されていない場合、仮説レスポンスは空のレスポンスヘッダーを返します。これは、ヘッダーが存在しない場合に一致するルールと一致する可能性があります。例: {"content-type": ["text/html; charset=utf-8", "multipart/form-data"]}
tabId

number 省略可

仮説リクエストが行われるタブの ID。実際のタブ ID に対応している必要はありません。デフォルトは -1 です。これは、リクエストがタブに関連付けられていないことを意味します。
topUrl

文字列省略可

Chrome 145 以降

リクエストに関連付けられた最上位フレームの URL（存在する場合）。
type

ResourceType

仮説リクエストのリソースタイプ。
URL

文字列

仮説リクエストの URL。

UnsupportedRegexReason

Chrome 87 以降

指定された正規表現がサポートされていない理由を説明します。

列挙型

"syntaxError"
正規表現の構文が正しくないか、RE2 構文で使用できない機能が使用されています。

"memoryLimitExceeded"
正規表現がメモリの上限を超えています。

UpdateRuleOptions

Chrome 87 以降

プロパティ

addRules

Rule[] 省略可

追加するルール。
removeRuleIds

number[] 省略可

削除するルールの ID。無効な ID は無視されます。

UpdateRulesetOptions

Chrome 87 以降

プロパティ

disableRulesetIds

string[] 省略可

無効にする必要がある静的 Ruleset に対応する ID のセット。
enableRulesetIds

string[] 省略可

有効にする静的 Ruleset に対応する ID のセット。

UpdateStaticRulesOptions

Chrome 111 以降

プロパティ

disableRuleIds

number[] 省略可

無効にする Ruleset のルールに対応する ID のセット。
enableRuleIds

number[] 省略可

有効にする Ruleset のルールに対応する ID のセット。
rulesetId

文字列

静的 Ruleset に対応する ID。

URLTransform

プロパティ

fragment

文字列省略可

リクエストの新しいフラグメント。空にするか、'#' で始める必要があります。空にした場合は、既存のフラグメントがクリアされます。
ホスト

文字列省略可

リクエストの新しいホスト。
パスワード

文字列省略可

リクエストの新しいパスワード。
パス

文字列省略可

リクエストの新しいパス。空の場合、既存のパスはクリアされます。
ポート

文字列省略可

リクエストの新しいポート。空の場合、既存のポートはクリアされます。
クエリ

文字列省略可

リクエストの新しいクエリ。空にするか、「?」で始める必要があります。空にした場合は、既存のクエリがクリアされます。
queryTransform

QueryTransform （省略可）

クエリの Key-Value ペアを追加、削除、または置換します。
スキーム

文字列省略可

リクエストの新しいスキーム。使用できる値は、「http」、「https」、「ftp」、「chrome-extension」です。
ユーザー名

文字列省略可

リクエストの新しいユーザー名。

プロパティ

DYNAMIC_RULESET_ID

拡張機能によって追加された動的ルールのルールセット ID。

値

"_dynamic"

GETMATCHEDRULES_QUOTA_INTERVAL

MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL getMatchedRules 呼び出しを行うことができる時間間隔（分単位）。追加の呼び出しはすぐに失敗し、runtime.lastError を設定します。注: ユーザージェスチャーに関連付けられた getMatchedRules 呼び出しは割り当ての対象外です。

値

GUARANTEED_MINIMUM_STATIC_RULES

Chrome 89 以降

有効な静的ルールセット全体で拡張機能に保証される静的ルールの最小数。この上限を超えるルールは、グローバル静的ルールの上限としてカウントされます。

値

30000

MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL

GETMATCHEDRULES_QUOTA_INTERVAL の期間内に getMatchedRules を呼び出すことができる回数。

値

MAX_NUMBER_OF_DYNAMIC_RULES

拡張機能が追加できる動的ルールの最大数。

値

30000

MAX_NUMBER_OF_ENABLED_STATIC_RULESETS

Chrome 94 以降

拡張機能が一度に有効にできる静的 Rulesets の最大数。

値

MAX_NUMBER_OF_REGEX_RULES

拡張機能が追加できる正規表現ルールの最大数。この上限は、動的ルールのセットとルールリソースファイルで指定されたルールのセットに対して個別に評価されます。

値

1000

MAX_NUMBER_OF_SESSION_RULES

Chrome 120 以降

拡張機能が追加できるセッションスコープルールの最大数。

値

5000

MAX_NUMBER_OF_STATIC_RULESETS

拡張機能が "rule_resources" マニフェストキーの一部として指定できる静的 Rulesets の最大数。

値

100

MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES

Chrome 120 以降

拡張機能が追加できる「安全でない」動的ルールの最大数。

値

5000

MAX_NUMBER_OF_UNSAFE_SESSION_RULES

Chrome 120 以降

拡張機能が追加できる「安全でない」セッションスコープルールの最大数。

値

5000

SESSION_RULESET_ID

Chrome 90 以降

拡張機能によって追加されたセッションスコープのルールのルールセット ID。

値

"_session"

メソッド

getAvailableStaticRuleCount()

Chrome 89 以降

chrome.declarativeNetRequest.getAvailableStaticRuleCount(): Promise<number>

拡張機能が有効にできる静的ルールの数（グローバル静的ルールの上限に達するまで）を返します。

戻り値

Promise<number>

Chrome 91 以降

getDisabledRuleIds()

Chrome 111 以降

chrome.declarativeNetRequest.getDisabledRuleIds(
  options: GetDisabledRuleIdsOptions,
): Promise<number[]>

現在無効になっている、指定された Ruleset 内の静的ルールのリストを返します。

パラメータ

オプション

GetDisabledRuleIdsOptions

クエリするルールセットを指定します。

戻り値

Promise<number[]>

そのルールセットで無効になっているルールに対応する ID のリストで解決される Promise。

getDynamicRules()

chrome.declarativeNetRequest.getDynamicRules(
  filter?: GetRulesFilter,
): Promise<Rule[]>

拡張機能の現在の動的ルールのセットを返します。発信者は、必要に応じて filter を指定して、取得したルールのリストをフィルタできます。

パラメータ

filter

GetRulesFilter 省略可

Chrome 111 以降

取得したルールのリストをフィルタするオブジェクト。

戻り値

Promise<Rule[]>

Chrome 91 以降

動的ルールのセットで解決される Promise。一時的な内部エラーが発生した場合、Promise は拒否されることがあります。

getEnabledRulesets()

chrome.declarativeNetRequest.getEnabledRulesets(): Promise<string[]>

現在有効になっている静的ルールセットの ID を返します。

戻り値

Promise<string[]>

Chrome 91 以降

有効な静的 Ruleset に対応する ID のリストで解決される Promise。

getMatchedRules()

chrome.declarativeNetRequest.getMatchedRules(
  filter?: MatchedRulesFilter,
): Promise<RulesMatchedDetails>

拡張機能に一致するすべてのルールを返します。呼び出し元は、必要に応じて filter を指定して、一致するルールのリストをフィルタできます。このメソッドは、"declarativeNetRequestFeedback" 権限を持つ拡張機能、または filter で指定された tabId に対して "activeTab" 権限が付与されている拡張機能でのみ使用できます。注: 5 分以上前に一致した、アクティブなドキュメントに関連付けられていないルールは返されません。

パラメータ

filter

MatchedRulesFilter 省略可

一致するルールのリストをフィルタするオブジェクト。

戻り値

Promise<RulesMatchedDetails>

Chrome 91 以降

一致するルールのリストが取得されたときに解決される Promise。エラーが発生した場合、Promise は拒否されます。これは、権限が不十分である、割り当てを超えているなど、複数の理由で発生する可能性があります。

getSessionRules()

Chrome 90 以降

chrome.declarativeNetRequest.getSessionRules(
  filter?: GetRulesFilter,
): Promise<Rule[]>

拡張機能の現在のセッションスコープルールのセットを返します。発信者は、必要に応じて filter を指定して、取得したルールのリストをフィルタできます。

パラメータ

filter

GetRulesFilter 省略可

Chrome 111 以降

取得したルールのリストをフィルタするオブジェクト。

戻り値

Promise<Rule[]>

Chrome 91 以降

セッションスコープのルールのセットで解決される Promise。

isRegexSupported()

Chrome 87 以降

chrome.declarativeNetRequest.isRegexSupported(
  regexOptions: RegexOptions,
): Promise<IsRegexSupportedResult>

指定された正規表現が regexFilter ルール条件としてサポートされるかどうかを確認します。

パラメータ

regexOptions

RegexOptions

チェックする正規表現。

戻り値

Promise<IsRegexSupportedResult>

Chrome 91 以降

正規表現がサポートされているかどうかと、サポートされていない場合はその理由で構成される詳細情報で解決される Promise。

setExtensionActionOptions()

Chrome 88 以降

chrome.declarativeNetRequest.setExtensionActionOptions(
  options: ExtensionActionOptions,
): Promise<void>

タブのアクション数を拡張機能アクションのバッジテキストとして表示するかどうかを設定し、アクション数を増やす方法を提供します。

パラメータ

オプション

ExtensionActionOptions

戻り値

Promise<void>

Chrome 91 以降

testMatchOutcome()

Chrome 103 以降

chrome.declarativeNetRequest.testMatchOutcome(
  request: TestMatchRequestDetails,
): Promise<TestMatchOutcomeResult>

拡張機能の declarativeNetRequest ルールのいずれかが仮説リクエストと一致するかどうかを確認します。注: この機能は、拡張機能の開発時にのみ使用することを想定しているため、パッケージ化されていない拡張機能でのみ使用できます。

パラメータ

リクエスト

TestMatchRequestDetails

戻り値

Promise<TestMatchOutcomeResult>

一致したルールの詳細を含む Promise。

updateDynamicRules()

chrome.declarativeNetRequest.updateDynamicRules(
  options: UpdateRuleOptions,
): Promise<void>

拡張機能の現在の動的ルールのセットを変更します。最初に options.removeRuleIds にリストされている ID のルールが削除され、次に options.addRules で指定されたルールが追加されます。注:

この更新は単一のアトミックオペレーションとして行われます。指定されたすべてのルールが追加および削除されるか、エラーが返されます。
これらのルールは、ブラウザセッションと拡張機能の更新にわたって保持されます。
拡張機能パッケージの一部として指定された静的ルールは、この関数を使用して削除できません。
MAX_NUMBER_OF_DYNAMIC_RULES は、拡張機能が追加できる動的ルールの最大数です。安全でないルールの数は MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES を超えてはなりません。

パラメータ

オプション

UpdateRuleOptions

Chrome 87 以降

戻り値

Promise<void>

Chrome 91 以降

更新が完了すると解決される Promise。エラーが発生した場合、Promise は拒否され、ルールセットは変更されません。これは、無効なルール形式、重複するルール ID、ルール数の上限超過、内部エラーなど、さまざまな理由で発生する可能性があります。

updateEnabledRulesets()

chrome.declarativeNetRequest.updateEnabledRulesets(
  options: UpdateRulesetOptions,
): Promise<void>

拡張機能で有効になっている静的ルールセットのセットを更新します。最初に options.disableRulesetIds にリストされている ID のルールセットが削除され、次に options.enableRulesetIds にリストされているルールセットが追加されます。有効な静的ルールセットのセットはセッション間で保持されますが、拡張機能のアップデート間では保持されません。つまり、rule_resources マニフェストキーによって、各拡張機能のアップデートで有効な静的ルールセットのセットが決まります。

パラメータ

オプション

UpdateRulesetOptions

Chrome 87 以降

戻り値

Promise<void>

Chrome 91 以降

更新が完了すると解決される Promise。エラーが発生した場合、Promise は拒否され、有効なルールセットのセットは変更されません。これは、無効なルールセット ID、ルール数の上限超過、内部エラーなど、さまざまな理由で発生する可能性があります。

updateSessionRules()

Chrome 90 以降

chrome.declarativeNetRequest.updateSessionRules(
  options: UpdateRuleOptions,
): Promise<void>

拡張機能の現在のセッションスコープルールのセットを変更します。最初に options.removeRuleIds にリストされている ID のルールが削除され、次に options.addRules で指定されたルールが追加されます。注:

この更新は単一のアトミックオペレーションとして行われます。指定されたすべてのルールが追加および削除されるか、エラーが返されます。
これらのルールはセッション間で保持されず、メモリにバックアップされます。
MAX_NUMBER_OF_SESSION_RULES は、拡張機能が追加できるセッションルールの最大数です。

パラメータ

オプション

UpdateRuleOptions

戻り値

Promise<void>

Chrome 91 以降

更新が完了すると解決される Promise。エラーが発生した場合、Promise は拒否され、ルールセットは変更されません。これは、無効なルール形式、重複するルール ID、ルール数の上限超過など、さまざまな理由で発生する可能性があります。

updateStaticRules()

Chrome 111 以降

chrome.declarativeNetRequest.updateStaticRules(
  options: UpdateStaticRulesOptions,
): Promise<void>

Ruleset 内の個々の静的ルールを無効または有効にします。無効になっている Ruleset に属するルールに対する変更は、次回有効になったときに反映されます。

パラメータ

オプション

UpdateStaticRulesOptions

戻り値

Promise<void>

更新が完了すると解決される Promise。エラーが発生した場合、Promise は拒否され、有効な静的ルールは変更されません。

イベント

onRuleMatchedDebug

chrome.declarativeNetRequest.onRuleMatchedDebug.addListener(
  callback: function,
)

ルールがリクエストと一致したときに呼び出されます。これはデバッグ目的でのみ使用されるため、"declarativeNetRequestFeedback" 権限を持つパッケージ化されていない拡張機能でのみ使用できます。

パラメータ

callback

関数

callback パラメータは次のようになります。
```
(info: MatchedRuleInfoDebug) => void
```
- 情報
  
  MatchedRuleInfoDebug

chrome.declarativeNetRequest コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

説明

権限

対象

マニフェスト

ルールとルールセット

動的ルールセットとセッション スコープのルールセット

静的ルールセット

迅速な審査

静的ルールとルールセットを有効または無効にする

ビルドルール

URL の照合

URL フィルタの構文

正規表現

適切な URL 条件を記述する

ルールの評価

リクエスト前

リクエスト ヘッダーが送信される前

回答を受け取ったら

安全なルール

ルールの制限事項

静的ルール

セッション ルール

ダイナミック ルール

正規表現を使用するルール

Service Worker とのインタラクション

ウェブ アクセス可能なリソース

ヘッダーの変更

例

コードの例

ダイナミック ルールを更新する

静的ルールセットを更新する

ルールの例

「priority」キー

リダイレクト

ヘッダー

型

DomainType

列挙型

ExtensionActionOptions

プロパティ

GetDisabledRuleIdsOptions

プロパティ

GetRulesFilter

プロパティ

HeaderInfo

プロパティ

HeaderOperation

列挙型

IsRegexSupportedResult

プロパティ

MatchedRule

プロパティ

MatchedRuleInfo

プロパティ

MatchedRuleInfoDebug

プロパティ

MatchedRulesFilter

プロパティ

ModifyHeaderInfo

プロパティ

QueryKeyValue

プロパティ

QueryTransform

プロパティ

Redirect

プロパティ

RegexOptions

プロパティ

RequestDetails

プロパティ

RequestMethod

列挙型

ResourceType

列挙型

Rule

プロパティ

RuleAction

プロパティ

RuleActionType

chrome.declarativeNetRequest

動的ルールセットとセッションスコープのルールセット

リクエストヘッダーが送信される前

セッションルール

ダイナミックルール

ウェブアクセス可能なリソース

ダイナミックルールを更新する