chrome.declarativeNetRequest

Description

L'API chrome.declarativeNetRequest permet de bloquer ou de modifier les requêtes réseau en spécifiant des règles déclaratives. Les extensions peuvent ainsi modifier les requêtes réseau sans les intercepter ni en afficher le contenu, ce qui renforce la confidentialité.

Autorisations

declarativeNetRequest
declarativeNetRequestWithHostAccess

Les autorisations "declarativeNetRequest" et "declarativeNetRequestWithHostAccess" offrent les mêmes fonctionnalités. La différence entre les deux réside dans le moment où les autorisations sont demandées ou accordées.

"declarativeNetRequest"
Déclenche un avertissement d'autorisation au moment de l'installation, mais fournit un accès implicite aux règles allow, allowAllRequests et block. Utilisez-la dans la mesure du possible pour éviter d'avoir à demander un accès complet aux hôtes.
"declarativeNetRequestFeedback"
Active les fonctionnalités de débogage pour les extensions décompressées, en particulier getMatchedRules() et onRuleMatchedDebug.
"declarativeNetRequestWithHostAccess"
Au moment de l'installation, aucun avertissement d'autorisation ne s'affiche, mais vous devez demander des autorisations d'hôte avant de pouvoir effectuer une action sur un hôte. Cette option est appropriée lorsque vous souhaitez utiliser des règles de requête réseau déclaratives dans une extension qui dispose déjà d'autorisations d'hôte sans générer d'avertissements supplémentaires.

Disponibilité

Chrome 84 ou version ultérieure

Fichier manifeste

