chrome.declarativeNetRequest

Descripción

La API de chrome.declarativeNetRequest se usa para bloquear o modificar solicitudes de red mediante la especificación de reglas declarativas. Esto permite que las extensiones modifiquen las solicitudes de red sin interceptarlas ni ver su contenido, lo que proporciona más privacidad.

Permisos

declarativeNetRequest
declarativeNetRequestWithHostAccess

Los permisos "declarativeNetRequest" y "declarativeNetRequestWithHostAccess" proporcionan las mismas funciones. La diferencia entre ellos es cuándo se solicitan o otorgan los permisos.

"declarativeNetRequest"
Ejecuta una advertencia de permiso en el momento de la instalación, pero proporciona acceso implícito a las reglas allow, allowAllRequests y block. Úsalo cuando sea posible para evitar tener que solicitar acceso completo a los hosts.
"declarativeNetRequestFeedback"
Habilita las funciones de depuración para las extensiones descomprimidas, específicamente getMatchedRules() y onRuleMatchedDebug.
"declarativeNetRequestWithHostAccess"
No se muestra una advertencia de permiso en el momento de la instalación, pero debes solicitar permisos de host antes de poder realizar cualquier acción en un host. Esto es apropiado cuando deseas usar reglas de solicitud de red declarativas en una extensión que ya tiene permisos de host sin generar advertencias adicionales.

Disponibilidad

Chrome 84 y versiones posteriores

Manifiesto

Además de los permisos descritos anteriormente, ciertos tipos de conjuntos de reglas, en particular los estáticos, requieren declarar la clave de manifiesto "declarative_net_request", que debe ser un diccionario con una sola clave llamada "rule_resources". Esta clave es un array que contiene diccionarios del tipo Ruleset, como se muestra a continuación. (Ten en cuenta que el nombre "Ruleset" no aparece en el JSON del manifiesto, ya que es solo un array). Más adelante en este documento, se explican los conjuntos de reglas estáticos.

{
  "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/*"
  ],
  ...
}

Reglas y conjuntos de reglas

Para usar esta API, especifica uno o más conjuntos de reglas. Un conjunto de reglas contiene un array de reglas. Una sola regla realiza una de las siguientes acciones:

  • Bloquear una solicitud de red
  • Actualiza el esquema (de HTTP a HTTPS).
  • Evita que se bloquee una solicitud negando las reglas bloqueadas coincidentes.
  • Redireccionar una solicitud de red
  • Modifica los encabezados de solicitud o respuesta.

Existen tres tipos de conjuntos de reglas, que se administran de maneras ligeramente diferentes.

Dinámico
Persisten en las sesiones del navegador y las actualizaciones de extensiones, y se administran con JavaScript mientras se usa una extensión.
Sesión
Se borra cuando se cierra el navegador y cuando se instala una versión nueva de la extensión. Las reglas de sesión se administran con JavaScript mientras se usa una extensión.
Estático
Se empaquetan, instalan y actualizan cuando se instala o actualiza una extensión. Las reglas estáticas se almacenan en archivos de reglas con formato JSON y se enumeran en el archivo de manifiesto.

Conjuntos de reglas dinámicos y centrados en la sesión

Los conjuntos de reglas dinámicos y de sesión se administran con JavaScript mientras se usa una extensión.

  • Las reglas dinámicas persisten en las sesiones del navegador y las actualizaciones de extensiones.
  • Las reglas de sesión se borran cuando se cierra el navegador y cuando se instala una versión nueva de la extensión.

Solo hay uno de cada uno de estos tipos de conjuntos de reglas. Una extensión puede agregar o quitar reglas de forma dinámica llamando a updateDynamicRules() y updateSessionRules(), siempre que no se superen los límites de reglas. Para obtener información sobre los límites de las reglas, consulta Límites de las reglas. Puedes ver un ejemplo de esto en ejemplos de código.

Conjuntos de reglas estáticos

A diferencia de las reglas dinámicas y de sesión, las reglas estáticas se empaquetan, instalan y actualizan cuando se instala o actualiza una extensión. Se almacenan en archivos de reglas en formato JSON, que se indican a la extensión con las claves "declarative_net_request" y "rule_resources" como se describió anteriormente, así como uno o más diccionarios Ruleset. Un diccionario Ruleset contiene una ruta de acceso al archivo de reglas, un ID para el conjunto de reglas que contiene el archivo y si está habilitado o inhabilitado. Los dos últimos son importantes cuando habilitas o inhabilitas un conjunto de reglas de forma programática.

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

Para probar los archivos de reglas, carga la extensión sin empaquetar. Los errores y las advertencias sobre reglas estáticas no válidas solo se muestran para las extensiones descomprimidas. Se ignoran las reglas estáticas no válidas en las extensiones empaquetadas.

Revisión expedita

Es posible que los cambios en los conjuntos de reglas estáticos sean aptos para una revisión acelerada. Consulta la revisión acelerada para cambios aptos.

Habilita y habilita reglas y conjuntos de reglas estáticos

Tanto las reglas estáticas individuales como los conjuntos de reglas estáticos completos se pueden habilitar o inhabilitar durante el tiempo de ejecución.

El conjunto de reglas estáticas y conjuntos de reglas habilitados se conserva en todas las sesiones del navegador. Tampoco se conservan en las actualizaciones de la extensión, lo que significa que solo las reglas que elegiste dejar en tus archivos de reglas estarán disponibles después de una actualización.

Por motivos de rendimiento, también hay límites para la cantidad de reglas y conjuntos de reglas que se pueden habilitar a la vez. Llama a getAvailableStaticRuleCount() para verificar la cantidad de reglas adicionales que se pueden habilitar. Para obtener información sobre los límites de las reglas, consulta Límites de las reglas.

Para habilitar o inhabilitar las reglas estáticas, llama a updateStaticRules(). Este método toma un objeto UpdateStaticRulesOptions, que contiene arreglos de IDs de reglas para habilitar o inhabilitar. Los IDs se definen con la clave "id" del diccionario Ruleset. Existe un límite máximo de 5,000 reglas estáticas inhabilitadas.

Para habilitar o inhabilitar los conjuntos de reglas estáticos, llama a updateEnabledRulesets(). Este método toma un objeto UpdateRulesetOptions, que contiene arreglos de IDs de conjuntos de reglas para habilitar o inhabilitar. Los IDs se definen con la clave "id" del diccionario Ruleset.

Reglas de compilación

Independientemente del tipo, una regla comienza con cuatro campos, como se muestra a continuación. Mientras que las claves "id" y "priority" toman un número, las claves "action" y "condition" pueden proporcionar varias condiciones de bloqueo y redireccionamiento. La siguiente regla bloquea todas las solicitudes de secuencia de comandos que se originan en "foo.com" a cualquier URL con "abc" como subcadena.

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

