API-referentie

De meeste extensies hebben toegang nodig tot een of meer Chrome Extensions API's om te kunnen functioneren. Deze API-referentie beschrijft de API's die beschikbaar zijn voor gebruik in extensies en presenteert voorbeeldgebruiksscenario's.

Common Extensions API-functies

Een Extensions API bestaat uit een naamruimte met methoden en eigenschappen voor het werken met extensies, en meestal, maar niet altijd, manifestvelden voor het bestand manifest.json . Voor de naamruimte chrome.action is bijvoorbeeld een object "action" in het manifest vereist. Voor veel API's zijn ook machtigingen in het manifest vereist.

Methoden in extensie-API's zijn asynchroon , tenzij anders vermeld. Asynchrone methoden keren onmiddellijk terug, zonder te wachten tot de bewerking die ze aanroept, is voltooid. Gebruik beloften om de resultaten van deze methoden te krijgen. Zie Asynchrone methoden voor meer informatie.

API's voor Chrome-extensies

toegankelijkheidKenmerken

Gebruik de chrome.accessibilityFeatures API om de toegankelijkheidsfuncties van Chrome te beheren. Deze API is afhankelijk van het ChromeSetting-prototype van het type API voor het verkrijgen en instellen van individuele toegankelijkheidsfuncties. Om functiestatussen te krijgen, moet de extensie de machtiging accessibilityFeatures.read aanvragen. Voor het wijzigen van de functiestatus heeft de extensie de machtiging accessibilityFeatures.modify nodig. Houd er rekening mee dat accessibilityFeatures.modify geen toestemming voor accessibilityFeatures.read impliceert.

actie
Chroom 88+ MV3+

Gebruik de chrome.action API om het pictogram van de extensie in de Google Chrome-werkbalk te beheren.

alarmen

Gebruik de chrome.alarms API om te plannen dat code periodiek of op een bepaald tijdstip in de toekomst wordt uitgevoerd.

geluid
AlleenChrome 59+ ChromeOS

De chrome.audio API is bedoeld om gebruikers in staat te stellen informatie te verkrijgen over de audioapparaten die op het systeem zijn aangesloten en deze te bedienen. Deze API is momenteel alleen beschikbaar in kioskmodus voor ChromeOS.

bladwijzers

Gebruik de chrome.bookmarks API om bladwijzers te maken, ordenen en anderszins te manipuleren. Zie ook Pagina's overschrijven , waarmee u een aangepaste pagina Bladwijzerbeheer kunt maken.

browsegegevens

Gebruik de chrome.browsingData API om browsegegevens uit het lokale profiel van een gebruiker te verwijderen.

certificaatAanbieder
Chrome 46+ Alleen ChromeOS

Gebruik deze API om certificaten beschikbaar te stellen aan het platform dat deze certificaten kan gebruiken voor TLS-authenticaties.

opdrachten

Gebruik de opdrachten-API 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.

inhoudInstellingen

Gebruik de chrome.contentSettings API om instellingen te wijzigen die bepalen of websites functies zoals cookies, JavaScript en plug-ins kunnen gebruiken. Meer in het algemeen kunt u met de inhoudsinstellingen het gedrag van Chrome per site aanpassen in plaats van globaal.

contextMenu's

Gebruik de chrome.contextMenus API om items toe te voegen aan het contextmenu van Google Chrome. U kunt kiezen op welke typen objecten de toevoegingen aan het contextmenu van toepassing zijn, zoals afbeeldingen, hyperlinks en pagina's.

koekjes

Gebruik de chrome.cookies API om cookies op te vragen en te wijzigen, en om een ​​melding te krijgen wanneer ze veranderen.

debugger

De chrome.debugger API dient als alternatief transport voor het protocol voor foutopsporing op afstand van Chrome. Gebruik chrome.debugger om aan een of meer tabbladen te koppelen om netwerkinteractie te instrumenteren, JavaScript te debuggen, de DOM en CSS te muteren, en meer. Gebruik de Debuggee eigenschap tabId om tabbladen te targeten met sendCommand en gebeurtenissen te routeren op tabId vanuit onEvent callbacks.

declaratieveInhoud

