chrome.declarativeNetRequest

Descrizione

L'API chrome.declarativeNetRequest viene utilizzata per bloccare o modificare le richieste di rete specificando regole dichiarative. In questo modo le estensioni possono modificare le richieste di rete senza intercettarle e visualizzarne i contenuti, garantendo così maggiore privacy.

Autorizzazioni

declarativeNetRequest
declarativeNetRequestWithHostAccess

Le autorizzazioni "declarativeNetRequest" e "declarativeNetRequestWithHostAccess" offrono le stesse funzionalità. Le differenze sono quando le autorizzazioni vengono richieste o concesse.

"declarativeNetRequest"
Attiva un avviso di autorizzazione al momento dell'installazione, ma fornisce accesso implicito alle regole allow, allowAllRequests e block. Utilizzalo quando possibile per evitare di dover richiedere l'accesso completo agli host.
"declarativeNetRequestFeedback"
Abilita le funzionalità di debug per le estensioni non pacchettizzate, in particolare getMatchedRules() e onRuleMatchedDebug.
"declarativeNetRequestWithHostAccess"
Al momento dell'installazione non viene mostrato un avviso di autorizzazione, ma devi richiedere le autorizzazioni dell'host prima di poter eseguire qualsiasi azione su un host. Ciò è appropriato quando vuoi utilizzare regole dichiarative per le richieste nette in un'estensione che dispone già di autorizzazioni host senza generare avvisi aggiuntivi.

Disponibilità

Chrome 84 e versioni successive

Manifest