Coincidencia de URLs

La solicitud de red declarativa permite hacer coincidir URLs con una sintaxis de coincidencia de patrones o expresiones regulares.

Sintaxis del filtro de URL

La clave "condition" de una regla permite una clave "urlFilter" para actuar en las URLs de un dominio especificado. Puedes crear patrones con tokens de coincidencia de patrones. Estos son algunos ejemplos.

urlFilter Combinaciones No coincide
"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

Expresiones regulares

Las condiciones también pueden usar expresiones regulares. Consulta la clave "regexFilter". Para obtener información sobre los limites que se aplican a estas condiciones, consulta Reglas que usan expresiones regulares.

Escribe condiciones de URL adecuadas

Ten cuidado cuando escribas reglas para que siempre coincidan con un dominio completo. De lo contrario, tu regla podría coincidir en situaciones inesperadas. Por ejemplo, cuando se usa la sintaxis de coincidencia de patrones:

  • google.com coincide de forma incorrecta con https://example.com/?param=google.com
  • ||google.com coincide incorrectamente con https://google.company
  • https://www.google.com coincide incorrectamente con https://example.com/?param=https://www.google.com

Considera usar lo siguiente:

  • ||google.com/, que coincide con todas las rutas de acceso y todos los subdominios.
  • |https://www.google.com/, que coincide con todas las rutas y no con subdominios.

Del mismo modo, usa los caracteres ^ y / para fijar una expresión regular. Por ejemplo, ^https:\/\/www\.google\.com\/ coincide con cualquier ruta de acceso en https://www.google.com.

Evaluación de reglas

El navegador aplica las reglas de DNR en varias etapas del ciclo de vida de la solicitud de red.

Antes de la solicitud

Antes de que se realice una solicitud, una extensión puede bloquearla o redireccionarla (incluida la actualización del esquema de HTTP a HTTPS) con una regla coincidente.

Para cada extensión, el navegador determina una lista de reglas de coincidencia. No se incluyen aquí las reglas con una acción modifyHeaders, ya que se controlarán más adelante. Además, las reglas con una condición responseHeaders se considerarán más adelante (cuando los encabezados de respuesta estén disponibles) y no se incluirán.

Luego, para cada extensión, Chrome elige un candidato como máximo por solicitud. Chrome encuentra una regla coincidente ordenando todas las reglas coincidentes por prioridad. Las reglas con la misma prioridad se ordenan por acción (allow o allowAllRequests > block > upgradeScheme > redirect).

Si el candidato es una regla allow o allowAllRequests, o si la trama en la que se realiza la solicitud coincidió anteriormente con una regla allowAllRequests de prioridad superior o igual a esta extensión, la solicitud se "permite" y la extensión no tendrá ningún efecto en ella.

Si más de una extensión quiere bloquear o redireccionar esta solicitud, se elige una sola acción. Para ello, Chrome ordena las reglas en el orden block > redirect o upgradeScheme > allow o allowAllRequests. Si dos reglas son del mismo tipo, Chrome elige la regla de la extensión instalada más recientemente.

Antes de que se envíen los encabezados de la solicitud

Antes de que Chrome envíe encabezados de solicitud al servidor, los encabezados se actualizan en función de las reglas modifyHeaders que coincidan.

Dentro de una sola extensión, Chrome crea la lista de modificaciones que se deben realizar encontrando todas las reglas modifyHeaders que coincidan. Al igual que antes, solo se incluyen las reglas que tienen una prioridad más alta que cualquier regla allow o allowAllRequests coincidente.

Chrome aplica estas reglas en un orden de modo que las reglas de una extensión instalada más recientemente siempre se evalúen antes que las de una extensión más antigua. Además, las reglas de una prioridad más alta de una extensión siempre se aplican antes que las reglas de una prioridad más baja de la misma extensión. En particular, incluso entre extensiones:

  • Si una regla se adjunta a un encabezado, las reglas de menor prioridad solo pueden adjuntarse a ese encabezado. No se permiten las operaciones de configuración ni de eliminación.
  • Si una regla establece un encabezado, solo se pueden agregar a ese encabezado reglas de prioridad inferior de la misma extensión. No se permiten otros cambios.
  • Si una regla quita un encabezado, las reglas de menor prioridad no pueden modificarlo más.

Una vez que se recibe una respuesta

Una vez que se reciben los encabezados de respuesta, Chrome evalúa las reglas con una condición responseHeaders.

Después de ordenar estas reglas por action y priority, y excluir las reglas que se vuelven redundantes por una regla allow o allowAllRequests coincidente (esto ocurre de manera idéntica a los pasos de "Antes de la solicitud"), Chrome puede bloquear o redireccionar la solicitud en nombre de una extensión.

Ten en cuenta que, si una solicitud llegó a esta etapa, significa que ya se envió al servidor y que este recibió datos como el cuerpo de la solicitud. Se seguirá ejecutando una regla de bloqueo o redireccionamiento con una condición de encabezados de respuesta, pero no podrá bloquear ni redireccionar la solicitud.

En el caso de una regla de bloqueo, la página que realizó la solicitud recibe una respuesta bloqueada y Chrome finaliza la solicitud antes de tiempo. En el caso de una regla de redireccionamiento, Chrome realiza una solicitud nueva a la URL redireccionada. Asegúrate de considerar si estos comportamientos cumplen con las expectativas de privacidad de tu extensión.

Si la solicitud no se bloquea ni redirecciona, Chrome aplica las reglas modifyHeaders. La aplicación de modificaciones a los encabezados de respuesta funciona de la misma manera que se describe en "Antes de que se envíen los encabezados de solicitud". Aplicar modificaciones a los encabezados de la solicitud no hace nada, ya que la solicitud ya se realizó.

Reglas seguras

Las reglas seguras se definen como reglas con una acción de block, allow, allowAllRequests o upgradeScheme. Estas reglas están sujetas a una cuota de reglas dinámicas más alta.

Límites de las reglas

Existe una sobrecarga de rendimiento para cargar y evaluar reglas en el navegador, por lo que se aplican algunos límites cuando se usa la API. Los límites dependen del tipo de regla que uses.

Reglas estáticas

Las reglas estáticas son aquellas que se especifican en los archivos de reglas declarados en el archivo de manifiesto. Una extensión puede especificar hasta 100 conjuntos de reglas estáticos como parte de la clave de manifiesto "rule_resources", pero solo se pueden habilitar 50 de estos conjuntos de reglas a la vez. El último se denomina MAX_NUMBER_OF_ENABLED_STATIC_RULESETS. En conjunto, esos conjuntos de reglas tienen garantizadas al menos 30,000 reglas. Esto se denomina GUARANTEED_MINIMUM_STATIC_RULES.