Gebruik de chrome.declarativeContent API om acties uit te voeren afhankelijk van de inhoud van een pagina, zonder dat u toestemming nodig heeft om de inhoud van de pagina te lezen.

declaratieveNetRequest
Chroom 84+

De chrome.declarativeNetRequest API wordt gebruikt om netwerkverzoeken te blokkeren of te wijzigen door declaratieve regels op te geven. Hierdoor kunnen extensies netwerkverzoeken wijzigen zonder deze te onderscheppen en de inhoud ervan te bekijken, waardoor meer privacy wordt geboden.

bureaubladCapture

De Desktop Capture API legt de inhoud van het scherm, individuele vensters of individuele tabbladen vast.

devtools.inspectedWindow

Gebruik de chrome.devtools.inspectedWindow API voor interactie 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.network API om de informatie op te halen over netwerkverzoeken die worden weergegeven door de ontwikkelaarstools in het netwerkpaneel.

devtools.panels

Gebruik de chrome.devtools.panels API om uw extensie te integreren in de gebruikersinterface van het Developer Tools-venster: maak uw eigen panelen, krijg toegang tot bestaande panelen en voeg zijbalken toe.

devtools.performance
Chroom 129+

Gebruik de chrome.devtools.performance API om te luisteren naar updates van de opnamestatus in het deelvenster Prestaties in DevTools.

devtools.recorder
Chroom 105+

Gebruik de chrome.devtools.recorder API om het Recorder-paneel in DevTools aan te passen.

dns
Ontwikkelaarskanaal

Gebruik de chrome.dns API voor dns-resolutie.

documentScan
AlleenChrome 44+ ChromeOS

Gebruik de chrome.documentScan API om afbeeldingen van aangesloten documentscanners te ontdekken en op te halen.

dom
Chroom 88+

Gebruik de chrome.dom API om toegang te krijgen tot speciale DOM API's voor extensies

downloads

Gebruik de chrome.downloads API om downloads programmatisch te initiëren, controleren, manipuleren en zoeken.

enterprise.deviceAttributen
Chrome 46+ Alleen ChromeOS Vereist beleid

Gebruik de chrome.enterprise.deviceAttributes API om apparaatkenmerken te lezen. Opmerking: deze API is alleen beschikbaar voor extensies die afgedwongen zijn geïnstalleerd door bedrijfsbeleid.

enterprise.hardwarePlatform
Chrome 71+ Vereist beleid

Gebruik de chrome.enterprise.hardwarePlatform API om de fabrikant en het model van het hardwareplatform waarop de browser draait op te halen. Opmerking: deze API is alleen beschikbaar voor extensies die zijn geïnstalleerd volgens bedrijfsbeleid.

enterprise.networkingAttributen
Chrome 85+ Alleen ChromeOS Vereist beleid

Gebruik de chrome.enterprise.networkingAttributes API om informatie over uw huidige netwerk te lezen. Opmerking: deze API is alleen beschikbaar voor extensies die afgedwongen zijn geïnstalleerd door bedrijfsbeleid.

enterprise.platformsleutels
Alleen ChromeOS Vereist beleid

Gebruik de chrome.enterprise.platformKeys API 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 op een andere manier via chrome.platformKeys.

evenementen

De naamruimte chrome.events bevat algemene typen die worden gebruikt door API's die gebeurtenissen verzenden om u op de hoogte te stellen wanneer er iets interessants gebeurt.

verlenging

De chrome.extension API heeft hulpprogramma's die door elke extensiepagina kunnen worden gebruikt. Het bevat ondersteuning voor het uitwisselen van berichten tussen een extensie en de inhoudsscripts of tussen extensies, zoals gedetailleerd beschreven in Message Passing .

extensieTypes

De chrome.extensionTypes API bevat typedeclaraties voor Chrome-extensies.

fileBrowserHandler
Alleen ChromeOS Alleen voorgrond

Gebruik de chrome.fileBrowserHandler API 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.fileSystemProvider API om bestandssystemen te maken die toegankelijk zijn via bestandsbeheer in Chrome OS.

lettertypeInstellingen

Gebruik de chrome.fontSettings API om de lettertype-instellingen van Chrome te beheren.

gcm

Gebruik chrome.gcm om apps en extensies in staat te stellen berichten te verzenden en ontvangen via Firebase Cloud Messaging (FCM).