En plus des autorisations décrites précédemment, certains types de règles, en particulier les règles statiques, nécessitent de déclarer la clé manifeste "declarative_net_request", qui doit être un dictionnaire avec une seule clé appelée "rule_resources". Cette clé est un tableau contenant des dictionnaires de type Ruleset, comme illustré ci-dessous. (Notez que le nom "Ruleset" n'apparaît pas dans le fichier manifeste JSON, car il ne s'agit que d'un tableau.) Les règles statiques sont expliquées plus loin dans ce document.

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

Règles et ensembles de règles

Pour utiliser cette API, spécifiez un ou plusieurs jeux de règles. Un ensemble de règles contient un tableau de règles. Une seule règle peut avoir l'un des effets suivants:

  • Bloquez une requête réseau.
  • Mettez à niveau le schéma (http vers https).
  • Empêchez une requête d'être bloquée en annulant les règles bloquées correspondantes.
  • Rediriger une requête réseau.
  • Modifiez les en-têtes de requête ou de réponse.

Il existe trois types de règles, gérés de manière légèrement différente.

Dynamique
Persistent entre les sessions de navigateur et les mises à niveau d'extensions, et sont gérés à l'aide de JavaScript lorsqu'une extension est utilisée.
Session
Effacé lorsque le navigateur s'arrête et qu'une nouvelle version de l'extension est installée. Les règles de session sont gérées à l'aide de JavaScript lorsque vous utilisez une extension.
Statique
Emballé, installé et mis à jour lorsqu'une extension est installée ou mise à niveau. Les règles statiques sont stockées dans des fichiers de règles au format JSON et listées dans le fichier manifeste.

Ensembles de règles dynamiques et de portée session

Les règles dynamiques et de session sont gérées à l'aide de JavaScript lorsqu'une extension est utilisée.

  • Les règles dynamiques persistent d'une session de navigateur à l'autre et lors des mises à niveau des extensions.
  • Les règles de session sont effacées lorsque le navigateur s'arrête et lorsqu'une nouvelle version de l'extension est installée.

Il n'existe qu'un seul type de règles pour chacun de ces types. Une extension peut ajouter ou supprimer des règles de manière dynamique en appelant updateDynamicRules() et updateSessionRules(), à condition que les limites de règles ne soient pas dépassées. Pour en savoir plus sur les limites des règles, consultez la section Limites des règles. Vous trouverez un exemple de ce cas sous Exemples de code.

Ensembles de règles statiques

Contrairement aux règles dynamiques et de session, les règles statiques sont empaquetées, installées et mises à jour lorsqu'une extension est installée ou mise à niveau. Elles sont stockées dans des fichiers de règles au format JSON, qui sont indiqués à l'extension à l'aide des clés "declarative_net_request" et "rule_resources" comme décrit ci-dessus, ainsi qu'un ou plusieurs dictionnaires Ruleset. Un dictionnaire Ruleset contient un chemin d'accès au fichier de règles, un ID pour l'ensemble de règles contenu dans le fichier et l'état d'activation ou de désactivation de l'ensemble de règles. Les deux derniers sont importants lorsque vous activez ou désactivez un ensemble de règles de manière programmatique.

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

Pour tester les fichiers de règles, chargez votre extension non compressée. Les erreurs et avertissements concernant les règles statiques non valides ne s'affichent que pour les extensions décompressées. Les règles statiques non valides dans les extensions compressées sont ignorées.

Examen accéléré

Les modifications apportées aux règles statiques peuvent être examinées plus rapidement. Consultez la procédure d'examen accélérée pour les modifications éligibles.

Activer et désactiver des règles et des ensembles de règles statiques

Les règles statiques individuelles et les ensembles de règles statiques complets peuvent être activés ou désactivés au moment de l'exécution.

L'ensemble des règles statiques et des ensembles de règles activés est conservé d'une session de navigateur à l'autre. Aucune de ces deux options n'est conservée lors des mises à jour de l'extension. Par conséquent, seules les règles que vous avez choisi de laisser dans vos fichiers de règles sont disponibles après une mise à jour.

Pour des raisons de performances, le nombre de règles et de jeux de règles pouvant être activés simultanément est également limité. Appelez getAvailableStaticRuleCount() pour vérifier le nombre de règles supplémentaires pouvant être activées. Pour en savoir plus sur les limites des règles, consultez la section Limites des règles.

Pour activer ou désactiver les règles statiques, appelez updateStaticRules(). Cette méthode reçoit un objet UpdateStaticRulesOptions, qui contient des tableaux d'ID de règles à activer ou à désactiver. Les ID sont définis à l'aide de la clé "id" du dictionnaire Ruleset. Le nombre maximal de règles statiques désactivées est limité à 5 000.

Pour activer ou désactiver des ensembles de règles statiques, appelez updateEnabledRulesets(). Cette méthode reçoit un objet UpdateRulesetOptions, qui contient des tableaux d'ID de règles à activer ou à désactiver. Les ID sont définis à l'aide de la clé "id" du dictionnaire Ruleset.

Règles de compilation

Quel que soit le type, une règle commence par quatre champs, comme illustré ci-dessous. Alors que les clés "id" et "priority" acceptent un nombre, les clés "action" et "condition" peuvent fournir plusieurs conditions de blocage et de redirection. La règle suivante bloque toutes les requêtes de script provenant de "foo.com" et envoyées à une URL contenant "abc" comme sous-chaîne.

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

Mise en correspondance des URL

La requête réseau déclarative permet de faire correspondre des URL à l'aide d'une syntaxe de correspondance de modèle ou d'expressions régulières.

Syntaxe du filtre d'URL

La clé "condition" d'une règle permet à une clé "urlFilter" d'agir sur les URL d'un domaine spécifié. Vous créez des modèles à l'aide de jetons de correspondance de modèles. Voici quelques exemples :

urlFilter Correspond à Ne correspond pas
"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

Expressions régulières

Les conditions peuvent également utiliser des expressions régulières. Consultez la clé "regexFilter". Pour en savoir plus sur les limites qui s'appliquent à ces conditions, consultez la section Règles utilisant des expressions régulières.

Écrire des conditions d'URL appropriées

Lorsque vous rédigez des règles, veillez à toujours faire correspondre l'ensemble d'un domaine. Sinon, votre règle peut correspondre à des situations inattendues. Par exemple, lorsque vous utilisez la syntaxe de correspondance de modèles:

  • google.com ne correspond pas correctement à https://example.com/?param=google.com
  • ||google.com ne correspond pas correctement à https://google.company
  • https://www.google.com ne correspond pas correctement à https://example.com/?param=https://www.google.com

Envisagez d'utiliser:

  • ||google.com/, qui correspond à tous les chemins et à tous les sous-domaines.
  • |https://www.google.com/, qui correspond à tous les chemins et à aucun sous-domaine.

De même, utilisez les caractères ^ et / pour ancrer une expression régulière. Par exemple, ^https:\/\/www\.google\.com\/ correspond à n'importe quel chemin d'accès sur https://www.google.com.

Évaluation des règles

Les règles DNR sont appliquées par le navigateur à différentes étapes du cycle de vie des requêtes réseau.

Avant la demande

Avant qu'une requête ne soit envoyée, une extension peut la bloquer ou la rediriger (y compris en passant du protocole HTTP au protocole HTTPS) à l'aide d'une règle correspondante.

Pour chaque extension, le navigateur détermine une liste de règles de correspondance. Les règles avec une action modifyHeaders ne sont pas incluses ici, car elles seront traitées ultérieurement. De plus, les règles avec une condition responseHeaders seront prises en compte ultérieurement (lorsque les en-têtes de réponse seront disponibles) et ne seront pas incluses.

Ensuite, pour chaque extension, Chrome ne sélectionne qu'un seul candidat par requête. Chrome trouve une règle correspondante en triant toutes les règles correspondantes par priorité. Les règles ayant la même priorité sont triées par action (allow ou allowAllRequests > block > upgradeScheme > redirect).

Si le candidat est une règle allow ou allowAllRequests, ou si le frame dans lequel la requête est effectuée a déjà correspondu à une règle allowAllRequests de priorité supérieure ou égale à celle de cette extension, la requête est "autorisée" et l'extension n'a aucun effet sur la requête.

Si plusieurs extensions souhaitent bloquer ou rediriger cette requête, une seule action est choisie. Chrome trie les règles dans l'ordre block > redirect ou upgradeScheme > allow ou allowAllRequests. Si deux règles sont du même type, Chrome choisit celle de l'extension la plus récemment installée.

Avant l'envoi des en-têtes de requête

Avant que Chrome n'envoie les en-têtes de requête au serveur, ils sont mis à jour en fonction des règles modifyHeaders correspondantes.

Dans une seule extension, Chrome génère la liste des modifications à effectuer en recherchant toutes les règles modifyHeaders correspondantes. Comme précédemment, seules les règles ayant une priorité plus élevée que les règles allow ou allowAllRequests correspondantes sont incluses.

Chrome applique ces règles dans un ordre tel que les règles d'une extension installée plus récemment sont toujours évaluées avant celles d'une extension plus ancienne. De plus, les règles de priorité plus élevée d'une extension sont toujours appliquées avant les règles de priorité inférieure de la même extension. Par exemple, même entre les extensions:

  • Si une règle est ajoutée à un en-tête, les règles de priorité inférieure ne peuvent être ajoutées qu'à cet en-tête. Les opérations de définition et de suppression ne sont pas autorisées.
  • Si une règle définit un en-tête, seules les règles de priorité inférieure de la même extension peuvent s'y ajouter. Aucune autre modification n'est autorisée.
  • Si une règle supprime un en-tête, les règles de priorité inférieure ne peuvent plus le modifier.

Une fois la réponse reçue

Une fois les en-têtes de réponse reçus, Chrome évalue les règles avec une condition responseHeaders.

Après avoir trié ces règles par action et priority, et exclu les règles devenues redondantes par une règle allow ou allowAllRequests correspondante (ce qui se produit de la même manière que les étapes de la section "Avant la requête"), Chrome peut bloquer ou rediriger la requête au nom d'une extension.

Notez que si une requête est parvenue à cette étape, elle a déjà été envoyée au serveur et le serveur a reçu des données telles que le corps de la requête. Une règle de blocage ou de redirection avec une condition d'en-têtes de réponse s'exécute toujours, mais ne peut pas bloquer ni rediriger la requête.

Dans le cas d'une règle de blocage, la page ayant effectué la requête reçoit une réponse bloquée et Chrome met fin à la requête prématurément. Dans le cas d'une règle de redirection, Chrome envoie une nouvelle requête à l'URL redirigée. Assurez-vous de déterminer si ces comportements répondent aux attentes en matière de confidentialité pour votre extension.

Si la requête n'est pas bloquée ni redirigée, Chrome applique les règles modifyHeaders. L'application de modifications aux en-têtes de réponse fonctionne de la même manière que décrit dans la section "Avant l'envoi des en-têtes de requête". Appliquer des modifications aux en-têtes de requête ne sert à rien, car la requête a déjà été effectuée.

Règles sécurisées

Les règles sécurisées sont définies comme des règles dont l'action est block, allow, allowAllRequests ou upgradeScheme. Ces règles sont soumises à un quota accru de règles dynamiques.

Limites de règles

Le chargement et l'évaluation des règles dans le navigateur entraînent une surcharge des performances. Par conséquent, certaines limites s'appliquent lorsque vous utilisez l'API. Les limites dépendent du type de règle que vous utilisez.

Règles statiques

Les règles statiques sont celles spécifiées dans les fichiers de règles déclarés dans le fichier manifeste. Une extension peut spécifier jusqu'à 100 ensembles de règles statiques dans la clé manifeste "rule_resources", mais seuls 50 d'entre eux peuvent être activés à la fois. Ce dernier est appelé MAX_NUMBER_OF_ENABLED_STATIC_RULESETS. Ensemble, ces ensembles de règles garantissent au moins 30 000 règles. C'est ce qu'on appelle le GUARANTEED_MINIMUM_STATIC_RULES.

Le nombre de règles disponibles dépend du nombre de règles activées par toutes les extensions installées dans le navigateur d'un utilisateur. Vous pouvez trouver ce nombre au moment de l'exécution en appelant getAvailableStaticRuleCount(). Vous trouverez un exemple de ce cas sous Exemples de code.

Règles de session

Une extension peut contenir jusqu'à 5 000 règles de session. Il est exposé en tant que MAX_NUMBER_OF_SESSION_RULES.

Avant Chrome 120, la limite était de 5 000 règles dynamiques et de session combinées.

Les règles dynamiques

Une extension peut comporter au moins 5 000 règles dynamiques. Il est exposé en tant que MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES.

À partir de Chrome 121, une limite plus élevée de 30 000 règles est disponible pour les règles dynamiques sûres, exposées sous la forme MAX_NUMBER_OF_DYNAMIC_RULES. Toute règle non sécurisée ajoutée dans la limite de 5 000 règles sera également prise en compte dans cette limite.

Avant Chrome 120, la limite était de 5 000 règles dynamiques et de session combinées.

Règles utilisant des expressions régulières

Tous les types de règles peuvent utiliser des expressions régulières. Toutefois, le nombre total de règles d'expression régulière de chaque type ne peut pas dépasser 1 000. Il s'agit de MAX_NUMBER_OF_REGEX_RULES.

De plus, chaque règle doit être inférieure à 2 Ko une fois compilée. Cela correspond à peu près à la complexité de la règle. Si vous essayez de charger une règle qui dépasse cette limite, un avertissement semblable au suivant s'affiche, et la règle est ignorée.

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

Interactions avec les service workers

Une requête declarativeNetRequest ne s'applique qu'aux requêtes qui atteignent la pile réseau. Cela inclut les réponses du cache HTTP, mais peut ne pas inclure les réponses qui passent par le gestionnaire onfetch d'un service worker. declarativeNetRequest n'affecte pas les réponses générées par le service worker ou récupérées à partir de CacheStorage, mais il affecte les appels à fetch() effectués dans un service worker.

Ressources Web accessibles

Une règle declarativeNetRequest ne peut pas rediriger une requête de ressource publique vers une ressource non accessible sur le Web. Cette opération déclenche une erreur. Cela est vrai même si la ressource accessible sur le Web spécifiée appartient à l'extension de redirection. Pour déclarer des ressources pour declarativeNetRequest, utilisez le tableau "web_accessible_resources" du fichier manifeste.

Modification de l'en-tête

L'opération d'ajout n'est acceptée que pour les en-têtes suivants: accept, accept-encoding, accept-language, access-control-request-headers, cache-control, connection, content-language, cookie, forwarded, if-match, if-none-match, keep-alive, range, te, trailer, transfer-encoding, upgrade, user-agent, via, want-digest, x-forwarded-for.

Exemples

Exemples de code

Mettre à jour les règles dynamiques

L'exemple suivant montre comment appeler updateDynamicRules(). La procédure pour updateSessionRules() est la même.

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

Mettre à jour les règles statiques

L'exemple suivant montre comment activer et désactiver des règles en tenant compte du nombre de règles statiques disponibles et du nombre maximal de règles statiques activées. Vous devez le faire lorsque le nombre de règles statiques dont vous avez besoin dépasse le nombre autorisé. Pour que cela fonctionne, certains de vos ensembles de règles doivent être installés et d'autres désactivés (en définissant "Enabled" sur false dans le fichier manifeste).

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

Exemples de règles

Les exemples suivants montrent comment Chrome hiérarchise les règles dans une extension. Lorsque vous les examinez, vous pouvez ouvrir les règles de priorisation dans une fenêtre distincte.

Clé "priority"

Ces exemples nécessitent une autorisation d'hôte pour *://*.example.com/*.

Pour déterminer la priorité d'une URL spécifique, examinez les clés "priority" (définie par le développeur), "action" et "urlFilter". Ces exemples font référence à l'exemple de fichier de règles présenté ci-dessous.

Navigation vers https://google.com
Deux règles couvrent cette URL: les règles avec les ID 1 et 4. La règle avec l'ID 1 s'applique, car les actions "block" ont une priorité plus élevée que les actions "redirect". Les autres règles ne s'appliquent pas, car elles concernent des URL plus longues.
Navigation vers https://google.com/1234
En raison de l'URL plus longue, la règle avec l'ID 2 correspond désormais en plus des règles avec les ID 1 et 4. La règle avec l'ID 2 s'applique, car "allow" a une priorité plus élevée que "block" et "redirect".
Navigation vers https://google.com/12345
Les quatre règles correspondent à cette URL. La règle avec l'ID 3 s'applique, car sa priorité définie par le développeur est la plus élevée du groupe.
[
  {
    "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"] }
  },
]