La cantidad de reglas disponibles después de eso depende de cuántas reglas habiliten todas las extensiones instaladas en el navegador de un usuario. Para encontrar este número en el entorno de ejecución, llama a getAvailableStaticRuleCount(). Puedes ver un ejemplo de esto en ejemplos de código.

Reglas de sesión

Una extensión puede tener hasta 5,000 reglas de sesión. Se expone como MAX_NUMBER_OF_SESSION_RULES.

Antes de Chrome 120, había un límite de 5,000 reglas dinámicas y de sesión combinadas.

Normas dinámicas

Una extensión puede tener al menos 5,000 reglas dinámicas. Se expone como MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES.

A partir de Chrome 121, hay un límite más grande de 30,000 reglas disponibles para las reglas dinámicas seguras, expuestas como MAX_NUMBER_OF_DYNAMIC_RULES. Todas las reglas no seguras que se agreguen dentro del límite de 5,000 también se tendrán en cuenta para este límite.

Antes de Chrome 120, había un límite de 5,000 reglas dinámicas y de sesión combinadas.

Reglas que usan expresiones regulares

Todos los tipos de reglas pueden usar expresiones regulares. Sin embargo, la cantidad total de reglas de expresión regular de cada tipo no puede exceder las 1,000. Esto se denomina MAX_NUMBER_OF_REGEX_RULES.

Además, cada regla debe tener menos de 2 KB una vez compilada. Esto se correlaciona de manera aproximada con la complejidad de la regla. Si intentas cargar una regla que supere este límite, verás una advertencia como la siguiente y se ignorará la regla.

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

Interacciones con los service workers

Un objeto declarativeNetRequest solo se aplica a las solicitudes que llegan a la pila de red. Esto incluye las respuestas de la caché HTTP, pero es posible que no incluya las respuestas que pasan por el controlador onfetch de un trabajador de servicio. declarativeNetRequest no afectará las respuestas que genera el trabajador de servicio o que se recuperan de CacheStorage, pero sí afectará las llamadas a fetch() que se realizan en un trabajador de servicio.

Recursos accesibles a través de la Web

Una regla declarativeNetRequest no puede redireccionar desde una solicitud de recurso público a un recurso al que no se puede acceder a través de la Web. De lo contrario, se generará un error. Esto es así incluso si el recurso web accesible especificado es propiedad de la extensión de redireccionamiento. Para declarar recursos para declarativeNetRequest, usa el array "web_accessible_resources" del manifiesto.

Modificación del encabezado

La operación de adición solo es compatible con los siguientes encabezados: 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 y x-forwarded-for.

Ejemplos

Ejemplos de código

Actualiza las reglas dinámicas

En el siguiente ejemplo, se muestra cómo llamar a updateDynamicRules(). El procedimiento para updateSessionRules() es el mismo.

// 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
});

Actualiza los conjuntos de reglas estáticos

En el siguiente ejemplo, se muestra cómo habilitar y deshabilitar conjuntos de reglas teniendo en cuenta la cantidad de conjuntos de reglas estáticos disponibles y la cantidad máxima de conjuntos de reglas estáticos habilitados. Esto se hace cuando la cantidad de reglas estáticas que necesitas supera la cantidad permitida. Para que esto funcione, algunos de tus conjuntos de reglas deben instalarse con algunos inhabilitados (configura "Enabled" como false en el archivo de manifiesto).

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);
}

Ejemplos de reglas

En los siguientes ejemplos, se muestra cómo Chrome prioriza las reglas en una extensión. Cuando las revises, te recomendamos que abras las reglas de priorización en una ventana independiente.

La clave "priority"

Estos ejemplos requieren permiso de host para *://*.example.com/*.

Para determinar la prioridad de una URL en particular, observa la clave "priority" (definida por el desarrollador), la clave "action" y la clave "urlFilter". Estos ejemplos se refieren al archivo de reglas de ejemplo que se muestra debajo de ellos.

Navegación a https://google.com
Dos reglas abarcan esta URL: las reglas con los IDs 1 y 4. Se aplica la regla con el ID 1 porque las acciones "block" tienen una prioridad más alta que las acciones "redirect". Las reglas restantes no se aplican porque son para URLs más largas.
Navegación a https://google.com/1234
Debido a la URL más larga, la regla con el ID 2 ahora coincide además de las reglas con los IDs 1 y 4. Se aplica la regla con el ID 2 porque "allow" tiene una prioridad más alta que "block" y "redirect".
Navegación a https://google.com/12345
Las cuatro reglas coinciden con esta URL. Se aplica la regla con el ID 3 porque su prioridad definida por el desarrollador es la más alta del grupo.
[
  {
    "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"] }
  },
]

Redireccionamientos

El siguiente ejemplo requiere permiso de host para *://*.example.com/*.

En el siguiente ejemplo, se muestra cómo redireccionar una solicitud de example.com a una página dentro de la extensión. La ruta de acceso de la extensión /a.jpg se resuelve en chrome-extension://EXTENSION_ID/a.jpg, donde EXTENSION_ID es el ID de tu extensión. Para que esto funcione, el manifiesto debe declarar /a.jpg como un recurso accesible a través de la Web.

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

En el siguiente ejemplo, se usa la clave "transform" para redireccionar a un subdominio de example.com. Usa un ancla de nombre de dominio ("||") para interceptar solicitudes con cualquier esquema de example.com. La clave "scheme" en "transform" especifica que los redireccionamientos al subdominio siempre usarán "https".

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

En el siguiente ejemplo, se usan expresiones regulares para redireccionar de https://www.abc.xyz.com/path a https://abc.xyz.com/path. En la clave "regexFilter", observa cómo se escapan los períodos y que el grupo de captura selecciona “abc” o “def”. La clave "regexSubstitution" especifica la primera coincidencia que se muestra de la expresión regular con "1". En este caso, "abc" se captura de la URL redireccionada y se coloca en la sustitución.

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

Encabezados

En el siguiente ejemplo, se quitan todas las cookies de un marco principal y de los submarcos.

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

Tipos

DomainType

Indica si la solicitud es propia o de terceros para el marco en el que se originó. Se dice que una solicitud es propia si tiene el mismo dominio (eTLD+1) que el marco en el que se originó.

Enum

"firstParty"
La solicitud de red es propia del marco en el que se originó.

"thirdParty"
La solicitud de red es de terceros para la trama en la que se originó.

ExtensionActionOptions

Chrome 88 y versiones posteriores

