chrome.permissions

refresh date: 2026-09-25 robots: noindex

Beschreibung

Verwenden Sie die chrome.permissions API, um deklarierte optionale Berechtigungen zur Laufzeit und nicht zur Installationszeit anzufordern. So verstehen Nutzer, warum die Berechtigungen erforderlich sind, und gewähren nur die erforderlichen Berechtigungen.

Übersicht

Berechtigungswarnungen beschreiben die von einer API gewährten Funktionen. Einige dieser Warnungen sind jedoch möglicherweise nicht offensichtlich. Mit der Permissions API können Entwickler Berechtigungswarnungen erklären und neue Funktionen schrittweise einführen. So können Nutzer die Erweiterung risikofrei kennenlernen. So können Nutzer festlegen, wie viel Zugriff sie gewähren und welche Funktionen sie aktivieren möchten.

Die Hauptfunktion der Erweiterung für optionale Berechtigungen besteht beispielsweise darin, die Seite „Neuer Tab“ zu überschreiben. Eine Funktion ist die Anzeige des Tagesziels des Nutzers. Für diese Funktion ist nur die Berechtigung storage erforderlich, die keine Warnung enthält. Die Erweiterung hat eine zusätzliche Funktion, die Nutzer durch Klicken auf die folgende Schaltfläche aktivieren können:

Schaltfläche für Erweiterungen, die zusätzliche Funktionen aktiviert

Für die Anzeige der am häufigsten besuchten Websites des Nutzers ist die Berechtigung topSites erforderlich, für die die folgende Warnung gilt.

Erweiterungswarnung für die topSites API

Optionale Berechtigungen implementieren

Schritt 1: Entscheiden, welche Berechtigungen erforderlich und welche optional sind

Eine Erweiterung kann sowohl erforderliche als auch optionale Berechtigungen deklarieren. Im Allgemeinen gilt Folgendes:

  • Verwenden Sie erforderliche Berechtigungen, wenn sie für die grundlegende Funktionalität Ihrer Erweiterung erforderlich sind.
  • Verwenden Sie optionale Berechtigungen, wenn sie für optionale Funktionen in Ihrer Erweiterung erforderlich sind.

Vorteile von erforderlichen Berechtigungen:

  • Weniger Aufforderungen: Eine Erweiterung kann den Nutzer einmal auffordern, alle Berechtigungen zu akzeptieren.
  • Einfachere Entwicklung: Die erforderlichen Berechtigungen sind garantiert vorhanden.

Vorteile von optionalen Berechtigungen:

  • Mehr Sicherheit: Erweiterungen werden mit weniger Berechtigungen ausgeführt, da Nutzer nur die erforderlichen Berechtigungen aktivieren.
  • Bessere Informationen für Nutzer: Eine Erweiterung kann erklären, warum sie eine bestimmte Berechtigung benötigt, wenn der Nutzer die entsprechende Funktion aktiviert.
  • Einfachere Upgrades: Wenn Sie Ihre Erweiterung aktualisieren, wird sie von Chrome nicht für Ihre Nutzer deaktiviert, wenn durch das Upgrade optionale und keine erforderlichen Berechtigungen hinzugefügt werden.

Schritt 2: Optionale Berechtigungen im Manifest deklarieren

Deklarieren Sie optionale Berechtigungen in Ihrem Erweiterungsmanifest mit dem Schlüssel optional_permissions im selben Format wie das Feld permissions:

{
  "name": "My extension",
  ...
  "optional_permissions": ["tabs"],
  "optional_host_permissions": ["https://www.google.com/"],
  ...
}

Wenn Sie Hosts anfordern möchten, die Sie erst zur Laufzeit ermitteln, fügen Sie "https://*/*" in das Feld optional_host_permissions Ihrer Erweiterung ein. So können Sie einen beliebigen Ursprung in Permissions.origins angeben, solange er ein übereinstimmendes Schema hat.