Redirections

L'exemple ci-dessous nécessite une autorisation de l'hôte pour *://*.example.com/*.

L'exemple suivant montre comment rediriger une requête de example.com vers une page de l'extension elle-même. Le chemin d'accès de l'extension /a.jpg est résolu en chrome-extension://EXTENSION_ID/a.jpg, où EXTENSION_ID correspond à l'ID de votre extension. Pour que cela fonctionne, le fichier manifeste doit déclarer /a.jpg comme ressource accessible sur le Web.

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

L'exemple suivant utilise la clé "transform" pour rediriger vers un sous-domaine d'example.com. Il utilise un ancrage de nom de domaine ("||") pour intercepter les requêtes avec n'importe quel schéma provenant d'example.com. La clé "scheme" dans "transform" spécifie que les redirections vers le sous-domaine utiliseront toujours "https".

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

L'exemple suivant utilise des expressions régulières pour rediriger de https://www.abc.xyz.com/path vers https://abc.xyz.com/path. Dans la clé "regexFilter", notez que les points sont échappés et que le groupe de capture sélectionne "abc" ou "def". La clé "regexSubstitution" spécifie la première correspondance renvoyée par l'expression régulière à l'aide de "\1". Dans ce cas, "abc" est extrait de l'URL redirigée et placé dans la substitution.

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

En-têtes

L'exemple suivant supprime tous les cookies d'un frame principal et de tous les sous-frames.

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

Types

DomainType

Indique si la demande est propriétaire ou tierce par rapport au frame à partir duquel elle a été envoyée. Une requête est dite propriétaire si elle a le même domaine (eTLD+1) que la trame à l'origine de la requête.

Énumération

"firstParty"
La requête réseau est propriétaire du frame à partir duquel elle a été générée.

"thirdParty"
La requête réseau est tierce par rapport au frame à partir duquel elle a été générée.

ExtensionActionOptions

Chrome 88 ou version ultérieure

Propriétés

  • displayActionCountAsBadgeText

    booléen facultatif

    Indique si le nombre d'actions d'une page doit être affiché automatiquement en tant que texte du badge de l'extension. Cette préférence est conservée entre les sessions.

  • tabUpdate

    TabActionCountUpdate facultatif

    Chrome 89 et versions ultérieures

    Détails sur la façon dont le nombre d'actions de l'onglet doit être ajusté.

GetDisabledRuleIdsOptions

Chrome 111 ou version ultérieure

Propriétés

  • rulesetId

    chaîne

    ID correspondant à un Ruleset statique.

GetRulesFilter

Chrome 111 ou version ultérieure

Propriétés

  • ruleIds

    number[] facultatif

    Si vous spécifiez des ID, seules les règles correspondants sont incluses.

