De meeste extensies hebben toegang nodig tot een of meer Chrome Extensions API's om te functioneren. Deze API-referentie beschrijft de API's die beschikbaar zijn voor gebruik in extensies en geeft voorbeelden van hoe ze gebruikt kunnen worden.
Vanaf Chrome 144 zijn alle Chrome Extension API's ook beschikbaar onder de namespace browser (bijv. ` browser.tabs.create({}) ). Dit is een alias voor de chrome namespace (bijv. ` chrome.tabs.create({}) ) en is bedoeld voor compatibiliteit met andere browsers die de browser namespace gebruiken voor hun extensie-API's.
Algemene extensie-API-functies
Een Extensions API bestaat uit een namespace met methoden en eigenschappen voor het uitvoeren van extensiewerkzaamheden, en meestal, maar niet altijd, manifestvelden voor het manifest.json bestand. De namespace chrome.action vereist bijvoorbeeld een "action" -object in het manifest. Veel API's vereisen ook machtigingen in het manifest.
Methoden in extensie-API's zijn asynchroon , tenzij anders vermeld. Asynchrone methoden retourneren direct, zonder te wachten tot de bewerking die ze aanroept is voltooid. Gebruik promises om de resultaten van deze asynchrone methoden te verkrijgen.
Chrome-extensie-API's
- toegankelijkheidsfuncties
Gebruik de
chrome.accessibilityFeaturesAPI om de toegankelijkheidsfuncties van Chrome te beheren. Deze API is gebaseerd op het ChromeSetting-prototype van het type API voor het ophalen en instellen van individuele toegankelijkheidsfuncties. Om de status van een functie op te halen, moet de extensie toestemming vragen vooraccessibilityFeatures.read. Voor het wijzigen van de status van een functie heeft de extensie toestemming nodig vooraccessibilityFeatures.modify. Houd er rekening mee dataccessibilityFeatures.modifygeen toestemmingaccessibilityFeatures.readimpliceert.- actie
- Chrome 88+ MV3+
Gebruik de
chrome.actionAPI om het pictogram van de extensie in de Google Chrome-werkbalk te beheren. - alarmen
Gebruik de
chrome.alarmsAPI om code in te plannen die periodiek of op een specifiek tijdstip in de toekomst moet worden uitgevoerd.- audio
- Chrome 59+ alleen voor ChromeOS
De
chrome.audioAPI is beschikbaar gesteld om gebruikers informatie te laten verkrijgen over en controle te geven over de audioapparaten die op het systeem zijn aangesloten. Deze API is momenteel alleen beschikbaar in de kioskmodus voor ChromeOS. - bladwijzers
Gebruik de
chrome.bookmarksAPI om bladwijzers te maken, te organiseren en te beheren. Zie ook Pagina's overschrijven , waarmee je een aangepaste pagina voor bladwijzerbeheer kunt maken.- browseData
Gebruik de
chrome.browsingDataAPI om browsegegevens uit het lokale profiel van een gebruiker te verwijderen.- certificaataanbieder
- Chrome 46+ alleen voor ChromeOS
Gebruik deze API om certificaten beschikbaar te stellen aan het platform, dat deze certificaten vervolgens kan gebruiken voor TLS-authenticatie.
- commando's
Gebruik de commands API om sneltoetsen toe te voegen die acties in uw extensie activeren, bijvoorbeeld een actie om de browser te openen of een opdracht naar de extensie te sturen.
- inhoudsinstellingen
Gebruik de
chrome.contentSettingsAPI om instellingen te wijzigen die bepalen of websites functies zoals cookies, JavaScript en plug-ins mogen gebruiken. Meer in het algemeen kunt u met inhoudsinstellingen het gedrag van Chrome per website aanpassen in plaats van globaal.- contextMenu's
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 te wijzigen, en om een melding te ontvangen wanneer ze veranderen.- debugger
De
chrome.debuggerAPI dient als alternatief transportmechanisme voor het externe debugprotocol van Chrome. Gebruikchrome.debuggerom verbinding te maken met een of meer tabbladen om netwerkinteractie te instrumenteren, JavaScript te debuggen, de DOM en CSS te wijzigen en meer. Gebruik de eigenschaptabIdDebuggeeom tabbladen te targeten metsendCommanden gebeurtenissen te routeren op basis vantabIdvanuitonEvent-callbacks.- declaratieve inhoud
Gebruik de
chrome.declarativeContentAPI om acties uit te voeren op basis van de inhoud van een pagina, zonder dat er toestemming nodig is om de inhoud van de pagina te lezen.- declarativeNetRequest
- Chrome 84+
De
chrome.declarativeNetRequestAPI wordt gebruikt om netwerkverzoeken te blokkeren of te wijzigen door middel van declaratieve regels. Hierdoor kunnen extensies netwerkverzoeken aanpassen zonder ze te onderscheppen en de inhoud ervan te bekijken, wat zorgt voor meer privacy. - bureaubladCapture
De Desktop Capture API legt de inhoud van het scherm, afzonderlijke vensters of afzonderlijke tabbladen vast.
- devtools.inspectedWindow
Gebruik de
chrome.devtools.inspectedWindowAPI om te interageren met het geïnspecteerde venster: verkrijg de tab-ID voor de geïnspecteerde pagina, evalueer de code in de context van het geïnspecteerde venster, herlaad de pagina of verkrijg de lijst met resources binnen de pagina.- devtools.network
Gebruik de
chrome.devtools.networkAPI om de informatie over netwerkverzoeken op te halen die wordt weergegeven in het netwerkpaneel van de ontwikkelaarstools.- ontwikkelaarstools.panelen
Gebruik de
chrome.devtools.panelsAPI om uw extensie te integreren in de gebruikersinterface van het venster Ontwikkelaarstools: maak uw eigen panelen, krijg toegang tot bestaande panelen en voeg zijbalken toe.- devtools.performance
- Chrome 129+
Gebruik de
chrome.devtools.performanceAPI om te luisteren naar updates over de opnamestatus in het paneel Prestaties in DevTools. - devtools.recorder
- Chrome 105+
Gebruik de
chrome.devtools.recorderAPI om het Recorder-paneel in DevTools aan te passen. - dns
- Ontwikkelaarskanaal
Gebruik de
chrome.dnsAPI voor DNS-resolutie. - documentScan
- Chrome 44+ Alleen voor ChromeOS
Gebruik de
chrome.documentScanAPI om afbeeldingen van aangesloten documentscanners te ontdekken en op te halen. - dom
- Chrome 88+
Gebruik de
chrome.domAPI om toegang te krijgen tot speciale DOM API's voor extensies. - downloaden
Gebruik de
chrome.downloadsAPI om programmatisch downloads te starten, te volgen, te beheren en te zoeken.- enterprise.apparaatkenmerken
Gebruik de
chrome.enterprise.deviceAttributesAPI om apparaatkenmerken uit te lezen. Let op: deze API is alleen beschikbaar voor extensies die via bedrijfsbeleid verplicht zijn geïnstalleerd.- enterprise.hardwarePlatform
- Chrome 71+ vereist beleid
Gebruik de
chrome.enterprise.hardwarePlatformAPI om de fabrikant en het model van het hardwareplatform waarop de browser draait te achterhalen. Let op: deze API is alleen beschikbaar voor extensies die zijn geïnstalleerd via bedrijfsbeleid. - bedrijfslogin
Gebruik de
chrome.enterprise.loginAPI om Managed Guest-sessies te verlaten. Let op: deze API is alleen beschikbaar voor extensies die via bedrijfsbeleid in ChromeOS Managed Guest-sessies zijn geïnstalleerd.- enterprise.networkingAttributes
Gebruik de
chrome.enterprise.networkingAttributesAPI om informatie over uw huidige netwerk te lezen. Let op: deze API is alleen beschikbaar voor extensies die door het bedrijfsbeleid verplicht zijn geïnstalleerd.- enterprise.platformKeys
- Alleen voor ChromeOS. Vereist beleid.
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-authenticatie, netwerktoegang of door andere extensies via chrome.platformKeys. - evenementen
De namespace
chrome.eventsbevat veelgebruikte typen die door API's worden ingezet om gebeurtenissen te verzenden en u te informeren wanneer er iets interessants gebeurt.- verlenging
De
chrome.extensionAPI bevat hulpprogramma's die door elke extensiepagina kunnen worden gebruikt. Het biedt onder andere ondersteuning voor het uitwisselen van berichten tussen een extensie en de bijbehorende scripts, of tussen extensies onderling, zoals gedetailleerd beschreven in Berichtenuitwisseling .- extensietypen
De
chrome.extensionTypesAPI bevat typeaanduidingen voor Chrome-extensies.- fileBrowserHandler
- Alleen voor ChromeOS. Alleen op de voorgrond.
Gebruik de
chrome.fileBrowserHandlerAPI om de bestandsbrowser van Chrome OS uit te breiden. Je kunt deze API bijvoorbeeld gebruiken om gebruikers bestanden naar je website te laten uploaden. - bestandssysteemprovider
- alleen ChromeOS
Gebruik de
chrome.fileSystemProviderAPI om bestandssystemen te creëren die toegankelijk zijn vanuit de bestandsbeheerder van Chrome OS. - lettertype-instellingen
Gebruik de
chrome.fontSettingsAPI om de lettertype-instellingen van Chrome te beheren.- gcm
Gebruik
chrome.gcmom apps en extensies in staat te stellen berichten te verzenden en te ontvangen via Firebase Cloud Messaging (FCM).- geschiedenis
Gebruik de
chrome.historyAPI om te communiceren met de pagina's die de browser heeft bezocht. Je kunt URL's toevoegen, verwijderen en opvragen in de browsergeschiedenis. Zie Pagina's overschrijven om de geschiedenispagina te vervangen door je eigen versie.- i18n
Gebruik de
chrome.i18ninfrastructuur om internationalisering in uw hele app of extensie te implementeren.- identiteit
Gebruik de
chrome.identityAPI om OAuth2-toegangstokens te verkrijgen.- inactief
Gebruik de
chrome.idleAPI om te detecteren wanneer de inactieve status van de machine verandert.- input.time
- alleen ChromeOS
Gebruik de
chrome.input.imeAPI om een aangepaste IME voor Chrome OS te implementeren. Hiermee kan uw extensie toetsaanslagen verwerken, de compositie instellen en het kandidaatvenster beheren. - instantie-ID
- Chrome 44+
Gebruik
chrome.instanceIDom toegang te krijgen tot de Instance ID-service. - loginState
- Chrome 78+ alleen voor ChromeOS
Gebruik de
chrome.loginStateAPI om de inlogstatus te lezen en te controleren. - beheer
De
chrome.managementAPI biedt manieren om geïnstalleerde apps en extensies te beheren.- meldingen
Gebruik de
chrome.notificationsAPI om uitgebreide meldingen te maken met behulp van sjablonen en deze meldingen aan gebruikers weer te geven in het systeemvak.- buiten beeld
- Chrome 109+ 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 bekend als de omnibox.
- paginaCapture
Gebruik de
chrome.pageCaptureAPI om een tabblad als MHTML op te slaan.- toestemmingen
Gebruik de
chrome.permissionsAPI om tijdens de uitvoering optionele machtigingen aan te vragen in plaats van tijdens de installatie. Zo begrijpen gebruikers waarom de machtigingen nodig zijn en verlenen ze alleen de noodzakelijke machtigingen.- platformKeys
- Chrome 45+ Alleen voor ChromeOS
Gebruik de
chrome.platformKeysAPI om toegang te krijgen tot clientcertificaten die door het platform worden beheerd. Als de gebruiker of het beleid de toestemming verleent, kan een extensie een dergelijk certificaat gebruiken in zijn eigen authenticatieprotocol. Dit maakt bijvoorbeeld het gebruik van door het platform beheerde certificaten in VPN's van derden mogelijk (zie chrome.vpnProvider ). - stroom
Gebruik de
chrome.powerAPI om de energiebeheerfuncties van het systeem te overschrijven.- printeraanbieder
- Chrome 44+
De
chrome.printerProviderAPI biedt toegang tot gebeurtenissen die door de printmanager worden gebruikt om printers die door extensies worden beheerd op te vragen, hun mogelijkheden te controleren en printopdrachten naar deze printers te verzenden. - afdrukken
- Chrome 81+ Alleen voor ChromeOS
Gebruik de
chrome.printingAPI om printopdrachten te verzenden naar printers die op een Chromebook zijn geïnstalleerd. - printstatistieken
Gebruik de
chrome.printingMetricsAPI om gegevens over printergebruik op te halen.- privacy
Gebruik de
chrome.privacyAPI om het gebruik te beheren van de functies in Chrome die de privacy van een gebruiker kunnen beïnvloeden. Deze API is gebaseerd op het ChromeSetting-prototype van het type API voor het ophalen en instellen van de Chrome-configuratie.- processen
- Ontwikkelaarskanaal
Gebruik de
chrome.processesAPI om te communiceren met de processen van de browser. - volmacht
Gebruik de
chrome.proxyAPI om de proxy-instellingen van Chrome te beheren. Deze API maakt gebruik van het ChromeSetting-prototype van het type API voor het ophalen en instellen van de proxyconfiguratie.- leeslijst
- Chrome 120+ MV3+
Gebruik de
chrome.readingListAPI om items in de leeslijst te lezen en te wijzigen. - runtime
Gebruik de
chrome.runtimeAPI om de service worker op te halen, details over het manifest te verkrijgen en te luisteren naar en te reageren op gebeurtenissen in de levenscyclus van de extensie. Je kunt deze API ook gebruiken om relatieve paden van URL's om te zetten naar volledig gekwalificeerde URL's.- scripten
- Chrome 88+ MV3+
Gebruik de
chrome.scriptingAPI om scripts in verschillende contexten uit te voeren. - zoekopdracht
- Chrome 87+
Gebruik de
chrome.searchAPI om te zoeken via de standaardprovider. - sessies
Gebruik de
chrome.sessionsAPI om tabbladen en vensters uit een browsersessie op te vragen en te herstellen.- zijpaneel
- Chrome 114+ MV3+
Gebruik de
chrome.sidePanelAPI om content in het zijpaneel van de browser weer te geven, naast de hoofdinhoud van een webpagina. - opslag
Gebruik de
chrome.storageAPI om gebruikersgegevens op te slaan, op te halen en wijzigingen daarin bij te houden.- systeem.cpu
Gebruik de
system.cpuAPI om CPU-metadata op te vragen.- systeem.weergave
Gebruik de
system.displayAPI om weergavemetadata op te vragen.- systeemgeheugen
De
chrome.system.memoryAPI.- systeem.opslag
Gebruik de
chrome.system.storageAPI om informatie over opslagapparaten op te vragen en een melding te ontvangen wanneer een verwijderbaar opslagapparaat wordt aangesloten en losgekoppeld.- systeemLog
Gebruik de
chrome.systemLogAPI om Chrome-systeemlogboeken van extensies vast te leggen.- tabCapture
Gebruik de
chrome.tabCaptureAPI om te interageren met mediastromen van tabbladen.- tabGroups
- Chrome 89+ MV3+
Gebruik de
chrome.tabGroupsAPI om te communiceren met het tabgroeperingssysteem van de browser. Met deze API kunt u tabgroepen in de browser wijzigen en herschikken. Om tabs te groeperen en te degroeperen, of om op te vragen welke tabs zich in groepen bevinden, gebruikt u dechrome.tabsAPI. - tabbladen
Gebruik de
chrome.tabsAPI om te communiceren met het tabbladensysteem van de browser. Met deze API kunt u tabbladen in de browser maken, wijzigen en herschikken.- topsites
Gebruik de
chrome.topSitesAPI om toegang te krijgen tot de meest bezochte websites die worden weergegeven op de pagina voor nieuwe tabbladen. Snelkoppelingen die door de gebruiker zijn aangepast, worden hier niet bij weergegeven.- tts
Gebruik de
chrome.ttsAPI om gesynthetiseerde tekst-naar-spraak (TTS) af te spelen. Zie ook de gerelateerdettsEngineAPI, waarmee een extensie een spraakengine kan implementeren.- ttsEngine
Gebruik de
chrome.ttsEngineAPI om een tekst-naar-spraak (TTS)-engine te implementeren met behulp van een extensie. Als uw extensie zich registreert bij deze API, ontvangt deze gebeurtenissen met een uit te spreken zin en andere parameters wanneer een extensie of Chrome-app dettsAPI gebruikt om spraak te genereren. Uw extensie kan vervolgens gebruikmaken van beschikbare webtechnologie om de spraak te synthetiseren en uit te voeren, en gebeurtenissen terugsturen naar de aanroepende functie om de status te rapporteren.- typen
De
chrome.typesAPI bevat typedeclaraties voor Chrome.- gebruikersscripts
- Chrome 120+ MV3+
Gebruik de
userScriptsAPI om gebruikersscripts uit te voeren in de User Scripts-context. - vpnProvider
- Chrome 43+ Alleen voor ChromeOS
Gebruik de
chrome.vpnProviderAPI om een VPN-client te implementeren. - behang
- Chrome 43+ Alleen voor ChromeOS
Gebruik de
chrome.wallpaperAPI om de achtergrond van ChromeOS te wijzigen. - webAuthenticationProxy
- Chrome 115+ MV3+
De
chrome.webAuthenticationProxyAPI stelt software voor externe bureaubladtoegang die op een externe host draait in staat om WebAuthn-verzoeken te onderscheppen en deze vervolgens op een lokale client af te handelen. - webNavigatie
Gebruik de
chrome.webNavigationAPI om meldingen te ontvangen over de status van lopende navigatieverzoeken.- webRequest
Gebruik de
chrome.webRequestAPI om verkeer te observeren en te analyseren, en om lopende verzoeken te onderscheppen, te blokkeren of te wijzigen.- ramen
Gebruik de
chrome.windowsAPI om met browservensters te communiceren. Met deze API kunt u vensters in de browser maken, wijzigen en herschikken.