chrome.declarativeNetRequest

Описание

API chrome.declarativeNetRequest используется для блокировки или изменения сетевых запросов путём указания декларативных правил. Это позволяет расширениям изменять сетевые запросы, не перехватывая их и не просматривая их содержимое, обеспечивая тем самым большую конфиденциальность.

Разрешения

declarativeNetRequest
declarativeNetRequestWithHostAccess

Разрешения « declarativeNetRequest » и « declarativeNetRequestWithHostAccess » предоставляют одинаковые возможности. Различия между ними заключаются в том, когда разрешения запрашиваются или предоставляются.

"declarativeNetRequest"
Вызывает предупреждение о нехватке прав доступа во время установки, но предоставляет неявный доступ к правилам allow , allowAllRequests и block . Используйте это по возможности, чтобы избежать необходимости запрашивать полный доступ к хостам.
"declarativeNetRequestFeedback"
Включает функции отладки для распакованных расширений , в частности getMatchedRules() и onRuleMatchedDebug .
"declarativeNetRequestWithHostAccess"
Предупреждение о наличии прав доступа не отображается во время установки, но перед выполнением каких-либо действий на хосте необходимо запросить разрешения. Это удобно, если вы хотите использовать декларативные правила сетевых запросов в расширении, у которого уже есть разрешения на доступ к хосту, без генерации дополнительных предупреждений.

Доступность

Хром 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, укажите один или несколько наборов правил. Набор правил содержит массив правил. Каждое правило выполняет одно из следующих действий:

  • Блокировать сетевой запрос.
  • Обновите схему (с http на https).
  • Предотвратите блокировку запроса, отменив все соответствующие правила блокировки.
  • Перенаправление сетевого запроса.
  • Измените заголовки запроса или ответа.

Существует три типа наборов правил, управление которыми немного различается.

Динамичный
Сохраняются между сеансами браузера и обновлениями расширений и управляются с помощью JavaScript, пока используется расширение.
Сессия
Сбрасывается при закрытии браузера и установке новой версии расширения. Правила сеанса управляются с помощью JavaScript, пока используется расширение.
Статичный
Упаковывается, устанавливается и обновляется при установке или обновлении расширения. Статические правила хранятся в файлах правил в формате JSON и перечислены в файле манифеста.

Динамические и сеансовые наборы правил

Во время использования расширения динамические и сеансовые наборы правил управляются с помощью JavaScript.

  • Динамические правила сохраняются во всех сеансах браузера и обновлениях расширений.
  • Правила сеанса очищаются при закрытии браузера и установке новой версии расширения.

Существует только один тип каждого набора правил. Расширение может динамически добавлять или удалять правила, вызывая updateDynamicRules() и updateSessionRules() , при условии, что ограничения правил не превышаются. Подробнее об ограничениях правил см. в разделе Ограничения правил . Пример можно увидеть в разделе Примеры кода .

Статические наборы правил

В отличие от динамических и сеансовых правил, статические правила упаковываются, устанавливаются и обновляются при установке или обновлении расширения. Они хранятся в файлах правил в формате JSON, которые указываются расширению с помощью ключей "declarative_net_request" и "rule_resources" , как описано выше , а также одного или нескольких словарей наборов Ruleset . Словарь Ruleset содержит путь к файлу правил, идентификатор набора правил в файле и информацию о том, включен или отключен набор правил. Последние два параметра важны при программном включении или отключении набора правил.

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

Для проверки файлов правил загрузите распакованное расширение . Ошибки и предупреждения о недействительных статических правилах отображаются только для распакованных расширений. Недействительные статические правила в упакованных расширениях игнорируются.

Ускоренное рассмотрение

Изменения в статических наборах правил могут быть рассмотрены в ускоренном порядке. См. информацию об ускоренном рассмотрении изменений .

Включение и отключение статических правил и наборов правил

Как отдельные статические правила, так и полные статические наборы правил могут быть включены или отключены во время выполнения.

Набор включённых статических правил и наборов правил сохраняется между сеансами браузера. Ни те, ни другие не сохраняются при обновлениях расширений, то есть после обновления доступны только те правила, которые вы решили оставить в файлах правил.

Из соображений производительности также существуют ограничения на количество правил и наборов правил, которые можно включить одновременно. Вызовите метод getAvailableStaticRuleCount() чтобы проверить количество дополнительных правил, которые можно включить. Сведения об ограничениях правил см. в разделе Ограничения правил .

Чтобы включить или отключить статические правила , вызовите updateStaticRules() . Этот метод принимает объект UpdateStaticRulesOptions , содержащий массивы идентификаторов правил, которые нужно включить или отключить. Идентификаторы определяются с помощью ключа "id" словаря Ruleset . Максимальное количество отключенных статических правил — 5000.

Чтобы включить или отключить статические наборы правил , вызовите метод updateEnabledRulesets() . Этот метод принимает объект UpdateRulesetOptions , содержащий массивы идентификаторов наборов правил, которые нужно включить или отключить. Идентификаторы определяются с помощью ключа "id" словаря Ruleset .

Правила сборки

Независимо от типа, правило начинается с четырёх полей, как показано ниже. Ключи "id" и "priority" принимают числовое значение, а ключи "action" и "condition" могут содержать несколько условий блокировки и перенаправления. Следующее правило блокирует все запросы скриптов, исходящие с "foo.com" к любому URL-адресу с подстрокой "abc" .

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