Propiedades

  • displayActionCountAsBadgeText

    booleano opcional

    Indica si se debe mostrar automáticamente el recuento de acciones de una página como el texto de la insignia de la extensión. Esta preferencia persiste en todas las sesiones.

  • tabUpdate

    TabActionCountUpdate opcional

    Chrome 89 y versiones posteriores

    Detalles sobre cómo se debe ajustar el recuento de acciones de la pestaña

GetDisabledRuleIdsOptions

Chrome 111 y versiones posteriores

Propiedades

  • rulesetId

    string

    El ID correspondiente a un Ruleset estático.

GetRulesFilter

Chrome 111 y versiones posteriores

Propiedades

  • ruleIds

    number[] opcional

    Si se especifica, solo se incluyen las reglas con IDs coincidentes.

HeaderInfo

Chrome 128 y versiones posteriores

Propiedades

  • excludedValues

    string[] opcional

    Si se especifica, esta condición no coincide si el encabezado existe, pero su valor contiene al menos un elemento de esta lista. Usa la misma sintaxis de patrón de coincidencia que values.

  • encabezado

    string

    Es el nombre del encabezado. Esta condición coincide con el nombre solo si no se especifican values y excludedValues.

  • valores

    string[] opcional

    Si se especifica, esta condición coincide si el valor del encabezado coincide con al menos un patrón de esta lista. Esto admite la coincidencia de valores de encabezado sin distinción entre mayúsculas y minúsculas, además de las siguientes construcciones:

    '*' : Coincide con cualquier cantidad de caracteres.

    '?' : Coincide con cero o un carácter.

    Se puede escapar "*" y "?" con una barra invertida, p. ej., "\*" y "\?".

HeaderOperation

Chrome 86 y versiones posteriores

Aquí se describen las operaciones posibles para una regla "modifyHeaders".

Enum

"append"
Agrega una entrada nueva para el encabezado especificado. Esta operación no se admite para los encabezados de solicitud.

"set"
Establece un valor nuevo para el encabezado especificado y quita los encabezados existentes con el mismo nombre.

"remove"
Quita todas las entradas del encabezado especificado.

IsRegexSupportedResult

Chrome 87 y versiones posteriores

Propiedades

  • isSupported

    booleano

  • Reason

    UnsupportedRegexReason opcional

    Especifica el motivo por el que no se admite la expresión regular. Solo se proporciona si isSupported es falso.

MatchedRule

Propiedades

  • ruleId

    número

    El ID de una regla coincidente.

  • rulesetId

    string

    Es el ID del Ruleset al que pertenece esta regla. Para una regla que proviene del conjunto de reglas dinámicas, será igual a DYNAMIC_RULESET_ID.

MatchedRuleInfo

Propiedades

  • regla

    MatchedRule

  • tabId

    número

    Es el tabId de la pestaña desde la que se originó la solicitud si la pestaña aún está activa. De lo contrario, -1.

  • timeStamp

    número

    Es la hora en que se encontró una coincidencia con la regla. Las marcas de tiempo corresponderán a la convención de JavaScript para las horas, es decir, la cantidad de milisegundos desde la época.

MatchedRuleInfoDebug

Propiedades

  • request

    RequestDetails

    Son los detalles de la solicitud para la que se encontró una coincidencia con la regla.

  • regla

    MatchedRule

MatchedRulesFilter

Propiedades

  • minTimeStamp

    número opcional

    Si se especifica, solo coincide con las reglas posteriores a la marca de tiempo determinada.

  • tabId

    número opcional

    Si se especifica, solo coincide con las reglas de la pestaña determinada. Coincide con las reglas que no están asociadas con ninguna pestaña activa si se establece en -1.

ModifyHeaderInfo

Chrome 86 y versiones posteriores

Propiedades

  • encabezado

    string

    Es el nombre del encabezado que se modificará.

  • operación

    HeaderOperation

    Es la operación que se realizará en un encabezado.

  • valor

    cadena opcional

    Es el valor nuevo del encabezado. Se debe especificar para las operaciones append y set.

QueryKeyValue

Propiedades

  • clave

    string

  • replaceOnly

    booleano opcional

    Chrome 94 y versiones posteriores

    Si es verdadero, la clave de consulta se reemplaza solo si ya está presente. De lo contrario, la clave también se agrega si falta. La configuración predeterminada es "false".

  • valor

    string

QueryTransform

Propiedades

  • addOrReplaceParams

    QueryKeyValue[] opcional

    Es la lista de pares clave-valor de consulta que se agregarán o reemplazarán.

  • removeParams

    string[] opcional

    Es la lista de claves de consulta que se quitarán.

Redirect

Propiedades

  • extensionPath

    cadena opcional

    Es la ruta de acceso relativa al directorio de extensión. Debe comenzar con “/”.

  • regexSubstitution

    cadena opcional

    Patrón de sustitución para reglas que especifican un regexFilter. La primera coincidencia de regexFilter dentro de la URL se reemplazará con este patrón. Dentro de regexSubstitution, se pueden usar dígitos con escape de barra invertida (\1 a \9) para insertar los grupos de captura correspondientes. \0 hace referencia a todo el texto coincidente.

  • transform

    URLTransform opcional

    Transformaciones de URL que se deben realizar.

  • url

    cadena opcional

    La URL de redireccionamiento. No se permiten redireccionamientos a URLs de JavaScript.

RegexOptions

Chrome 87 y versiones posteriores

Propiedades

  • isCaseSensitive

    booleano opcional

    Indica si el regex especificado distingue mayúsculas de minúsculas. La opción predeterminada es true.

  • regex

    string

    Es la expresión regular que se va a verificar.

  • requireCapturing

    booleano opcional

    Indica si el regex especificado requiere captura. La captura solo es necesaria para las reglas de redireccionamiento que especifican una acción regexSubstition. El valor predeterminado es falso.

RequestDetails

