chrome.declarativeNetRequest

Descripción

La API de chrome.declarativeNetRequest se usa para bloquear o modificar solicitudes de red especificando 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

declarativeNetRequestFeedback
host_permissions

Disponibilidad

Chrome 84 y versiones posteriores

Manifiesto

Además de los permisos descritos anteriormente, ciertos tipos de conjuntos de reglas, específicamente los conjuntos de reglas estáticos, requieren que se declare 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 de 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). Los conjuntos de reglas estáticos se explican más adelante en este documento.

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

Conceptos y uso

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:

  • Bloquea una solicitud de red.
  • Actualiza el esquema (de HTTP a HTTPS).
  • Evita que se bloquee una solicitud negando cualquier regla bloqueada coincidente.
  • Redirige una solicitud de red.
  • Modificar los encabezados de solicitud o respuesta

Existen tres tipos de conjuntos de reglas, que se administran de formas 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 nueva versión de la extensión. Las reglas de sesión se administran con JavaScript mientras se usa una extensión.
Estática
Se empaqueta, instala y actualiza 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.

En las siguientes secciones, se explican los tipos de conjuntos de reglas en detalle.

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 en las actualizaciones de la extensión.
  • Las reglas de sesión se borran cuando se cierra el navegador y cuando se instala una nueva versión de la extensión.

Solo hay un conjunto de reglas de cada uno de estos tipos. Una extensión puede agregar o quitar reglas de forma dinámica llamando a updateDynamicRules() y updateSessionRules(), siempre que no se excedan los límites de reglas. Para obtener información sobre los límites de reglas, consulta Límites de 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 el conjunto de reglas 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 tu extensión sin empaquetar. Los errores y las advertencias sobre reglas estáticas no válidas solo se muestran para las extensiones sin empaquetar. Se ignoran las reglas estáticas no válidas en las extensiones empaquetadas.

Cómo habilitar y deshabilitar reglas y conjuntos de reglas estáticos

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

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

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

Para habilitar o inhabilitar reglas estáticas, llama a updateStaticRules(). Este método toma un objeto UpdateStaticRulesOptions, que contiene arrays de IDs de reglas para habilitar o inhabilitar. Los IDs se definen con la clave "id" del diccionario Ruleset.

Para habilitar o inhabilitar los conjuntos de reglas estáticos, llama a updateEnabledRulesets(). Este método toma un objeto UpdateRulesetOptions, que contiene arrays 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. Si bien 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 secuencias de comandos que se originan en "foo.com" a cualquier URL que contenga "abc" como subcadena.

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

Caracteres coincidentes de urlFilter

La clave "condition" de una regla permite una clave "urlFilter" para actuar sobre las URLs de un dominio especificado. Creas patrones con tokens de coincidencia de patrones. A continuación, se muestran 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://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

Priorización de reglas

Las reglas se activan con las solicitudes enviadas desde las páginas web. Si varias reglas coinciden con una solicitud en particular, se deben priorizar las reglas. En esta sección, se explica cómo se priorizan. La priorización se realiza en dos etapas.

  1. La prioridad se determina para las reglas dentro de una extensión.
  2. Si más de una extensión puede aplicar una regla a una solicitud, se determina la prioridad para todas las extensiones que coinciden con una solicitud en particular.

Si piensas en la coincidencia de esta manera, cualquier regla que priorice una extensión en particular se priorizará en comparación con las reglas de otras extensiones.

Priorización de reglas dentro de una extensión

En una sola extensión, la priorización se determina con el siguiente proceso:

  1. Se devuelve la regla con la prioridad más alta definida por el desarrollador (en otras palabras, el campo "priority").

  2. Si hay más de una regla con la prioridad más alta definida por el desarrollador, las reglas se priorizan con el campo "action", en el siguiente orden:

    1. allow
    2. allowAllRequests
    3. block
    4. upgradeScheme
    5. redirect

  3. Si el tipo de acción no es block ni redirect, se evalúan las reglas de modifyHeaders que coincidan. Ten en cuenta que, si hay reglas con una prioridad definida por el desarrollador inferior a la prioridad especificada para allow y allowAllRequests, se ignorarán esas reglas.

  4. Si varias reglas modifican el mismo encabezado, la modificación se determina según el campo "priority" definido por el desarrollador y las operaciones especificadas.

    • Si una regla se agrega a un encabezado, las reglas de menor prioridad solo se pueden agregar a ese encabezado. No se permiten las operaciones de configuración y eliminación.
    • Si una regla establece un encabezado, las reglas de menor prioridad solo pueden agregar información a ese encabezado. No se permiten otras modificaciones.
    • Si una regla quita un encabezado, las reglas de menor prioridad no podrán modificarlo más.