HeaderInfo

Chrome 128 et versions ultérieures

Propriétés

  • excludedValues

    string[] facultatif

    Si cette valeur est spécifiée, cette condition n'est pas satisfaite si l'en-tête existe, mais que sa valeur contient au moins un élément de cette liste. Il utilise la même syntaxe de modèle de correspondance que values.

  • en-tête

    chaîne

    Nom de l'en-tête. Cette condition ne correspond au nom que si values et excludedValues ne sont pas spécifiés.

  • valeurs

    string[] facultatif

    Si elle est spécifiée, cette condition correspond si la valeur de l'en-tête correspond à au moins un modèle de cette liste. Cette fonctionnalité est compatible avec la correspondance des valeurs d'en-tête sans distinction entre majuscules et minuscules, ainsi qu'avec les constructions suivantes:

    '*' : correspond à un nombre illimité de caractères.

    '?' : correspond à zéro ou un caractère.

    Les caractères * et ? peuvent être échappés à l'aide d'une barre oblique inverse, par exemple : \* et \?

HeaderOperation

Chrome 86 ou version ultérieure

Cette section décrit les opérations possibles pour une règle "modifyHeaders".

Énumération

"append"
Ajoute une entrée pour l'en-tête spécifié. Cette opération n'est pas acceptée pour les en-têtes de requête.

"set"
Définit une nouvelle valeur pour l'en-tête spécifié, en supprimant tous les en-têtes existants portant le même nom.

"remove"
Supprime toutes les entrées pour l'en-tête spécifié.

IsRegexSupportedResult

Chrome 87 ou version ultérieure

Propriétés

  • isSupported

    booléen

  • reason

    UnsupportedRegexReason facultatif

    Indique pourquoi l'expression régulière n'est pas acceptée. N'est fourni que si la valeur de isSupported est "false".

MatchedRule

Propriétés

  • ruleId

    Nombre

    ID d'une règle correspondante.

  • rulesetId

    chaîne

    ID de l'Ruleset auquel cette règle appartient. Pour une règle provenant de l'ensemble de règles dynamiques, cette valeur est égale à DYNAMIC_RULESET_ID.

MatchedRuleInfo

Propriétés

  • règle

    MatchedRule

  • tabId

    Nombre

    Id de l'onglet à partir duquel la requête a été envoyée, si l'onglet est toujours actif. Sinon -1.

  • timeStamp

    Nombre

    Heure à laquelle la règle a été appliquée. Les codes temporels correspondent à la convention JavaScript pour les heures, c'est-à-dire le nombre de millisecondes écoulées depuis l'epoch.

MatchedRuleInfoDebug

Propriétés

MatchedRulesFilter

Propriétés

  • minTimeStamp

    number facultatif

    Si spécifié, ne correspond qu'aux règles après l'horodatage donné.

  • tabId

    number facultatif

    Si spécifié, ne correspond qu'aux règles de l'onglet donné. Correspond aux règles qui ne sont associées à aucun onglet actif si la valeur est -1.

ModifyHeaderInfo

Chrome 86 ou version ultérieure

Propriétés

  • en-tête

    chaîne

    Nom de l'en-tête à modifier.

  • opération

    HeaderOperation

    Opération à effectuer sur un en-tête.

  • valeur

    chaîne facultatif

    Nouvelle valeur de l'en-tête. Doit être spécifié pour les opérations append et set.

QueryKeyValue

Propriétés

  • clé

    chaîne

  • replaceOnly

    booléen facultatif

    Chrome 94 ou version ultérieure

    Si la valeur est "true", la clé de requête n'est remplacée que si elle est déjà présente. Sinon, la clé est également ajoutée si elle est manquante. Valeur par défaut : "false".

  • valeur

    chaîne

QueryTransform

Propriétés

  • addOrReplaceParams

    QueryKeyValue[] facultatif

    Liste des paires clé-valeur de requête à ajouter ou à remplacer.

  • removeParams

    string[] facultatif

    Liste des clés de requête à supprimer.

Redirect

Propriétés

  • extensionPath

    chaîne facultatif

    Chemin d'accès relatif au répertoire des extensions. Doit commencer par "/".

  • regexSubstitution

    chaîne facultatif

    Modèle de substitution pour les règles qui spécifient un regexFilter. La première occurrence de regexFilter dans l'URL sera remplacée par ce modèle. Dans regexSubstitution, vous pouvez utiliser des chiffres échappés par une barre oblique inverse (\1 à \9) pour insérer les groupes de capture correspondants. \0 fait référence à l'ensemble du texte associé.

  • transform

    URLTransform facultatif

    Transformations d'URL à effectuer.

  • url

    chaîne facultatif

    URL de redirection. Les redirections vers des URL JavaScript ne sont pas autorisées.

RegexOptions

Chrome 87 ou version ultérieure

Propriétés

  • isCaseSensitive

    booléen facultatif

    Indique si l'regex spécifié est sensible à la casse. La valeur par défaut est "true".

  • regex

    chaîne

    Expression régulière à vérifier.

  • requireCapturing

    booléen facultatif

    Indique si le regex spécifié doit être capturé. La capture n'est requise que pour les règles de redirection qui spécifient une action regexSubstition. La valeur par défaut est "false" (inactif).

RequestDetails

Propriétés

  • documentId

    chaîne facultatif

    Chrome 106 ou version ultérieure

    Identifiant unique du document du frame, si cette requête concerne un frame.

  • documentLifecycle

    DocumentLifecycle facultatif

    Chrome 106 ou version ultérieure

    Cycle de vie du document du frame, si cette requête concerne un frame.

  • frameId

    Nombre

    La valeur 0 indique que la requête se produit dans le frame principal. Une valeur positive indique l'ID d'un sous-frame dans lequel la requête se produit. Si le document d'un (sous-)cadre est chargé (type est main_frame ou sub_frame), frameId indique l'ID de ce cadre, et non celui du cadre externe. Les ID de frame sont uniques dans un onglet.

  • frameType

    FrameType facultatif

    Chrome 106 ou version ultérieure

    Type du frame, si cette requête concerne un frame.

  • initiateur

    chaîne facultatif

    Origine de la requête. Cela ne change pas avec les redirections. S'il s'agit d'une origine opaque, la chaîne "null" est utilisée.

  • method

    chaîne

    Méthode HTTP standard.

  • parentDocumentId

    chaîne facultatif

    Chrome 106 ou version ultérieure

    Identifiant unique du document parent du frame, si cette requête concerne un frame et qu'il a un parent.

  • parentFrameId

    Nombre

    ID du frame qui encapsule le frame ayant envoyé la requête. Définissez la valeur sur -1 si aucun cadre parent n'existe.

  • requestId

    chaîne

    ID de la requête. Les ID de requête sont uniques dans une session de navigateur.

  • tabId

    Nombre

    ID de l'onglet dans lequel la requête est effectuée. Définissez cette valeur sur -1 si la requête n'est pas liée à un onglet.

  • Type de ressource de la requête.

  • url

    chaîne

    URL de la requête.