Propiedades

  • documentId

    cadena opcional

    Chrome 106 y versiones posteriores

    Es el identificador único del documento del marco, si esta solicitud es para un marco.

  • documentLifecycle

    DocumentLifecycle opcional

    Chrome 106 y versiones posteriores

    El ciclo de vida del documento del marco, si esta solicitud es para un marco

  • frameId

    número

    El valor 0 indica que la solicitud se realiza en el marco principal. Un valor positivo indica el ID de un submarco en el que se realiza la solicitud. Si se carga el documento de un marco (submarco) (type es main_frame o sub_frame), frameId indica el ID de este marco, no el ID del marco exterior. Los IDs de marco son únicos dentro de una pestaña.

  • frameType

    FrameType opcional

    Chrome 106 y versiones posteriores

    Es el tipo de marco, si esta solicitud es para un marco.

  • iniciador

    cadena opcional

    El origen en el que se inició la solicitud. Esto no cambia a través de redireccionamientos. Si se trata de un origen opaco, se usará la cadena "null".

  • method

    string

    Método HTTP estándar.

  • parentDocumentId

    cadena opcional

    Chrome 106 y versiones posteriores

    Es el identificador único del documento superior del marco, si esta solicitud es para un marco y tiene un elemento superior.

  • parentFrameId

    número

    Es el ID de la trama que une la trama que envió la solicitud. Se establece en -1 si no existe un marco superior.

  • requestId

    string

    Es el ID de la solicitud. Los IDs de solicitud son únicos dentro de una sesión del navegador.

  • tabId

    número

    Es el ID de la pestaña en la que se realiza la solicitud. Establece -1 si la solicitud no está relacionada con una pestaña.

  • Es el tipo de recurso de la solicitud.

  • url

    string

    La URL de la solicitud.

RequestMethod

Chrome 91 y versiones posteriores

Aquí se describe el método de solicitud HTTP de una solicitud de red.

Enum

"connect"

"delete"

"get"

"head"

"options"

"patch"

"post"

"put"

"other"

ResourceType

Describe el tipo de recurso de la solicitud de red.

Enum

"main_frame"

"sub_frame"

"stylesheet"

"script"

"image"

"font"

"object"

"xmlhttprequest"

"ping"

"csp_report"

"media"

"websocket"

"webtransport"

"webbundle"

"other"

Rule

Propiedades

  • acción

    RuleAction

    Es la acción que se realizará si coincide esta regla.

  • de transición

    RuleCondition

    Es la condición en la que se activa esta regla.

  • id

    número

    Un ID que identifica de forma exclusiva una regla. Es obligatorio y debe ser mayor o igual que 1.

  • priority

    número opcional

    Prioridad de la regla. El valor predeterminado es 1. Cuando se especifica, debe ser mayor o igual que 1.

RuleAction

Propiedades

  • redireccionamiento

    Redireccionamiento opcional

    Describe cómo se debe realizar el redireccionamiento. Solo es válido para las reglas de redireccionamiento.

  • requestHeaders

    ModifyHeaderInfo[] opcional

    Chrome 86 y versiones posteriores

    Los encabezados de la solicitud que se modificarán para la solicitud. Solo es válido si RuleActionType es "modifyHeaders".

  • responseHeaders

    ModifyHeaderInfo[] opcional

    Chrome 86 y versiones posteriores

    Los encabezados de respuesta que se modificarán para la solicitud. Solo es válido si RuleActionType es "modifyHeaders".

  • Es el tipo de acción que se realizará.

RuleActionType

Describe el tipo de acción que se debe realizar si coincide una RuleCondition determinada.

Enum

"block"
Bloquea la solicitud de red.

"redirect"
Redirecciona la solicitud de red.

"allow"
Permite la solicitud de red. La solicitud no se interceptará si hay una regla de permiso que coincida con ella.

"upgradeScheme"
Actualiza el esquema de la URL de solicitud de red a https si la solicitud es http o ftp.

"modifyHeaders"
Modifica los encabezados de solicitud o respuesta de la solicitud de red.

"allowAllRequests"
Permite todas las solicitudes dentro de una jerarquía de marcos, incluida la solicitud del marco.

RuleCondition