Priorización de reglas entre extensiones

Si solo una extensión tiene una regla que coincide con una solicitud, se aplica esa regla. Sin embargo, si más de una extensión coincide con una solicitud, se usa el siguiente proceso:

  1. Las reglas se priorizan con el campo "action", en el siguiente orden:

    1. block
    2. redirect o upgradeScheme
    3. allow o allowAllRequests

  2. Si coinciden más de una regla, tiene prioridad la extensión instalada más recientemente.

Límites de las reglas

Cargar y evaluar reglas en el navegador genera una sobrecarga de rendimiento, 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 las que se especifican en los archivos de reglas declarados en el archivo de manifiesto. Una extensión puede especificar hasta 50 conjuntos de reglas estáticos como parte de la clave de manifiesto "rule_resources", pero solo se pueden habilitar 10 de estos conjuntos de reglas a la vez. Este último se denomina MAX_NUMBER_OF_ENABLED_STATIC_RULESETS. En conjunto, esos conjuntos de reglas garantizan 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. Puedes encontrar este número en el tiempo de ejecución llamando a getAvailableStaticRuleCount(). Puedes ver un ejemplo de esto en ejemplos de código.

Reglas dinámicas y de sesiones

Los límites que se aplican a las reglas dinámicas y de sesión son más simples que los de las reglas estáticas. La cantidad total de ambos no puede exceder los 5,000. Esto se denomina MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES.

Reglas que usan regex

Todos los tipos de reglas pueden usar expresiones regulares. Sin embargo, la cantidad total de reglas de expresiones regulares de cada tipo no puede superar 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 aproximadamente con la complejidad de la regla. Si intentas cargar una regla que supera este límite, verás una advertencia como la que se muestra a continuación y se ignorará la regla.

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

Interacciones con service workers

Un 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 service worker. declarativeNetRequest no afectará las respuestas generadas por el service worker ni las recuperadas de CacheStorage, pero sí afectará las llamadas a fetch() realizadas en un service worker.

Recursos accesibles desde la Web

Una regla de declarativeNetRequest no puede redireccionar una solicitud de recurso público a un recurso al que no se pueda acceder desde la Web. Si lo haces, se activará un error. Esto se aplica incluso si el recurso especificado accesible desde la Web es propiedad de la extensión que realiza el redireccionamiento. Para declarar recursos para declarativeNetRequest, usa el array "web_accessible_resources" del manifiesto.

Ejemplos

Ejemplos de código

Actualiza 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 conjuntos de reglas estáticos