Berechtigungen, die nicht als optional angegeben werden können

Die meisten Berechtigungen für Chrome-Erweiterungen können als optional angegeben werden. Es gelten folgende Ausnahmen:

Berechtigung Beschreibung
"debugger" Die chrome.debugger API dient als alternativer Transport für das Remote-Debugging-Protokoll von Chrome.
"declarativeNetRequest" Gewährt der Erweiterung Zugriff auf die chrome.declarativeNetRequest API.
"devtools" Ermöglicht der Erweiterung, die Funktionalität der Chrome-Entwicklertools zu erweitern.
"experimental" Nur Canary- und Entwicklerversion. Gewährt der Erweiterung Zugriff auf chrome.experimental-APIs.
"geolocation" Ermöglicht der Erweiterung, die HTML5-API zur Standortbestimmung zu verwenden.
"mdns" Gewährt der Erweiterung Zugriff auf die chrome.mdns API.
"proxy" Gewährt der Erweiterung Zugriff auf die chrome.proxy API, um die Proxy-Einstellungen von Chrome zu verwalten.
"tts" Die chrome.tts API gibt synthetisierte Text-zu-Sprache (TTS) wieder.
"ttsEngine" Die chrome.ttsEngine API implementiert eine Text-zu-Sprache-Engine (TTS) mithilfe einer Erweiterung.
"wallpaper" Nur ChromeOS: Verwenden Sie die chrome.wallpaper API, um den ChromeOS-Hintergrund zu ändern.

Weitere Informationen zu verfügbaren Berechtigungen und den entsprechenden Warnungen findest du unter Berechtigungen deklarieren und Nutzer warnen.

Schritt 3: Optionale Berechtigungen anfordern

Fordern Sie die Berechtigungen innerhalb einer Nutzergeste mit permissions.request() an:

document.querySelector('#my-button').addEventListener('click', (event) => {
  // Permissions must be requested from inside a user gesture, like a button's
  // click handler.
  chrome.permissions.request({
    permissions: ['tabs'],
    origins: ['https://www.google.com/']
  }, (granted) => {
    // The callback argument will be true if the user granted the permissions.
    if (granted) {
      doSomething();
    } else {
      doSomethingElse();
    }
  });
});

Chrome fordert den Nutzer auf, die Berechtigungen hinzuzufügen, wenn dies zu anderen Warnmeldungen führt als die, die der Nutzer bereits gesehen und akzeptiert hat. Der vorherige Code könnte beispielsweise zu einem Prompt wie diesem führen:

Beispiel für eine Aufforderung zur Bestätigung von Berechtigungen

Schritt 4: Aktuelle Berechtigungen der Erweiterung prüfen

Mit permission.contains() können Sie prüfen, ob Ihre Erweiterung eine bestimmte Berechtigung oder einen bestimmten Satz von Berechtigungen hat:

chrome.permissions.contains({
  permissions: ['tabs'],
  origins: ['https://www.google.com/']
}, (result) => {
  if (result) {
    // The extension has the permissions.
  } else {
    // The extension doesn't have the permissions.
  }
});

Schritt 5: Berechtigungen entfernen

Sie sollten Berechtigungen entfernen, wenn Sie sie nicht mehr benötigen. Nachdem eine Berechtigung entfernt wurde, wird sie durch den Aufruf von permissions.request() normalerweise wieder hinzugefügt, ohne dass der Nutzer dazu aufgefordert wird.

chrome.permissions.remove({
  permissions: ['tabs'],
  origins: ['https://www.google.com/']
}, (removed) => {
  if (removed) {
    // The permissions have been removed.
  } else {
    // The permissions have not been removed (e.g., you tried to remove
    // required permissions).
  }
});

Typen

Permissions