geschiedenis

Gebruik de chrome.history API om te communiceren met de browsergeschiedenis van bezochte pagina's. U kunt URL's in de browsergeschiedenis toevoegen, verwijderen en ernaar opvragen. Zie Pagina's overschrijven om de geschiedenispagina te overschrijven met uw eigen versie.

ik18n

Gebruik de chrome.i18n infrastructuur om internationalisering in uw hele app of extensie te implementeren.

identiteit

Gebruik de chrome.identity API om OAuth2-toegangstokens te verkrijgen.

inactief

Gebruik de chrome.idle API om te detecteren wanneer de inactieve status van de machine verandert.

invoer.ime
Alleen ChromeOS

Gebruik de chrome.input.ime API om een ​​aangepaste IME voor Chrome OS te implementeren. Hierdoor kan uw extensie toetsaanslagen verwerken, de compositie instellen en het kandidaatvenster beheren.

instantie-ID
Chroom 44+

Gebruik chrome.instanceID om toegang te krijgen tot de Instance ID-service.

loginState
AlleenChrome 78+ ChromeOS

Gebruik de chrome.loginState API om de inlogstatus te lezen en te controleren.

beheer

De chrome.management API biedt manieren om geïnstalleerde apps en extensies te beheren.

meldingen

Gebruik de chrome.notifications API om uitgebreide meldingen te maken met behulp van sjablonen en deze meldingen aan gebruikers in het systeemvak weer te geven.

buiten het scherm
Chroom 109+ MV3+

Gebruik de offscreen API om offscreen-documenten te maken en te 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.pageCapture API om een ​​tabblad op te slaan als MHTML.

machtigingen

Gebruik de chrome.permissions API om gedeclareerde optionele machtigingen tijdens runtime aan te vragen in plaats van tijdens de installatie, zodat gebruikers begrijpen waarom de machtigingen nodig zijn en alleen de machtigingen verlenen die nodig zijn.

platformsleutels
AlleenChrome 45+ ChromeOS

Gebruik de chrome.platformKeys API 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 aangepaste authenticatieprotocol. Dit maakt bijvoorbeeld het gebruik van platformbeheerde certificaten in VPN's van derden mogelijk (zie chrome.vpnProvider ).

stroom

Gebruik de chrome.power API om de energiebeheerfuncties van het systeem te overschrijven.

printerProvider
Chroom 44+

De chrome.printerProvider API maakt gebeurtenissen zichtbaar die door Print Manager worden gebruikt om printers te bevragen die worden beheerd door extensies, om hun mogelijkheden te bevragen en om afdruktaken naar deze printers te verzenden.

afdrukken
AlleenChrome 81+ ChromeOS

Gebruik de chrome.printing API om afdruktaken te verzenden naar printers die op Chromebook zijn geïnstalleerd.

afdrukkenMetrieken
Chrome 79+ Alleen ChromeOS Vereist beleid

Gebruik de chrome.printingMetrics API om gegevens over het afdrukgebruik op te halen.

privacy

Gebruik de chrome.privacy API om het gebruik van de functies in Chrome te beheren die van invloed kunnen zijn op de privacy van een gebruiker. Deze API is afhankelijk van het ChromeSetting-prototype van het type API voor het ophalen en instellen van de Chrome-configuratie.

processen
Ontwikkelaarskanaal

Gebruik de chrome.processes API om te communiceren met de browserprocessen.

volmacht

Gebruik de chrome.proxy API om de proxy-instellingen van Chrome te beheren. Deze API is afhankelijk van het ChromeSetting-prototype van het type API voor het ophalen en instellen van de proxyconfiguratie.

leeslijst
Chroom 120+ MV3+

Gebruik de chrome.readingList API om de items in de Leeslijst te lezen en te wijzigen.

looptijd

Gebruik de chrome.runtime API 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. U kunt deze API ook gebruiken om het relatieve pad van URL's om te zetten in volledig gekwalificeerde URL's.

scripten
Chroom 88+ MV3+

Gebruik de chrome.scripting API om scripts in verschillende contexten uit te voeren.

zoekopdracht
Chroom 87+

Gebruik de chrome.search API om via de standaardprovider te zoeken.