RequestMethod

Chrome 91 et versions ultérieures

Il décrit la méthode de requête HTTP d'une requête réseau.

Énumération

"connect"

"delete"

"get"

"head"

"options"

"patch"

"post"

"put"

"other"

ResourceType

Il décrit le type de ressource de la requête réseau.

Énumération

"main_frame"

"sub_frame"

"stylesheet"

"script"

"image"

"font"

"object"

"xmlhttprequest"

"ping"

"csp_report"

"media"

"websocket"

"webtransport"

"webbundle"

"other"

Rule

Propriétés

  • action

    RuleAction

    Action à effectuer en cas de correspondance avec cette règle.

  • Condition sous laquelle cette règle est déclenchée.

  • id

    Nombre

    ID qui identifie de manière unique une règle. Obligatoire et doit être supérieur ou égal à 1.

  • priorité

    number facultatif

    Priorité de la règle. La valeur par défaut est 1. Si spécifié, doit être supérieur ou égal à 1.

RuleAction

Propriétés

  • redirection

    Redirection facultatif

    Décrit comment la redirection doit être effectuée. Valable uniquement pour les règles de redirection.

  • requestHeaders

    ModifyHeaderInfo[] facultatif

    Chrome 86 ou version ultérieure

    En-têtes de requête à modifier pour la requête. Valide uniquement si RuleActionType est "modifyHeaders".

  • responseHeaders

    ModifyHeaderInfo[] facultatif

    Chrome 86 ou version ultérieure

    En-têtes de réponse à modifier pour la requête. Valide uniquement si RuleActionType est "modifyHeaders".

  • Type d'action à effectuer.

RuleActionType

Décrit le type d'action à effectuer si une règle donnée correspond.

Énumération

"block"
Bloque la requête réseau.

"redirect"
Redirige la requête réseau.

"allow"
Autoriser la requête réseau. La requête n'est pas interceptée si une règle d'autorisation lui correspond.

"upgradeScheme"
Met à niveau le schéma de l'URL de la requête réseau en https si la requête est http ou ftp.

"modifyHeaders"
Modifie les en-têtes de requête/réponse à partir de la requête réseau.

"allowAllRequests"
Autorise toutes les requêtes dans une hiérarchie de frames, y compris la requête de frame elle-même.

RuleCondition

Propriétés

  • domainType

    DomainType facultatif

    Indique si la requête réseau est propriétaire ou tierce par rapport au domaine à partir duquel elle a été envoyée. Si elle est omise, toutes les requêtes sont acceptées.

  • domaines

    string[] facultatif

    Obsolète depuis Chrome 101

    Utilisez plutôt initiatorDomains.

    La règle ne correspondra qu'aux requêtes réseau provenant de la liste des domains.

  • excludedDomains

    string[] facultatif

    Obsolète depuis Chrome 101

    Utilisez plutôt excludedInitiatorDomains.

    La règle ne correspondra pas aux requêtes réseau provenant de la liste de excludedDomains.

  • excludedInitiatorDomains

    string[] facultatif

    Chrome 101 ou version ultérieure

    La règle ne correspondra pas aux requêtes réseau provenant de la liste de excludedInitiatorDomains. Si la liste est vide ou omise, aucun domaine n'est exclu. Cette valeur prévaut sur initiatorDomains.

    Remarques :

    • Les sous-domaines tels que "a.example.com" sont également autorisés.
    • Les entrées ne doivent contenir que des caractères ASCII.
    • Utilisez l'encodage punycode pour les domaines internationalisés.
    • Cette valeur correspond à l'initiateur de la requête et non à l'URL de la requête.
    • Les sous-domaines des domaines listés sont également exclus.
  • excludedRequestDomains

    string[] facultatif

    Chrome 101 ou version ultérieure

    La règle ne correspond pas aux requêtes réseau lorsque les domaines correspondent à l'un de la liste des excludedRequestDomains. Si la liste est vide ou omise, aucun domaine n'est exclu. Cette valeur prévaut sur requestDomains.

    Remarques :

    • Les sous-domaines tels que "a.example.com" sont également autorisés.
    • Les entrées ne doivent contenir que des caractères ASCII.
    • Utilisez l'encodage punycode pour les domaines internationalisés.
    • Les sous-domaines des domaines listés sont également exclus.
  • excludedRequestMethods

    RequestMethod[] facultatif

    Chrome 91 ou version ultérieure

    Liste des méthodes de requête auxquelles la règle ne correspond pas. Vous ne devez spécifier qu'un seul élément requestMethods et excludedRequestMethods. Si aucun d'eux n'est spécifié, toutes les méthodes de requête sont acceptées.

  • excludedResourceTypes

    ResourceType[] facultatif

    Liste des types de ressources auxquels la règle ne correspond pas. Vous ne devez spécifier qu'un seul élément resourceTypes et excludedResourceTypes. Si aucun d'eux n'est spécifié, tous les types de ressources, à l'exception de "main_frame", sont bloqués.

  • excludedResponseHeaders

    HeaderInfo[] facultatif

    Chrome 128 et versions ultérieures

    La règle ne correspond pas si la requête correspond à une condition d'en-tête de réponse de cette liste (si elle est spécifiée). Si les options excludedResponseHeaders et responseHeaders sont spécifiées, la propriété excludedResponseHeaders est prioritaire.

  • excludedTabIds

    number[] facultatif

    Chrome 92 ou version ultérieure

    Liste des tabs.Tab.id auxquels la règle ne doit pas correspondre. Un ID de tabs.TAB_ID_NONE exclut les requêtes qui ne proviennent pas d'un onglet. Compatible uniquement avec les règles de portée session.

  • initiatorDomains

    string[] facultatif

    Chrome 101 ou version ultérieure

    La règle ne correspondra qu'aux requêtes réseau provenant de la liste des initiatorDomains. Si la liste est omise, la règle s'applique aux requêtes provenant de tous les domaines. Une liste vide n'est pas autorisée.

    Remarques :

    • Les sous-domaines tels que "a.example.com" sont également autorisés.
    • Les entrées ne doivent contenir que des caractères ASCII.
    • Utilisez l'encodage punycode pour les domaines internationalisés.
    • Cette valeur correspond à l'initiateur de la requête et non à l'URL de la requête.
    • Les sous-domaines des domaines listés sont également mis en correspondance.
  • isUrlFilterCaseSensitive

    booléen facultatif

    Indique si urlFilter ou regexFilter (selon la valeur spécifiée) est sensible à la casse. La valeur par défaut est "false".

  • regexFilter

    chaîne facultatif

    Expression régulière à mettre en correspondance avec l'URL de la requête réseau. Cette syntaxe suit la syntaxe RE2.

    Remarque: Vous ne pouvez spécifier qu'un seul urlFilter ou regexFilter.

    Remarque: regexFilter ne doit contenir que des caractères ASCII. Il est mis en correspondance avec une URL dans laquelle l'hôte est encodé au format punycode (en cas de domaines internationalisés) et tous les autres caractères non ASCII sont encodés en URL au format UTF-8.

  • requestDomains

    string[] facultatif

    Chrome 101 ou version ultérieure

    La règle ne correspondra aux requêtes réseau que si le domaine correspond à l'un de la liste requestDomains. Si la liste est omise, la règle s'applique aux requêtes provenant de tous les domaines. Une liste vide n'est pas autorisée.

    Remarques :

    • Les sous-domaines tels que "a.example.com" sont également autorisés.
    • Les entrées ne doivent contenir que des caractères ASCII.
    • Utilisez l'encodage punycode pour les domaines internationalisés.
    • Les sous-domaines des domaines listés sont également mis en correspondance.
  • requestMethods

    RequestMethod[] facultatif

    Chrome 91 et versions ultérieures

    Liste des méthodes de requête HTTP que la règle peut faire correspondre. Une liste vide n'est pas autorisée.

    Remarque: Spécifier une condition de règle requestMethods exclut également les requêtes non HTTP(S), contrairement à excludedRequestMethods.

  • resourceTypes

    ResourceType[] facultatif

    Liste des types de ressources auxquels la règle peut correspondre. Une liste vide n'est pas autorisée.

    Remarque: Ce paramètre doit être spécifié pour les règles allowAllRequests et ne peut inclure que les types de ressources sub_frame et main_frame.

  • responseHeaders

    HeaderInfo[] facultatif

    Chrome 128 et versions ultérieures

    La règle correspond si la requête correspond à l'une des conditions d'en-tête de réponse de cette liste (le cas échéant).

  • tabIds

    number[] facultatif

    Chrome 92 ou version ultérieure

    Liste des tabs.Tab.id auxquels la règle doit correspondre. Un ID de tabs.TAB_ID_NONE correspond aux requêtes qui ne proviennent pas d'un onglet. Une liste vide n'est pas autorisée. Compatible uniquement avec les règles de portée session.

  • urlFilter

    chaîne facultatif

    Format qui est comparé à l'URL de la requête réseau. Constructions compatibles:

    * : caractère générique: correspond à un nombre illimité de caractères.

    | : ancrage gauche/droite: s'il est utilisé à chaque extrémité du format, spécifie respectivement le début/la fin de l'URL.

    '||' : ancre de nom de domaine: si elle est utilisée au début du modèle, elle spécifie le début d'un (sous-)domaine de l'URL.

    '^' : caractère séparateur: correspond à n'importe quel caractère, sauf une lettre, un chiffre ou l'un des caractères suivants: _, -, . ou %. Il correspond également à la fin de l'URL.

    urlFilter se compose donc des parties suivantes: (ancrage gauche/nom de domaine facultatif) + modèle + (ancrage droit facultatif).

    Si elle est omise, toutes les URL sont mises en correspondance. Une chaîne vide n'est pas autorisée.

    Un modèle commençant par ||* n'est pas autorisé. Utilisez * à la place.

    Remarque: Vous ne pouvez spécifier qu'un seul élément urlFilter ou regexFilter.

    Remarque: urlFilter ne doit contenir que des caractères ASCII. Il est mis en correspondance avec une URL dans laquelle l'hôte est encodé au format punycode (en cas de domaines internationalisés) et tous les autres caractères non ASCII sont encodés en URL au format UTF-8. Par exemple, lorsque l'URL de la requête est http://abc.рф?q=ф, urlFilter est mis en correspondance avec l'URL http://abc.xn--p1ai/?q=%D1%84.