Oltre alle autorizzazioni descritte in precedenza, alcuni tipi di set di regole, in particolare quelli statici, richiedono la dichiarazione della chiave manifest "declarative_net_request", che dovrebbe essere un dizionario con una singola chiave denominata "rule_resources". Questa chiave è un array contenente dizionari di tipo Ruleset, come mostrato di seguito. Tieni presente che il nome "Ruleset" non compare nel file JSON del file manifest poiché si tratta semplicemente di un array. I set di regole statici vengono spiegati più avanti in questo 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/*"
  ],
  ...
}

Concetti e utilizzo

Per utilizzare questa API, specificare uno o più set di regole. Una serie di regole contiene un array di regole. Una singola regola esegue una delle seguenti operazioni:

  • Blocca una richiesta di rete.
  • Esegui l'upgrade dello schema (da http a https).
  • Impedisci che una richiesta venga bloccata annullando le regole bloccate corrispondenti.
  • Reindirizza una richiesta di rete.
  • Modifica le intestazioni della richiesta o della risposta.

Esistono tre tipi di set di regole, gestiti in modi leggermente diversi.

Dinamico
Permangono su tutte le sessioni del browser e sugli upgrade delle estensioni e vengono gestiti tramite JavaScript mentre è in uso un'estensione.
Sessione
Cancellata all'arresto del browser e all'installazione di una nuova versione dell'estensione. Le regole di sessione vengono gestite tramite JavaScript mentre è in uso un'estensione.
Statiche
Pacchettizzati, installati e aggiornati quando un'estensione viene installata o aggiornata. Le regole statiche vengono archiviate in file di regole in formato JSON ed elencate nel file manifest.

Le prossime sezioni spiegano in dettaglio i tipi di set di regole.

Set di regole dinamici e con ambito sessione

I set di regole dinamici e relativi alle sessioni vengono gestiti tramite JavaScript mentre è in uso un'estensione.

  • Le regole dinamiche vengono mantenute durante le sessioni del browser e gli upgrade delle estensioni.
  • Le regole per le sessioni vengono cancellate all'arresto del browser e all'installazione di una nuova versione dell'estensione.

Esiste un solo tipo di set di regole. Un'estensione può aggiungere o rimuovere le regole in modo dinamico chiamando updateDynamicRules() e updateSessionRules(), a condizione che i limiti delle regole non vengano superati. Per informazioni sui limiti delle regole, consulta l'articolo Limiti delle regole. Puoi vedere un esempio nella sezione Esempi di codice.

Set di regole statici

A differenza delle regole dinamiche e di sessione, le regole statiche vengono pacchettizzate, installate e aggiornate quando un'estensione viene installata o aggiornata. Sono archiviati in file di regole in formato JSON, che vengono indicati all'estensione utilizzando le chiavi "declarative_net_request" e "rule_resources" come descritto sopra, nonché uno o più dizionari Ruleset. Un dizionario Ruleset contiene un percorso al file di regole, un ID per la serie di regole contenuta nel file e indica se la serie di regole è attivata o meno. Gli ultimi due aspetti sono importanti quando si attiva o disattiva un set di regole in modo programmatico.

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

Per testare i file delle regole, carica l'estensione non pacchettizzata. Gli errori e gli avvisi relativi a regole statiche non valide vengono visualizzati solo per le estensioni non pacchettizzate. Le regole statiche non valide nelle estensioni pacchetti vengono ignorate.

Revisione rapida

Le modifiche ai set di regole statici possono essere idonee per la revisione rapida. Consulta la revisione rapida per le modifiche idonee.

Attivazione e disattivazione di regole e set di regole statici

È possibile abilitare o disabilitare sia le singole regole statiche sia i set di regole statici completi in fase di runtime.

L'insieme di regole e set di regole statici attivati viene mantenuto in tutte le sessioni del browser. Nessuno dei due viene mantenuto negli aggiornamenti delle estensioni, il che significa che solo le regole che hai scelto di lasciare nei file delle regole sono disponibili dopo un aggiornamento.

Per migliorare le prestazioni, esistono anche dei limiti al numero di regole e set di regole che possono essere abilitati contemporaneamente. Chiama il numero getAvailableStaticRuleCount() per verificare il numero di regole aggiuntive che possono essere attivate. Per informazioni sui limiti delle regole, consulta l'articolo Limiti delle regole.

Per attivare o disattivare le regole statiche, chiama updateStaticRules(). Questo metodo prende un oggetto UpdateStaticRulesOptions, che contiene array di ID di regole da attivare o disattivare. Gli ID vengono definiti usando la chiave "id" del dizionario Ruleset.

Per attivare o disattivare i rulesets statici, chiama updateEnabledRulesets(). Questo metodo prende un oggetto UpdateRulesetOptions, che contiene array di ID di set di regole da attivare o disattivare. Gli ID vengono definiti usando la chiave "id" del dizionario Ruleset.

Crea regole

Indipendentemente dal tipo, una regola inizia con quattro campi, come mostrato di seguito. Mentre le chiavi "id" e "priority" prendono un numero, le chiavi "action" e "condition" potrebbero prevedere diverse condizioni di blocco e reindirizzamento. La seguente regola blocca tutte le richieste di script provenienti da "foo.com" a qualsiasi URL con "abc" come sottostringa.

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

urlFiltra i caratteri corrispondenti

La chiave "condition" di una regola consente a una chiave "urlFilter" di agire sugli URL in un dominio specificato. Puoi creare i pattern utilizzando i token di corrispondenza dei pattern. Ecco alcuni esempi.

urlFilter Corrisponde a Non corrisponde
"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

Assegnazione della priorità alle regole

Le regole vengono attivate dalle richieste inviate dalle pagine web. Se più regole corrispondono a una determinata richiesta, queste devono avere la priorità. Questa sezione spiega come vengono assegnate le priorità. L'assegnazione delle priorità avviene in due fasi.

  1. La priorità è determinata per le regole all'interno di un'estensione.
  2. Se più estensioni possono applicare una regola a una richiesta, la priorità viene determinata per tutte le estensioni che soddisfano una determinata richiesta.

La corrispondenza avviene in questo modo: qualunque regola a cui è assegnata una determinata estensione, avrà quindi la priorità rispetto alle regole di altre estensioni.

Assegnazione della priorità alle regole all'interno di un'estensione

All'interno di una singola estensione, l'assegnazione delle priorità viene determinata mediante il seguente processo:

  1. Viene restituita la regola con la priorità definita dallo sviluppatore più alta (in altre parole, il campo "priority").

  2. Se sono presenti più regole con la priorità definita dallo sviluppatore più alta, le regole vengono assegnate con priorità utilizzando il campo "action", nel seguente ordine:

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

  3. Se il tipo di azione non è block o redirect, vengono valutate tutte le regole modifyHeaders corrispondenti. Tieni presente che se sono presenti regole con una priorità definita dallo sviluppatore inferiore alla priorità specificata per allow e allowAllRequests, queste regole vengono ignorate.

  4. Se più regole modificano la stessa intestazione, la modifica è determinata dal campo "priority" definito dallo sviluppatore e dalle operazioni specificate.

    • Se una regola viene aggiunta a un'intestazione, le regole con priorità inferiore possono aggiungere solo a quell'intestazione. Le operazioni di impostazione e rimozione non sono consentite.
    • Se una regola imposta un'intestazione, le regole con priorità inferiore possono essere aggiunte solo a quell'intestazione. Non sono consentite altre modifiche.
    • Se una regola rimuove un'intestazione, le regole con priorità inferiore non potranno modificare ulteriormente l'intestazione.

Assegnazione della priorità alle regole tra le estensioni

Se solo un'estensione ha una regola che corrisponde a una richiesta, tale regola viene applicata. Tuttavia, se più estensioni corrispondono a una richiesta, viene utilizzato il seguente processo:

  1. Per assegnare la priorità alle regole viene utilizzato il campo "action", nel seguente ordine:

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

  2. Se più di una regola corrisponde, l'estensione installata più di recente avrà la priorità.

Regole di sicurezza

Le regole sicure sono definite come regole con un'azione block, allow, allowAllRequests o upgradeScheme. Queste regole sono soggette a una quota aumentata per le regole dinamiche.

Limiti delle regole

Poiché esiste un overhead in termini di prestazioni per il caricamento e la valutazione delle regole nel browser, si applicano alcuni limiti quando si utilizza l'API. I limiti dipendono dal tipo di regola che stai utilizzando.

Regole statiche

Le regole statiche sono quelle specificate nei file delle regole dichiarati nel file manifest. Un'estensione può specificare fino a 100 rulesets statici come parte della chiave manifest "rule_resources", ma è possibile abilitare solo 50 set di regole alla volta. Quest'ultimo si chiama MAX_NUMBER_OF_ENABLED_STATIC_RULESETS. Collettivamente, questi insiemi di regole sono garantite per almeno 30.000 regole. Questo è chiamato GUARANTEED_MINIMUM_STATIC_RULES.

Il numero di regole disponibili dipende dal numero di regole attivate da tutte le estensioni installate sul browser di un utente. Puoi trovare questo numero in fase di runtime chiamando il numero getAvailableStaticRuleCount(). Puoi vedere un esempio nella sezione Esempi di codice.

Regole di sessione

Un'estensione può avere fino a 5000 regole per le sessioni. Questo viene esposto come MAX_NUMBER_OF_SESSION_RULES.

Prima di Chrome 120, esisteva un limite di 5000 regole combinate dinamiche e di sessione.

Regole dinamiche

Un'estensione può avere almeno 5000 regole dinamiche. Questo viene esposto come MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES.

A partire da Chrome 121, è previsto un limite più ampio,pari a 30.000 regole per le regole dinamiche sicure, indicate come MAX_NUMBER_OF_DYNAMIC_RULES. Anche eventuali regole non sicure aggiunte entro il limite di 5000 verranno conteggiate ai fini di questo limite.

Prima di Chrome 120, era previsto un limite di 5000 regole combinate dinamiche e di sessione.

Regole che utilizzano espressioni regolari

Tutti i tipi di regole possono utilizzare le espressioni regolari; tuttavia, il numero totale di regole per le espressioni regolari di ciascun tipo non può essere maggiore di 1000. Questo valore è denominato MAX_NUMBER_OF_REGEX_RULES.

Inoltre, una volta compilata, ciascuna regola deve essere inferiore a 2 kB. Ciò è correlato più o meno alla complessità della regola. Se tenti di caricare una regola che supera questo limite, viene visualizzato un avviso come il seguente e la regola verrà ignorata.

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

Interazioni con i service worker

Una richiesta declarativeNetRequest si applica solo alle richieste che raggiungono lo stack di rete. Sono incluse le risposte dalla cache HTTP, ma potrebbero non includere risposte che passano attraverso il gestore onfetch di un service worker. declarativeNetRequest non influirà sulle risposte generate dal service worker o recuperate da CacheStorage, ma influirà sulle chiamate a fetch() effettuate in un service worker.

Risorse accessibili dal web

Una regola declarativeNetRequest non può reindirizzare da una richiesta di risorsa pubblica a una risorsa non accessibile dal web. Questa operazione genera un errore. Questo si verifica anche se la risorsa accessibile sul web specificata è di proprietà dell'estensione di reindirizzamento. Per dichiarare le risorse per declarativeNetRequest, utilizza l'array "web_accessible_resources" del manifest.

Esempi

Esempi di codice

Aggiorna le regole dinamiche

L'esempio seguente mostra come chiamare updateDynamicRules(). La procedura per updateSessionRules() è la stessa.

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

Aggiornamento set di regole statici

L'esempio seguente illustra come attivare e disattivare i set di regole tenendo conto del numero di set di regole statici disponibili e di quello massimo abilitati. Questo accade quando il numero di regole statiche necessarie supera il numero consentito. Affinché questo comando funzioni, alcuni set di regole dovrebbero essere installati con alcuni di essi disabilitati (impostando "Enabled" su false all'interno del file manifest).

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

Esempi di regole

I seguenti esempi illustrano in che modo Chrome assegna la priorità alle regole in un'estensione. Quando le esamini, potresti voler aprire le regole di assegnazione delle priorità in un'altra finestra.

Il tasto "Priorità"

Questi esempi richiedono l'autorizzazione host per *://*.example.com/*.

Per stabilire la priorità di un determinato URL, osserva la chiave "priority" (definita dallo sviluppatore), la chiave "action" e la chiave "urlFilter". Questi esempi fanno riferimento al file di regole di esempio riportato di seguito.

Navigazione su https://google.com
Questo URL è gestito da due regole: le regole con ID 1 e 4. La regola con ID 1 si applica perché le azioni "block" hanno una priorità più alta rispetto a quelle in "redirect". Le altre regole non si applicano perché si riferiscono a URL più lunghi.
Navigazione all'indirizzo https://google.com/1234
A causa dell'URL più lungo, la regola con ID 2 ora corrisponde in aggiunta alle regole con ID 1 e 4. La regola con ID 2 si applica perché "allow" ha una priorità più alta di "block" e "redirect".
Navigazione all'indirizzo https://google.com/12345
Tutte e quattro le regole corrispondono a questo URL. La regola con ID 3 si applica perché la sua priorità definita dallo sviluppatore è la più alta del gruppo.
[
  {
    "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"] }
  },
]

Reindirizzamenti

L'esempio seguente richiede l'autorizzazione di hosting per *://*.example.com/*.

L'esempio seguente mostra come reindirizzare una richiesta da example.com a una pagina all'interno dell'estensione stessa. Il percorso dell'estensione /a.jpg viene risolto in chrome-extension://EXTENSION_ID/a.jpg, dove EXTENSION_ID è l'ID dell'estensione. Affinché questo comando funzioni, il manifest deve dichiarare /a.jpg come risorsa accessibile dal web.

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

Quanto segue utilizza la chiave "transform" per reindirizzare a un sottodominio di example.com. Utilizza un ancoraggio del nome di dominio ("||") per intercettare le richieste con qualsiasi schema da example.com. La chiave "scheme" in "transform" specifica che i reindirizzamenti al sottodominio utilizzeranno sempre "https".

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

L'esempio seguente utilizza le espressioni regolari per eseguire il reindirizzamento da https://www.abc.xyz.com/path a https://abc.xyz.com/path. Nella chiave "regexFilter", osserva come vengono utilizzati i caratteri di escape dei punti e che il gruppo di acquisizione seleziona "abc" o "def". La chiave "regexSubstitution" specifica la prima corrispondenza restituita dell'espressione regolare utilizzando "\1". In questo caso, "abc" viene acquisito dall'URL reindirizzato e inserito nella sostituzione.

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

Intestazioni

L'esempio seguente rimuove tutti i cookie da un frame principale e da eventuali frame secondari.

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

Tipi

DomainType

Indica se la richiesta è proprietaria o di terze parti del frame in cui è stata originata. Una richiesta viene considerata proprietaria se ha lo stesso dominio (eTLD+1) del frame in cui ha avuto origine la richiesta.

Enum

"firstParty"
La richiesta di rete è proprietaria del frame da cui è stata originata.

"thirdParty"
La richiesta di rete è di una terza parte del frame da cui è stata originata.

ExtensionActionOptions

Chrome 88 e versioni successive

Proprietà

  • displayActionCountAsBadgeText

    booleano facoltativo

    Indica se visualizzare automaticamente il conteggio delle azioni per una pagina come testo del badge dell'estensione. Questa preferenza è persistente in tutte le sessioni.

  • tabUpdate

    TabActionCountUpdate facoltativo

    Chrome 89 e versioni successive

    Dettagli su come deve essere modificato il conteggio delle azioni della scheda.

GetDisabledRuleIdsOptions

Chrome 111 e versioni successive

Proprietà

  • rulesetId

    stringa

    L'ID corrispondente a un elemento statico Ruleset.

GetRulesFilter

Chrome 111 e versioni successive

Proprietà

  • ruleIds

    numero[] facoltativo

    Se specificato, vengono incluse solo le regole con ID corrispondenti.

HeaderOperation

Chrome 86 e versioni successive

Descrive le possibili operazioni per una regola "modifyHeaders".

Enum

"append"
Aggiunge una nuova voce per l'intestazione specificata. Questa operazione non è supportata per le intestazioni delle richieste.

"set"
Imposta un nuovo valore per l'intestazione specificata, rimuovendo qualsiasi intestazione esistente con lo stesso nome.

"remove"
Rimuove tutte le voci per l'intestazione specificata.

IsRegexSupportedResult

Chrome 87 e versioni successive

Proprietà

  • isSupported

    boolean

  • motivo

    FacoltativoUnsupportedRegexReason

    Specifica il motivo per cui l'espressione regolare non è supportata. Fornito solo se isSupported è falso.

MatchedRule

Proprietà

  • ruleId

    numero

    L'ID di una regola corrispondente.

  • rulesetId

    stringa

    ID del Ruleset a cui appartiene questa regola. Per una regola che ha origine dall'insieme di regole dinamiche, il valore sarà pari a DYNAMIC_RULESET_ID.

MatchedRuleInfo

Proprietà

  • regola

    MatchedRule

  • tabId

    numero

    Il tabId della scheda da cui ha avuto origine la richiesta se la scheda è ancora attiva. Altrimenti -1.

  • timeStamp

    numero

    L'ora in cui è stata trovata una corrispondenza con la regola. I timestamp corrisponderanno alla convenzione JavaScript per i tempi, ovvero il numero di millisecondi dall'epoca.

MatchedRuleInfoDebug

Proprietà

  • richiesta

    RequestDetails

    Dettagli sulla richiesta a cui è stata rilevata la corrispondenza con la regola.

  • regola

    MatchedRule

MatchedRulesFilter

Proprietà

  • minTimeStamp

    numero facoltativo

    Se specificato, le regole vengono associate solo dopo il timestamp specificato.

  • tabId

    numero facoltativo

    Se specificato, corrisponde solo alle regole per la scheda specificata. Corrisponde alle regole non associate ad alcuna scheda attiva se impostata su -1.

ModifyHeaderInfo

Chrome 86 e versioni successive

Proprietà

  • intestazione

    stringa

    Il nome dell'intestazione da modificare.

  • operazione

    HeaderOperation

    L'operazione da eseguire su un'intestazione.

  • valore

    stringa facoltativo

    Il nuovo valore per l'intestazione. Deve essere specificato per le operazioni append e set.

QueryKeyValue

Proprietà

  • chiave

    stringa

  • replaceOnly

    booleano facoltativo

    Chrome 94 e versioni successive

    Nel primo caso, la chiave di query viene sostituita solo se è già presente. In caso contrario, la chiave viene aggiunta anche se non è presente. Il valore predefinito è false.

  • valore

    stringa

QueryTransform

Proprietà

  • addOrReplaceParams

    QueryKeyValue[] facoltativo

    L'elenco di coppie chiave-valore di query da aggiungere o sostituire.

  • removeParams

    string[] facoltativo

    L'elenco di chiavi di query da rimuovere.

Redirect

Proprietà

  • extensionPath

    stringa facoltativo

    Percorso relativo alla directory dell'estensione. Deve iniziare con "/".

  • regexSubstitution

    stringa facoltativo

    Pattern di sostituzione per le regole che specificano un regexFilter. La prima corrispondenza di regexFilter all'interno dell'URL verrà sostituita con questo pattern. All'interno di regexSubstitution, è possibile utilizzare cifre con caratteri di escape rovesciati (da \1 a \9) per inserire i gruppi di acquisizione corrispondenti. \0 si riferisce all'intero testo corrispondente.

  • e trasformerai

    URLTransform facoltativo

    Trasformazioni degli URL da eseguire.

  • url

    stringa facoltativo

    L'URL di reindirizzamento. I reindirizzamenti agli URL JavaScript non sono consentiti.

RegexOptions

Chrome 87 e versioni successive

Proprietà

  • isCaseSensitive

    booleano facoltativo

    Se il valore regex specificato è sensibile alle maiuscole. Il valore predefinito è true.

  • regex

    stringa

    L'espressione regolare da verificare.

  • requireCapturing

    booleano facoltativo

    Indica se è necessario acquisire il valore regex specificato. L'acquisizione è obbligatoria solo per le regole di reindirizzamento che specificano un'azione regexSubstition. Il valore predefinito è false.

RequestDetails

Proprietà

  • documentId

    stringa facoltativo

    Chrome 106 e versioni successive

    L'identificatore univoco del documento del frame, se la richiesta riguarda un frame.

  • documentLifecycle

    DocumentLifecycle facoltativo

    Chrome 106 e versioni successive

    Il ciclo di vita del documento del frame, se la richiesta riguarda un frame.

  • frameId

    numero

    Il valore 0 indica che la richiesta avviene nel frame principale; un valore positivo indica l'ID di un frame secondario in cui avviene la richiesta. Se il documento di un (sub-)frame viene caricato (type è main_frame o sub_frame), frameId indica l'ID di questo frame, non l'ID del frame esterno. Gli ID frame sono univoci all'interno di una scheda.

  • frameType

    FrameType facoltativo

    Chrome 106 e versioni successive

    Il tipo di frame, se la richiesta è relativa a un frame.

  • iniziatore

    stringa facoltativo

    L'origine in cui è stata avviata la richiesta. Ciò non avviene con i reindirizzamenti. Se si tratta di un'origine opaca, verrà utilizzata la stringa "null".

  • method

    stringa

    Metodo HTTP standard.

  • parentDocumentId

    stringa facoltativo

    Chrome 106 e versioni successive

    L'identificatore univoco del documento principale del frame, se la richiesta riguarda un frame e ne ha uno.

  • parentFrameId

    numero

    ID del frame che aggrega il frame che ha inviato la richiesta. Imposta il valore su -1 se non esiste alcun frame principale.

  • requestId

    stringa

    L'ID della richiesta. Gli ID richiesta sono univoci all'interno di una sessione del browser.

  • tabId

    numero

    L'ID della scheda in cui avviene la richiesta. Imposta su -1 se la richiesta non è correlata a una scheda.

  • Il tipo di risorsa della richiesta.

  • url

    stringa

    L'URL della richiesta.

RequestMethod

Chrome 91 e versioni successive

Descrive il metodo di richiesta HTTP di una richiesta di rete.

Enum

"get"

"head"

"patch"

"post"

"put"

ResourceType

Descrive il tipo di risorsa della richiesta di rete.

Enum

"main_frame"

"sub_frame"

"script"

"image"

"font"

"object"

"xmlhttprequest"

"ping"

"csp_report"

"media"

"websocket"

"webbundle"

Rule

Proprietà

  • azione

    RuleAction

    L'azione da eseguire in caso di corrispondenza a questa regola.

  • Condizione

    RuleCondition

    La condizione in cui viene attivata questa regola.

  • ID

    numero

    Un ID che identifica in modo univoco una regola. È obbligatorio e deve essere maggiore o uguale a 1.

  • delle campagne

    numero facoltativo

    Priorità della regola. Il valore predefinito è 1. Se specificato, deve essere maggiore o uguale a 1.

RuleAction

Proprietà

  • reindirizzamento

    Reindirizzamento facoltativo

    Descrive come deve essere eseguito il reindirizzamento. Valido solo per le regole di reindirizzamento.

  • requestHeaders

    ModifyHeaderInfo[] facoltativo

    Chrome 86 e versioni successive

    Le intestazioni della richiesta da modificare per la richiesta. Valido solo se RuleActionType è "modifyHeaders".

  • responseHeaders

    ModifyHeaderInfo[] facoltativo

    Chrome 86 e versioni successive

    Le intestazioni della risposta da modificare per la richiesta. Valido solo se RuleActionType è "modifyHeaders".

  • Il tipo di azione da eseguire.

RuleActionType

Descrive il tipo di azione da intraprendere se una determinata condizione della regola corrisponde.

Enum

"block"
Blocca la richiesta di rete.

"redirect"
Reindirizza la richiesta di rete.

"allow"
Consenti la richiesta di rete. La richiesta non verrà intercettata se esiste una regola di autorizzazione corrispondente.

"upgradeScheme"
Esegui l'upgrade dello schema dell'URL delle richieste di rete a https se la richiesta è http o ftp.

"modifyHeaders"
Modifica le intestazioni di richiesta/risposta dalla richiesta di rete.

"allowAllRequests"
Consenti tutte le richieste all'interno di una gerarchia di frame, inclusa la richiesta frame stessa.

RuleCondition

Proprietà

  • domainType

    DomainType facoltativo

    Specifica se la richiesta di rete è proprietaria o di terze parti del dominio da cui ha avuto origine. Se omesso, tutte le richieste vengono accettate.

  • domini

    string[] facoltativo

    Ritirato da Chrome 101

    In alternativa, utilizza initiatorDomains

    La regola corrisponderà solo alle richieste di rete provenienti dall'elenco di domains.

  • excludedDomains

    string[] facoltativo

    Ritirato da Chrome 101

    In alternativa, utilizza excludedInitiatorDomains

    La regola non corrisponderà alle richieste di rete provenienti dall'elenco di excludedDomains.

  • excludedInitiatorDomains

    string[] facoltativo

    Chrome 101 e versioni successive

    La regola non corrisponderà alle richieste di rete provenienti dall'elenco di excludedInitiatorDomains. Se l'elenco è vuoto o omesso, nessun dominio viene escluso. Ha la precedenza su initiatorDomains.

    Note:

    • Sono consentiti anche i sottodomini come "a.example.com".
    • Le voci devono contenere solo caratteri ASCII.
    • Utilizza la codifica punycode per i domini internazionalizzati.
    • Questo corrisponde all'iniziatore della richiesta e non all'URL della richiesta.
    • Sono esclusi anche i sottodomini dei domini elencati.
  • excludedRequestDomains

    string[] facoltativo

    Chrome 101 e versioni successive

    La regola non corrisponderà alle richieste di rete quando i domini corrispondono a uno dell'elenco di excludedRequestDomains. Se l'elenco è vuoto o omesso, nessun dominio viene escluso. Ha la precedenza su requestDomains.

    Note:

    • Sono consentiti anche i sottodomini come "a.example.com".
    • Le voci devono contenere solo caratteri ASCII.
    • Utilizza la codifica punycode per i domini internazionalizzati.
    • Sono esclusi anche i sottodomini dei domini elencati.
  • excludedRequestMethods

    RequestMethod[] facoltativo

    Chrome 91 e versioni successive

    Elenco dei metodi di richiesta non corrispondenti alla regola. È necessario specificare solo uno tra requestMethods e excludedRequestMethods. Se nessuno dei due metodi viene specificato, viene trovata una corrispondenza con tutti i metodi di richiesta.

  • excludedResourceTypes

    ResourceType[] facoltativo

    Elenco dei tipi di risorse a cui la regola non corrisponderà. È necessario specificare solo uno tra resourceTypes e excludedResourceTypes. Se nessuno dei due viene specificato, tutti i tipi di risorse tranne "main_frame" vengono bloccati.

  • excludedTabIds

    numero[] facoltativo

    Chrome 92 e versioni successive

    Elenco di tabs.Tab.id che non devono corrispondere alla regola. L'ID tabs.TAB_ID_NONE esclude le richieste che non provengono da una scheda. Supportata solo per le regole basate sulle sessioni.

  • initiatorDomains

    string[] facoltativo

    Chrome 101 e versioni successive

    La regola corrisponderà solo alle richieste di rete provenienti dall'elenco di initiatorDomains. Se l'elenco viene omesso, la regola viene applicata alle richieste provenienti da tutti i domini. Non è consentito un elenco vuoto.

    Note:

    • Sono consentiti anche i sottodomini come "a.example.com".
    • Le voci devono contenere solo caratteri ASCII.
    • Utilizza la codifica punycode per i domini internazionalizzati.
    • Questo corrisponde all'iniziatore della richiesta e non all'URL della richiesta.
    • Vengono corrispondenti anche i sottodomini dei domini elencati.
  • isUrlFilterCaseSensitive

    booleano facoltativo

    Se urlFilter o regexFilter (a seconda di quale sia specificata) è sensibile alle maiuscole. Il valore predefinito è false.

  • regexFilter

    stringa facoltativo

    Espressione regolare per trovare una corrispondenza con l'URL della richiesta di rete. Questa operazione segue la sintassi RE2.

    Nota: è possibile specificare un solo elemento tra urlFilter o regexFilter.

    Nota: regexFilter deve essere composto solo da caratteri ASCII. Questo viene abbinato a un URL in cui l'host è codificato nel formato punycode (in caso di domini internazionalizzati) e tutti gli altri caratteri non ASCII sono codificati in formato utf-8.

  • requestDomains

    string[] facoltativo

    Chrome 101 e versioni successive

    La regola corrisponderà alle richieste di rete solo se il dominio corrisponde a una richiesta nell'elenco di requestDomains. Se l'elenco viene omesso, la regola viene applicata alle richieste provenienti da tutti i domini. Non è consentito un elenco vuoto.

    Note:

    • Sono consentiti anche i sottodomini come "a.example.com".
    • Le voci devono contenere solo caratteri ASCII.
    • Utilizza la codifica punycode per i domini internazionalizzati.
    • Vengono corrispondenti anche i sottodomini dei domini elencati.
  • requestMethods

    RequestMethod[] facoltativo

    Chrome 91 e versioni successive

    Elenco di metodi di richiesta HTTP con cui la regola può corrispondere. Non è consentito un elenco vuoto.

    Nota: se specifichi una condizione della regola requestMethods, verranno escluse anche le richieste non HTTP(s), mentre se specifichi excludedRequestMethods no.

  • resourceTypes

    ResourceType[] facoltativo

    Elenco dei tipi di risorse a cui la regola può corrispondere. Non è consentito un elenco vuoto.

    Nota: deve essere specificato per le regole allowAllRequests e può includere solo i tipi di risorse sub_frame e main_frame.

  • tabIds

    numero[] facoltativo

    Chrome 92 e versioni successive

    Elenco di tabs.Tab.id a cui la regola deve corrispondere. L'ID tabs.TAB_ID_NONE corrisponde alle richieste che non provengono da una scheda. Non è consentito un elenco vuoto. Supportata solo per le regole basate sulle sessioni.

  • urlFilter

    stringa facoltativo

    Il pattern che viene confrontato con l'URL della richiesta di rete. Costrutti supportati:

    '*' : jolly: trova qualsiasi numero di caratteri.

    '|' : ancoraggio a sinistra/destra: se utilizzato a una delle due estremità del pattern, consente di specificare rispettivamente l'inizio e la fine dell'URL.

    '||' : ancoraggio del nome di dominio: se utilizzato all'inizio del pattern, specifica l'inizio di un (sotto)dominio dell'URL.

    '^' : separatore: corrisponde a qualsiasi cosa tranne una lettera, una cifra o uno dei seguenti: _, -, . o %. Corrisponde anche alla fine dell'URL.

    Di conseguenza, urlFilter è composto dalle seguenti parti: (ancoraggio sinistro/nome di dominio facoltativo) + pattern + (ancoraggio a destra facoltativo).

    Se omesso, viene trovata una corrispondenza per tutti gli URL. Non è consentita una stringa vuota.

    Non è consentito utilizzare un pattern che inizia con ||*. Usa invece il criterio *.

    Nota: è possibile specificare un solo elemento tra urlFilter o regexFilter.

    Nota: urlFilter deve essere composto solo da caratteri ASCII. Questo viene abbinato a un URL in cui l'host è codificato nel formato punycode (in caso di domini internazionalizzati) e tutti gli altri caratteri non ASCII sono codificati in formato utf-8. Ad esempio, se l'URL della richiesta è http://abc.рCerchi?q=impostare, il valore urlFilter verrà abbinato all'URL http://abc.xn--p1ai/?q=%D1%84.

Ruleset

Proprietà

  • abilitata

    boolean

    Indica se il set di regole è abilitato per impostazione predefinita.

  • ID

    stringa

    Una stringa non vuota che identifica in modo univoco la serie di regole. Gli ID che iniziano con "_" sono riservati per uso interno.

  • percorso

    stringa

    Il percorso del set di regole JSON relativo alla directory dell'estensione.

RulesMatchedDetails

Proprietà

  • rulesMatchedInfo

    MatchedRuleInfo[]

    Regole corrispondenti al filtro specificato.

TabActionCountUpdate

Chrome 89 e versioni successive

Proprietà

  • aumenta

    numero

    L'importo di cui incrementare il conteggio delle azioni della scheda. I valori negativi diminuiranno il conteggio.

  • tabId

    numero

    La scheda per cui aggiornare il conteggio delle azioni.

TestMatchOutcomeResult

Chrome 103 e versioni successive

Proprietà

  • matchedRules

    MatchedRule[]

    Le regole (se presenti) che soddisfano la richiesta ipotetica.

TestMatchRequestDetails

Chrome 103 e versioni successive

Proprietà

  • iniziatore

    stringa facoltativo

    L'URL dell'iniziatore (se presente) per la richiesta ipotetica.

  • method

    RequestMethod facoltativo

    Metodo HTTP standard della richiesta ipotetica. Il valore predefinito è "get" per le richieste HTTP e viene ignorato per le richieste non HTTP.

  • tabId

    numero facoltativo

    L'ID della scheda in cui avviene la richiesta ipotetica. Non deve necessariamente corrispondere a un ID scheda reale. Il valore predefinito è -1, il che significa che la richiesta non è correlata a una scheda.

  • Il tipo di risorsa della richiesta ipotetica.

  • url

    stringa

    L'URL della richiesta ipotetica.

UnsupportedRegexReason

Chrome 87 e versioni successive

Descrive il motivo per cui una determinata espressione regolare non è supportata.

Enum

"syntaxError"
L'espressione regolare è sintatticamente errata oppure utilizza funzionalità non disponibili nella sintassi RE2.

"memoryLimitExceeded"
L'espressione regolare supera il limite di memoria.

UpdateRuleOptions

Chrome 87 e versioni successive

Proprietà

  • addRules

    Regola[] facoltativa

    Regole da aggiungere.

  • removeRuleIds

    numero[] facoltativo

    ID delle regole da rimuovere. Eventuali ID non validi verranno ignorati.

UpdateRulesetOptions

Chrome 87 e versioni successive

Proprietà

  • disableRulesetIds

    string[] facoltativo

    L'insieme di ID corrispondente a un elemento Ruleset statico che deve essere disattivato.

  • enableRulesetIds

    string[] facoltativo

    L'insieme di ID corrispondente a un elemento Ruleset statico che deve essere attivato.

UpdateStaticRulesOptions

Chrome 111 e versioni successive

Proprietà

  • disableRuleIds

    numero[] facoltativo

    Insieme di ID corrispondenti alle regole in Ruleset da disattivare.

  • enableRuleIds

    numero[] facoltativo

    Insieme di ID corrispondenti alle regole in Ruleset da attivare.

  • rulesetId

    stringa

    L'ID corrispondente a un elemento statico Ruleset.

URLTransform

Proprietà

  • frammento

    stringa facoltativo

    Il nuovo frammento per la richiesta. Deve essere vuoto, nel qual caso il frammento esistente viene cancellato oppure deve iniziare con "#".

  • organizzatore

    stringa facoltativo

    Il nuovo host per la richiesta.

  • password

    stringa facoltativo

    La nuova password per la richiesta.

  • percorso

    stringa facoltativo

    Il nuovo percorso della richiesta. Se è vuoto, il percorso esistente viene cancellato.

  • porta

    stringa facoltativo

    La nuova porta per la richiesta. Se è vuoto, la porta esistente viene cancellata.

  • query

    stringa facoltativo

    La nuova query per la richiesta. Deve essere vuoto, nel qual caso la query esistente viene cancellata oppure deve iniziare con "?".

  • queryTransform

    QueryTransform facoltativo

    Aggiungi, rimuovi o sostituisci coppie chiave-valore della query.

  • schema

    stringa facoltativo

    Il nuovo schema per la richiesta. I valori consentiti sono "http", "https", "ftp" e "chrome-extension".

  • nome utente

    stringa facoltativo

    Il nuovo nome utente per la richiesta.

Proprietà

DYNAMIC_RULESET_ID

ID set di regole per le regole dinamiche aggiunte dall'estensione.

Valore

GETMATCHEDRULES_QUOTA_INTERVAL

Intervallo di tempo entro il quale è possibile effettuare chiamate a MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL getMatchedRules, specificato in minuti. Le chiamate aggiuntive non riusciranno immediatamente e verranno impostate runtime.lastError. Nota: le chiamate getMatchedRules associate a un gesto dell'utente sono esenti dalla quota.

Valore

10

GUARANTEED_MINIMUM_STATIC_RULES

Chrome 89 e versioni successive

Il numero minimo di regole statiche garantite a un'estensione nei relativi set di regole statici abilitati. Qualsiasi regola che supera questo limite verrà conteggiata ai fini del limite di regole statico globale.

Valore

30.000

MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL

Il numero di volte in cui è possibile chiamare getMatchedRules in un periodo di GETMATCHEDRULES_QUOTA_INTERVAL.

Valore

20

MAX_NUMBER_OF_DYNAMIC_RULES

Il numero massimo di regole dinamiche che un'estensione può aggiungere.

Valore

30.000

MAX_NUMBER_OF_ENABLED_STATIC_RULESETS

Chrome 94 e versioni successive

Il numero massimo di Rulesets statici che un'estensione può attivare in qualsiasi momento.

Valore

50

MAX_NUMBER_OF_REGEX_RULES

Il numero massimo di regole basate su espressioni regolari che un'estensione può aggiungere. Questo limite viene valutato separatamente per l'insieme di regole dinamiche e per quelle specificate nel file delle risorse delle regole.

Valore

1000

MAX_NUMBER_OF_SESSION_RULES

Chrome 120 e versioni successive

Il numero massimo di regole con ambito a livello di sessione che un'estensione può aggiungere.

Valore

5000

MAX_NUMBER_OF_STATIC_RULESETS

Il numero massimo di Rulesets statici che un'estensione può specificare come parte della chiave manifest "rule_resources".

Valore

100

MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES

Chrome 120 e versioni successive

Il numero massimo di regole dinamiche "non sicure" che un'estensione può aggiungere.

Valore

5000

MAX_NUMBER_OF_UNSAFE_SESSION_RULES

Chrome 120 e versioni successive

Il numero massimo di regole con ambito a livello di sessione "non sicure" che un'estensione può aggiungere.

Valore

5000

SESSION_RULESET_ID

Chrome 90 e versioni successive

ID set di regole per le regole basate sulle sessioni aggiunte dall'estensione.

Valore

"_session"

Metodi

getAvailableStaticRuleCount()

Promesso Chrome 89 o versioni successive 
chrome.declarativeNetRequest.getAvailableStaticRuleCount(
  callback?: function,
)

Restituisce il numero di regole statiche che un'estensione può attivare prima che venga raggiunto il limite di regole statiche globale.

Parametri

  • callback

    funzione facoltativa

    Il parametro callback ha un aspetto simile al seguente: 

    (count: number) => void

    • count

      numero

Valori restituiti

  • Promesso<numero>

    Chrome 91 e versioni successive

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo passato al callback.

getDisabledRuleIds()

Promesso Chrome 111 o versioni successive 
chrome.declarativeNetRequest.getDisabledRuleIds(
  options: GetDisabledRuleIdsOptions,
  callback?: function,
)

Restituisce l'elenco di regole statiche nell'elemento Ruleset specificato che sono attualmente disattivate.

Parametri

  • opzioni del modello.

    GetDisabledRuleIdsOptions

    Specifica il set di regole su cui eseguire la query.

  • callback

    funzione facoltativa

    Il parametro callback ha un aspetto simile al seguente: 

    (disabledRuleIds: number[]) => void

    • disabledRuleIds

      numero[]

Valori restituiti

  • Prometti<numero[]>

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo passato al callback.

getDynamicRules()

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

Restituisce l'insieme corrente di regole dinamiche per l'estensione. I chiamanti possono facoltativamente filtrare l'elenco delle regole recuperate specificando un filter.

Parametri

  • filtra

    GetRulesFilter facoltativo

    Chrome 111 e versioni successive

    Un oggetto per filtrare l'elenco delle regole recuperate.

  • callback

    funzione facoltativa

    Il parametro callback ha un aspetto simile al seguente: 

    (rules: Rule[]) => void

Valori restituiti

  • Prometti<regola[]>

    Chrome 91 e versioni successive

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo passato al callback.

getEnabledRulesets()

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

Restituisce gli ID per l'insieme corrente di set di regole statici abilitati.

Parametri

  • callback

    funzione facoltativa

    Il parametro callback ha un aspetto simile al seguente: 

    (rulesetIds: string[]) => void

    • rulesetIds

      stringa[]

Valori restituiti

  • Promesso<string[]>

    Chrome 91 e versioni successive

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo passato al callback.

getMatchedRules()

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

Restituisce tutte le regole corrispondenti per l'estensione. I chiamanti possono facoltativamente filtrare l'elenco delle regole corrispondenti specificando un filter. Questo metodo è disponibile soltanto per le estensioni con l'autorizzazione "declarativeNetRequestFeedback" o per le quali è stata concessa l'autorizzazione "activeTab" per il tabId specificato in filter. Nota: le regole non associate a un documento attivo che sono state associate più di cinque minuti prima non verranno restituite.

Parametri

Valori restituiti

  • Chrome 91 e versioni successive

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo passato al callback.

getSessionRules()

Promesso Chrome 90 o versioni successive 
chrome.declarativeNetRequest.getSessionRules(
  filter?: GetRulesFilter,
  callback?: function,
)

Restituisce l'insieme corrente di regole con ambito a livello di sessione per l'estensione. I chiamanti possono facoltativamente filtrare l'elenco delle regole recuperate specificando un filter.

Parametri

  • filtra

    GetRulesFilter facoltativo

    Chrome 111 e versioni successive

    Un oggetto per filtrare l'elenco delle regole recuperate.

  • callback

    funzione facoltativa

    Il parametro callback ha un aspetto simile al seguente: 

    (rules: Rule[]) => void

Valori restituiti

  • Prometti<regola[]>

    Chrome 91 e versioni successive

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo passato al callback.

isRegexSupported()

Prometti Chrome 87 e versioni successive 
chrome.declarativeNetRequest.isRegexSupported(
  regexOptions: RegexOptions,
  callback?: function,
)

Verifica se l'espressione regolare specificata sarà supportata come condizione della regola regexFilter.

Parametri

Valori restituiti

  • Chrome 91 e versioni successive

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo passato al callback.

setExtensionActionOptions()

Prometti Chrome 88 e versioni successive 
chrome.declarativeNetRequest.setExtensionActionOptions(
  options: ExtensionActionOptions,
  callback?: function,
)

Consente di configurare se il conteggio delle azioni per le schede deve essere visualizzato come testo del badge dell'azione dell'estensione e fornisce un modo per incrementare il conteggio delle azioni.

Parametri

  • opzioni del modello.

    ExtensionActionOptions

  • callback

    funzione facoltativa

    Chrome 89 e versioni successive

    Il parametro callback ha un aspetto simile al seguente: 

    () => void

Valori restituiti

  • Promise<void>

    Chrome 91 e versioni successive

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo passato al callback.

testMatchOutcome()

Promesso Chrome 103 o versioni successive 
chrome.declarativeNetRequest.testMatchOutcome(
  request: TestMatchRequestDetails,
  callback?: function,
)

Controlla se una delle regole declarativeNetRequest dell'estensione corrisponde a una richiesta ipotetica. Nota: disponibile solo per le estensioni non pacchettizzate, in quanto questa è destinata esclusivamente a essere utilizzata durante lo sviluppo delle estensioni.

Parametri

Valori restituiti

  • Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo passato al callback.

updateDynamicRules()

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

Consente di modificare l'insieme corrente di regole dinamiche per l'estensione. Prima vengono rimosse le regole con ID elencati in options.removeRuleIds e poi vengono aggiunte le regole specificate in options.addRules. Note:

  • Questo aggiornamento avviene come una singola operazione atomica: tutte le regole specificate vengono aggiunte e rimosse oppure viene restituito un errore.
  • Queste regole sono persistenti in tutte le sessioni del browser e negli aggiornamenti delle estensioni.
  • Le regole statiche specificate come parte del pacchetto di estensioni non possono essere rimosse utilizzando questa funzione.
  • MAX_NUMBER_OF_DYNAMIC_RULES è il numero massimo di regole dinamiche che un'estensione può aggiungere. Il numero di regole non sicure non deve superare MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES.

Parametri

  • opzioni del modello.

    UpdateRuleOptions

    Chrome 87 e versioni successive
  • callback

    funzione facoltativa

    Il parametro callback ha un aspetto simile al seguente: 

    () => void

Valori restituiti

  • Promise<void>

    Chrome 91 e versioni successive

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo passato al callback.

updateEnabledRulesets()

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

Consente di aggiornare l'insieme di set di regole statici abilitati per l'estensione. Le serie di regole con ID elencati nel campo options.disableRulesetIds vengono prima rimosse e poi vengono aggiunte le serie di regole elencate in options.enableRulesetIds. Tieni presente che l'insieme di set di regole statici attivati viene mantenuto tra le sessioni, ma non negli aggiornamenti delle estensioni, poiché la chiave manifest rule_resources determinerà l'insieme di set di regole statici attivati a ogni aggiornamento delle estensioni.

Parametri

  • opzioni del modello.

    UpdateRulesetOptions

    Chrome 87 e versioni successive
  • callback

    funzione facoltativa

    Il parametro callback ha un aspetto simile al seguente: 

    () => void

Valori restituiti

  • Promise<void>

    Chrome 91 e versioni successive

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo passato al callback.

updateSessionRules()

Promesso Chrome 90 o versioni successive 
chrome.declarativeNetRequest.updateSessionRules(
  options: UpdateRuleOptions,
  callback?: function,
)

Modifica l'insieme corrente di regole con ambito a livello di sessione per l'estensione. Prima vengono rimosse le regole con ID elencati in options.removeRuleIds e poi vengono aggiunte le regole specificate in options.addRules. Note:

  • Questo aggiornamento avviene come una singola operazione atomica: tutte le regole specificate vengono aggiunte e rimosse oppure viene restituito un errore.
  • Queste regole non vengono rese persistenti tra le sessioni e sono supportate in memoria.
  • MAX_NUMBER_OF_SESSION_RULES è il numero massimo di regole per le sessioni che un'estensione può aggiungere.

Parametri

  • opzioni del modello.

    UpdateRuleOptions

  • callback

    funzione facoltativa

    Il parametro callback ha un aspetto simile al seguente: 

    () => void

Valori restituiti

  • Promise<void>

    Chrome 91 e versioni successive

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo passato al callback.

updateStaticRules()

Promesso Chrome 111 o versioni successive 
chrome.declarativeNetRequest.updateStaticRules(
  options: UpdateStaticRulesOptions,
  callback?: function,
)

Disattiva e attiva singole regole statiche in una Ruleset. Le modifiche alle regole appartenenti a un Ruleset disattivato avranno effetto alla successiva attivazione.

Parametri

  • opzioni del modello.

    UpdateStaticRulesOptions

  • callback

    funzione facoltativa

    Il parametro callback ha un aspetto simile al seguente: 

    () => void

Valori restituiti

  • Promise<void>

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo passato al callback.

Eventi

onRuleMatchedDebug

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

Attivato quando una regola corrisponde a una richiesta. Disponibile solo per le estensioni non pacchettizzate con autorizzazione "declarativeNetRequestFeedback", in quanto questa è destinata a essere utilizzata esclusivamente a scopo di debug.

Parametri