sessies

Gebruik de chrome.sessions API om tabbladen en vensters uit een browsersessie op te vragen en te herstellen.

zijpaneel
Chroom 114+ MV3+

Gebruik de chrome.sidePanel API om inhoud in het zijpaneel van de browser te hosten, naast de hoofdinhoud van een webpagina.

opslag

Gebruik de chrome.storage API om wijzigingen in gebruikersgegevens op te slaan, op te halen en bij te houden.

systeem.cpu

Gebruik de system.cpu API om CPU-metagegevens op te vragen.

systeem.display

Gebruik de system.display API om metagegevens van het display op te vragen.

systeemgeheugen

De chrome.system.memory -API.

systeemopslag

Gebruik de chrome.system.storage API om gegevens over opslagapparaten op te vragen en ontvang een melding wanneer een verwijderbaar opslagapparaat wordt aangesloten en losgekoppeld.

systeemLog
Chrome 125+ Alleen ChromeOS Vereist beleid

Gebruik de chrome.systemLog API om Chrome-systeemlogboeken van extensies op te nemen.

tabbladCapture

Gebruik de chrome.tabCapture API voor interactie met tabbladmediastreams.

tabbladGroepen
Chroom 89+ MV3+

Gebruik de chrome.tabGroups API om te communiceren met het tabbladgroeperingssysteem van de browser. U kunt deze API gebruiken om tabbladgroepen in de browser te wijzigen en opnieuw in te delen. Gebruik de chrome.tabs API om tabbladen te groeperen en de groepering ervan op te heffen, of om te vragen welke tabbladen zich in groepen bevinden.

tabbladen

Gebruik de chrome.tabs API om te communiceren met het tabbladsysteem van de browser. U kunt deze API gebruiken om tabbladen in de browser te maken, te wijzigen en opnieuw in te delen.

topSites

Gebruik de chrome.topSites API om toegang te krijgen tot de topsites (dat wil zeggen de meest bezochte sites) die worden weergegeven op de nieuwe tabbladpagina. Deze omvatten geen snelkoppelingen die door de gebruiker zijn aangepast.

tts

Gebruik de chrome.tts API om gesynthetiseerde tekst-naar-spraak (TTS) af te spelen. Zie ook de gerelateerde ttsEngine API, waarmee een extensie een spraakengine kan implementeren.

ttsMotor

Gebruik de chrome.ttsEngine API om een ​​tekst-naar-spraak-engine (TTS) te implementeren met behulp van een extensie. Als uw extensie zich registreert met behulp van deze API, ontvangt deze gebeurtenissen met een uiting die moet worden uitgesproken en andere parameters wanneer een extensie of Chrome-app de tts API gebruikt om spraak te genereren. Uw toestel kan vervolgens elke beschikbare webtechnologie gebruiken om de spraak te synthetiseren en uit te voeren, en gebeurtenissen terug te sturen naar de belfunctie om de status te rapporteren.

typen

De chrome.types API bevat typedeclaraties voor Chrome.

gebruikersscripts
Chroom 120+ MV3+

Gebruik de userScripts API om gebruikersscripts uit te voeren in de context van Gebruikersscripts.

vpnProvider
Chrome 43+ Alleen ChromeOS

Gebruik de chrome.vpnProvider API om een ​​VPN-client te implementeren.

behang
Chrome 43+ Alleen ChromeOS

Gebruik de chrome.wallpaper API om de ChromeOS-achtergrond te wijzigen.

webAuthenticatieProxy
Chroom 115+ MV3+

Met de chrome.webAuthenticationProxy API kan externe desktopsoftware die op een externe host draait, Web Authentication API (WebAuthn)-aanvragen onderscheppen om deze op een lokale client af te handelen.

webNavigatie

Gebruik de chrome.webNavigation API om meldingen te ontvangen over de status van navigatieverzoeken tijdens de vlucht.

webAanvraag

Gebruik de chrome.webRequest API om verkeer te observeren en analyseren en om verzoeken tijdens de vlucht te onderscheppen, blokkeren of wijzigen.

ramen

Gebruik de chrome.windows API voor interactie met browservensters. U kunt deze API gebruiken om vensters in de browser te maken, aan te passen en opnieuw in te delen.