De meeste extensies hebben toegang nodig tot een of meer API's voor Chrome-extensies om te kunnen werken. In deze API-referentie worden de API's beschreven die beschikbaar zijn voor gebruik in extensies en worden voorbeelden van use cases gegeven.
Vanaf Chrome 148 zijn deze API's ook beschikbaar onder de naamruimte browser als een alternatief voor meerdere browsers voor chrome. Ga naar
De browsernaamruimte
voor richtlijnen voor de overstap.
Veelgebruikte functies van de Extensions API
Een Extensions API bestaat uit een naamruimte met methoden en eigenschappen voor het uitvoeren van extensiewerk en meestal, maar niet altijd, manifestvelden voor het bestand manifest.json. De naamruimte browser.action vereist bijvoorbeeld een "action"-object in het manifest. Voor veel API's zijn ook rechten in het manifest vereist.
Methoden in extensie-API's zijn asynchroon, tenzij anders vermeld. Asynchrone methoden worden onmiddellijk geretourneerd, zonder te wachten tot de bewerking die ze aanroept, is voltooid. Gebruik promises om de resultaten van deze asynchrone methoden te krijgen.
Chrome Extension API's
- accessibilityFeatures
-
Gebruik de
chrome.accessibilityFeaturesAPI om de toegankelijkheidsfuncties van Chrome te beheren. Deze API is afhankelijk van het ChromeSetting-prototype van het type API om afzonderlijke toegankelijkheidsfuncties op te halen en in te stellen. De extensie moet het rechtaccessibilityFeatures.readaanvragen om functiestatussen te krijgen. De extensie heeft het rechtaccessibilityFeatures.modifynodig om de functiestatus aan te passen.accessibilityFeatures.modifyimpliceert niet het rechtaccessibilityFeatures.read. - action
-
Chrome 88+ browser.* sinds Chrome 148 MV3+
Gebruik de
chrome.actionAPI om het icoon van de extensie in de Google Chrome-werkbalk te beheren. - alarms
-
Gebruik de
chrome.alarmsAPI om code te plannen die periodiek of op een bepaald moment in de toekomst moet worden uitgevoerd. - audio
-
Chrome 59+ browser.* sinds Chrome 148 Alleen ChromeOS
De
chrome.audioAPI wordt geleverd zodat gebruikers informatie kunnen krijgen over de audioapparaten die aan het systeem zijn gekoppeld en deze kunnen bedienen. Deze API is op dit moment alleen beschikbaar in de kioskmodus voor ChromeOS. - bookmarks
-
Gebruik de
chrome.bookmarksAPI om bookmarks te maken, te ordenen en op andere manieren te bewerken. Bekijk ook Overschrijvingspagina's, waarmee je een aangepaste pagina voor de bookmarkmanager kunt maken. - browsingData
-
Gebruik de
chrome.browsingDataAPI om browsegegevens te verwijderen uit het lokale profiel van een gebruiker. - certificateProvider
-
Chrome 46+ browser.* sinds Chrome 148 Alleen ChromeOS
Gebruik deze API om certificaten beschikbaar te maken voor het platform, dat deze certificaten kan gebruiken voor TLS-verificaties.
- opdrachten
-
Gebruik de API voor opdrachten om sneltoetsen toe te voegen die acties in je extensie activeren, bijvoorbeeld een actie om de browseractie te openen of een opdracht naar de extensie te sturen.
- contentSettings
-
Gebruik de
chrome.contentSettingsAPI om instellingen te wijzigen die bepalen of websites functies zoals cookies, JavaScript en plug-ins kunnen gebruiken. Meer in het algemeen kun je met contentinstellingen het gedrag van Chrome aanpassen per site in plaats van wereldwijd. - contextMenus
-
Gebruik de
chrome.contextMenusAPI om items toe te voegen aan het contextmenu van Google Chrome. Je kunt kiezen op welke typen objecten je contextmenu-toevoegingen van toepassing zijn, zoals afbeeldingen, hyperlinks en pagina's. - cookies
-
Gebruik de
chrome.cookiesAPI om cookies op te vragen en aan te passen en om een melding te krijgen als ze worden gewijzigd. - debugger
-
De
chrome.debuggerAPI dient als alternatief transport voor het protocol voor externe foutopsporing van Chrome. Gebruikchrome.debuggerom aan een of meer tabbladen te koppelen om onder andere netwerkinteractie te instrumenteren, JavaScript te debuggen en de DOM en CSS te muteren. Gebruik de propertyDebuggeetabIdom tabbladen te targeten metsendCommanden gebeurtenissen te routeren optabIdvanuitonEvent-callbacks. - declarativeContent
-
Gebruik de
chrome.declarativeContentAPI om acties uit te voeren op basis van de content van een pagina, zonder dat je rechten nodig hebt om de content van de pagina te lezen. - declarativeNetRequest
-
Chrome 84 of hoger browser.* sinds Chrome 148
De
chrome.declarativeNetRequestAPI wordt gebruikt om netwerkverzoeken te blokkeren of aan te passen door declaratieve regels op te geven. Zo kunnen extensies netwerkverzoeken aanpassen zonder ze te onderscheppen en de content ervan te bekijken. Dit biedt meer privacy. - desktopCapture
-
De Desktop Capture API legt de content van het scherm, afzonderlijke vensters of afzonderlijke tabbladen vast.
- devtools.inspectedWindow
-
Gebruik de
chrome.devtools.inspectedWindowAPI om te communiceren met het geïnspecteerde venster: verkrijg de tabblad-ID voor de geïnspecteerde pagina, evalueer de code in de context van het geïnspecteerde venster, laad de pagina opnieuw of verkrijg de lijst met bronnen op de pagina. - devtools.network
-
Gebruik de
chrome.devtools.networkAPI om de informatie over netwerkverzoeken op te halen die door de tools voor ontwikkelaars wordt getoond in het deelvenster Netwerk. - devtools.panels
-
Gebruik de
chrome.devtools.panelsAPI om je extensie te integreren in de UI van het venster Ontwikkelaarstools: maak je eigen deelvensters, open bestaande deelvensters en voeg zijbalken toe. - devtools.performance
-
Chrome 129+ browser.* sinds Chrome 152
Gebruik de
chrome.devtools.performanceAPI om te luisteren naar statusupdates van opnamen in het deelvenster Prestaties in DevTools. - devtools.recorder
-
Chrome 105+ browser.* sinds Chrome 152
Gebruik de
chrome.devtools.recorderAPI om het Recorder-deelvenster in DevTools aan te passen. - dns
-
Dev-kanaal
Gebruik de
chrome.dnsAPI voor DNS-omzetting. - documentScan
-
Chrome 44 en hoger browser.* sinds Chrome 148 Alleen ChromeOS
Gebruik de
chrome.documentScanAPI om afbeeldingen van gekoppelde documentscanners te ontdekken en op te halen. - dom
-
Chrome 88+ browser.* sinds Chrome 148
Gebruik de
chrome.domAPI om toegang te krijgen tot speciale DOM API's voor extensies - downloads
-
Gebruik de
chrome.downloadsAPI om downloads programmatisch te starten, te controleren, te manipuleren en te zoeken. - enterprise.deviceAttributes
-
Gebruik de
chrome.enterprise.deviceAttributesAPI om apparaatkenmerken te lezen. Opmerking: Deze API is alleen beschikbaar voor extensies die afgedwongen worden geïnstalleerd door bedrijfsbeleid. - enterprise.hardwarePlatform
-
Gebruik de
chrome.enterprise.hardwarePlatformAPI om de fabrikant en het model van het hardwareplatform te krijgen waarop de browser wordt uitgevoerd. Opmerking: Deze API is alleen beschikbaar voor extensies die zijn geïnstalleerd op basis van bedrijfsbeleid. - enterprise.login
-
Gebruik de
chrome.enterprise.loginAPI om beheerde gastsessies te beëindigen. Opmerking: Deze API is alleen beschikbaar voor extensies die zijn geïnstalleerd via bedrijfsbeleid in beheerde gastsessies in ChromeOS. - enterprise.networkingAttributes
-
Gebruik de
chrome.enterprise.networkingAttributesAPI om informatie over je huidige netwerk te lezen. Opmerking: Deze API is alleen beschikbaar voor extensies die afgedwongen worden geïnstalleerd door bedrijfsbeleid. - enterprise.platformKeys
-
Alleen ChromeOS Beleid vereist
Gebruik de
chrome.enterprise.platformKeysAPI om sleutels te genereren en certificaten voor deze sleutels te installeren. De certificaten worden beheerd door het platform en kunnen worden gebruikt voor TLS-verificatie, netwerktoegang of door andere extensies via chrome.platformKeys. - gebeurtenissen
-
De naamruimte
chrome.eventsbevat veelvoorkomende typen die worden gebruikt door API's die gebeurtenissen verzenden om je op de hoogte te stellen als er iets interessants gebeurt. - extensie
-
De
chrome.extensionAPI heeft hulpprogramma's die kunnen worden gebruikt door elke extensiepagina. De API biedt ondersteuning voor de uitwisseling van berichten tussen een extensie en de bijbehorende contentscripts of tussen extensies, zoals gedetailleerd beschreven in Berichten doorgeven. - extensionTypes
-
De
chrome.extensionTypesAPI bevat typedeclaraties voor Chrome-extensies. - fileBrowserHandler
-
Alleen ChromeOS Alleen op de voorgrond
Gebruik de
chrome.fileBrowserHandlerAPI om de ChromeOS-bestandsbrowser uit te breiden. Je kunt deze API bijvoorbeeld gebruiken om gebruikers bestanden te laten uploaden naar je website. - fileSystemProvider
-
Alleen ChromeOS
Gebruik de
chrome.fileSystemProviderAPI om bestandssystemen te maken die kunnen worden geopend door de bestandsbeheerder op ChromeOS. - fontSettings
-
Gebruik de
chrome.fontSettingsAPI om de lettertype-instellingen van Chrome te beheren. - gcm
-
Gebruik
chrome.gcmom apps en extensies toe te staan berichten te sturen en te krijgen via Firebase Cloud Messaging (FCM). - geschiedenis
-
Gebruik de
chrome.historyAPI om te communiceren met de browsergeschiedenis van bezochte pagina's. Je kunt URL's toevoegen, verwijderen en opvragen in de geschiedenis van de browser. Als je de geschiedenispagina wilt overschrijven met je eigen versie, ga je naar Pagina's overschrijven. - i18n
-
Gebruik de
chrome.i18n-infrastructuur om internationalisering te implementeren in je hele app of extensie. - identity
-
Gebruik de
chrome.identityAPI om OAuth2-toegangstokens te krijgen. - idle
-
Gebruik de
chrome.idleAPI om te detecteren wanneer de inactieve status van de machine verandert. - input.ime
-
Alleen ChromeOS
Gebruik de
chrome.input.imeAPI om een aangepaste IME voor ChromeOS te implementeren. Hiermee kan je extensie toetsaanslagen verwerken, de samenstelling instellen en het kandidaatvenster beheren. - instanceID
-
Chrome 44+ browser.* sinds Chrome 148
Gebruik
chrome.instanceIDom toegang te krijgen tot de Instance ID-service. - loginState
-
Chrome 78 en hoger browser.* sinds Chrome 148 Alleen ChromeOS
Gebruik de
chrome.loginStateAPI om de inlogstatus te lezen en te controleren. -
De
chrome.managementAPI biedt manieren om geïnstalleerde apps en extensies te beheren. - mimeHandler
-
Chrome 151+
Gebruik de
chrome.mimeHandlerAPI om MIME-typestreams te verwerken in extensies van derden. - meldingen
-
Gebruik de
chrome.notificationsAPI om uitgebreide meldingen te maken met templates en deze meldingen aan gebruikers te tonen in het systeemvak. - buiten beeld
-
Chrome 109+ browser.* sinds Chrome 148 MV3+
Gebruik de
offscreenAPI om offscreen documenten te maken en te beheren. - omnibox
-
Met de omnibox-API kun je een zoekwoord registreren in de adresbalk van Google Chrome, ook wel de omnibox genoemd.
- pageCapture
-
Gebruik de
chrome.pageCaptureAPI om een tabblad op te slaan als MHTML. - rechten
-
Gebruik de
chrome.permissionsAPI om gedeclareerde optionele rechten aan te vragen tijdens de runtime in plaats van tijdens de installatie, zodat gebruikers begrijpen waarom de rechten nodig zijn en alleen de rechten verlenen die nodig zijn. - platformKeys
-
Chrome 45+ browser.* sinds Chrome 148 Alleen ChromeOS
Gebruik de
chrome.platformKeysAPI om toegang te krijgen tot clientcertificaten die door het platform worden beheerd. Als de gebruiker of het beleid het recht verleent, kan een extensie een dergelijk certificaat gebruiken in het aangepaste verificatieprotocol. Zo kunnen door het platform beheerde certificaten worden gebruikt in VPN's van derden (zie chrome.vpnProvider). - power
-
Gebruik de
chrome.powerAPI om de energiebeheerfuncties van het systeem te overschrijven. - printerProvider
-
Chrome 44+ browser.* sinds Chrome 148
De
chrome.printerProviderAPI toont gebeurtenissen die door de afdrukbeheerder worden gebruikt om printers te zoeken die worden beheerd door extensies, om hun mogelijkheden te zoeken en om afdruktaken naar deze printers te sturen. - afdrukken
-
Chrome 81+ browser.* sinds Chrome 148 Alleen ChromeOS
Gebruik de
chrome.printingAPI om afdruktaken naar printers te sturen die op de Chromebook zijn geïnstalleerd. - printingMetrics
-
Gebruik de
chrome.printingMetricsAPI om gegevens over afdrukgebruik op te halen. - privacy
-
Gebruik de
chrome.privacyAPI om het gebruik van de functies in Chrome te beheren die de privacy van een gebruiker kunnen beïnvloeden. Deze API is afhankelijk van het ChromeSetting-prototype van de type-API om de configuratie van Chrome op te halen en in te stellen. - processen
-
Dev-kanaal
Gebruik de
chrome.processesAPI om te communiceren met de processen van de browser. - proxy
-
Gebruik de
chrome.proxyAPI om de proxyinstellingen van Chrome te beheren. Deze API is afhankelijk van het ChromeSetting-prototype van het type API om de proxyconfiguratie op te halen en in te stellen. - publicSuffix
-
Chrome 153 of hoger
Gebruik de
chrome.publicSuffixAPI om de Public Suffix List (PSL) van de browser op te vragen. - readingList
-
Chrome 120+ browser.* sinds Chrome 148 MV3+
Gebruik de
chrome.readingListAPI om de items in de Leeslijst te lezen en aan te passen. - runtime
-
Gebruik de
chrome.runtimeAPI om de servicemedewerker op te halen, details over het manifest te retourneren en te luisteren naar en te reageren op gebeurtenissen in de levenscyclus van de extensie. Je kunt deze API ook gebruiken om het relatieve pad van URL's om te zetten in volledig gekwalificeerde URL's. - scripting
-
Chrome 88+ browser.* sinds Chrome 148 MV3+
Gebruik de
chrome.scriptingAPI om een script uit te voeren in verschillende contexten. - search
-
Chrome 87+ browser.* sinds Chrome 148
Gebruik de
chrome.searchAPI om te zoeken via de standaard provider. - sessies
-
Gebruik de
chrome.sessionsAPI om tabbladen en vensters uit een browsesessie op te vragen en te herstellen. - sidePanel
-
Chrome 114+ browser.* sinds Chrome 148 MV3+
Gebruik de
chrome.sidePanelAPI om content te hosten in het zijvenster van de browser naast de hoofdcontent van een webpagina. - opslag
-
Gebruik de
chrome.storageAPI om wijzigingen in gebruikersgegevens op te slaan, op te halen en bij te houden. - system.cpu
-
Gebruik de
system.cpuAPI om CPU-metadata op te vragen. - system.display
-
Gebruik de
system.displayAPI om display-metadata op te vragen. - system.memory
-
De
chrome.system.memoryAPI. - system.storage
-
Gebruik de
chrome.system.storageAPI om informatie over opslagapparaten op te vragen en een melding te krijgen als een verwisselbaar opslagapparaat wordt aangesloten of losgekoppeld. - systemLog
-
Gebruik de
chrome.systemLogAPI om Chrome-systeemlogboeken van extensies op te nemen. - tabCapture
-
Gebruik de
chrome.tabCaptureAPI om te communiceren met mediastreamtabbladen. - tabGroups
-
Chrome 89+ browser.* sinds Chrome 148 MV3+
Gebruik de
chrome.tabGroupsAPI om te communiceren met het systeem voor tabbladgroepering van de browser. Je kunt deze API gebruiken om tabbladgroepen in de browser aan te passen en opnieuw te rangschikken. Gebruik dechrome.tabsAPI om tabbladen te groeperen en de groepering ongedaan te maken, of om op te vragen welke tabbladen zich in groepen bevinden. - tabbladen
-
Gebruik de
chrome.tabsAPI om te communiceren met het tabbladsysteem van de browser. Je kunt deze API gebruiken om tabbladen in de browser te maken, aan te passen en opnieuw te rangschikken. - topSites
-
Gebruik de
chrome.topSitesAPI om toegang te krijgen tot de populairste sites (de meest bezochte sites) die worden getoond op de pagina Nieuw tabblad. Dit zijn geen sneltoetsen die door de gebruiker zijn aangepast. - tts
-
Gebruik de
chrome.ttsAPI om gesynthetiseerde tekst-naar-spraak (TTS) af te spelen. Bekijk ook de gerelateerdettsEngineAPI, waarmee een extensie een spraakengine kan implementeren. - ttsEngine
-
Gebruik de
chrome.ttsEngineAPI om een tekst-naar-spraak-engine(TTS) te implementeren met een extensie. Als je extensie zich registreert met deze API, krijgt deze gebeurtenissen met een uitspraak die moet worden uitgesproken en andere parameters als een extensie of Chrome-app dettsAPI gebruikt om spraak te genereren. Je extensie kan dan elke beschikbare webtechnologie gebruiken om de spraak te synthetiseren en uit te voeren, en gebeurtenissen terug te sturen naar de aanroepende functie om de status te melden. - typen
-
De
chrome.typesAPI bevat typedeclaraties voor Chrome. - userScripts
-
Chrome 120+ browser.* sinds Chrome 148 MV3+
Gebruik de
userScriptsAPI om gebruikersscripts uit te voeren in de context van gebruikersscripts. - vpnProvider
-
Chrome 43+ browser.* sinds Chrome 148 Alleen ChromeOS
Gebruik de
chrome.vpnProviderAPI om een VPN-client te implementeren. - achtergrond
-
Chrome 43+ browser.* sinds Chrome 148 Alleen ChromeOS
Gebruik de
chrome.wallpaperAPI om de ChromeOS-achtergrond te wijzigen. - webAuthenticationProxy
-
Chrome 115+ browser.* sinds Chrome 148 MV3+
Met de
chrome.webAuthenticationProxyAPI kan software voor extern bureaublad die op een externe host wordt uitgevoerd, Web Authentication API-verzoeken (WebAuthn) onderscheppen om ze op een lokale client te verwerken. - webNavigation
-
Gebruik de
chrome.webNavigationAPI om meldingen te krijgen over de status van navigatieverzoeken tijdens de vlucht. - webRequest
-
Gebruik de
chrome.webRequestAPI om verkeer te observeren en te analyseren en om verzoeken tijdens de uitvoering te onderscheppen, te blokkeren of aan te passen. - windows
-
Gebruik de
chrome.windowsAPI om te communiceren met browservensters. Je kunt deze API gebruiken om vensters in de browser te maken, aan te passen en opnieuw te rangschikken.