Guida di riferimento alle API

Per funzionare, la maggior parte delle estensioni deve accedere a una o più API di Estensioni di Chrome. Questo riferimento API descrive le API disponibili per l'uso nelle estensioni e presenta casi d'uso di esempio.

Funzionalità comuni dell'API Extensions

Un'API Extensions è costituita da uno spazio dei nomi contenente metodi e proprietà per far funzionare le estensioni e solitamente, ma non sempre, campi manifest per il file manifest.json. Ad esempio, lo spazio dei nomi chrome.action richiede un oggetto "action" nel manifest. Molte API richiedono anche le autorizzazioni nel manifest.

Se non diversamente indicato, i metodi nelle API di estensione sono asincroni. I metodi asincroni vengono restituiti immediatamente, senza attendere il completamento dell'operazione che li chiama. Usa le promesse per ottenere i risultati di questi metodi. Per ulteriori informazioni, consulta la sezione Metodi asincroni.

API per le estensioni di Chrome

accessibilityFeatures

Usa l'API chrome.accessibilityFeatures per gestire le funzioni di accessibilità di Chrome. Questa API si basa sul prototipo ChromeSetting dell'API di tipo per recuperare e impostare singole funzioni di accessibilità. Per ricevere gli stati delle funzionalità, l'estensione deve richiedere l'autorizzazione accessibilityFeatures.read. Per modificare lo stato della funzionalità, l'estensione richiede l'autorizzazione accessibilityFeatures.modify. Tieni presente che accessibilityFeatures.modify non implica l'autorizzazione accessibilityFeatures.read.

azione
Chrome 88 e versioni successive MV3 o versioni successive

Utilizza l'API chrome.action per controllare l'icona dell'estensione nella barra degli strumenti di Google Chrome.

sveglie

Utilizza l'API chrome.alarms per pianificare il codice in modo che venga eseguito periodicamente o in un momento specifico nel futuro.

audio
Chrome 59 e versioni successive Solo ChromeOS

L'API chrome.audio viene fornita per consentire agli utenti di ottenere informazioni sui dispositivi audio collegati al sistema e controllarli. Questa API è attualmente disponibile solo in modalità kiosk per ChromeOS.

preferiti

Usa l'API chrome.bookmarks per creare, organizzare e manipolare in altro modo i preferiti. Consulta anche l'articolo Eseguire l'override delle pagine, che puoi utilizzare per creare una pagina Gestione Preferiti personalizzata.

browsingData

Utilizza l'API chrome.browsingData per rimuovere i dati di navigazione dal profilo locale di un utente.

certificateProvider
Chrome 46 e versioni successive Solo ChromeOS

Utilizza questa API per esporre i certificati alla piattaforma che li può usare per le autenticazioni TLS.

comandi

Utilizza l'API dei comandi per aggiungere scorciatoie da tastiera che attivano azioni nell'estensione, ad esempio un'azione per aprire l'azione del browser o inviare un comando all'estensione.

contentSettings

Utilizza l'API chrome.contentSettings per modificare le impostazioni che controllano se i siti web possono utilizzare funzionalità come cookie, JavaScript e plug-in. In termini più generali, le impostazioni dei contenuti consentono di personalizzare il comportamento di Chrome in base al sito anziché a livello globale.

contextMenus

Utilizza l'API chrome.contextMenus per aggiungere elementi al menu contestuale di Google Chrome. Puoi scegliere i tipi di oggetti a cui si applicano le aggiunte al menu contestuale, ad esempio immagini, link ipertestuali e pagine.

cookie

Usa l'API chrome.cookies per eseguire query e modificare i cookie e per ricevere una notifica quando cambiano.

debugger

L'API chrome.debugger funge da trasporto alternativo per il protocollo di debug remoto di Chrome. Usa chrome.debugger per collegarti a una o più schede allo strumento dell'interazione con la rete, eseguire il debug del codice JavaScript, modificare il DOM e il CSS e così via. Utilizza il comando tabId di debug per scegliere come target le schede con sendCommand e indirizza gli eventi tramite tabId dai callback onEvent.

declarativeContent

Usa l'API chrome.declarativeContent per eseguire azioni in base ai contenuti di una pagina, senza richiedere l'autorizzazione a leggerli.