Ruleset

Propriétés

  • activé

    booléen

    Indique si le jeu de règles est activé par défaut.

  • id

    chaîne

    Chaîne non vide identifiant de manière unique l'ensemble de règles. Les ID commençant par "_" sont réservés à un usage interne.

  • chemin d'accès

    chaîne

    Chemin d'accès du jeu de règles JSON par rapport au répertoire de l'extension.

RulesMatchedDetails

Propriétés

  • rulesMatchedInfo

    MatchedRuleInfo[]

    Règles correspondant au filtre donné.

TabActionCountUpdate

Chrome 89 et versions ultérieures

Propriétés

  • increment

    Nombre

    Quantité à ajouter au nombre d'actions de l'onglet. Les valeurs négatives réduisent le nombre.

  • tabId

    Nombre

    Onglet pour lequel mettre à jour le nombre d'actions.

TestMatchOutcomeResult

Chrome 103 ou version ultérieure

Propriétés

  • matchedRules

    MatchedRule[]

    Règles (le cas échéant) qui correspondent à la requête hypothétique.

TestMatchRequestDetails

Chrome 103 ou version ultérieure

Propriétés

  • initiateur

    chaîne facultatif

    URL de l'initiateur (le cas échéant) de la requête hypothétique.

  • method

    RequestMethod facultatif

    Méthode HTTP standard de la requête hypothétique. La valeur par défaut est "get" pour les requêtes HTTP et est ignorée pour les requêtes non HTTP.

  • responseHeaders

    objet facultatif

    Chrome 129 ou version ultérieure

    En-têtes fournis par une réponse hypothétique si la requête n'est pas bloquée ni redirigée avant d'être envoyée. Représenté sous la forme d'un objet qui met en correspondance un nom d'en-tête avec une liste de valeurs de chaîne. Si cet élément n'est pas spécifié, la réponse hypothétique renverra des en-têtes de réponse vides, qui peuvent correspondre à des règles basées sur l'absence d'en-têtes. Exemple : {"content-type": ["text/html; charset=utf-8", "multipart/form-data"]}

  • tabId

    number facultatif

    ID de l'onglet dans lequel la requête hypothétique a lieu. Ne doit pas nécessairement correspondre à un ID d'onglet réel. La valeur par défaut est -1, ce qui signifie que la requête n'est pas associée à un onglet.

  • Type de ressource de la requête hypothétique.

  • url

    chaîne

    URL de la requête hypothétique.

UnsupportedRegexReason

Chrome 87 ou version ultérieure

Indique pourquoi une expression régulière donnée n'est pas acceptée.

Énumération

"syntaxError"
La syntaxe de l'expression régulière est incorrecte ou utilise des fonctionnalités non disponibles dans la syntaxe RE2.

"memoryLimitExceeded"
L'expression régulière dépasse la limite de mémoire.

UpdateRuleOptions

Chrome 87 ou version ultérieure

Propriétés

  • addRules

    Règle[] facultatif

    Règles à ajouter.

  • removeRuleIds

    number[] facultatif

    ID des règles à supprimer. Les ID non valides seront ignorés.

UpdateRulesetOptions

Chrome 87 ou version ultérieure

Propriétés

  • disableRulesetIds

    string[] facultatif

    Ensemble d'ID correspondant à un Ruleset statique à désactiver.

  • enableRulesetIds

    string[] facultatif

    Ensemble d'ID correspondant à un Ruleset statique qui doit être activé.

UpdateStaticRulesOptions

Chrome 111 ou version ultérieure

Propriétés

  • disableRuleIds

    number[] facultatif

    Ensemble d'ID correspondant aux règles de l'Ruleset à désactiver.

  • enableRuleIds

    number[] facultatif

    Ensemble d'ID correspondant aux règles de l'Ruleset à activer.

  • rulesetId

    chaîne

    ID correspondant à un Ruleset statique.

