Die meisten Erweiterungen benötigen Zugriff auf eine oder mehrere APIs für Chrome-Erweiterungen, damit sie funktionieren. In dieser API-Referenz werden die verfügbaren APIs beschrieben. zur Verwendung in Erweiterungen. Außerdem werden Beispiele für Anwendungsfälle vorgestellt.
Allgemeine Extensions API-Funktionen
Eine Extensions API besteht aus einem Namespace, der Methoden und Eigenschaften für die Ausführung von Erweiterungen enthält. Normalerweise ist dies aber nicht der Fall.
immer Manifestfelder für die Datei manifest.json
. Für den Namespace chrome.action
ist beispielsweise ein "action"
-Objekt erforderlich
im Manifest. Für viele APIs sind außerdem Berechtigungen im Manifest erforderlich.
Sofern nicht anders angegeben, sind Methoden in Erweiterungs-APIs asynchron. Asynchrone Methoden werden sofort und ohne Wartezeit zurückgegeben für den Vorgang zum Beenden. Verwenden Sie Promise-Objekte, um die Ergebnisse dieser Methoden zu erhalten. Weitere Informationen finden Sie unter Asynchrone Methoden.
APIs für Chrome-Erweiterungen
- accessibilityFeatures
-
Mit der
chrome.accessibilityFeatures
API kannst du die Bedienungshilfen von Chrome verwalten. Diese API basiert auf dem ChromeSetting-Prototyp des Typs API, um einzelne Bedienungshilfen abzurufen und festzulegen. Zum Abrufen von Funktionsstatus muss die Erweiterung die BerechtigungaccessibilityFeatures.read
anfordern. Damit der Funktionsstatus geändert werden kann, benötigt die Erweiterung die BerechtigungaccessibilityFeatures.modify
. Hinweis:accessibilityFeatures.modify
impliziert keineaccessibilityFeatures.read
-Berechtigung. - Aktion
-
Chrome (ab Version 88) MV3+
Mit der
chrome.action
API kannst du das Symbol der Erweiterung in der Google Chrome-Symbolleiste verwalten. - Wecker
-
Mit der
chrome.alarms
API können Sie Code so planen, dass er regelmäßig oder zu einem bestimmten Zeitpunkt in der Zukunft ausgeführt wird. - Audio
-
Chrome 59 und höher Nur ChromeOS
Die
chrome.audio
API wird bereitgestellt, damit Nutzer Informationen über die mit dem System verbundenen Audiogeräte abrufen und steuern können. Diese API ist derzeit nur im Kioskmodus für ChromeOS verfügbar. - Lesezeichen
-
Mit der
chrome.bookmarks
API können Sie Lesezeichen erstellen, organisieren und anderweitig bearbeiten. Mit Seiten überschreiben können Sie auch eine benutzerdefinierte Seite im Lesezeichenmanager erstellen. - browsingData
-
Mit der
chrome.browsingData
API kannst du Browserdaten aus dem lokalen Profil eines Nutzers entfernen. - certificateProvider
-
Chrome (ab Version 46) Nur ChromeOS
Verwenden Sie diese API, um der Plattform Zertifikate zur Verfügung zu stellen, die diese Zertifikate für TLS-Authentifizierungen verwenden können.
- Befehle
-
Verwenden Sie die Befehls-API, um Tastenkombinationen hinzuzufügen, die Aktionen in Ihrer Erweiterung auslösen, z. B. eine Aktion zum Öffnen der Browseraktion oder zum Senden eines Befehls an die Erweiterung.
- contentSettings
-
Mit der
chrome.contentSettings
API kannst du Einstellungen ändern, um festzulegen, ob Websites Funktionen wie Cookies, JavaScript und Plug-ins verwenden dürfen. Allgemein gesagt, können Sie das Verhalten von Chrome mithilfe der Inhaltseinstellungen für einzelne Websites und nicht global anpassen. - contextMenus
-
Verwende die
chrome.contextMenus
API, um dem Kontextmenü von Google Chrome Elemente hinzuzufügen. Sie können auswählen, für welche Typen von Objekten Ihre Kontextmenüs gelten sollen, z. B. Bilder, Hyperlinks und Seiten. - Cookies
-
Verwenden Sie die
chrome.cookies
API, um Cookies abzufragen und zu ändern und sich bei Änderungen benachrichtigen zu lassen. - Debugger
-
Die
chrome.debugger
API dient als alternativer Transport für das Remote-Debugging-Protokoll von Chrome. Verwenden Siechrome.debugger
, um einen oder mehrere Tabs hinzuzufügen, um die Netzwerkinteraktion zu instrumentieren, JavaScript-Fehler zu beheben, das DOM und CSS zu ändern und vieles mehr. Verwende dieDebuggee
-EigenschafttabId
, um ein Targeting auf Tabs mitsendCommand
vorzunehmen und Ereignisse nachtabId
ausonEvent
-Callbacks weiterzuleiten. - declarativeContent
-
Mit der
chrome.declarativeContent
API kannst du je nach Inhalt einer Seite Aktionen ausführen, ohne dass eine Berechtigung zum Lesen des Seiteninhalts erforderlich ist. - declarativeNetRequest
-
Chrome (ab Version 84)
Die
chrome.declarativeNetRequest
API wird verwendet, um Netzwerkanfragen durch Angabe deklarativer Regeln zu blockieren oder zu ändern. So können Erweiterungen Netzwerkanfragen ändern, ohne sie abzufangen und zu sehen, was für mehr Datenschutz sorgt. - desktopCapture
-
Die Desktop Capture API erfasst den Inhalt des Bildschirms, einzelner Fenster oder einzelner Tabs.
- devtools.inspectedWindow
-
Verwenden Sie die
chrome.devtools.inspectedWindow
API, um mit dem untersuchten Fenster zu interagieren: Rufen Sie die Tab-ID der untersuchten Seite ab, bewerten Sie den Code im Kontext des untersuchten Fensters, aktualisieren Sie die Seite oder rufen Sie die Liste der Ressourcen auf der Seite ab. - devtools.network
-
Mit der
chrome.devtools.network
API können Sie die Informationen zu Netzwerkanfragen abrufen, die von den Entwicklertools im Bereich „Netzwerk“ angezeigt werden. - devtools.panels
-
Mit der
chrome.devtools.panels
API kannst du deine Erweiterung in die Benutzeroberfläche des Fensters der Entwicklertools einbinden. So kannst du eigene Bereiche erstellen, auf vorhandene Bereiche zugreifen und Seitenleisten hinzufügen. - devtools.performance
-
Ausstehend
Mit der
chrome.devtools.performance
API kannst du dir im Bereich „Leistung“ in den Entwicklertools Aktualisierungen des Aufzeichnungsstatus anhören. - devtools.recorder
-
Chrome 105 oder höher
Mit der
chrome.devtools.recorder
API kannst du den Rekorder-Bereich in den Entwicklertools anpassen. - dns
-
<ph type="x-smartling-placeholder"></ph> Entwicklerversion
Verwenden Sie die
chrome.dns
API für die DNS-Auflösung. - documentScan
-
Chrome (ab Version 44) Nur ChromeOS
Verwenden Sie die
chrome.documentScan
API, um Bilder von angehängten Dokumentenscannern zu ermitteln und abzurufen. - Dom
-
Chrome (ab Version 88)
Mit der
chrome.dom
API auf spezielle DOM APIs für Erweiterungen zugreifen - Downloads
-
Mit der
chrome.downloads
API kannst du Downloads programmatisch starten, überwachen, manipulieren und suchen. - enterprise.deviceAttributes
-
Verwenden Sie die
chrome.enterprise.deviceAttributes
API, um Geräteattribute zu lesen. Hinweis: Diese API ist nur für Erweiterungen verfügbar, deren Installation durch eine Unternehmensrichtlinie erzwungen wird. - enterprise.hardwarePlatform
-
Chrome 71 und höher <ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> Erfordert Richtlinie
Verwenden Sie die
chrome.enterprise.hardwarePlatform
API, um den Hersteller und das Modell der Hardwareplattform abzurufen, auf der der Browser ausgeführt wird. Hinweis: Diese API ist nur für Erweiterungen verfügbar, die über die Unternehmensrichtlinie installiert wurden. - enterprise.networkingAttributes
-
Mit der
chrome.enterprise.networkingAttributes
API können Sie Informationen zu Ihrem aktuellen Netzwerk lesen. Hinweis: Diese API ist nur für Erweiterungen verfügbar, deren Installation durch eine Unternehmensrichtlinie erzwungen wird. - enterprise.platformKeys
-
<ph type="x-smartling-placeholder"></ph> Nur ChromeOS <ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> Erfordert Richtlinie
Verwenden Sie die
chrome.enterprise.platformKeys
API, um Schlüssel zu generieren und Zertifikate für diese Schlüssel zu installieren. Die Zertifikate werden von der Plattform verwaltet und können für die TLS-Authentifizierung, den Netzwerkzugriff oder eine andere Erweiterung über „chrome.platformKeys“ verwendet werden. - Ereignisse
-
Der Namespace
chrome.events
enthält gängige Typen, die von APIs verwendet werden, die Ereignisse auslösen, um Sie über interessante Ereignisse zu informieren. - Erweiterung
-
Die
chrome.extension
API enthält Dienstprogramme, die von jeder Erweiterungsseite verwendet werden können. Diese Funktion unterstützt den Austausch von Nachrichten zwischen einer Erweiterung und ihren Inhaltsskripten oder zwischen Erweiterungen. Weitere Informationen hierzu finden Sie unter Nachrichtenweitergabe. - extensionTypes
-
Die
chrome.extensionTypes
API enthält Typdeklarationen für Chrome-Erweiterungen. - fileBrowserHandler
-
<ph type="x-smartling-placeholder"></ph> Nur ChromeOS Nur Vordergrund
Verwenden Sie die
chrome.fileBrowserHandler
API, um den Chrome OS-Dateibrowser zu erweitern. Sie können diese API beispielsweise verwenden, um Nutzern das Hochladen von Dateien auf Ihre Website zu ermöglichen. - fileSystemProvider
-
<ph type="x-smartling-placeholder"></ph> Nur ChromeOS
Verwende die
chrome.fileSystemProvider
API, um Dateisysteme zu erstellen, auf die unter ChromeOS über den Dateimanager zugegriffen werden kann. - fontSettings
-
Verwende die
chrome.fontSettings
API, um die Einstellungen für Schriftarten in Chrome zu verwalten. - gcm
-
Verwenden Sie
chrome.gcm
, um Apps und Erweiterungen zu ermöglichen, Nachrichten über Firebase Cloud Messaging (FCM) zu senden und zu empfangen. - Verlauf
-
Sie können die
chrome.history
API verwenden, um mit dem Datensatz des Browsers zu den besuchten Seiten zu interagieren. Sie können URLs im Browserverlauf hinzufügen, entfernen und abfragen. Wie Sie die Verlaufsseite durch Ihre eigene Version überschreiben, erfahren Sie unter Seiten überschreiben. - i18n
-
Verwenden Sie die
chrome.i18n
-Infrastruktur, um die Internationalisierung für Ihre gesamte App oder Erweiterung zu implementieren. - Identität
-
Verwende die
chrome.identity
API, um OAuth2-Zugriffstokens abzurufen. - inaktiv
-
Verwenden Sie die
chrome.idle
API, um zu erkennen, wenn sich der Inaktivitätsstatus der Maschine ändert. - input.ime
-
<ph type="x-smartling-placeholder"></ph> Nur ChromeOS
Mit der
chrome.input.ime
API kannst du einen benutzerdefinierten IME für Chrome OS implementieren. Dadurch kann Ihre Erweiterung Tastenanschläge verarbeiten, die Anordnung festlegen und das Kandidatenfenster verwalten. - instanceID
-
Chrome (ab Version 44)
Verwenden Sie
chrome.instanceID
, um auf den Instanz-ID-Dienst zuzugreifen. - loginState
-
Chrome 78 oder höher Nur ChromeOS
Verwenden Sie die
chrome.loginState
API, um den Anmeldestatus zu lesen und zu beobachten. - verwaltung
-
Mit der
chrome.management
API können Sie installierte Apps und Erweiterungen verwalten. - Benachrichtigungen
-
Mit der
chrome.notifications
API können Sie mithilfe von Vorlagen umfangreiche Benachrichtigungen erstellen und Nutzern in der Taskleiste anzeigen lassen. - außerhalb des Bildschirms
-
Chrome 109 oder höher MV3+
Mit der
offscreen
API können Sie Dokumente erstellen und verwalten, die nicht auf dem Bildschirm zu sehen sind. - Omnibox
-
Mit der Omnibox API können Sie Keywords in der Adressleiste von Google Chrome, auch Omnibox genannt, registrieren.
- pageCapture
-
Verwenden Sie die
chrome.pageCapture
API, um einen Tab als MHTML zu speichern. - Berechtigungen
-
Verwenden Sie die
chrome.permissions
API, um deklarierte optionale Berechtigungen zur Laufzeit anzufordern, anstatt zum Zeitpunkt der Installation. So verstehen Nutzer, warum die Berechtigungen erforderlich sind, und gewähren nur die notwendigen Berechtigungen. - platformKeys
-
Chrome (ab Version 45) Nur ChromeOS
Verwenden Sie die
chrome.platformKeys
API, um auf von der Plattform verwaltete Clientzertifikate zuzugreifen. Wenn der Nutzer oder die Richtlinie die Berechtigung erteilt, kann eine Erweiterung ein solches Zertifikat in ihrem benutzerdefinierten Authentifizierungsprotokoll verwenden. Beispiel: Dadurch können von der Plattform verwaltete Zertifikate in Drittanbieter-VPNs verwendet werden (siehe chrome.vpnProvider). - Stromversorgung
-
Mit der
chrome.power
API können Sie die Energieverwaltungsfunktionen des Systems überschreiben. - printerProvider
-
Chrome (ab Version 44)
Die
chrome.printerProvider
API zeigt Ereignisse an, die vom Druckmanager verwendet werden, um von Erweiterungen gesteuerte Drucker abzufragen, deren Funktionen abzufragen und Druckaufträge an diese Drucker zu senden. -
Chrome (ab Version 81) Nur ChromeOS
Mit der
chrome.printing
API können Sie Druckaufträge an Drucker senden, die auf Chromebook installiert sind. - printingMetrics
-
Verwenden Sie die
chrome.printingMetrics
API, um Daten zur Drucknutzung abzurufen. - Datenschutz
-
Mit der
chrome.privacy
API kannst du die Nutzung von Funktionen in Chrome steuern, die sich auf den Datenschutz für Nutzer auswirken können. Diese API basiert auf dem ChromeSetting-Prototyp des Typs API zum Abrufen und Festlegen der Chrome-Konfiguration. - Prozesse
-
<ph type="x-smartling-placeholder"></ph> Entwicklerversion
Verwenden Sie die
chrome.processes
API, um mit den Prozessen des Browsers zu interagieren. - proxy
-
Verwenden Sie die
chrome.proxy
API, um die Proxy-Einstellungen von Chrome zu verwalten. Diese API basiert auf dem ChromeSetting-Prototyp des Typs API zum Abrufen und Festlegen der Proxy-Konfiguration. - readingList
-
Chrome 120 oder höher MV3+
Mit der
chrome.readingList
API kannst du die Elemente in der Leseliste auslesen und ändern. - runtime
-
Verwenden Sie die
chrome.runtime
API, um den Service Worker abzurufen, Details zum Manifest zurückzugeben und auf Ereignisse im Erweiterungslebenszyklus zu warten und darauf zu reagieren. Sie können diese API auch verwenden, um den relativen Pfad von URLs in voll qualifizierte URLs umzuwandeln. - Scripting
-
Chrome (ab Version 88) MV3+
Mit der
chrome.scripting
API kannst du ein Script in verschiedenen Kontexten ausführen. - search
-
Chrome (ab Version 87)
Verwenden Sie die
chrome.search
API, um über den Standardanbieter zu suchen. - Sitzungen
-
Mit der
chrome.sessions
API können Sie Tabs und Fenster aus einer Browsersitzung abfragen und wiederherstellen. - sidePanel
-
Chrome 114 und höher MV3+
Mit der
chrome.sidePanel
API kannst du Inhalte in der Seitenleiste des Browsers neben dem Hauptinhalt einer Webseite hosten. - Speicherplatz
-
Mit der
chrome.storage
API können Sie Änderungen an Nutzerdaten speichern, abrufen und verfolgen. - system.cpu
-
Verwenden Sie die
system.cpu
API, um CPU-Metadaten abzufragen. - system.display
-
Verwenden Sie die
system.display
API, um Anzeigemetadaten abzufragen. - system.memory
-
Die
chrome.system.memory
API. - system.storage
-
Mit der
chrome.system.storage
API können Sie Informationen zu Speichergeräten abfragen und sich benachrichtigen lassen, wenn ein Wechseldatenträger angeschlossen und getrennt wird. - systemLog
-
Mit der
chrome.systemLog
API kannst du Chrome-Systemprotokolle von Erweiterungen aufzeichnen. - tabCapture
-
Über die
chrome.tabCapture
API kannst du mit Tab-Medienstreams interagieren. - tabGroups
-
Chrome (ab Version 89) MV3+
Du kannst die
chrome.tabGroups
API verwenden, um mit dem Tab-Gruppierungssystem des Browsers zu interagieren. Mit dieser API können Sie Tabgruppen im Browser ändern und neu anordnen. Verwenden Sie diechrome.tabs
API, um Tabs zu gruppieren und ihre Gruppierung aufzuheben oder abzufragen, welche Tabs in Gruppen enthalten sind. - Tabs
-
Verwenden Sie die
chrome.tabs
API, um mit dem Tabsystem des Browsers zu interagieren. Sie können dieses API verwenden, um Tabs im Browser zu erstellen, zu ändern und neu anzuordnen. - topSites
-
Verwenden Sie die
chrome.topSites
API, um auf die Top-Websites zuzugreifen (d.h. die am häufigsten besuchten Websites), die auf der Seite „Neuer Tab“ angezeigt werden. Dazu gehören keine vom Nutzer angepassten Verknüpfungen. - TTS
-
Verwenden Sie die
chrome.tts
API, um die synthetische Sprachausgabe abzuspielen. Weitere Informationen finden Sie in der zugehörigenttsEngine
API, die es einer Erweiterung ermöglicht, eine Sprach-Engine zu implementieren. - ttsEngine
-
Mit der
chrome.ttsEngine
API können Sie eine Text-in-Sprache-Engine(TTS) mithilfe einer Erweiterung implementieren. Wenn sich Ihre Erweiterung über diese API registriert, empfängt sie Ereignisse mit einer gesprochenen Äußerung sowie andere Parameter, wenn eine Erweiterung oder Chrome-App dietts
API zur Generierung von Sprache verwendet. Ihre Erweiterung kann dann jede verfügbare Webtechnologie verwenden, um die Sprache zu synthetisieren und auszugeben und Ereignisse an die aufrufende Funktion zurückzusenden, um den Status zu melden. - Typen
-
Die
chrome.types
API enthält Typdeklarationen für Chrome. - userScripts
-
Chrome 120 oder höher MV3+
Mit der
userScripts
API können Sie Nutzerskripte im Kontext von Nutzerskripts ausführen. - vpnProvider
-
Chrome (ab Version 43) Nur ChromeOS
Verwenden Sie die
chrome.vpnProvider
API, um einen VPN-Client zu implementieren. -
Chrome (ab Version 43) Nur ChromeOS
Verwenden Sie die
chrome.wallpaper
API, um den ChromeOS-Hintergrund zu ändern. - webAuthenticationProxy
-
Chrome 115 oder höher MV3+
Mit der
chrome.webAuthenticationProxy
API kann Remote Desktop-Software, die auf einem Remote-Host ausgeführt wird, Web Authentication API-Anfragen (WebAuthn) abfangen, um sie auf einem lokalen Client zu verarbeiten. - webNavigation
-
Verwenden Sie die
chrome.webNavigation
API, um Benachrichtigungen über den Status laufender Navigationsanfragen zu erhalten. - webRequest
-
Mit der
chrome.webRequest
API können Sie Traffic beobachten und analysieren sowie laufende Anfragen abfangen, blockieren oder ändern. - fenster
-
Verwenden Sie die
chrome.windows
API, um mit Browserfenstern zu interagieren. Sie können dieses API verwenden, um Fenster im Browser zu erstellen, zu ändern und neu anzuordnen.