Manifest V2 拡張機能は、2026 年 8 月 31 日に Chrome ウェブストアから削除されました。ユーザーが再び拡張機能を利用できるようにするには、Manifest V3 に移行してください。

Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

chrome.declarativeNetRequest

更新日: 2026-09-25 robots: noindex

説明

chrome.declarativeNetRequest API は、宣言型ルールを指定してネットワークリクエストをブロックまたは変更するために使用されます。これにより、拡張機能はネットワークリクエストを傍受して内容を確認することなく変更できるため、プライバシーが向上します。

権限

declarativeNetRequest
declarativeNetRequestWithHostAccess

declarativeNetRequestFeedback
host_permissions

対象

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 つ以上のルールセットを指定します。ルールセットにはルールの配列が含まれています。1 つのルールで次のいずれかを行います。

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

ルールセットには 3 つの種類があり、それぞれ管理方法が少し異なります。

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

以降のセクションでは、ルールセットの種類について詳しく説明します。

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

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

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

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

静的ルールセット

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

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

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

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

個々の静的ルールと完全な静的ルールセットは、どちらも実行時に有効または無効にできます。

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

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

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

静的ルールセットを有効または無効にするには、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"]
  }
}

urlFilter の一致文字

ルールの "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://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

ルールの優先順位付け

ルールは、ウェブページから送信されたリクエストによってトリガーされます。複数のルールが特定のリクエストに一致する場合は、ルールに優先度を付ける必要があります。このセクションでは、それらの優先順位付けについて説明します。優先順位付けは 2 つの段階で行われます。

優先度は、拡張機能内のルールに対して決定されます。
複数の拡張機能がリクエストにルールを適用できる場合、特定のリクエストに一致するすべての拡張機能に対して優先度が決定されます。

この方法で一致を考えると、特定の拡張機能が優先するルールは、他の拡張機能のルールよりも優先されます。

拡張機能内でのルールの優先順位付け

1 つの拡張機能内では、次のプロセスを使用して優先順位が決定されます。

デベロッパーが定義した優先度（"priority" フィールド）が最も高いルールが返されます。
デベロッパーが定義した優先度が最も高いルールが複数ある場合、ルールは "action" フィールドを使用して次の順序で優先されます。
1. allow
2. allowAllRequests
3. block
4. upgradeScheme
5. redirect
アクションタイプが block または redirect でない場合、一致する modifyHeaders ルールが評価されます。デベロッパーが定義した優先度が allow と allowAllRequests に指定された優先度よりも低いルールがある場合、そのようなルールは無視されます。
複数のルールが同じヘッダーを変更する場合、変更はデベロッパーが定義した "priority" フィールドと指定されたオペレーションによって決定されます。
- ルールがヘッダーに追加される場合、優先度の低いルールはそのヘッダーにのみ追加できます。設定オペレーションと削除オペレーションは許可されません。
- ルールでヘッダーが設定されている場合、優先度の低いルールはそのヘッダーにのみ追加できます。その他の変更は認められません。
- ルールによってヘッダーが削除された場合、優先度の低いルールでヘッダーをさらに変更することはできません。

拡張機能間のルールの優先度

リクエストに一致するルールを持つ拡張機能が 1 つだけの場合、そのルールが適用されます。ただし、複数の拡張機能がリクエストに一致する場合は、次のプロセスが使用されます。

ルールは "action" フィールドを使用して、次の順序で優先されます。
1. block
2. redirect または upgradeScheme
3. allow または allowAllRequests
複数のルールが一致する場合は、最後にインストールされた拡張機能が優先されます。

ルールの制限事項

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

静的ルール

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

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

ダイナミックルールとセッションルール

動的ルールとセッションルールに適用される制限は、静的ルールよりもシンプルです。両方の合計数は 5,000 を超えることはできません。これを MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES と呼びます。

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

すべてのタイプのルールで正規表現を使用できますが、各タイプの正規表現ルールの合計数は 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" 配列を使用します。

例

コードの例

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

次の例は、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 以降

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

文字列省略可

リクエストが開始されたオリジン。これはリダイレクトによって変更されることはありません。不透明なオリジンの場合は、文字列「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 のリスト。ID が tabs.TAB_ID_NONE の場合、タブから送信されていないリクエストと一致します。空のリストは使用できません。セッションスコープのルールでのみサポートされます。
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 以降

プロパティ

initiator

文字列省略可

仮想リクエストのイニシエーター 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 以降

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

値

5,000

MAX_NUMBER_OF_STATIC_RULESETS

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

値

100

MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES

Chrome 120 以降

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

値

5,000

MAX_NUMBER_OF_UNSAFE_SESSION_RULES

Chrome 120 以降

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

値

5,000

SESSION_RULESET_ID

Chrome 90 以降

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

値

"_session"

メソッド

getAvailableStaticRuleCount()

Promise Chrome 89 以降

chrome.declarativeNetRequest.getAvailableStaticRuleCount(
  callback?: function,
): Promise<number>

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

パラメータ

callback

function 省略可