Propiedades

  • domainType

    DomainType opcional

    Especifica si la solicitud de red es propia o de terceros para el dominio del que se originó. Si se omite, se aceptan todas las solicitudes.

  • dominios

    string[] opcional

    Se dejó de usar desde Chrome 101

    Usa initiatorDomains en su lugar.

    La regla solo coincidirá con las solicitudes de red que provengan de la lista de domains.

  • excludedDomains

    string[] opcional

    Se dejó de usar desde Chrome 101

    Usa excludedInitiatorDomains en su lugar.

    La regla no coincidirá con las solicitudes de red que se originen en la lista de excludedDomains.

  • excludedInitiatorDomains

    string[] opcional

    Chrome 101 y versiones posteriores

    La regla no coincidirá con las solicitudes de red que se originen en la lista de excludedInitiatorDomains. Si la lista está vacía o se omite, no se excluyen dominios. Esto tiene prioridad sobre initiatorDomains.

    Notas:

    • También se permiten subdominios, como "a.example.com".
    • Las entradas deben contener solo caracteres ASCII.
    • Usa la codificación Punycode para los dominios internacionalizados.
    • Esto coincide con el iniciador de la solicitud, no con la URL de la solicitud.
    • También se excluyen los subdominios de los dominios enumerados.
  • excludedRequestDomains

    string[] opcional

    Chrome 101 y versiones posteriores

    La regla no coincidirá con las solicitudes de red cuando los dominios coincidan con uno de la lista de excludedRequestDomains. Si la lista está vacía o se omite, no se excluyen dominios. Esto tiene prioridad sobre requestDomains.

    Notas:

    • También se permiten subdominios, como "a.example.com".
    • Las entradas deben contener solo caracteres ASCII.
    • Usa la codificación Punycode para los dominios internacionalizados.
    • También se excluyen los subdominios de los dominios enumerados.
  • excludedRequestMethods

    RequestMethod[] opcional

    Chrome 91 y versiones posteriores

    Es la lista de métodos de solicitud con los que no coincidirá la regla. Solo se debe especificar una de requestMethods y excludedRequestMethods. Si no se especifica ninguno de ellos, se coinciden todos los métodos de solicitud.

  • excludedResourceTypes

    ResourceType[] opcional

    Es la lista de tipos de recursos con los que no coincidirá la regla. Solo se debe especificar una de resourceTypes y excludedResourceTypes. Si no se especifica ninguno de ellos, se bloquean todos los tipos de recursos, excepto "main_frame".

  • excludedResponseHeaders

    HeaderInfo[] opcional

    Chrome 128 y versiones posteriores

    La regla no coincide si la solicitud coincide con alguna condición del encabezado de respuesta de esta lista (si se especifica). Si se especifican excludedResponseHeaders y responseHeaders, la propiedad excludedResponseHeaders tiene prioridad.

  • excludedTabIds

    number[] opcional

    Chrome 92 y versiones posteriores

    Es una lista de tabs.Tab.id con los que la regla no debe coincidir. Un ID de tabs.TAB_ID_NONE excluye las solicitudes que no se originan en una pestaña. Solo se admite para reglas centradas en la sesión.

  • initiatorDomains

    string[] opcional

    Chrome 101 y versiones posteriores

    La regla solo coincidirá con las solicitudes de red que provengan de la lista de initiatorDomains. Si se omite la lista, la regla se aplica a las solicitudes de todos los dominios. No se permite una lista vacía.

    Notas:

    • También se permiten subdominios, como "a.example.com".
    • Las entradas deben contener solo caracteres ASCII.
    • Usa la codificación Punycode para los dominios internacionalizados.
    • Esto coincide con el iniciador de la solicitud, no con la URL de la solicitud.
    • También se incluyen los subdominios de los dominios enumerados.
  • isUrlFilterCaseSensitive

    booleano opcional

    Si urlFilter o regexFilter (lo que se especifique) distingue mayúsculas de minúsculas. El valor predeterminado es falso.

  • regexFilter

    cadena opcional

    Expresión regular que coincide con la URL de la solicitud de red. Esto sigue la sintaxis RE2.

    Nota: Solo se puede especificar una de urlFilter o regexFilter.

    Nota: regexFilter debe estar compuesto solo de caracteres ASCII. Se compara con una URL en la que el host está codificado en formato Punycode (en el caso de los dominios internacionalizados) y cualquier otro carácter que no sea ASCII está codificado en formato UTF-8.

  • requestDomains

    string[] opcional

    Chrome 101 y versiones posteriores

    La regla solo coincidirá con las solicitudes de red cuando el dominio coincida con uno de la lista de requestDomains. Si se omite la lista, la regla se aplica a las solicitudes de todos los dominios. No se permite una lista vacía.

    Notas:

    • También se permiten subdominios, como "a.example.com".
    • Las entradas deben contener solo caracteres ASCII.
    • Usa la codificación Punycode para los dominios internacionalizados.
    • También se incluyen los subdominios de los dominios enumerados.
  • requestMethods

    RequestMethod[] opcional

    Chrome 91 y versiones posteriores

    Es la lista de métodos de solicitud HTTP con los que puede coincidir la regla. No se permite una lista vacía.

    Nota: Si especificas una condición de regla requestMethods, también se excluirán las solicitudes que no sean HTTP(s), mientras que si especificas excludedRequestMethods, no se excluirán.

  • resourceTypes

    ResourceType[] opcional

    Es la lista de tipos de recursos con los que puede coincidir la regla. No se permite una lista vacía.

    Nota: Esto se debe especificar para las reglas allowAllRequests y solo puede incluir los tipos de recursos sub_frame y main_frame.

  • responseHeaders

    HeaderInfo[] opcional

    Chrome 128 y versiones posteriores

    La regla coincide si la solicitud coincide con alguna condición del encabezado de respuesta de esta lista (si se especifica).

  • tabIds

    number[] opcional

    Chrome 92 y versiones posteriores

    Es una lista de tabs.Tab.id con los que debe coincidir la regla. Un ID de tabs.TAB_ID_NONE coincide con las solicitudes que no se originan en una pestaña. No se permite una lista vacía. Solo se admite para reglas centradas en la sesión.

  • urlFilter

    cadena opcional

    Es el patrón que coincide con la URL de la solicitud de red. Construciones admitidas:

    '*' : Comodín: Coincide con cualquier cantidad de caracteres.

    '|' : Anclaje izquierdo o derecho: Si se usa en cualquiera de los extremos del patrón, especifica el principio o el final de la URL, respectivamente.

    '||' : Anclaje de nombre de dominio: Si se usa al comienzo del patrón, especifica el inicio de un dominio (subdominio) de la URL.

    '^': Es un carácter separador que coincide con cualquier elemento, excepto una letra, un dígito o uno de los siguientes: _, -, . o %. Esto también coincide con el final de la URL.

    Por lo tanto, urlFilter se compone de las siguientes partes: (anclaje opcional de nombre de dominio/izquierda) + patrón + (anclaje opcional de derecha).

    Si se omite, se hacen coincidir todas las URLs. No se permite una cadena vacía.

    No se permite un patrón que comience con ||*. Usa * en su lugar.

    Nota: Solo se puede especificar una de urlFilter o regexFilter.

    Nota: urlFilter debe estar compuesto solo de caracteres ASCII. Se compara con una URL en la que el host está codificado en formato Punycode (en el caso de los dominios internacionalizados) y cualquier otro carácter que no sea ASCII está codificado en formato UTF-8. Por ejemplo, cuando la URL de la solicitud es http://abc.рф?q=ф, el urlFilter coincidirá con la URL http://abc.xn--p1ai/?q=%D1%84.

Ruleset

Propiedades

  • habilitado

    booleano

    Indica si el conjunto de reglas está habilitado de forma predeterminada.

  • id

    string

    Es una cadena no vacía que identifica de forma exclusiva el conjunto de reglas. Los IDs que comienzan con "_" están reservados para uso interno.

  • ruta de acceso

    string

    Es la ruta del conjunto de reglas JSON en relación con el directorio de la extensión.

RulesMatchedDetails

Propiedades

  • rulesMatchedInfo

    MatchedRuleInfo[]

    Son las reglas que coinciden con el filtro determinado.

TabActionCountUpdate

Chrome 89 y versiones posteriores

Propiedades

  • increment

    número

    Es la cantidad por la que se incrementará el recuento de acciones de la pestaña. Los valores negativos disminuirán el recuento.

  • tabId

    número

    Es la pestaña para la que se actualizará el recuento de acciones.

TestMatchOutcomeResult

Chrome 103 y versiones posteriores

Propiedades

  • matchedRules

    MatchedRule[]

    Las reglas (si las hay) que coinciden con la solicitud hipotética

TestMatchRequestDetails

Chrome 103 y versiones posteriores

Propiedades

  • iniciador

    cadena opcional

    La URL del iniciador (si la hay) para la solicitud hipotética.

  • method

    RequestMethod opcional

    Es el método HTTP estándar de la solicitud hipotética. El valor predeterminado es “get” para las solicitudes HTTP y se ignora para las solicitudes que no son HTTP.

  • responseHeaders

    objeto opcional

    Chrome 129 y versiones posteriores

    Los encabezados que proporciona una respuesta hipotética si la solicitud no se bloquea ni redirecciona antes de que se envíe. Se representa como un objeto que asigna un nombre de encabezado a una lista de valores de cadena. Si no se especifica, la respuesta hipotética mostrará encabezados de respuesta vacíos, que pueden coincidir con reglas que coinciden con la no existencia de encabezados. P. ej., {"content-type": ["text/html; charset=utf-8", "multipart/form-data"]}

  • tabId

    número opcional

    El ID de la pestaña en la que se realiza la solicitud hipotética. No es necesario que corresponda a un ID de pestaña real. El valor predeterminado es -1, lo que significa que la solicitud no está relacionada con una pestaña.

  • Es el tipo de recurso de la solicitud hipotética.

  • url

    string

    La URL de la solicitud hipotética.

