Riferimento API

La maggior parte delle estensioni ha bisogno di accedere a una o più API di estensioni di Chrome per funzionare. Questo riferimento all'API descrive le API disponibili per l'utilizzo nelle estensioni e presenta casi d'uso di esempio.

Funzionalità comuni dell'API Common Extensions

Un'API Extensions è costituita da uno spazio dei nomi che contiene metodi e proprietà per il funzionamento delle estensioni e, di solito, ma non sempre, i campi manifest per il file manifest.json. Ad esempio, lo spazio dei nomi chrome.action richiede un oggetto "action" nel file manifest. Molte API richiedono anche le autorizzazioni nel manifest.

I metodi nelle API di estensione sono a sincronia asincrona, se non diversamente indicato. I metodi asincroni restituiscono immediatamente il risultato, senza attendere la fine dell'operazione che li chiama. Utilizza le promesse per ottenere i risultati di questi metodi asincroni.

Manifest V3 è supportato in genere in Chrome 88 o versioni successive. Per le funzionalità delle estensioni aggiunte nelle versioni successive di Chrome, consulta la documentazione di riferimento dell'API per informazioni sull'assistenza. Se la tua estensione richiede un'API specifica, puoi specificare una versione minima di Chrome nel file manifest.

API di 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 ottenere e impostare le singole funzionalità di accessibilità. Per ottenere gli stati delle funzionalità, l'estensione deve richiedere l'autorizzazione accessibilityFeatures.read. Per modificare lo stato delle funzionalità, l'estensione richiede l'autorizzazione accessibilityFeatures.modify. Tieni presente che accessibilityFeatures.modify non implica l'autorizzazione accessibilityFeatures.read.

action

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 l'esecuzione del codice periodicamente o in un orario specifico nel futuro.

audio

Chrome 59 e versioni successive Solo ChromeOS

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

preferiti

Utilizza l'API chrome.bookmarks per creare, organizzare e gestire i preferiti. Consulta anche Override Pages, 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 alla piattaforma i certificati che possono essere utilizzati per le autenticazioni TLS.

comandi

Utilizza l'API Commands 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 stabiliscono se i siti web possono utilizzare funzionalità quali cookie, JavaScript e plug-in. Più in generale, le impostazioni dei contenuti ti 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 applicare le aggiunte del menu contestuale, ad esempio immagini, link ipertestuali e pagine.

cookie

Utilizza l'API chrome.cookies per eseguire query e modificare i cookie, nonché 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 per analizzare l'interazione con la rete, eseguire il debug di JavaScript, modificare DOM e CSS e altro ancora. Utilizza la proprietà Debuggee tabId per scegliere come target le schede con sendCommand e indirizzare gli eventi in base a tabId dalle richiamate onEvent.

declarativeContent

Usa l'API chrome.declarativeContent per intraprendere azioni a seconda dei contenuti di una pagina, senza richiedere l'autorizzazione a leggerne i contenuti.

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

desktopCapture

L'API Desktop Capture acquisisce i contenuti 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 per la pagina ispezionata, valuta il codice nel contesto della finestra ispezionata, ricarica la pagina o ottieni 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 la tua estensione nell'interfaccia utente della finestra Strumenti per sviluppatori: crea i tuoi riquadri, accedi ai riquadri esistenti e aggiungi barre laterali.

devtools.performance

Chrome 129 e versioni successive

Usa l'API chrome.devtools.performance per ascoltare gli aggiornamenti sullo stato della registrazione nel riquadro Prestazioni in DevTools.

devtools.recorder

Chrome 105 e versioni successive

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

dns

Canale Dev

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

documentScan

Chrome 44 e versioni successive Solo ChromeOS

Utilizza l'API chrome.documentScan per rilevare e recuperare immagini dagli scanner di documenti collegati.

dom

Chrome 88 e versioni successive

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

download

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

enterprise.deviceAttributes