callback パラメータは次のようになります。
```
(count: number) => void
```
- count
  
  数値

戻り値

Promise<number>

Chrome 91 以降

Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getDisabledRuleIds()

Promise Chrome 111 以降

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

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

パラメータ

オプション

GetDisabledRuleIdsOptions

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

function 省略可

callback パラメータは次のようになります。
```
(disabledRuleIds: number[]) => void
```
- disabledRuleIds
  
  number[]

戻り値

Promise<number[]>

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

Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getDynamicRules()

Promise

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

拡張機能の現在の動的ルールのセットを返します。呼び出し元は、filter を指定して、取得したルールのリストをフィルタできます。

パラメータ

filter

GetRulesFilter 省略可

Chrome 111 以降

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

function 省略可

callback パラメータは次のようになります。
```
(rules: Rule[]) => void
```
- ルール
  
  Rule[]

戻り値

Promise<Rule[]>

Chrome 91 以降

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

Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getEnabledRulesets()

Promise

chrome.declarativeNetRequest.getEnabledRulesets(
  callback?: function,
): Promise<string[]>

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

パラメータ

callback

function 省略可

callback パラメータは次のようになります。
```
(rulesetIds: string[]) => void
```
- rulesetIds
  
  string[]

戻り値

Promise<string[]>

Chrome 91 以降

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

Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getMatchedRules()

Promise

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

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

パラメータ

filter

MatchedRulesFilter 省略可

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

function 省略可

callback パラメータは次のようになります。
```
(details: RulesMatchedDetails) => void
```
- 詳細
  
  RulesMatchedDetails

戻り値

Promise<RulesMatchedDetails>

Chrome 91 以降

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

Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getSessionRules()

Promise Chrome 90 以降

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

拡張機能のセッションスコープのルールの現在のセットを返します。呼び出し元は、filter を指定して、取得したルールのリストをフィルタできます。

パラメータ

filter

GetRulesFilter 省略可

Chrome 111 以降

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

function 省略可

callback パラメータは次のようになります。
```
(rules: Rule[]) => void
```
- ルール
  
  Rule[]

戻り値

Promise<Rule[]>

Chrome 91 以降

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

Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

isRegexSupported()

Promise Chrome 87 以降

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

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

パラメータ

regexOptions

RegexOptions

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

function 省略可

callback パラメータは次のようになります。
```
(result: IsRegexSupportedResult) => void
```
- 件の結果
  
  IsRegexSupportedResult

戻り値

Promise<IsRegexSupportedResult>

Chrome 91 以降

正規表現がサポートされているかどうかと、サポートされていない場合はその理由を含む詳細を解決する Promise。

Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

setExtensionActionOptions()

Promise Chrome 88 以降

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

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

パラメータ

オプション

ExtensionActionOptions
callback

function 省略可

Chrome 89 以降

callback パラメータは次のようになります。
```
() => void
```

戻り値

Promise<void>

Chrome 91 以降

Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

testMatchOutcome()

Promise Chrome 103 以降

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

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

パラメータ

リクエスト

TestMatchRequestDetails
callback

function 省略可

callback パラメータは次のようになります。
```
(result: TestMatchOutcomeResult) => void
```
- 件の結果
  
  TestMatchOutcomeResult

戻り値

Promise<TestMatchOutcomeResult>

一致したルールの詳細で解決される Promise。

Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

updateDynamicRules()

Promise

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

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

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

パラメータ

オプション

UpdateRuleOptions

Chrome 87 以降
callback

function 省略可

callback パラメータは次のようになります。
```
() => void
```

戻り値

Promise<void>

Chrome 91 以降

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

Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

updateEnabledRulesets()

Promise

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

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

パラメータ

オプション

UpdateRulesetOptions

Chrome 87 以降
callback

function 省略可

callback パラメータは次のようになります。
```
() => void
```

戻り値

Promise<void>

Chrome 91 以降

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

Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

updateSessionRules()

Promise Chrome 90 以降

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

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

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

パラメータ

オプション

UpdateRuleOptions
callback

function 省略可

callback パラメータは次のようになります。
```
() => void
```

戻り値

Promise<void>

Chrome 91 以降

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

Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

updateStaticRules()

Promise Chrome 111 以降

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

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

パラメータ

オプション

UpdateStaticRulesOptions
callback

function 省略可

callback パラメータは次のようになります。
```
() => void
```

戻り値

Promise<void>

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

Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

イベント

onRuleMatchedDebug

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

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

パラメータ

callback

関数

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

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

説明

権限

対象

マニフェスト

コンセプトと使用方法

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

静的ルールセット

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

ビルドルール

urlFilter の一致文字

ルールの優先順位付け

拡張機能内でのルールの優先順位付け

拡張機能間のルールの優先度

ルールの制限事項

静的ルール

ダイナミック ルールとセッション ルール

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

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

列挙型

RuleCondition

プロパティ

RuleConditionKeys

列挙型

Ruleset

プロパティ

RulesMatchedDetails

chrome.declarativeNetRequest

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

ダイナミックルールとセッションルール

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