URL-сопоставление

Декларативный сетевой запрос предоставляет возможность сопоставлять URL-адреса либо с помощью синтаксиса сопоставления с шаблоном, либо с помощью регулярных выражений.

Синтаксис фильтра URL

Ключ "condition" правила позволяет ключу "urlFilter" действовать над URL-адресами в указанном домене. Шаблоны создаются с помощью токенов сопоставления с шаблонами . Вот несколько примеров.

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://baexample.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 выбирает не более одного кандидата на запрос. Chrome находит соответствующее правило, упорядочивая все соответствующие правила по приоритету. Правила с одинаковым приоритетом сортируются по действию ( allow или allowAllRequests > block > upgradeScheme > redirect ).

Если кандидатом является правило allow или allowAllRequests или фрейм, в котором сделан запрос, ранее соответствовал правилу allowAllRequests с более высоким или равным приоритетом из этого расширения, запрос «разрешается», и расширение не окажет на него никакого влияния.

Если несколько расширений хотят заблокировать или перенаправить этот запрос, выбирается одно действие. Chrome сортирует правила в block order > redirect или upgradeScheme > allow или allowAllRequests . Если два правила относятся к одному типу, Chrome выбирает правило из последнего установленного расширения.

Перед отправкой заголовков запроса

Прежде чем Chrome отправит заголовки запроса на сервер, заголовки обновляются на основе соответствующих правил modifyHeaders .

В рамках одного расширения Chrome формирует список изменений, которые необходимо выполнить, находя все соответствующие правила modifyHeaders . Как и раньше, включаются только правила с более высоким приоритетом, чем любые соответствующие правила allow или allowAllRequests .

Chrome применяет эти правила в таком порядке, что правила из недавно установленного расширения всегда применяются раньше правил из более старого расширения. Кроме того, правила с более высоким приоритетом из одного расширения всегда применяются раньше правил с более низким приоритетом из того же расширения. Примечательно, что даже между расширениями:

  • Если правило добавляется к заголовку, то правила с более низким приоритетом могут добавляться только к этому заголовку. Операции установки и удаления не допускаются.
  • Если правило устанавливает заголовок, то к нему могут быть добавлены только правила с более низким приоритетом из того же расширения. Другие изменения не допускаются.
  • Если правило удаляет заголовок, то правила с более низким приоритетом не могут дальше изменять заголовок.

После получения ответа

После получения заголовков ответа Chrome оценивает правила с условием responseHeaders .

После сортировки этих правил по action и priority и исключения любых правил, которые стали избыточными из-за соответствующего правила allow или allowAllRequests (это происходит идентично шагам в разделе «Перед запросом»), Chrome может заблокировать или перенаправить запрос от имени расширения.

Обратите внимание: если запрос дошёл до этого этапа, он уже отправлен на сервер, и сервер получил данные, подобные телу запроса. Правило блокировки или перенаправления с условием в заголовках ответа всё равно будет работать, но не сможет фактически заблокировать или перенаправить запрос.

В случае правила блокировки это обрабатывается страницей, отправившей запрос, которая получает заблокированный ответ, и Chrome досрочно завершает запрос. В случае правила перенаправления Chrome отправляет новый запрос на перенаправленный URL. Убедитесь, что такое поведение соответствует требованиям конфиденциальности вашего расширения.

Если запрос не заблокирован или не перенаправлен, Chrome применяет все правила modifyHeaders . Изменение заголовков ответа происходит так же, как описано в разделе «До отправки заголовков запроса». Изменение заголовков запроса ни к чему не приводит, поскольку запрос уже был отправлен.

Правила безопасности

Безопасные правила определяются как правила с действием block , allow , allowAllRequests или upgradeScheme . На эти правила распространяется увеличенная динамическая квота правил.

Пределы правил

Загрузка и оценка правил в браузере снижает производительность, поэтому при использовании API действуют некоторые ограничения. Ограничения зависят от типа используемого правила.

Статические правила

Статические правила — это правила, указанные в файлах правил, объявленных в файле манифеста. Расширение может указать до 100 статических наборов правил в рамках ключа манифеста "rule_resources" , но только 50 из этих наборов правил могут быть включены одновременно. Последнее называется MAX_NUMBER_OF_ENABLED_STATIC_RULESETS . В совокупности для этих наборов правил гарантировано не менее 30 000 правил. Это называется GUARANTEED_MINIMUM_STATIC_RULES .

Количество доступных правил после этого зависит от того, сколько правил включено во всех расширениях, установленных в браузере пользователя. Это число можно узнать во время выполнения, вызвав метод getAvailableStaticRuleCount() . Пример можно увидеть в разделе «Примеры кода» .

Правила сеанса

Расширение может содержать до 5000 правил сеанса. Это отображается как MAX_NUMBER_OF_SESSION_RULES .

До Chrome 120 существовало ограничение в 5000 комбинированных динамических и сеансовых правил.

Динамические правила

Расширение может содержать не менее 5000 динамических правил. Это отображается как MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES .

Начиная с Chrome 121, для безопасных динамических правил доступно большее ограничение — 30 000 правил, которое отображается как MAX_NUMBER_OF_DYNAMIC_RULES . Любые небезопасные правила, добавленные в пределах лимита в 5000, также будут учитываться при подсчёте этого ограничения.