UnsupportedRegexReason

Chrome 87 y versiones posteriores

Describe el motivo por el que no se admite una expresión regular determinada.

Enum

"syntaxError"
La expresión regular es sintácticamente incorrecta o usa funciones que no están disponibles en la sintaxis RE2.

"memoryLimitExceeded"
La expresión regular supera el límite de memoria.

UpdateRuleOptions

Chrome 87 y versiones posteriores

Propiedades

  • addRules

    Rule[] opcional

    Reglas que se agregarán.

  • removeRuleIds

    number[] opcional

    IDs de las reglas que se quitarán. Se ignorarán los IDs no válidos.

UpdateRulesetOptions

Chrome 87 y versiones posteriores

Propiedades

  • disableRulesetIds

    string[] opcional

    Es el conjunto de IDs correspondientes a un Ruleset estático que se debe inhabilitar.

  • enableRulesetIds

    string[] opcional

    Es el conjunto de IDs correspondientes a un Ruleset estático que se debe habilitar.

UpdateStaticRulesOptions

Chrome 111 y versiones posteriores

Propiedades

  • disableRuleIds

    number[] opcional

    Es un conjunto de IDs correspondientes a las reglas de Ruleset que se inhabilitarán.

  • enableRuleIds

    number[] opcional

    Es un conjunto de IDs correspondientes a las reglas en Ruleset que se habilitarán.

  • rulesetId

    string

    El ID correspondiente a un Ruleset estático.

URLTransform

Propiedades

  • fragment

    cadena opcional

    El nuevo fragmento para la solicitud. Debe estar vacío, en cuyo caso se borra el fragmento existente, o debe comenzar con "#".

  • host

    cadena opcional

    El nuevo host de la solicitud.

  • contraseña

    cadena opcional

    La contraseña nueva para la solicitud.

  • ruta de acceso

    cadena opcional

    Es la ruta nueva para la solicitud. Si está vacío, se borra la ruta existente.

  • puerto

    cadena opcional

    El puerto nuevo para la solicitud Si está vacío, se borra el puerto existente.

  • consulta

    cadena opcional

    Es la nueva consulta de la solicitud. Debe estar vacío, en cuyo caso se borra la consulta existente, o debe comenzar con "?".

  • queryTransform

    QueryTransform opcional

    Agrega, quita o reemplaza los pares clave-valor de la consulta.

  • esquema

    cadena opcional

    El nuevo esquema de la solicitud. Los valores permitidos son “http”, “https”, “ftp” y “chrome-extension”.

  • username

    cadena opcional

    El nuevo nombre de usuario para la solicitud.

Propiedades

DYNAMIC_RULESET_ID

Es el ID del conjunto de reglas para las reglas dinámicas que agrega la extensión.

Valor

"_dynamic"

GETMATCHEDRULES_QUOTA_INTERVAL

Es el intervalo de tiempo dentro del cual se pueden realizar llamadas a MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL getMatchedRules, especificado en minutos. Las llamadas adicionales fallarán de inmediato y establecerán runtime.lastError. Nota: Las llamadas a getMatchedRules asociadas con un gesto del usuario están exentas de la cuota.

Valor

10

GUARANTEED_MINIMUM_STATIC_RULES

Chrome 89 y versiones posteriores

Es la cantidad mínima de reglas estáticas garantizadas para una extensión en sus conjuntos de reglas estáticas habilitados. Todas las reglas que superen este límite se tendrán en cuenta para el límite de reglas estáticas globales.

Valor

30000

MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL

Es la cantidad de veces que se puede llamar a getMatchedRules en un período de GETMATCHEDRULES_QUOTA_INTERVAL.

Valor

20

MAX_NUMBER_OF_DYNAMIC_RULES

Es la cantidad máxima de reglas dinámicas que puede agregar una extensión.

Valor

30000

MAX_NUMBER_OF_ENABLED_STATIC_RULESETS

Chrome 94 y versiones posteriores

Es la cantidad máxima de Rulesets estáticos que una extensión puede habilitar a la vez.

Valor

50

MAX_NUMBER_OF_REGEX_RULES

Es la cantidad máxima de reglas de expresiones regulares que puede agregar una extensión. Este límite se evalúa por separado para el conjunto de reglas dinámicas y las que se especifican en el archivo de recursos de reglas.

Valor

1,000

MAX_NUMBER_OF_SESSION_RULES

Chrome 120 y versiones posteriores

Es la cantidad máxima de reglas centradas en la sesión que puede agregar una extensión.

Valor

5,000

MAX_NUMBER_OF_STATIC_RULESETS

Es la cantidad máxima de Rulesets estáticos que una extensión puede especificar como parte de la clave de manifiesto "rule_resources".

Valor

100

MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES

Chrome 120 y versiones posteriores

Es la cantidad máxima de reglas dinámicas "no seguras" que puede agregar una extensión.

Valor

5,000

MAX_NUMBER_OF_UNSAFE_SESSION_RULES

Chrome 120 y versiones posteriores

Es la cantidad máxima de reglas centradas en la sesión "no seguras" que puede agregar una extensión.

Valor

5,000

SESSION_RULESET_ID

Chrome 90 y versiones posteriores

Es el ID del conjunto de reglas para las reglas centradas en la sesión que agrega la extensión.

Valor

"_session"

Métodos

getAvailableStaticRuleCount()

Promesa Chrome 89 y versiones posteriores 
chrome.declarativeNetRequest.getAvailableStaticRuleCount(
  callback?: function,
)

Muestra la cantidad de reglas estáticas que una extensión puede habilitar antes de alcanzar el límite de reglas estáticas globales.

Parámetros

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (count: number) => void

    • count

      número

Muestra

  • Promise<number>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

getDisabledRuleIds()

Promesa Chrome 111 y versiones posteriores 
chrome.declarativeNetRequest.getDisabledRuleIds(
  options: GetDisabledRuleIdsOptions,
  callback?: function,
)

Muestra la lista de reglas estáticas en el Ruleset determinado que están inhabilitadas actualmente.

Parámetros

  • Especifica el conjunto de reglas para consultar.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (disabledRuleIds: number[]) => void

    • disabledRuleIds

      number[]

Muestra

  • Promise<number[]>

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

getDynamicRules()

Promesa 
chrome.declarativeNetRequest.getDynamicRules(
  filter?: GetRulesFilter,
  callback?: function,
)

Muestra el conjunto actual de reglas dinámicas para la extensión. De manera opcional, los emisores pueden filtrar la lista de reglas recuperadas si especifican un filter.