Attribute

  • origins

    string[] optional

    Die Liste der Hostberechtigungen, einschließlich der im Manifest in den Schlüsseln optional_permissions oder permissions angegebenen Berechtigungen und der mit Inhaltsskripts verknüpften Berechtigungen.

  • Berechtigungen

    string[] optional

    Liste der benannten Berechtigungen (ohne Hosts oder Ursprünge).

Methoden

contains()

Promise
chrome.permissions.contains(
  permissions: Permissions,
  callback?: function,
)
: Promise<boolean>

Prüft, ob die Erweiterung die angegebenen Berechtigungen hat.

Parameter

  • Berechtigungen
  • callback

    function optional

    Der Parameter callback sieht so aus:

    (result: boolean) => void

    • Ergebnis

      boolean

      „True“, wenn die Erweiterung die angegebenen Berechtigungen hat. Wenn ein Ursprung sowohl als optionale Berechtigung als auch als Übereinstimmungsmuster für Inhaltsskripts angegeben ist, wird false zurückgegeben, es sei denn, beide Berechtigungen werden gewährt.

Ausgabe

  • Promise<boolean>

    Chrome 96 oder höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

getAll()

Promise
chrome.permissions.getAll(
  callback?: function,
)
: Promise<Permissions>

Ruft die aktuellen Berechtigungen der Erweiterung ab.

Parameter

  • callback

    function optional

    Der Parameter callback sieht so aus:

    (permissions: Permissions) => void

    • Berechtigungen

      Die aktiven Berechtigungen der Erweiterung. Die Property origins enthält die gewährten Ursprünge, die in den Schlüsseln permissions und optional_permissions im Manifest angegeben sind, sowie die Ursprünge, die mit Inhaltsskripts verknüpft sind.

Ausgabe

  • Promise<Permissions>

    Chrome 96 oder höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

remove()

Promise
chrome.permissions.remove(
  permissions: Permissions,
  callback?: function,
)
: Promise<boolean>

Entfernt den Zugriff auf die angegebenen Berechtigungen. Wenn beim Entfernen der Berechtigungen Probleme auftreten, wird das Promise abgelehnt.

Parameter

  • Berechtigungen
  • callback

    function optional

    Der Parameter callback sieht so aus:

    (removed: boolean) => void

    • entfernt

      boolean

      Wahr, wenn die Berechtigungen entfernt wurden.

Ausgabe

  • Promise<boolean>

    Chrome 96 oder höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

request()

Promise
chrome.permissions.request(
  permissions: Permissions,
  callback?: function,
)
: Promise<boolean>

Fordert Zugriff auf die angegebenen Berechtigungen an und zeigt dem Nutzer bei Bedarf eine Aufforderung an. Diese Berechtigungen müssen entweder im Feld optional_permissions des Manifests definiert sein oder es muss sich um erforderliche Berechtigungen handeln, die vom Nutzer nicht gewährt wurden. Pfade in Ursprungsmustern werden ignoriert. Sie können Teilmengen optionaler Ursprungsberechtigungen anfordern. Wenn Sie beispielsweise *://*\/* im Abschnitt optional_permissions des Manifests angeben, können Sie http://example.com/ anfordern. Wenn beim Anfordern der Berechtigungen Probleme auftreten, wird das Promise abgelehnt.

Parameter

  • Berechtigungen
  • callback

    function optional

    Der Parameter callback sieht so aus:

    (granted: boolean) => void

    • Berechtigung erteilt

      boolean

      „True“, wenn der Nutzer die angegebenen Berechtigungen gewährt hat.

Ausgabe

  • Promise<boolean>

    Chrome 96 oder höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

Ereignisse

onAdded

chrome.permissions.onAdded.addListener(
  callback: function,
)

Wird ausgelöst, wenn die Erweiterung neue Berechtigungen erhält.

Parameter

onRemoved

chrome.permissions.onRemoved.addListener(
  callback: function,
)

Wird ausgelöst, wenn der Zugriff auf Berechtigungen von der Erweiterung entfernt wurde.

Parameter