До Chrome 120 существовало ограничение в 5000 комбинированных динамических и сеансовых правил.

Правила, использующие регулярные выражения

Все типы правил могут использовать регулярные выражения; однако общее количество правил регулярных выражений каждого типа не может превышать 1000. Это называется MAX_NUMBER_OF_REGEX_RULES .

Кроме того, размер каждого правила после компиляции должен быть менее 2 КБ. Это примерно соответствует сложности правила. При попытке загрузить правило, превышающее этот лимит, вы увидите предупреждение, подобное следующему, и правило будет проигнорировано.

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

Взаимодействие с работниками сферы услуг

Запрос declarativeNetRequest применяется только к запросам, достигающим сетевого стека. Это включает ответы из HTTP-кеша, но может не включать ответы, проходящие через обработчик onfetch сервис-воркера. Запрос declarativeNetRequest не повлияет на ответы, сгенерированные сервис-воркером или извлеченные из CacheStorage , но повлияет на вызовы 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 определяет приоритет правил в расширении. При их просмотре вы можете открыть правила определения приоритета в отдельном окне.

Клавиша «приоритет»

Для этих примеров требуется разрешение хоста на *://*.example.com/* .

Чтобы определить приоритет конкретного URL-адреса, проверьте ключи "priority" (определённые разработчиком), "action" и "urlFilter" . Эти примеры относятся к файлу правил, приведённому ниже.

Переход на https://google.com
На этот URL распространяются два правила: правила с идентификаторами 1 и 4. Правило с идентификатором 1 применяется, поскольку действия "block" имеют более высокий приоритет, чем действия "redirect" . Остальные правила не применяются, поскольку они предназначены для более длинных URL.
Переход на https://google.com/1234
Из-за более длинного URL-адреса теперь применяется правило с идентификатором 2 в дополнение к правилам с идентификаторами 1 и 4. Правило с идентификатором 2 применяется, поскольку "allow" имеет более высокий приоритет, чем "block" и "redirect" .
Переход на https://google.com/12345
Все четыре правила соответствуют этому URL. Правило с идентификатором 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 — это идентификатор вашего расширения. Для этого в манифесте необходимо указать /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. Ключ "scheme" в "transform" указывает, что перенаправления на поддомен всегда будут использовать протокол «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". В этом случае "abc" извлекается из перенаправленного URL и добавляется в подстановку. 