declarativeNetRequest
Chrome 84 e versioni successive

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 visualizzare i relativi contenuti, garantendo così maggiore privacy.

desktopCapture

L'API Desktop Capture acquisisce il contenuto dello schermo, di singole finestre o singole schede.

devtools.inspectedWindow

Utilizza l'API chrome.devtools.inspectedWindow per interagire con la finestra ispezionata: ottieni l'ID scheda della pagina ispezionata, valuta il codice nel contesto della finestra ispezionata, ricarica la pagina oppure ricevi l'elenco delle risorse all'interno della pagina.

devtools.network

Utilizza l'API chrome.devtools.network per recuperare le informazioni sulle richieste di rete visualizzate dagli Strumenti per sviluppatori nel riquadro Rete.

devtools.panels

Utilizza l'API chrome.devtools.panels per integrare l'estensione nell'interfaccia utente della finestra Strumenti per sviluppatori: crea i tuoi riquadri, accedi a quelli esistenti e aggiungi barre laterali.

devtools.recorder
Chrome 105 e versioni successive

Usa l'API chrome.devtools.recorder per personalizzare il riquadro Registratore in DevTools.

dns
Canale di sviluppo

Utilizza l'API chrome.dns per la risoluzione DNS.

documentScan
Chrome 44 e versioni successive Solo ChromeOS

Utilizza l'API chrome.documentScan per trovare e recuperare le immagini dagli scanner di documenti allegati.

dom
Chrome 88 e versioni successive

Utilizza l'API chrome.dom per accedere a API DOM speciali per le estensioni

download

Utilizza l'API chrome.downloads per avviare, monitorare, manipolare e cercare i download in modo programmatico.

enterprise.deviceAttributes
Chrome 46 e versioni successive Solo ChromeOS Richiede criterio

Usa l'API chrome.enterprise.deviceAttributes per leggere gli attributi dei dispositivi. Nota: questa API è disponibile solo per le estensioni con installazione forzata in base ai criteri aziendali.

enterprise.hardwarePlatform
Chrome 71 e versioni successive Criterio richiesto

Utilizza l'API chrome.enterprise.hardwarePlatform per ottenere il produttore e il modello della piattaforma hardware su cui viene eseguito il browser. Nota: questa API è disponibile solo per le estensioni installate in base ai criteri aziendali.

enterprise.networkingAttributes
Chrome 85 e versioni successive Solo ChromeOS Criterio richiesto

Usa l'API chrome.enterprise.networkingAttributes per leggere le informazioni sulla tua rete attuale. Nota: questa API è disponibile solo per le estensioni con installazione forzata in base ai criteri aziendali.

enterprise.platformKeys
Solo ChromeOS Criterio richiesto

Usa l'API chrome.enterprise.platformKeys per generare chiavi e installare certificati per queste chiavi. I certificati verranno gestiti dalla piattaforma e potranno essere utilizzati per l'autenticazione TLS, l'accesso alla rete o altre estensioni tramite {@link platformKeys chrome.platformKeys}.

eventi

Lo spazio dei nomi chrome.events contiene tipi comuni utilizzati dalle API che inviano eventi per avvisarti quando succede qualcosa di interessante.

estensione

L'API chrome.extension contiene utilità che possono essere utilizzate da qualsiasi pagina di estensione. Include il supporto per lo scambio di messaggi tra un'estensione e i relativi script di contenuti o tra le estensioni, come descritto in dettaglio nella sezione Trasmissione di messaggi.

extensionTypes

L'API chrome.extensionTypes contiene dichiarazioni del tipo per le estensioni di Chrome.

fileBrowserHandler
Solo ChromeOS Solo in primo piano

Utilizza l'API chrome.fileBrowserHandler per estendere il browser di file di ChromeOS. Ad esempio, puoi utilizzare questa API per consentire agli utenti di caricare file sul tuo sito web.

fileSystemProvider
Solo ChromeOS

Utilizza l'API chrome.fileSystemProvider per creare file system accessibili dal gestore di file su ChromeOS.

fontSettings

Usa l'API chrome.fontSettings per gestire le impostazioni dei caratteri di Chrome.

gcm

Utilizza chrome.gcm per abilitare app ed estensioni all'invio e alla ricezione di messaggi tramite Firebase Cloud Messaging (FCM).

cronologia