En el siguiente ejemplo, se muestra cómo habilitar y cómo inhabilitar 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 de tus conjuntos de reglas inhabilitados (establece "Enabled" en false dentro del 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 ilustra 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 separada.

La clave "priority"

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

Para determinar la prioridad de una URL en particular, consulta las claves "priority", "action" y "urlFilter" (definidas por el desarrollador). Estos ejemplos hacen referencia al archivo de regla de ejemplo que se muestra a continuación.

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 también 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 a 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 desde 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. Se usa un anclaje 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 devuelta 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 cualquier submarco.

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

Tipos

DomainType

Describe si la solicitud es propia o de terceros para el fotograma 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ó la solicitud.

Enum

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

"thirdParty"
La solicitud de red es de terceros para el marco en el 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 texto de la insignia de la extensión. Esta preferencia persiste entre sesiones.

  • tabUpdate

    TabActionCountUpdate opcional

    Chrome 89 y versiones posteriores

    Son los detalles sobre cómo se debe ajustar el recuento de acciones de la pestaña.

GetDisabledRuleIdsOptions

Chrome 111 y versiones posteriores

Propiedades

  • rulesetId

    string

    Es 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 ni 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 que no distinguen mayúsculas de minúsculas, además de las siguientes construcciones:

    "*" : Coincide con cualquier cantidad de caracteres.

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

    Los caracteres "*" y "?" se pueden escapar con una barra inversa, p. ej., "\*" y "\?".

HeaderOperation

Chrome 86 y versiones posteriores

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

Enum

"append"
Agrega una nueva entrada 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

    Es el ID de una regla de coincidencia.

  • rulesetId

    string

    ID del Ruleset al que pertenece esta regla. En el caso de una regla que se origina en el conjunto de reglas dinámicas, este valor 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, devuelve -1.

  • timeStamp

    número

    Es la fecha y hora en que se cumplió 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

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 no asociadas a 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

    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 búsqueda solo se reemplaza 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 la consulta que se agregarán o reemplazarán.

  • removeParams

    string[] opcional

    Es la lista de claves de búsqueda que se quitarán.

Redirect

Propiedades

  • extensionPath

    cadena opcional

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

  • regexSubstitution

    cadena opcional

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

  • transform

    URLTransform opcional

    Son las transformaciones de URL que se realizarán.

  • url

    cadena opcional

    Es la URL de redireccionamiento. No se permiten los 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 verificará.

  • requireCapturing

    booleano opcional

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

RequestDetails

Propiedades

  • documentId

    cadena opcional

    Chrome 106 y versiones posteriores

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

  • documentLifecycle

    DocumentLifecycle opcional

    Chrome 106 y versiones posteriores

    Es el ciclo de vida del documento del iframe, si esta solicitud es para un iframe.

  • 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 (sub)marco (type es main_frame o sub_frame), frameId indica el ID de este marco, no el ID del marco externo. Los IDs de fotogramas son únicos dentro de una pestaña.

  • frameType

    FrameType opcional

    Chrome 106 y versiones posteriores

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

  • iniciador

    cadena opcional

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

  • method

    string

    Es el método HTTP estándar.

  • parentDocumentId

    cadena opcional

    Chrome 106 y versiones posteriores

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

  • parentFrameId

    número

    ID del iframe que contiene el iframe que envió la solicitud. Se establece en -1 si no existe un fotograma principal.

  • requestId

    string

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

  • tabId

    número

    ID de la pestaña en la que se realiza la solicitud. Se establece en -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

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

    Es un ID que identifica de forma única una regla. Es obligatorio y debe ser mayor o igual que 1.

  • priority

    número opcional

    Es la 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

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

  • responseHeaders

    ModifyHeaderInfo[] opcional

    Chrome 86 y versiones posteriores

    Son 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 la 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 en sí.

RuleCondition

Propiedades

  • domainType

    DomainType opcional

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

  • dominios

    string[] opcional

    Obsoleto desde Chrome 101

    En su lugar, usa initiatorDomains.

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

  • excludedDomains

    string[] opcional

    Obsoleto desde Chrome 101

    En su lugar, usa excludedInitiatorDomains.

    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 excluye ningún dominio. Tiene prioridad sobre initiatorDomains.

    Notas:

    • También se permiten subdominios como "a.example.com".
    • Las entradas deben contener solo caracteres ASCII.
    • Utiliza la codificación Punycode para los dominios internacionalizados.
    • Esto coincide con el iniciador de la solicitud y no con la URL de la solicitud.
    • También se excluyen los subdominios de los dominios incluidos en la lista.
  • 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 excluye ningún dominio. Tiene prioridad sobre requestDomains.

    Notas:

    • También se permiten subdominios como "a.example.com".
    • Las entradas deben contener solo caracteres ASCII.
    • Utiliza la codificación Punycode para los dominios internacionalizados.
    • También se excluyen los subdominios de los dominios incluidos en la lista.
  • 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 las propiedades requestMethods y excludedRequestMethods. Si no se especifica ninguno de ellos, se comparan 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 las propiedades resourceTypes y excludedResourceTypes. Si no se especifica ninguno de ellos, se bloquearán 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 de encabezado de respuesta en esta lista (si se especifica). Si se especifican excludedResponseHeaders y responseHeaders, la propiedad excludedResponseHeaders tiene prioridad.

  • excludedTabIds

    number[] opcional

    Chrome 92 y versiones posteriores

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

  • initiatorDomains

    string[] opcional

    Chrome 101 y versiones posteriores

    La regla solo coincidirá con las solicitudes de red que se originen en 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.
    • Utiliza la codificación Punycode para los dominios internacionalizados.
    • Esto coincide con el iniciador de la solicitud y no con la URL de la solicitud.
    • También se incluyen los subdominios de los dominios enumerados.
  • isUrlFilterCaseSensitive

    booleano opcional

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

  • regexFilter

    cadena opcional

    Es la expresión regular que debe coincidir con la URL de la solicitud de red. Esto sigue la sintaxis RE2.

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

    Nota: El regexFilter debe estar compuesto solo por caracteres ASCII. Esto coincide con una URL en la que el host está codificado en formato Punycode (en el caso de dominios internacionalizados) y cualquier otro carácter que no sea ASCII está codificado en formato de URL en 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.
    • Utiliza 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 una 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 de 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 de encabezado de respuesta en esta lista (si se especifica).

  • tabIds

    number[] opcional

    Chrome 92 y versiones posteriores

    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 con alcance de sesión.

  • urlFilter

    cadena opcional

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

    "*": Comodín que coincide con cualquier cantidad de caracteres.

    "|" : Anclaje a la izquierda o a la derecha: Si se usa en cualquiera de los extremos del patrón, especifica el comienzo o el final de la URL, respectivamente.

    "||" : Ancla de nombre de dominio: Si se usa al principio del patrón, especifica el inicio de un (sub)dominio de la URL.

    "^" : Carácter separador: Coincide con cualquier elemento, excepto una letra, un dígito o uno de los siguientes: _, -, . o %. También coincide con el final de la URL.

    Por lo tanto, urlFilter se compone de las siguientes partes: (anclaje izquierdo o nombre de dominio opcional) + patrón + (anclaje derecho opcional).

    Si se omite, se incluirán 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 uno de urlFilter o regexFilter.

    Nota: El urlFilter debe estar compuesto solo por caracteres ASCII. Esto coincide con una URL en la que el host está codificado en formato Punycode (en el caso de dominios internacionalizados) y cualquier otro carácter que no sea ASCII está codificado en formato de URL en 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 única el conjunto de reglas. Los IDs que comienzan con "_" están reservados para uso interno.

  • ruta de acceso

    string

    Es la ruta de acceso 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 en la que se incrementa 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[]

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

TestMatchRequestDetails

Chrome 103 y versiones posteriores

Propiedades

  • iniciador

    cadena opcional

    Es la URL del iniciador (si hay alguna) 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

    Son los encabezados que proporcionaría una respuesta hipotética si la solicitud no se bloquea ni se redirecciona antes de enviarse. 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 devolverá 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

    Es 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

    Es 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

    Son las 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 que corresponden a un Ruleset estático que se debe inhabilitar.

  • enableRulesetIds

    string[] opcional

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

UpdateStaticRulesOptions

Chrome 111 y versiones posteriores

Propiedades

  • disableRuleIds

    number[] opcional

    Es el conjunto de IDs que corresponden a las reglas en Ruleset que se deben inhabilitar.

  • enableRuleIds

    number[] opcional

    Es el conjunto de IDs que corresponden a las reglas en Ruleset que se habilitarán.

  • rulesetId

    string

    Es el ID correspondiente a un Ruleset estático.

URLTransform

Propiedades

  • fragment

    cadena opcional

    Es el fragmento nuevo de la solicitud. Debe estar vacío, en cuyo caso se borrará el fragmento existente, o debe comenzar con "#".

  • host

    cadena opcional

    Es el nuevo host de la solicitud.

  • contraseña

    cadena opcional

    Es la contraseña nueva para la solicitud.

  • ruta de acceso

    cadena opcional

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

  • puerto

    cadena opcional

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

  • consulta

    cadena opcional

    Es la consulta nueva para la solicitud. Debe estar vacío, en cuyo caso se borrará la búsqueda existente, o debe comenzar con "?".

  • queryTransform

    QueryTransform opcional

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

  • esquema

    cadena opcional

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

  • nombre de usuario

    cadena opcional

    Es 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 agregó la extensión.

Valor

"_dynamic"

GETMATCHEDRULES_QUOTA_INTERVAL

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 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 todos sus conjuntos de reglas estáticas habilitados. Las reglas que superen este límite se tendrán en cuenta para el límite global de reglas estáticas.

Valor

30,000

MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL

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

30,000

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 en un momento determinado.

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 con alcance de 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 "inseguras" 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 con alcance de sesión "inseguras" 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 con alcance de sesión que agregó la extensión.

Valor

"_session"

Métodos

getAvailableStaticRuleCount()

Promise Chrome 89 y versiones posteriores 
chrome.declarativeNetRequest.getAvailableStaticRuleCount(
  callback?: function,
): Promise<number>

Devuelve la cantidad de reglas estáticas que puede habilitar una extensión antes de que se alcance el límite global de reglas estáticas.

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 solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

getDisabledRuleIds()

Promise Chrome 111 y versiones posteriores 
chrome.declarativeNetRequest.getDisabledRuleIds(
  options: GetDisabledRuleIdsOptions,
  callback?: function,
): Promise<number[]>

Devuelve 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 solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

getDynamicRules()

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

Devuelve el conjunto actual de reglas dinámicas para la extensión. De manera opcional, los llamadores pueden filtrar la lista de reglas recuperadas especificando un filter.

Parámetros

  • filtrar

    GetRulesFilter opcional

    Chrome 111 y versiones posteriores

    Es 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 solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

getEnabledRulesets()

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

Devuelve los IDs del conjunto actual de reglas estáticas habilitadas.

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 solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

getMatchedRules()

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

Devuelve todas las reglas que coinciden con la extensión. De manera opcional, los llamadores 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 devolverán las reglas que no estén asociadas con un documento activo y que hayan coincidido hace más de cinco minutos.

Parámetros

Muestra

  • Chrome 91 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

getSessionRules()

Promesa Chrome 90 y versiones posteriores 
chrome.declarativeNetRequest.getSessionRules(
  filter?: GetRulesFilter,
  callback?: function,
): Promise<Rule[]>

Devuelve el conjunto actual de reglas con alcance de sesión para la extensión. De manera opcional, los llamadores pueden filtrar la lista de reglas recuperadas especificando un filter.

Parámetros

  • filtrar

    GetRulesFilter opcional

    Chrome 111 y versiones posteriores

    Es 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 solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

isRegexSupported()

Promise Chrome 87 y versiones posteriores 
chrome.declarativeNetRequest.isRegexSupported(
  regexOptions: RegexOptions,
  callback?: function,
): Promise<IsRegexSupportedResult>

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

Parámetros

Muestra

  • Chrome 91 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

setExtensionActionOptions()

Promise Chrome 88 y versiones posteriores 
chrome.declarativeNetRequest.setExtensionActionOptions(
  options: ExtensionActionOptions,
  callback?: function,
): Promise<void>

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

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 solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

testMatchOutcome()

Promise Chrome 103 y versiones posteriores 
chrome.declarativeNetRequest.testMatchOutcome(
  request: TestMatchRequestDetails,
  callback?: function,
): Promise<TestMatchOutcomeResult>

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

Parámetros

Muestra

  • Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

updateDynamicRules()

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

Modifica el conjunto actual de reglas dinámicas 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: o bien se agregan y quitan todas las reglas especificadas, o bien se devuelve un error.
  • Estas reglas persisten en las sesiones del navegador y en las actualizaciones de la extensión.
  • Las reglas estáticas especificadas como parte del paquete de extensión no se pueden quitar 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 solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

updateEnabledRulesets()

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

Actualiza el conjunto de reglas estáticas habilitadas 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 entre sesiones, pero no entre actualizaciones de extensiones, 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 solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

updateSessionRules()

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

Modifica el conjunto actual de reglas con alcance de 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: o bien se agregan y quitan todas las reglas especificadas, o bien se devuelve un error.
  • Estas reglas no se conservan entre sesiones y se almacenan 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 solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

updateStaticRules()

Promise Chrome 111 y versiones posteriores 
chrome.declarativeNetRequest.updateStaticRules(
  options: UpdateStaticRulesOptions,
  callback?: function,
): Promise<void>

Inhabilita y habilita reglas estáticas individuales en un Ruleset. Los cambios en las reglas que pertenecen a un Ruleset inhabilitado entrarán en vigencia 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 solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

Eventos

onRuleMatchedDebug

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

Se activa cuando una regla coincide con una solicitud. Solo está disponible para las extensiones no empaquetadas con el permiso "declarativeNetRequestFeedback", ya que solo se puede usar con fines de depuración.

Parámetros