Parámetros

  • filter

    GetRulesFilter opcional

    Chrome 111 y versiones posteriores

    Un objeto para filtrar la lista de reglas recuperadas.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (rules: Rule[]) => void

Muestra

  • Promise<Rule[]>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

getEnabledRulesets()

Promesa 
chrome.declarativeNetRequest.getEnabledRulesets(
  callback?: function,
)

Muestra los IDs del conjunto actual de conjuntos de reglas estáticas habilitados.

Parámetros

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (rulesetIds: string[]) => void

    • rulesetIds

      string[]

Muestra

  • Promise<string[]>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

getMatchedRules()

Promesa 
chrome.declarativeNetRequest.getMatchedRules(
  filter?: MatchedRulesFilter,
  callback?: function,
)

Muestra todas las reglas que coinciden con la extensión. De manera opcional, los emisores pueden filtrar la lista de reglas coincidentes especificando un filter. Este método solo está disponible para las extensiones con el permiso "declarativeNetRequestFeedback" o que tienen el permiso "activeTab" otorgado para el tabId especificado en filter. Nota: No se mostrarán las reglas no asociadas con un documento activo que coincidan con una búsqueda realizada hace más de cinco minutos.

Parámetros

Muestra

  • Chrome 91 y versiones posteriores

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

getSessionRules()

Promesa Chrome 90 y versiones posteriores 
chrome.declarativeNetRequest.getSessionRules(
  filter?: GetRulesFilter,
  callback?: function,
)

Muestra el conjunto actual de reglas centradas en la sesión para la extensión. De manera opcional, los emisores pueden filtrar la lista de reglas recuperadas si especifican un filter.

Parámetros

  • filter

    GetRulesFilter opcional

    Chrome 111 y versiones posteriores

    Un objeto para filtrar la lista de reglas recuperadas.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (rules: Rule[]) => void

Muestra

  • Promise<Rule[]>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

isRegexSupported()

Promesa Chrome 87 y versiones posteriores 
chrome.declarativeNetRequest.isRegexSupported(
  regexOptions: RegexOptions,
  callback?: function,
)

Comprueba si la expresión regular determinada se admitirá como condición de la regla regexFilter.

Parámetros

Muestra

  • Chrome 91 y versiones posteriores

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

setExtensionActionOptions()

Promesa Chrome 88 y versiones posteriores 
chrome.declarativeNetRequest.setExtensionActionOptions(
  options: ExtensionActionOptions,
  callback?: function,
)

Configura si el recuento de acciones de las pestañas se debe mostrar como el texto de la insignia de la acción de la extensión y proporciona una forma de incrementar ese recuento.

Parámetros

  • callback

    función opcional

    Chrome 89 y versiones posteriores

    El parámetro callback se ve de la siguiente manera: 

    () => void

Muestra

  • Promise<void>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

testMatchOutcome()

Promesa Chrome 103 y versiones posteriores 
chrome.declarativeNetRequest.testMatchOutcome(
  request: TestMatchRequestDetails,
  callback?: function,
)

Verifica si alguna de las reglas de declarativeNetRequest de la extensión coincidiría con una solicitud hipotética. Nota: Solo está disponible para extensiones descomprimidas, ya que solo se diseñó para usarse durante el desarrollo de extensiones.

Parámetros

Muestra

  • Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

updateDynamicRules()

Promesa 
chrome.declarativeNetRequest.updateDynamicRules(
  options: UpdateRuleOptions,
  callback?: function,
)

Modifica el conjunto actual de reglas dinámicas de la extensión. Primero, se quitan las reglas con los IDs que se indican en options.removeRuleIds y, luego, se agregan las reglas que se indican en options.addRules. Notas:

  • Esta actualización se realiza como una sola operación atómica: se agregan y quitan todas las reglas especificadas, o se muestra un error.
  • Estas reglas se conservan en las sesiones del navegador y en las actualizaciones de la extensión.
  • No se pueden quitar las reglas estáticas especificadas como parte del paquete de extensión con esta función.
  • MAX_NUMBER_OF_DYNAMIC_RULES es la cantidad máxima de reglas dinámicas que puede agregar una extensión. La cantidad de reglas no seguras no debe superar MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES.

Parámetros

  • Chrome 87 y versiones posteriores
  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

Muestra

  • Promise<void>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

updateEnabledRulesets()

Promesa 
chrome.declarativeNetRequest.updateEnabledRulesets(
  options: UpdateRulesetOptions,
  callback?: function,
)

Actualiza el conjunto de conjuntos de reglas estáticas habilitados para la extensión. Primero, se quitan los conjuntos de reglas con los IDs que se indican en options.disableRulesetIds y, luego, se agregan los conjuntos de reglas que se indican en options.enableRulesetIds. Ten en cuenta que el conjunto de conjuntos de reglas estáticos habilitados se conserva en todas las sesiones, pero no en todas las actualizaciones de la extensión, es decir, la clave de manifiesto rule_resources determinará el conjunto de conjuntos de reglas estáticos habilitados en cada actualización de la extensión.

Parámetros

  • Chrome 87 y versiones posteriores
  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

Muestra

  • Promise<void>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

updateSessionRules()

Promesa Chrome 90 y versiones posteriores 
chrome.declarativeNetRequest.updateSessionRules(
  options: UpdateRuleOptions,
  callback?: function,
)

Modifica el conjunto actual de reglas centradas en la sesión para la extensión. Primero, se quitan las reglas con los IDs que se indican en options.removeRuleIds y, luego, se agregan las reglas que se indican en options.addRules. Notas:

  • Esta actualización se realiza como una sola operación atómica: se agregan y quitan todas las reglas especificadas, o se muestra un error.
  • Estas reglas no se conservan en todas las sesiones y se respaldan en la memoria.
  • MAX_NUMBER_OF_SESSION_RULES es la cantidad máxima de reglas de sesión que puede agregar una extensión.

Parámetros

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

Muestra

  • Promise<void>

    Chrome 91 y versiones posteriores

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

updateStaticRules()

Promesa Chrome 111 y versiones posteriores 
chrome.declarativeNetRequest.updateStaticRules(
  options: UpdateStaticRulesOptions,
  callback?: function,
)

Inhabilita y habilita reglas estáticas individuales en un Ruleset. Los cambios en las reglas que pertenecen a un Ruleset inhabilitado se aplicarán la próxima vez que se habilite.

Parámetros

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

Muestra

  • Promise<void>

    Las promesas son compatibles con el manifiesto V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para la retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

Eventos

onRuleMatchedDebug

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

Se activa cuando una regla coincide con una solicitud. Solo está disponible para extensiones descomprimidas con el permiso "declarativeNetRequestFeedback", ya que está diseñado para usarse solo con fines de depuración.

Parámetros