Chrome 46 e versioni successive Solo ChromeOS Richiede criteri

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

enterprise.hardwarePlatform

Chrome 71 e versioni successive Richiede criteri

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 Richiede criteri

Utilizza l'API chrome.enterprise.networkingAttributes per leggere le informazioni sulla tua rete attuale. Nota: questa API è disponibile solo per le estensioni installate in modo forzato secondo i criteri aziendali.

enterprise.platformKeys

Solo ChromeOS Richiede criteri

Utilizza 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 da un'altra estensione tramite chrome.platformKeys.

eventi

Lo spazio dei nomi chrome.events contiene tipi comuni utilizzati dagli eventi di invio delle API per avvisarti quando succede qualcosa di interessante.

estensione

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

extensionTypes

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

fileBrowserHandler

Solo ChromeOS Solo 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 tramite Gestione file su ChromeOS.

fontSettings

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

gcm

Utilizza chrome.gcm per consentire ad app ed estensioni di inviare e ricevere messaggi tramite Firebase Cloud Messaging (FCM).

cronologia

Utilizza l'API chrome.history per interagire con il record delle pagine visitate del browser. Puoi aggiungere, rimuovere e eseguire query sugli URL nella cronologia del browser. Per sostituire la pagina della cronologia con la tua versione, vedi Sostituisci 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

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

input.ime

Solo ChromeOS

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

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 di accesso.

video

L'API chrome.management consente di gestire le app e le estensioni installate.

notifications

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

fuori schermo

Chrome 109 e versioni successive MV3 e versioni successive

Utilizza l'API offscreen per creare e gestire i documenti offscreen.

omnibox

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

pageCapture

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

autorizzazioni

Utilizza l'API chrome.permissions per richiedere le autorizzazioni facoltative dichiarate in fase di esecuzione anziché al momento dell'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 i criteri concedono l'autorizzazione, un'estensione può utilizzare un certificato di questo tipo nel proprio protocollo di autenticazione personalizzato. Ad esempio, consente l'utilizzo di certificati gestiti dalla piattaforma nelle VPN di terze parti (vedi chrome.vpnProvider).

power

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 espone gli eventi utilizzati da Gestione stampa per interrogare le 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

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

printingMetrics

Chrome 79 e versioni successive Solo ChromeOS Richiede criteri

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 dell'utente. Questa API si basa sul prototipo ChromeSetting del tipo API per ottenere e impostare la configurazione di Chrome.

processi

Canale per sviluppatori

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 ChromeSetting dell'API di tipo 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.

tempo di esecuzione

Usa l'API chrome.runtime per recuperare il service worker, restituire i dettagli del manifest, ascoltare gli eventi e rispondere agli eventi del 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 e versioni successive

Utilizza l'API chrome.scripting per eseguire 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 e versioni successive

Utilizza 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

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

system.display

Usa l'API system.display per eseguire query sui metadati display.

system.memory

L'API chrome.system.memory.

system.storage

Utilizza 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

Chrome 125 e versioni successive Solo ChromeOS Richiede criteri

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

tabCapture

Utilizza 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 riordinare i gruppi di schede nel browser. Per raggruppare e separare le schede o per eseguire query sulle schede incluse 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 riordinare 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 sono incluse le scorciatoie personalizzate dall'utente.

tts

Usa l'API chrome.tts per riprodurre la sintesi vocale (TTS). Vedi anche l'API ttsEngine correlata, che consente a un'estensione di implementare un motore 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 qualsiasi estensione o app Chrome utilizza l'API tts per generare voce. L'estensione può quindi utilizzare qualsiasi tecnologia web disponibile per sintetizzare e riprodurre il parlato, nonché per inviare gli eventi alla funzione di chiamata per segnalare lo stato.

types

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

userScripts

Chrome 120+ MV3+

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 di desktop remoto in esecuzione su un host remoto di intercettare le richieste dell'API Web Authentication (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 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.