Utilizza l'API chrome.history per interagire con il record del browser delle pagine visitate. Puoi aggiungere, rimuovere ed eseguire query sugli URL nella cronologia del browser. Per eseguire l'override della pagina della cronologia con la tua versione, consulta la sezione Override pagine.

i18n

Utilizza l'infrastruttura chrome.i18n per implementare l'internazionalizzazione nell'intera app o estensione.

identità

Utilizza l'API chrome.identity per ottenere i token di accesso OAuth2.

inattivo

Usa l'API chrome.idle per rilevare quando lo stato di inattività della macchina cambia.

input.ime

Utilizza l'API chrome.input.ime per implementare un IME personalizzato per ChromeOS. In questo modo l'estensione può gestire le sequenze di tasti, impostare la composizione e gestire la finestra candidata.

instanceID
Chrome 44 e versioni successive

Usa chrome.instanceID per accedere al servizio ID istanza.

loginState
Chrome 78 e versioni successive Solo ChromeOS

Utilizza l'API chrome.loginState per leggere e monitorare lo stato dell'accesso.

video

L'API chrome.management fornisce modi per gestire l'elenco di estensioni/app installate e in esecuzione. È particolarmente utile per le estensioni che sostituiscono la pagina Nuova scheda integrata.

notifiche

Utilizza l'API chrome.notifications per creare notifiche avanzate utilizzando i modelli e mostrare queste notifiche agli utenti nella barra delle applicazioni.

fuori schermo
Chrome 109 e versioni successive MV3 o versioni successive

Usa l'API offscreen per creare e gestire i documenti fuori schermo.

omnibox

L'API omnibox ti consente di registrare una parola chiave con la barra degli indirizzi di Google Chrome, nota anche come omnibox.

pageCapture

Utilizza l'API chrome.pageCapture per salvare una scheda in formato MHTML.

autorizzazioni

Utilizza l'API chrome.permissions per richiedere le autorizzazioni facoltative dichiarate in fase di esecuzione, anziché di installazione, in modo che gli utenti capiscano perché le autorizzazioni sono necessarie e concedino solo quelle necessarie.

platformKeys
Chrome 45 e versioni successive Solo ChromeOS

Utilizza l'API chrome.platformKeys per accedere ai certificati client gestiti dalla piattaforma. Se l'utente o il criterio concedono l'autorizzazione, un'estensione può usare tale certificato nel proprio protocollo di autenticazione personalizzato. Ad esempio, ciò consente l'utilizzo di certificati gestiti dalla piattaforma in VPN di terze parti (vedi {@link vpnProvider chrome.vpnProvider}).

alimentazione

Utilizza l'API chrome.power per eseguire l'override delle funzionalità di gestione dell'alimentazione del sistema.

printerProvider
Chrome 44 e versioni successive

L'API chrome.printerProvider mostra gli eventi utilizzati dal gestore di stampa per eseguire query sulle stampanti controllate da estensioni, per eseguire query sulle loro funzionalità e per inviare processi di stampa a queste stampanti.

stampa
Chrome 81 e versioni successive Solo ChromeOS

Usa l'API chrome.printing per inviare processi di stampa alle stampanti installate su Chromebook.

printingMetrics
Chrome 79 e versioni successive Solo ChromeOS Richiede criterio

Utilizza l'API chrome.printingMetrics per recuperare i dati sull'utilizzo della stampa.

privacy

Usa l'API chrome.privacy per controllare l'utilizzo delle funzionalità di Chrome che possono influire sulla privacy di un utente. Questa API si basa sul prototipo di API ChromeSetting per recuperare e impostare la configurazione di Chrome.

processi
Canale di sviluppo

Utilizza l'API chrome.processes per interagire con i processi del browser.

proxy

Utilizza l'API chrome.proxy per gestire le impostazioni del proxy di Chrome. Questa API si basa sul prototipo di API ChromeSetting per recuperare e impostare la configurazione del proxy.

readingList
Chrome 120 e versioni successive MV3 o versioni successive

Utilizza l'API chrome.readingList per leggere e modificare gli elementi nell'Elenco di lettura.

runtime

Utilizza l'API chrome.runtime per recuperare il service worker, restituire i dettagli del manifest e ascoltare gli eventi e rispondere durante il ciclo di vita dell'estensione. Puoi utilizzare questa API anche per convertire il percorso relativo degli URL in URL completi.

