De meeste extensies hebben toegang nodig tot een of meer API's voor Chrome-extensies om te kunnen functioneren. Deze API-referentie beschrijft de API's die beschikbaar zijn voor gebruik in extensies en presenteert voorbeelden van use cases.
Functies van de Common 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 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 aangegeven. Asynchrone methoden retourneren direct, zonder te wachten tot de bewerking die ze aanroept is voltooid. Gebruik promises om de resultaten van deze asynchrone methoden op te halen.
Chrome-extensie-API's
- toegankelijkheidsfuncties
Gebruik de
chrome.accessibilityFeaturesAPI om de toegankelijkheidsfuncties van Chrome te beheren. Deze API is afhankelijk van het ChromeSetting-prototype van het type API voor het ophalen en instellen van individuele toegankelijkheidsfuncties. Om functiestatussen op te halen, moet de extensie de toestemmingaccessibilityFeatures.readaanvragen. Om de functiestatus te wijzigen, heeft de extensie de toestemmingaccessibilityFeatures.modifynodig. Let op:accessibilityFeatures.modifyimpliceert geenaccessibilityFeatures.read-machtiging.- actie
- Chroom 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 te plannen die periodiek of op een bepaald tijdstip in de toekomst wordt uitgevoerd.- audio
- Chrome 59+ Alleen ChromeOS
De
chrome.audioAPI is bedoeld om gebruikers informatie te geven 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 ordenen en anderszins te bewerken. Zie ook 'Override Pages' , waarmee u een aangepaste Bookmark Manager-pagina kunt maken.- browseData
Gebruik de
chrome.browsingDataAPI om browsegegevens uit het lokale profiel van een gebruiker te verwijderen.- certificaataanbieder
- Chrome 46+ Alleen ChromeOS
Met deze API kunt u certificaten beschikbaar stellen aan het platform, dat deze certificaten kan gebruiken voor TLS-authenticatie.
- opdrachten
Gebruik de API voor opdrachten om sneltoetsen toe te voegen die acties in uw extensie activeren, bijvoorbeeld een actie om de browseractie 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 contentinstellingen het gedrag van Chrome per site aanpassen in plaats van wereldwijd.- contextMenu's
Gebruik de
chrome.contextMenusAPI om items toe te voegen aan het contextmenu van Google Chrome. U kunt kiezen op welke typen objecten uw contextmenu-toevoegingen van toepassing zijn, zoals afbeeldingen, hyperlinks en pagina's.- koekjes
Gebruik de
chrome.cookiesAPI om cookies op te vragen en te wijzigen, en om op de hoogte te worden gesteld wanneer ze veranderen.- debugger
De
chrome.debuggerAPI fungeert als alternatief transport 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 muteren, en meer. Gebruik de eigenschaptabIdDebuggeeom tabbladen te targeten metsendCommanden gebeurtenissen te routeren viatabIdvanuitonEventcallbacks.- declaratieveInhoud
Gebruik de API
chrome.declarativeContentom 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.- declaratieveNetRequest
- Chroom 84+
De
chrome.declarativeNetRequestAPI wordt gebruikt om netwerkverzoeken te blokkeren of te wijzigen door declaratieve regels te specificeren. Hierdoor kunnen extensies netwerkverzoeken wijzigen zonder deze te onderscheppen en de inhoud ervan te bekijken, wat zorgt voor meer privacy. - bureaublad vastleggen
Met de Desktop Capture API legt u de inhoud van het scherm, afzonderlijke vensters of afzonderlijke tabbladen vast.
- devtools.inspectedWindow
Gebruik de API
chrome.devtools.inspectedWindowom 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 binnen de pagina.- devtools.network
Gebruik de API
chrome.devtools.networkom de informatie op te halen over netwerkverzoeken die door de Developer Tools in het paneel Netwerk worden weergegeven.- devtools.panels
Gebruik de API
chrome.devtools.panelsom uw extensie te integreren in de gebruikersinterface van het Developer Tools-venster: maak uw eigen panelen, open bestaande panelen en voeg zijbalken toe.- devtools.prestaties
- Chroom 129+
Gebruik de API
chrome.devtools.performanceom te luisteren naar updates van de opnamestatus in het paneel Prestaties in DevTools. - devtools.recorder
- Chroom 105+
Gebruik de
chrome.devtools.recorderAPI om het Recorder-paneel in DevTools aan te passen. - dns
- Dev-kanaal
Gebruik de
chrome.dnsAPI voor DNS-omzetting. - documentScan
- Chrome 44+ Alleen ChromeOS
Gebruik de
chrome.documentScanAPI om afbeeldingen van aangesloten documentscanners te detecteren en op te halen. - dom
- Chroom 88+
Gebruik de
chrome.domAPI om toegang te krijgen tot speciale DOM API's voor extensies - downloaden
Gebruik de
chrome.downloadsAPI om downloads programmatisch te initiëren, controleren, manipuleren en zoeken.- enterprise.deviceAttributes
Gebruik de
chrome.enterprise.deviceAttributesAPI om apparaatkenmerken te lezen. Opmerking: Deze API is alleen beschikbaar voor extensies die geforceerd zijn geïnstalleerd volgens het bedrijfsbeleid.- 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. Opmerking: deze API is alleen beschikbaar voor extensies die via een bedrijfsbeleid zijn geïnstalleerd. - onderneming.login
Gebruik de
chrome.enterprise.loginAPI om beheerde gastsessies te verlaten. 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 uw huidige netwerk te lezen. Opmerking: deze API is alleen beschikbaar voor extensies die geforceerd zijn geïnstalleerd door het bedrijfsbeleid.- enterprise.platformKeys
- Alleen 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 andere extensies via chrome.platformKeys. - evenementen
De
chrome.events-naamruimte bevat algemene typen die worden gebruikt door API's die gebeurtenissen verzenden om u te waarschuwen wanneer er iets interessants gebeurt.- verlenging
De
chrome.extensionAPI bevat hulpprogramma's die door elke extensiepagina kunnen worden gebruikt. Het omvat ondersteuning voor het uitwisselen van berichten tussen een extensie en de bijbehorende contentscripts of tussen extensies onderling, zoals gedetailleerd beschreven in Berichten doorgeven .- extensieTypes
De
chrome.extensionTypesAPI bevat typedeclaraties voor Chrome-extensies.- bestandsbrowserhandler
- Alleen ChromeOS Alleen voorgrond
Gebruik de
chrome.fileBrowserHandlerAPI om de Chrome OS-bestandsbrowser uit te breiden. U kunt deze API bijvoorbeeld gebruiken om gebruikers in staat te stellen bestanden naar uw website te uploaden. - bestandssysteemprovider
- Alleen ChromeOS
Gebruik de
chrome.fileSystemProviderAPI om bestandssystemen te maken die toegankelijk zijn via de bestandsbeheerder in 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 ontvangen via Firebase Cloud Messaging (FCM).- geschiedenis
Gebruik de
chrome.historyAPI om te communiceren met de browsergeschiedenis van bezochte pagina's. U kunt URL's toevoegen, verwijderen en opvragen in de browsergeschiedenis. Zie Pagina's overschrijven om de geschiedenispagina te vervangen door uw eigen versie.- i18n
Gebruik de
chrome.i18ninfrastructuur om internationalisatie 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.- invoer.tijd
- 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
- Chroom 44+
Gebruik
chrome.instanceIDom toegang te krijgen tot de Instance ID-service. - loginState
- Chrome 78+ Alleen ChromeOS
Gebruik de
chrome.loginStateAPI om de aanmeldstatus te lezen en te controleren. - beheer
Met de
chrome.managementAPI kunt u geïnstalleerde apps en extensies beheren.- meldingen
Gebruik de
chrome.notificationsAPI om uitgebreide meldingen te maken met behulp van sjablonen en deze meldingen aan gebruikers te tonen in het systeemvak.- buiten beeld
- Chroom 109+ MV3+
Gebruik de
offscreenAPI om offscreen-documenten te maken en beheren. - omnibox
Met de omnibox API kunt u een trefwoord registreren in de adresbalk van Google Chrome, ook wel de omnibox genoemd.
- paginaCapture
Gebruik de
chrome.pageCaptureAPI om een tabblad op te slaan als MHTML.- toestemmingen
Gebruik de
chrome.permissionsAPI om opgegeven optionele machtigingen aan te vragen tijdens runtime in plaats van tijdens installatie. Zo begrijpen gebruikers waarom de machtigingen nodig zijn en verlenen ze alleen de noodzakelijke machtigingen.- platformKeys
- Chrome 45+ Alleen ChromeOS
Gebruik de
chrome.platformKeysAPI om toegang te krijgen tot clientcertificaten die door het platform worden beheerd. Als de gebruiker of het beleid hiervoor toestemming geeft, 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.- printerProvider
- Chroom 44+
De API
chrome.printerProvidermaakt gebeurtenissen beschikbaar die door de afdrukbeheerder worden gebruikt om printers te raadplegen die door extensies worden aangestuurd, om hun mogelijkheden te raadplegen en om afdruktaken naar deze printers te verzenden. - afdrukken
- Chrome 81+ Alleen ChromeOS
Gebruik de
chrome.printingAPI om afdruktaken te versturen naar printers die op uw Chromebook zijn geïnstalleerd. - printMetrics
Gebruik de
chrome.printingMetricsAPI om gegevens over het afdrukgebruik op te halen.- privacy
Gebruik de
chrome.privacyAPI om het gebruik van Chrome-functies te beheren 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
- Dev-kanaal
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 is gebaseerd op het ChromeSetting-prototype van het type API voor het ophalen en instellen van de proxyconfiguratie.- leeslijst
- Chroom 120+ MV3+
Gebruik de
chrome.readingListAPI om items in de leeslijst te lezen en te wijzigen. - looptijd
Gebruik de
chrome.runtimeAPI om de service worker op te halen, details over het manifest te retourneren en te luisteren naar en te reageren op gebeurtenissen in de levenscyclus van de extensie. U kunt deze API ook gebruiken om het relatieve pad van URL's om te zetten naar volledig gekwalificeerde URL's.- scripting
- Chroom 88+ MV3+
Gebruik de
chrome.scriptingAPI om scripts in verschillende contexten uit te voeren. - zoekopdracht
- Chroom 87+
Gebruik de
chrome.searchAPI om te zoeken via de standaardprovider. - sessies
Gebruik de
chrome.sessionsAPI om tabbladen en vensters van een browsersessie op te vragen en te herstellen.- zijpaneel
- Chroom 114+ MV3+
Gebruik de
chrome.sidePanelAPI om inhoud in het zijpaneel van de browser te hosten naast de hoofdinhoud van een webpagina. - opslag
Gebruik de
chrome.storageAPI om gebruikersgegevens op te slaan, op te halen en wijzigingen in deze gegevens bij te houden.- systeem.cpu
Gebruik de API
system.cpuom CPU-metagegevens op te vragen.- systeem.weergave
Gebruik de API
system.displayom weergavemetagegevens op te vragen.- systeemgeheugen
De
chrome.system.memoryAPI.- systeem.opslag
Gebruik de
chrome.system.storageAPI om informatie over opslagapparaten op te vragen en ontvang een melding wanneer een verwijderbaar opslagapparaat wordt aangesloten of losgekoppeld.- systeemLog
Gebruik de
chrome.systemLogAPI om Chrome-systeemlogboeken van extensies vast te leggen.- tabblad Vastleggen
Gebruik de
chrome.tabCaptureAPI om te communiceren met tabbladmediastreams.- tabbladGroepen
- Chroom 89+ MV3+
Gebruik de
chrome.tabGroupsAPI om te communiceren met het tabbladgroeperingssysteem van de browser. U kunt deze API gebruiken om tabbladgroepen in de browser te wijzigen en opnieuw te ordenen. Gebruik dechrome.tabsAPI om tabbladen te groeperen en degroeperen, of om op te vragen welke tabbladen in groepen zitten. - tabbladen
Gebruik de
chrome.tabsAPI om te communiceren met het tabbladsysteem van de browser. U kunt deze API gebruiken om tabbladen in de browser aan te maken, te wijzigen en opnieuw te ordenen.- topsites
Gebruik de
chrome.topSitesAPI om toegang te krijgen tot de topsites (d.w.z. de meest bezochte sites) die op de nieuwe tabbladpagina worden weergegeven. Deze bevatten geen door de gebruiker aangepaste snelkoppelingen.- 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 via deze API, ontvangt deze gebeurtenissen met een uit te spreken uiting en andere parameters wanneer een extensie of Chrome-app dettsAPI gebruikt om spraak te genereren. Uw extensie kan vervolgens elke beschikbare webtechnologie gebruiken 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
- Chroom 120+ MV3+
Gebruik de
userScriptsAPI om gebruikersscripts uit te voeren in de gebruikersscriptscontext. - VPN-provider
- Chrome 43+ Alleen ChromeOS
Gebruik de
chrome.vpnProviderAPI om een VPN-client te implementeren. - behang
- Chrome 43+ Alleen ChromeOS
Gebruik de
chrome.wallpaperAPI om de achtergrond van ChromeOS te wijzigen. - webAuthenticatieProxy
- Chroom 115+ MV3+
Met de API
chrome.webAuthenticationProxykan software voor externe bureaubladen die op een externe host wordt uitgevoerd, WebAuthn-verzoeken (Web Authentication API) onderscheppen, zodat deze op een lokale client kunnen worden verwerkt. - webnavigatie
Gebruik de
chrome.webNavigationAPI om meldingen te ontvangen over de status van navigatieverzoeken tijdens de vlucht.- webaanvraag
Gebruik de
chrome.webRequestAPI om verkeer te observeren en analyseren en om verzoeken tijdens de vlucht te onderscheppen, blokkeren of wijzigen.- ramen
Gebruik de
chrome.windowsAPI om te communiceren met browservensters. U kunt deze API gebruiken om vensters in de browser te maken, te wijzigen en opnieuw in te delen.