URLTransform

Propriétés

  • fragment

    chaîne facultatif

    Nouveau fragment de la requête. Doit être vide, auquel cas le fragment existant est effacé, ou doit commencer par "#".

  • hôte

    chaîne facultatif

    Nouvel hôte de la requête.

  • mot de passe

    chaîne facultatif

    Nouveau mot de passe pour la demande.

  • chemin d'accès

    chaîne facultatif

    Nouveau chemin d'accès de la requête. Si ce champ est vide, le chemin d'accès existant est effacé.

  • port

    chaîne facultatif

    Nouveau port de la requête. Si ce champ est vide, le port existant est effacé.

  • requête

    chaîne facultatif

    Nouvelle requête pour la requête. Doit être vide, auquel cas la requête existante est effacée, ou doit commencer par "?".

  • queryTransform

    QueryTransform facultatif

    Ajoutez, supprimez ou remplacez des paires clé-valeur de requête.

  • schéma

    chaîne facultatif

    Nouveau schéma de la requête. Les valeurs autorisées sont "http", "https", "ftp" et "chrome-extension".

  • nom d'utilisateur

    chaîne facultatif

    Nouveau nom d'utilisateur pour la requête.

Propriétés

DYNAMIC_RULESET_ID

ID du jeu de règles pour les règles dynamiques ajoutées par l'extension.

Valeur

"_dynamic"

GETMATCHEDRULES_QUOTA_INTERVAL

Intervalle de temps pendant lequel les appels MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL getMatchedRules peuvent être effectués, spécifié en minutes. Les appels supplémentaires échouent immédiatement et définissent runtime.lastError. Remarque: Les appels getMatchedRules associés à un geste utilisateur sont exemptés du quota.

Valeur

10

GUARANTEED_MINIMUM_STATIC_RULES

Chrome 89 et versions ultérieures

Nombre minimal de règles statiques garanties à une extension dans ses ensembles de règles statiques activés. Toute règle dépassant cette limite sera comptabilisée dans la limite globale des règles statiques.

Valeur

30000

MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL

Nombre d'appels de getMatchedRules possibles sur une période de GETMATCHEDRULES_QUOTA_INTERVAL.

Valeur

20

MAX_NUMBER_OF_DYNAMIC_RULES

Nombre maximal de règles dynamiques qu'une extension peut ajouter.

Valeur

30000

MAX_NUMBER_OF_ENABLED_STATIC_RULESETS

Chrome 94 ou version ultérieure

Nombre maximal de Rulesets statiques qu'une extension peut activer à la fois.

Valeur

50

MAX_NUMBER_OF_REGEX_RULES

Nombre maximal de règles d'expression régulière qu'une extension peut ajouter. Cette limite est évaluée séparément pour l'ensemble de règles dynamiques et celles spécifiées dans le fichier de ressources de règles.

Valeur

1 000

MAX_NUMBER_OF_SESSION_RULES

Chrome 120 et versions ultérieures

Nombre maximal de règles de portée session qu'une extension peut ajouter.

Valeur

5 000

MAX_NUMBER_OF_STATIC_RULESETS

Nombre maximal de Rulesets statiques qu'une extension peut spécifier dans la clé manifeste "rule_resources".

Valeur

100

MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES

Chrome 120 et versions ultérieures

Nombre maximal de règles dynamiques "non sécurisées" qu'une extension peut ajouter.

Valeur

5 000

MAX_NUMBER_OF_UNSAFE_SESSION_RULES

Chrome 120 et versions ultérieures

Nombre maximal de règles de portée de session "non sécurisées" qu'une extension peut ajouter.

Valeur

5 000

SESSION_RULESET_ID

Chrome 90 et versions ultérieures

ID du jeu de règles pour les règles de portée session ajoutées par l'extension.

Valeur

"_session"

Méthodes

getAvailableStaticRuleCount()

Promise Chrome 89 et versions ultérieures 
chrome.declarativeNetRequest.getAvailableStaticRuleCount(
  callback?: function,
)

Indique le nombre de règles statiques qu'une extension peut activer avant d'atteindre la limite globale de règles statiques.

Paramètres

  • rappel

    fonction facultatif

    Le paramètre callback se présente comme suit : 

    (count: number) => void

    • nombre

      Nombre

Renvoie

  • Promise<number>

    Chrome 91 et versions ultérieures

    Les promesses sont compatibles avec la version 3 du fichier manifeste et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse se résout avec le même type que celui transmis au rappel.

getDisabledRuleIds()

Promesse : Chrome 111 ou version ultérieure 
chrome.declarativeNetRequest.getDisabledRuleIds(
  options: GetDisabledRuleIdsOptions,
  callback?: function,
)

Renvoie la liste des règles statiques actuellement désactivées dans l'Ruleset donné.

Paramètres

  • Spécifie l'ensemble de règles à interroger.

  • rappel

    fonction facultatif

    Le paramètre callback se présente comme suit : 

    (disabledRuleIds: number[]) => void

    • disabledRuleIds

      number[]

Renvoie

  • Promise<number[]>

    Les promesses sont compatibles avec la version 3 du fichier manifeste et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse se résout avec le même type que celui transmis au rappel.

getDynamicRules()

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

Renvoie l'ensemble actuel de règles dynamiques pour l'extension. Les appelants peuvent éventuellement filtrer la liste des règles extraites en spécifiant un filter.

Paramètres

  • filtre

    GetRulesFilter facultatif

    Chrome 111 ou version ultérieure

    Objet permettant de filtrer la liste des règles extraites.

  • rappel

    fonction facultatif

    Le paramètre callback se présente comme suit : 

    (rules: Rule[]) => void

Renvoie

  • Promise<Rule[]>

    Chrome 91 et versions ultérieures

    Les promesses sont compatibles avec la version 3 du fichier manifeste et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse se résout avec le même type que celui transmis au rappel.

getEnabledRulesets()

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

Renvoie les ID de l'ensemble actuel de règles statiques activées.

Paramètres

  • rappel

    fonction facultatif

    Le paramètre callback se présente comme suit : 

    (rulesetIds: string[]) => void

    • rulesetIds

      chaîne[]

Renvoie

  • Promise<string[]>

    Chrome 91 ou version ultérieure

    Les promesses sont compatibles avec la version 3 du fichier manifeste et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse se résout avec le même type que celui transmis au rappel.

getMatchedRules()

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

Renvoie toutes les règles correspondant à l'extension. Les appelants peuvent éventuellement filtrer la liste des règles correspondantes en spécifiant un filter. Cette méthode n'est disponible que pour les extensions disposant de l'autorisation "declarativeNetRequestFeedback" ou ayant l'autorisation "activeTab" accordée pour le tabId spécifié dans filter. Remarque: Les règles qui ne sont pas associées à un document actif et qui ont été mises en correspondance il y a plus de cinq minutes ne seront pas renvoyées.

Paramètres