scripting
Chrome 88 e versioni successive MV3 o versioni successive

Utilizza l'API chrome.scripting per eseguire lo script in contesti diversi.

search
Chrome 87 e versioni successive

Utilizza l'API chrome.search per eseguire ricerche tramite il provider predefinito.

sessioni

Utilizza l'API chrome.sessions per eseguire query e ripristinare schede e finestre da una sessione di navigazione.

sidePanel
Chrome 114 e versioni successive MV3 o versioni successive

Usa l'API chrome.sidePanel per ospitare i contenuti nel riquadro laterale del browser insieme ai contenuti principali di una pagina web.

spazio di archiviazione

Utilizza l'API chrome.storage per archiviare, recuperare e monitorare le modifiche ai dati utente.

system.cpu

Usa l'API system.cpu per eseguire query sui metadati della CPU.

system.display

Utilizza l'API system.display per eseguire una query sui metadati di visualizzazione.

system.memory

L'API chrome.system.memory.

system.storage

Usa l'API chrome.system.storage per eseguire query sulle informazioni del dispositivo di archiviazione e ricevere una notifica quando un dispositivo di archiviazione rimovibile viene collegato e scollegato.

systemLog
In attesa Solo ChromeOS Richiede criterio

Usa l'API chrome.systemLog per registrare i log di sistema di Chrome dalle estensioni.

tabCapture

Usa l'API chrome.tabCapture per interagire con gli stream multimediali delle schede.

tabGroups
Chrome 89 e versioni successive MV3 o versioni successive

Utilizza l'API chrome.tabGroups per interagire con il sistema di raggruppamento delle schede del browser. Puoi utilizzare questa API per modificare e riorganizzare i gruppi di schede nel browser. Per raggruppare e separare le schede o per eseguire query sulle schede che sono inserite nei gruppi, utilizza l'API chrome.tabs.

schede

Utilizza l'API chrome.tabs per interagire con il sistema di schede del browser. Puoi utilizzare questa API per creare, modificare e ridisporre le schede nel browser.

topSites

Utilizza l'API chrome.topSites per accedere ai siti principali (ovvero i siti più visitati) visualizzati nella pagina Nuova scheda. Non includono scorciatoie personalizzate dall'utente.

tts

Utilizza l'API chrome.tts per riprodurre la sintesi vocale (TTS) sintetizzata. Vedi anche l'API {@link ttsEngine} correlata, che consente a un'estensione di implementare un motore di riconoscimento vocale.

ttsEngine

Utilizza l'API chrome.ttsEngine per implementare un motore di sintesi vocale(TTS) utilizzando un'estensione. Se l'estensione si registra utilizzando questa API, riceverà eventi contenenti un'espressione da pronunciare e altri parametri quando un'estensione o un'App di Chrome utilizza l'API {@link tts} per generare la sintesi vocale. L'estensione può quindi utilizzare qualsiasi tecnologia web disponibile per sintetizzare e riprodurre il parlato, nonché per inviare gli eventi alla funzione chiamante per segnalare lo stato.

tipi

L'API chrome.types contiene dichiarazioni del tipo per Chrome.

userScripts
Chrome 120 e versioni successive MV3 o versioni successive

Utilizza l'API userScripts per eseguire script utente nel contesto degli script utente.

vpnProvider
Chrome 43 e versioni successive Solo ChromeOS

Utilizza l'API chrome.vpnProvider per implementare un client VPN.

Chrome 43 e versioni successive Solo ChromeOS

Utilizza l'API chrome.wallpaper per cambiare lo sfondo di ChromeOS.

webAuthenticationProxy
Chrome 115 e versioni successive MV3 o versioni successive

L'API chrome.webAuthenticationProxy consente al software Remote Desktop eseguito su un host remoto di intercettare le richieste dell'API Web Authenticationn (WebAuthn) per gestirle su un client locale.

webNavigation

Utilizza l'API chrome.webNavigation per ricevere notifiche sullo stato delle richieste di navigazione in corso.

webRequest

Utilizza l'API chrome.webRequest per osservare e analizzare il traffico e per intercettare, bloccare o modificare le richieste in corso.

finestre

Utilizza l'API chrome.windows per interagire con le finestre del browser. Puoi utilizzare questa API per creare, modificare e ridisporre le finestre nel browser.