{
  "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"
Сетевой запрос является первым участником кадра, в котором он возник.

"третья сторона"
Сетевой запрос является третьим по отношению к фрейму, в котором он возник.

ExtensionActionOptions

Хром 88+

Характеристики

  • displayActionCountAsBadgeText

    логическое необязательное

    Отображать ли автоматически количество действий на странице в тексте значка расширения. Эта настройка сохраняется между сеансами.

  • вкладкаОбновление

    TabActionCountUpdate необязательно

    Хром 89+

    Подробная информация о том, как следует корректировать количество действий вкладки.

GetDisabledRuleIdsOptions

Хром 111+

Характеристики

  • rulesetId

    нить

    Идентификатор, соответствующий статическому Ruleset .

GetRulesFilter

Хром 111+

Характеристики

  • идентификаторы правил

    номер[] необязательно

    Если указано, включаются только правила с совпадающими идентификаторами.

HeaderInfo

Хром 128+

Характеристики

  • исключенные значения

    строка[] необязательная

    Если указано, это условие не выполняется, если заголовок существует, но его значение содержит хотя бы один элемент из этого списка. Используется тот же синтаксис шаблона сопоставления, что и values .

  • заголовок

    нить

    Имя заголовка. Это условие выполняется только в том случае, если не указаны ни values , ни excludedValues .

  • ценности

    строка[] необязательная

    Если указано, это условие выполняется, если значение заголовка соответствует хотя бы одному шаблону из этого списка. Поддерживается сопоставление значений заголовков без учёта регистра, а также следующие конструкции:

    '*' : Соответствует любому количеству символов.

    '?' : Соответствует нулю или одному символу(ам).

    Символы «*» и «?» можно экранировать обратной косой чертой, например, «\*» и «\?».

HeaderOperation

Хром 86+

Здесь описываются возможные операции для правила «modifyHeaders».

Перечисление

"добавить"
Добавляет новую запись для указанного заголовка. Эта операция не поддерживается для заголовков запросов.

"набор"
Устанавливает новое значение для указанного заголовка, удаляя все существующие заголовки с тем же именем.

"удалять"
Удаляет все записи для указанного заголовка.

IsRegexSupportedResult

Хром 87+

Характеристики

  • поддерживается

    булев

  • причина

    Необязательный параметр UnsupportedRegexReason

    Указывает причину, по которой регулярное выражение не поддерживается. Доступно только в том случае, если isSupported равно false.

MatchedRule

Характеристики

  • ruleId

    число

    Идентификатор правила сопоставления.

  • rulesetId

    нить

    Идентификатор Ruleset к которому принадлежит данное правило. Для правила, созданного из набора динамических правил, этот идентификатор будет равен DYNAMIC_RULESET_ID .

MatchedRuleInfo

Характеристики

  • правило

    MatchedRule

  • tabId

    число

    TabId вкладки, с которой был отправлен запрос, если вкладка всё ещё активна. В противном случае -1.

  • отметка времени

    число

    Время срабатывания правила. Временные метки будут соответствовать соглашению Javascript для времени, то есть количеству миллисекунд с начала эпохи.

MatchedRuleInfoDebug

Характеристики

MatchedRulesFilter

Характеристики

  • minTimeStamp

    номер необязательно

    Если указано, сопоставляет только правила после указанной временной метки.

  • tabId

    номер необязательно

    Если указано, сопоставляет только правила для заданной вкладки. Если указано значение -1, сопоставляет правила, не связанные ни с одной активной вкладкой.

ModifyHeaderInfo

Хром 86+

Характеристики

  • заголовок

    нить

    Имя заголовка, который необходимо изменить.

  • Операция, которая должна быть выполнена над заголовком.

  • ценить

    строка необязательная

    Новое значение заголовка. Необходимо указать для операций append и set .

QueryKeyValue

Характеристики

  • ключ

    нить

  • replaceOnly

    логическое необязательное

    Хром 94+

    Если задано значение true, ключ запроса заменяется только в том случае, если он уже присутствует. В противном случае ключ также добавляется, если он отсутствует. Значение по умолчанию — false.

  • ценить

    нить

QueryTransform

Характеристики

  • addOrReplaceParams

    QueryKeyValue [] необязательно

    Список пар ключ-значение запроса, которые необходимо добавить или заменить.

  • removeParams

    строка[] необязательная

    Список ключей запроса, которые необходимо удалить.

Redirect

Характеристики

  • extensionPath

    строка необязательная

    Путь относительно каталога расширения. Должен начинаться с «/».

  • regexПодстановка

    строка необязательная

    Шаблон подстановки для правил, в которых указан фильтр regexFilter . Первое совпадение с фильтром regexFilter в URL будет заменено этим шаблоном. В regexSubstitution для вставки соответствующих групп захвата можно использовать цифры, экранированные обратной косой чертой (от \1 до \9). \0 относится ко всему совпадающему тексту.

  • трансформировать

    URLTransform необязательно

    Преобразования URL для выполнения.

  • URL-адрес

    строка необязательная

    URL-адрес перенаправления. Перенаправления на URL-адреса JavaScript запрещены.

RegexOptions

Хром 87+

Характеристики

  • isCaseSensitive

    логическое необязательное

    Учитывает ли указанное regex ? Значение по умолчанию — true.

  • регулярное выражение

    нить

    Регулярное выражение для проверки.

  • требуетсяЗахват

    логическое необязательное

    Требуется ли захват для указанного regex . Захват требуется только для правил перенаправления, которые определяют действие regexSubstition . Значение по умолчанию — false.

RequestDetails

Характеристики

  • documentId

    строка необязательная

    Хром 106+

    Уникальный идентификатор документа фрейма, если это запрос фрейма.

  • жизненный цикл документа

    DocumentLifecycle (необязательно)

    Хром 106+

    Жизненный цикл документа фрейма, если это запрос на фрейм.

  • frameId

    число

    Значение 0 указывает на то, что запрос выполняется в основном фрейме; положительное значение указывает идентификатор подфрейма, в котором выполняется запрос. Если загружен документ (под)фрейма ( type — main_frame или sub_frame ), frameId указывает идентификатор этого фрейма, а не идентификатор внешнего фрейма. Идентификаторы фреймов уникальны в пределах вкладки.

  • frameType

    FrameType (необязательно)

    Хром 106+

    Тип фрейма, если это запрос фрейма.

  • инициатор

    строка необязательная

    Источник, откуда был инициирован запрос. Не изменяется при перенаправлениях. Если это непрозрачный источник, будет использована строка «null».

  • метод

    нить

    Стандартный метод HTTP.

  • parentDocumentId

    строка необязательная

    Хром 106+

    Уникальный идентификатор родительского документа фрейма, если это запрос фрейма и у него есть родительский документ.

  • parentFrameId

    число

    Идентификатор кадра, который является оболочкой кадра, отправившего запрос. Установите значение -1, если родительского кадра не существует.

  • requestId

    нить

    Идентификатор запроса. Идентификаторы запросов уникальны в пределах сеанса браузера.

  • tabId

    число

    Идентификатор вкладки, в которой выполнен запрос. Установите значение -1, если запрос не связан с вкладкой.

  • Тип ресурса запроса.

  • URL-адрес

    нить

    URL-адрес запроса.

RequestMethod

Хром 91+

Здесь описывается метод HTTP-запроса сетевого запроса.

Перечисление

"соединять"

"удалить"

"получать"

"голова"

"параметры"

"пластырь"

"почта"

"помещать"

"другой"

ResourceType

Здесь описывается тип ресурса сетевого запроса.

Перечисление

"main_frame"

"sub_frame"

"таблица стилей"

"сценарий"

"изображение"

"шрифт"

"объект"

"xmlhttprequest"

"пинг"

"csp_report"

"СМИ"

"вебсокет"

"вебтранспорт"

"webbundle"

"другой"

Rule

Характеристики

  • Действие, которое следует предпринять, если это правило срабатывает.

  • состояние

    ПравилоУсловие

    Условие, при котором срабатывает это правило.

  • идентификатор

    число

    Идентификатор, однозначно определяющий правило. Обязательный и должен быть >= 1.

  • приоритет

    номер необязательно

    Приоритет правила. По умолчанию 1. При указании приоритета должен быть >= 1.

RuleAction

Характеристики

  • перенаправление

    Перенаправление необязательно

    Описывает, как должно выполняться перенаправление. Действительно только для правил перенаправления.

  • requestHeaders

    ModifyHeaderInfo [] необязательно

    Хром 86+

    Заголовки запроса, которые необходимо изменить. Действительно только если RuleActionType — «modifyHeaders».

  • responseHeaders

    ModifyHeaderInfo [] необязательно

    Хром 86+

    Заголовки ответа, которые необходимо изменить для запроса. Действительно только если RuleActionType — «modifyHeaders».

  • Тип действия, которое необходимо выполнить.

RuleActionType

Описывает тип действия, которое следует предпринять, если заданное условие правила совпадает.

Перечисление

"блокировать"
Заблокировать сетевой запрос.

«перенаправление»
Перенаправить сетевой запрос.

"позволять"
Разрешить сетевой запрос. Запрос не будет перехвачен, если есть соответствующее разрешающее правило.

"upgradeScheme"
Обновите схему URL сетевого запроса до https, если запрос — http или ftp.

"modifyHeaders"
Измените заголовки запроса/ответа из сетевого запроса.

"allowAllRequests"
Разрешить все запросы внутри иерархии фрейма, включая сам запрос фрейма.

RuleCondition

Характеристики

  • Тип_домена

    DomainType необязательно

    Указывает, является ли сетевой запрос основным или сторонним по отношению к домену, с которого он был отправлен. Если этот параметр не указан, принимаются все запросы.

  • домены

    строка[] необязательная

    Не рекомендуется с версии Chrome 101

    Вместо этого используйте initiatorDomains

    Правило будет соответствовать только сетевым запросам, исходящим из списка domains .

  • исключенныедомены

    строка[] необязательная

    Не рекомендуется с версии Chrome 101

    Вместо этого используйте excludedInitiatorDomains

    Правило не будет соответствовать сетевым запросам, исходящим из списка excludedDomains .

  • исключенныеInitiatorDomains

    строка[] необязательная

    Хром 101+

    Правило не будет учитывать сетевые запросы, исходящие из списка excludedInitiatorDomains . Если список пуст или отсутствует, домены не исключаются. Это правило имеет приоритет над initiatorDomains .

    Примечания:

    • Также разрешены поддомены типа «a.example.com».
    • Записи должны состоять только из символов ASCII.
    • Используйте кодировку punycode для интернационализированных доменов.
    • Сопоставляется с инициатором запроса, а не с URL-адресом запроса.
    • Поддомены перечисленных доменов также исключены.
  • исключенныеRequestDomains

    строка[] необязательная

    Хром 101+

    Правило не будет учитывать сетевые запросы, если домен соответствует одному из списка excludedRequestDomains . Если список пуст или пропущен, домены не исключаются. Это правило имеет приоритет над requestDomains .

    Примечания:

    • Также разрешены поддомены типа «a.example.com».
    • Записи должны состоять только из символов ASCII.
    • Используйте кодировку punycode для интернационализированных доменов.
    • Поддомены перечисленных доменов также исключены.
  • исключенныеRequestMethods

    RequestMethod [] необязательно

    Хром 91+

    Список методов запроса, которые не будут соответствовать правилу. Необходимо указать только один из requestMethods или excludedRequestMethods . Если не указан ни один из них, будут соответствовать все методы запроса.

  • исключенныеResourceTypes

    ResourceType [] необязательно

    Список типов ресурсов, которые не будут соответствовать правилу. Необходимо указать только один из resourceTypes или excludedResourceTypes . Если не указан ни один из них, блокируются все типы ресурсов, кроме «main_frame».

  • исключенные заголовки ответов

    HeaderInfo [] необязательно

    Хром 128+

    Правило не срабатывает, если запрос соответствует любому условию заголовка ответа в этом списке (если указано). Если указаны оба свойства: excludedResponseHeaders и responseHeaders , то приоритет имеет свойство excludedResponseHeaders .

  • исключенныеTabIds

    номер[] необязательно

    Хром 92+

    Список tabs.Tab.id , которым правило не должно соответствовать. Идентификатор tabs.TAB_ID_NONE исключает запросы, не исходящие из вкладки. Поддерживается только для правил, действующих в рамках сеанса.

  • initiatorDomains

    строка[] необязательная

    Хром 101+

    Правило будет соответствовать только сетевым запросам, исходящим из списка initiatorDomains . Если список не указан, правило применяется к запросам со всех доменов. Пустой список не допускается.

    Примечания:

    • Также разрешены поддомены типа «a.example.com».
    • Записи должны состоять только из символов ASCII.
    • Используйте кодировку punycode для интернационализированных доменов.
    • Сопоставляется с инициатором запроса, а не с URL-адресом запроса.
    • Также сопоставляются поддомены перечисленных доменов.
  • isUrlFilterCaseSensitive

    логическое необязательное

    Чувствителен ли к регистру urlFilter или regexFilter (в зависимости от того, какой из них указан). Значение по умолчанию — false.

  • regexFilter

    строка необязательная

    Регулярное выражение для сопоставления с URL-адресом сетевого запроса. Оно соответствует синтаксису RE2 .

    Примечание: можно указать только один из параметров: urlFilter или regexFilter .

    Примечание: regexFilter должен содержать только символы ASCII. Он сопоставляется с URL-адресом, в котором хост закодирован в формате punycode (в случае интернационализированных доменов), а все остальные символы, не входящие в ASCII, закодированы в формате UTF-8.

  • requestDomains

    строка[] необязательная

    Хром 101+

    Правило будет применяться только к сетевым запросам, если домен совпадает с одним из списка requestDomains . Если список не указан, правило применяется к запросам со всех доменов. Пустой список не допускается.

    Примечания:

    • Также разрешены поддомены типа «a.example.com».
    • Записи должны состоять только из символов ASCII.
    • Используйте кодировку punycode для интернационализированных доменов.
    • Также сопоставляются поддомены перечисленных доменов.
  • requestMethods

    RequestMethod [] необязательно

    Хром 91+

    Список методов HTTP-запросов, которым может соответствовать правило. Пустой список не допускается.

    Примечание: указание условия правила requestMethods также исключит запросы, не являющиеся HTTP(s), тогда как указание excludedRequestMethods не позволит этого сделать.

  • Типы ресурсов

    ResourceType [] необязательно

    Список типов ресурсов, которым может соответствовать правило. Пустой список не допускается.

    Примечание: это необходимо указать для правил allowAllRequests и может включать только типы ресурсов sub_frame и main_frame .

  • responseHeaders

    HeaderInfo [] необязательно

    Хром 128+

    Правило срабатывает, если запрос соответствует любому условию заголовка ответа в этом списке (если указано).

  • tabIds

    номер[] необязательно

    Хром 92+

    Список tabs.Tab.id , которым должно соответствовать правило. Идентификатор tabs.TAB_ID_NONE соответствует запросам, исходящим не от вкладки. Пустой список не допускается. Поддерживается только для правил на уровне сеанса.

  • urlFilter

    строка необязательна

    Шаблон, который сопоставляется с URL-адресом сетевого запроса. Поддерживаемые конструкции:

    '*' : Подстановочный знак: соответствует любому количеству символов.

    '|' : Левая/правая привязка: если используется в любом конце шаблона, указывает начало/конец URL-адреса соответственно.

    '||' : Привязка имени домена: если используется в начале шаблона, указывает начало (суб)домена URL-адреса.

    '^' : Символ-разделитель: соответствует чему угодно, кроме буквы, цифры или одного из следующих символов: _ , - . . или % . Это также соответствует концу URL-адреса.

    Поэтому urlFilter состоит из следующих частей: (необязательная привязка слева/доменного имени) + шаблон + (необязательная правая привязка).

    Если этот параметр опущен, все URL-адреса совпадают. Пустая строка не допускается.

    Шаблон, начинающийся с ||* не допускается. Вместо этого используйте * .

    Примечание. Можно указать только один из urlFilter или regexFilter .

    Примечание. urlFilter должен состоять только из символов ASCII. Это сопоставляется с URL-адресом, в котором хост закодирован в формате punycode (в случае интернационализированных доменов), а любые другие символы, отличные от ascii, имеют URL-адрес, закодированный в utf-8. Например, если URL-адрес запроса — http://abc.рф?q=ф, urlFilter будет сопоставляться с URL-адресом http://abc.xn--p1ai/?q=%D1%84.

Ruleset

Характеристики

  • включено

    булев

    Включен ли набор правил по умолчанию.

  • идентификатор

    нить

    Непустая строка, однозначно идентифицирующая набор правил. Идентификаторы, начинающиеся с «_», зарезервированы для внутреннего использования.

  • путь

    нить

    Путь к набору правил JSON относительно каталога расширения.

RulesMatchedDetails

Характеристики

TabActionCountUpdate

Хром 89+

Характеристики

  • приращение

    число

    Сумма, на которую нужно увеличить количество действий на вкладке. Отрицательные значения уменьшат счетчик.

  • tabId

    число

    Вкладка, для которой обновляется количество действий.

TestMatchOutcomeResult

Хром 103+

Характеристики

TestMatchRequestDetails

Хром 103+

Характеристики

  • инициатор

    строка необязательна

    URL-адрес инициатора (если есть) гипотетического запроса.

  • метод

    RequestMethod необязательный

    Стандартный HTTP-метод гипотетического запроса. По умолчанию используется значение «get» для HTTP-запросов и игнорируется для запросов, отличных от HTTP.

  • Заголовки ответа

    объект необязательный

    Хром 129+

    Заголовки, предоставляемые гипотетическим ответом, если запрос не блокируется или не перенаправляется до его отправки. Представлен как объект, который сопоставляет имя заголовка со списком строковых значений. Если не указано иное, гипотетический ответ будет возвращать пустые заголовки ответа, которые могут соответствовать правилам, которые совпадают в случае отсутствия заголовков. Например {"content-type": ["text/html; charset=utf-8", "multipart/form-data"]}

  • tabId

    номер необязательно

    Идентификатор вкладки, в которой происходит гипотетический запрос. Не обязательно должен соответствовать реальному идентификатору вкладки. По умолчанию установлено значение -1, что означает, что запрос не связан с вкладкой.

  • Тип ресурса гипотетического запроса.

  • URL-адрес

    нить

    URL-адрес гипотетического запроса.

UnsupportedRegexReason

Хром 87+

Описывает причину, по которой данное регулярное выражение не поддерживается.

Перечисление

«синтаксическая ошибка»
Регулярное выражение синтаксически неверно или использует функции, недоступные в синтаксисе RE2 .

«Превышение лимита памяти»
Регулярное выражение превышает лимит памяти.

UpdateRuleOptions

Хром 87+

Характеристики

  • добавитьправила

    Правило [] необязательно

    Правила добавить.

  • удалитьRuleIds

    номер[] необязательно

    Идентификаторы правил, которые необходимо удалить. Любые недействительные идентификаторы будут игнорироваться.

UpdateRulesetOptions

Хром 87+

Характеристики

  • отключитьRulesetIds

    строка[] необязательно

    Набор идентификаторов, соответствующий статическому Ruleset , который следует отключить.

  • EnableRulesetIds

    строка[] необязательно

    Набор идентификаторов, соответствующий статическому Ruleset , который следует включить.

UpdateStaticRulesOptions

Хром 111+

Характеристики

  • отключитьрулеидс

    номер[] необязательно

    Набор идентификаторов, соответствующих правилам в Ruleset , которые необходимо отключить.

  • EnableRuleIds

    номер[] необязательно

    Набор идентификаторов, соответствующих правилам в Ruleset , которые необходимо включить.

  • Идентификатор набора правил

    нить

    Идентификатор, соответствующий статическому Ruleset .

URLTransform

Характеристики

  • фрагмент

    строка необязательна

    Новый фрагмент запроса. Должно быть либо пустым, в этом случае существующий фрагмент очищается; или должен начинаться с '#'.

  • хозяин

    строка необязательна

    Новый хост для запроса.

  • пароль

    строка необязательна

    Новый пароль для запроса.

  • путь

    строка необязательна

    Новый путь для запроса. Если пусто, существующий путь очищается.

  • порт

    строка необязательна

    Новый порт для запроса. Если пусто, существующий порт очищается.

  • запрос

    строка необязательна

    Новый запрос для запроса. Должно быть либо пустым, в этом случае существующий запрос очищается; или должно начинаться с '?'.

  • запросПреобразование

    QueryTransform необязательно

    Добавляйте, удаляйте или заменяйте пары ключ-значение запроса.

  • схема

    строка необязательна

    Новая схема запроса. Допустимые значения: «http», «https», «ftp» и «chrome-extension».

  • имя пользователя

    строка необязательна

    Новое имя пользователя для запроса.

Характеристики

DYNAMIC_RULESET_ID

Идентификатор набора правил для динамических правил, добавляемых расширением.

Ценить

"_динамический"

GETMATCHEDRULES_QUOTA_INTERVAL

Интервал времени, в течение которого могут быть выполнены вызовы MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL getMatchedRules , указан в минутах. Дополнительные вызовы немедленно завершатся ошибкой и будут установлены runtime.lastError . Примечание. Вызовы getMatchedRules , связанные с жестом пользователя, не подпадают под действие квоты.

Ценить

10

GUARANTEED_MINIMUM_STATIC_RULES

Хром 89+

Минимальное количество статических правил, гарантированное расширению во всех включенных статических наборах правил. Любые правила, превышающие этот предел, будут учитываться в глобальном лимите статических правил .

Ценить

30000

MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL

Сколько раз getMatchedRules можно вызывать в течение периода GETMATCHEDRULES_QUOTA_INTERVAL .

Ценить

20

MAX_NUMBER_OF_DYNAMIC_RULES

Максимальное количество динамических правил, которые может добавить расширение.

Ценить

30000

MAX_NUMBER_OF_ENABLED_STATIC_RULESETS

Хром 94+

Максимальное количество статических Rulesets расширение может включить одновременно.

Ценить

50

MAX_NUMBER_OF_REGEX_RULES

Максимальное количество правил регулярных выражений, которое может добавить расширение. Это ограничение оценивается отдельно для набора динамических правил и правил, указанных в файле ресурсов правил.

Ценить

1000

MAX_NUMBER_OF_SESSION_RULES

Хром 120+

Максимальное количество правил области сеанса, которое может добавить расширение.

Ценить

5000

MAX_NUMBER_OF_STATIC_RULESETS

Максимальное количество статических Rulesets расширение может указать как часть ключа манифеста "rule_resources" .

Ценить

100

MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES

Хром 120+

Максимальное количество «небезопасных» динамических правил, которые может добавить расширение.

Ценить

5000

MAX_NUMBER_OF_UNSAFE_SESSION_RULES

Хром 120+

Максимальное количество «небезопасных» правил области сеанса, которые может добавить расширение.

Ценить

5000

SESSION_RULESET_ID

Хром 90+

Идентификатор набора правил для правил на уровне сеанса, добавленных расширением.

Ценить

"_сессия"

Методы

getAvailableStaticRuleCount()

Хром 89+
chrome.declarativeNetRequest.getAvailableStaticRuleCount(): Promise<number>

Возвращает количество статических правил, которые расширение может включить до того, как будет достигнут глобальный предел статических правил .

Возврат

  • Обещание<число>

    Хром 91+

getDisabledRuleIds()

Хром 111+
chrome.declarativeNetRequest.getDisabledRuleIds(
  options: GetDisabledRuleIdsOptions,
): Promise<number[]>

Возвращает список статических правил в данном Ruleset , которые в данный момент отключены.

Параметры

Возврат

  • Обещание<номер[]>

getDynamicRules()

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

Возвращает текущий набор динамических правил для расширения. Вызывающие могут дополнительно фильтровать список выбранных правил, указав filter .

Параметры

  • фильтр

    GetRulesFilter необязательно

    Хром 111+

    Объект для фильтрации списка выбранных правил.

Возврат

getEnabledRulesets()

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

Возвращает идентификаторы текущего набора включенных статических наборов правил.

Возврат

  • Обещание<string[]>

    Хром 91+

getMatchedRules()

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

Возвращает все правила, соответствующие расширению. Вызывающие могут дополнительно фильтровать список совпадающих правил, указав filter . Этот метод доступен только расширениям с разрешением "declarativeNetRequestFeedback" или разрешением "activeTab" , предоставленным для tabId , указанного в filter . Примечание. Правила, не связанные с активным документом, сопоставленные более пяти минут назад, не будут возвращены.

Параметры

  • фильтр

    MatchedRulesFilter необязательно

    Объект для фильтрации списка совпадающих правил.

Возврат

getSessionRules()

Хром 90+
chrome.declarativeNetRequest.getSessionRules(
  filter?: GetRulesFilter,
): Promise<Rule[]>

Возвращает текущий набор правил области сеанса для расширения. Вызывающие могут дополнительно фильтровать список выбранных правил, указав filter .

Параметры

  • фильтр

    GetRulesFilter необязательно

    Хром 111+

    Объект для фильтрации списка выбранных правил.

Возврат

isRegexSupported()

Хром 87+
chrome.declarativeNetRequest.isRegexSupported(
  regexOptions: RegexOptions,
): Promise<IsRegexSupportedResult>

Проверяет, будет ли данное регулярное выражение поддерживаться в качестве условия правила regexFilter .

Параметры

Возврат

setExtensionActionOptions()

Хром 88+
chrome.declarativeNetRequest.setExtensionActionOptions(
  options: ExtensionActionOptions,
): Promise<void>

Определяет, должно ли количество действий для вкладок отображаться в виде текста значка действия расширения, и обеспечивает возможность увеличения этого количества действий.

Параметры

Возврат

  • Обещание<void>

    Хром 91+

testMatchOutcome()

Хром 103+
chrome.declarativeNetRequest.testMatchOutcome(
  request: TestMatchRequestDetails,
): Promise<TestMatchOutcomeResult>

Проверяет, будет ли какое-либо из правил declarativeNetRequest расширения соответствовать гипотетическому запросу. Примечание. Доступно только для распакованных расширений, поскольку оно предназначено только для использования во время разработки расширений.

Параметры

Возврат

updateDynamicRules()

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

Изменяет текущий набор динамических правил для расширения. Правила с идентификаторами, указанными в options.removeRuleIds , сначала удаляются, а затем добавляются правила, указанные в options.addRules . Примечания:

  • Это обновление происходит как одна атомарная операция: либо все указанные правила добавляются и удаляются, либо возвращается ошибка.
  • Эти правила сохраняются во всех сеансах браузера и при обновлении расширений.
  • Статические правила, указанные как часть пакета расширения, нельзя удалить с помощью этой функции.
  • MAX_NUMBER_OF_DYNAMIC_RULES — максимальное количество динамических правил, которые может добавить расширение. Количество небезопасных правил не должно превышать MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES .

Параметры

Возврат

  • Обещание<void>

    Хром 91+

updateEnabledRulesets()

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

Обновляет набор включенных статических наборов правил для расширения. Наборы правил с идентификаторами, перечисленными в options.disableRulesetIds , сначала удаляются, а затем добавляются наборы правил, перечисленные в options.enableRulesetIds . Обратите внимание, что набор включенных статических наборов правил сохраняется между сеансами, но не между обновлениями расширений, т. е. ключ манифеста rule_resources будет определять набор включенных статических наборов правил при каждом обновлении расширения.

Параметры

Возврат

  • Обещание<void>

    Хром 91+

updateSessionRules()

Хром 90+
chrome.declarativeNetRequest.updateSessionRules(
  options: UpdateRuleOptions,
): Promise<void>

Изменяет текущий набор правил области сеанса для расширения. Правила с идентификаторами, указанными в options.removeRuleIds , сначала удаляются, а затем добавляются правила, указанные в options.addRules . Примечания:

  • Это обновление происходит как одна атомарная операция: либо все указанные правила добавляются и удаляются, либо возвращается ошибка.
  • Эти правила не сохраняются между сеансами и сохраняются в памяти.
  • MAX_NUMBER_OF_SESSION_RULES — максимальное количество правил сеанса, которое может добавить расширение.

Параметры

Возврат

  • Обещание<void>

    Хром 91+

updateStaticRules()

Хром 111+
chrome.declarativeNetRequest.updateStaticRules(
  options: UpdateStaticRulesOptions,
): Promise<void>

Отключает и включает отдельные статические правила в Ruleset . Изменения правил, принадлежащих отключенному Ruleset вступят в силу при следующем включении этого набора.

Параметры

Возврат

  • Обещание<void>

События

onRuleMatchedDebug

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

Запускается, когда правило соответствует запросу. Доступно только для распакованных расширений с разрешением "declarativeNetRequestFeedback" поскольку оно предназначено для использования только в целях отладки.

Параметры