Renvoie

  • Chrome 91 ou version ultérieure

    Les promesses sont compatibles avec la version 3 du fichier manifeste et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse se résout avec le même type que celui transmis au rappel.

getSessionRules()

Promesse : Chrome 90 et versions ultérieures 
chrome.declarativeNetRequest.getSessionRules(
  filter?: GetRulesFilter,
  callback?: function,
)

Renvoie l'ensemble actuel de règles de portée de session pour l'extension. Les appelants peuvent éventuellement filtrer la liste des règles extraites en spécifiant un filter.

Paramètres

  • filtre

    GetRulesFilter facultatif

    Chrome 111 ou version ultérieure

    Objet permettant de filtrer la liste des règles extraites.

  • rappel

    fonction facultatif

    Le paramètre callback se présente comme suit : 

    (rules: Rule[]) => void

Renvoie

  • Promise<Rule[]>

    Chrome 91 ou version ultérieure

    Les promesses sont compatibles avec la version 3 du fichier manifeste et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse se résout avec le même type que celui transmis au rappel.

isRegexSupported()

Promise Chrome 87 et versions ultérieures 
chrome.declarativeNetRequest.isRegexSupported(
  regexOptions: RegexOptions,
  callback?: function,
)

Vérifie si l'expression régulière donnée est compatible en tant que condition de règle regexFilter.

Paramètres

Renvoie

  • Chrome 91 ou version ultérieure

    Les promesses sont compatibles avec la version 3 du fichier manifeste et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse se résout avec le même type que celui transmis au rappel.

setExtensionActionOptions()

Promise Chrome 88 et versions ultérieures 
chrome.declarativeNetRequest.setExtensionActionOptions(
  options: ExtensionActionOptions,
  callback?: function,
)

Configure si le nombre d'actions pour les onglets doit s'afficher sous forme de texte du badge de l'action de l'extension et permet d'augmenter ce nombre d'actions.

Paramètres

  • rappel

    fonction facultatif

    Chrome 89 et versions ultérieures

    Le paramètre callback se présente comme suit : 

    () => void

Renvoie

  • Promise<void>

    Chrome 91 et versions ultérieures

    Les promesses sont compatibles avec la version 3 du fichier manifeste et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse se résout avec le même type que celui transmis au rappel.

testMatchOutcome()

Promise Chrome 103 ou version ultérieure 
chrome.declarativeNetRequest.testMatchOutcome(
  request: TestMatchRequestDetails,
  callback?: function,
)

Vérifie si l'une des règles declarativeNetRequest de l'extension correspond à une requête hypothétique. Remarque: Cette option n'est disponible que pour les extensions non décompressées, car elle n'est destinée qu'à être utilisée pendant le développement de l'extension.

Paramètres

Renvoie

  • Les promesses sont compatibles avec la version 3 du fichier manifeste et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse se résout avec le même type que celui transmis au rappel.

updateDynamicRules()

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

Modifie l'ensemble actuel de règles dynamiques pour l'extension. Les règles dont les ID sont listés dans options.removeRuleIds sont d'abord supprimées, puis les règles indiquées dans options.addRules sont ajoutées. Remarques :

  • Cette mise à jour se produit en tant qu'opération atomique unique: toutes les règles spécifiées sont ajoutées et supprimées, ou une erreur est renvoyée.
  • Ces règles sont conservées entre les sessions de navigateur et les mises à jour des extensions.
  • Les règles statiques spécifiées dans le package d'extension ne peuvent pas être supprimées à l'aide de cette fonction.
  • MAX_NUMBER_OF_DYNAMIC_RULES correspond au nombre maximal de règles dynamiques qu'une extension peut ajouter. Le nombre de règles non sécurisées ne doit pas dépasser MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES.

Paramètres

  • Chrome 87 ou version ultérieure
  • rappel

    fonction facultatif

    Le paramètre callback se présente comme suit : 

    () => void

Renvoie

  • Promise<void>

    Chrome 91 ou version ultérieure

    Les promesses sont compatibles avec la version 3 du fichier manifeste et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse se résout avec le même type que celui transmis au rappel.

updateEnabledRulesets()

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

Met à jour l'ensemble des ensembles de règles statiques activés pour l'extension. Les règles dont les ID sont listés dans options.disableRulesetIds sont d'abord supprimées, puis les règles listées dans options.enableRulesetIds sont ajoutées. Notez que l'ensemble des règles statiques activées est conservé entre les sessions, mais pas entre les mises à jour de l'extension. Autrement dit, la clé de fichier manifeste rule_resources déterminera l'ensemble des règles statiques activées à chaque mise à jour de l'extension.

Paramètres

  • Chrome 87 ou version ultérieure
  • rappel

    fonction facultatif

    Le paramètre callback se présente comme suit : 

    () => void

Renvoie

  • Promise<void>

    Chrome 91 ou version ultérieure

    Les promesses sont compatibles avec la version 3 du fichier manifeste et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse se résout avec le même type que celui transmis au rappel.

updateSessionRules()

Promesse : Chrome 90 et versions ultérieures 
chrome.declarativeNetRequest.updateSessionRules(
  options: UpdateRuleOptions,
  callback?: function,
)

Modifie l'ensemble actuel de règles de portée session pour l'extension. Les règles dont les ID sont listés dans options.removeRuleIds sont d'abord supprimées, puis les règles indiquées dans options.addRules sont ajoutées. Remarques :

  • Cette mise à jour se produit en tant qu'opération atomique unique: toutes les règles spécifiées sont ajoutées et supprimées, ou une erreur est renvoyée.
  • Ces règles ne sont pas conservées entre les sessions et sont sauvegardées en mémoire.
  • MAX_NUMBER_OF_SESSION_RULES correspond au nombre maximal de règles de session qu'une extension peut ajouter.

Paramètres

  • rappel

    fonction facultatif

    Le paramètre callback se présente comme suit : 

    () => void

Renvoie

  • Promise<void>

    Chrome 91 ou version ultérieure

    Les promesses sont compatibles avec la version 3 du fichier manifeste et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse se résout avec le même type que celui transmis au rappel.

updateStaticRules()

Promesse : Chrome 111 ou version ultérieure 
chrome.declarativeNetRequest.updateStaticRules(
  options: UpdateStaticRulesOptions,
  callback?: function,
)

Désactive et active des règles statiques individuelles dans un Ruleset. Les modifications apportées aux règles appartenant à un Ruleset désactivé prendront effet lors de la prochaine activation de ce Ruleset.

Paramètres

  • rappel

    fonction facultatif

    Le paramètre callback se présente comme suit : 

    () => void

Renvoie

  • Promise<void>

    Les promesses sont compatibles avec la version 3 du fichier manifeste et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse se résout avec le même type que celui transmis au rappel.

Événements

onRuleMatchedDebug

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

Déclenché lorsqu'une règle est mise en correspondance avec une requête. Disponible uniquement pour les extensions décompressées avec l'autorisation "declarativeNetRequestFeedback", car cette option est destinée à être utilisée à des fins de débogage uniquement.

Paramètres