chrome.permissions

Beschreibung

Konzepte und Verwendung

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

Beispielsweise wird die Seite „Neuer Tab“ durch die Hauptfunktion der Erweiterung für optionale Berechtigungen überschrieben. Eine Funktion ist die Anzeige des Tagesziels des Nutzers. Für diese Funktion ist nur die Berechtigung Speicher erforderlich, für die keine Warnung angezeigt wird. Die Erweiterung hat eine zusätzliche Funktion, die Nutzer aktivieren können, indem sie auf die folgende Schaltfläche klicken:

Für die Anzeige der Top-Websites des Nutzers ist die Berechtigung topSites erforderlich. Dazu gilt die folgende Warnung:

Optionale Berechtigungen implementieren

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

Für eine Erweiterung können sowohl erforderliche als auch optionale Berechtigungen deklariert werden. Im Allgemeinen gilt Folgendes:

• Verwenden Sie erforderliche Berechtigungen, wenn sie für die grundlegenden Funktionen 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 Berechtigungen aktivieren, die erforderlich sind.
• Verbesserte Informationen für Nutzer:Eine Erweiterung kann erklären, warum eine bestimmte Berechtigung erforderlich ist, 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 das Upgrade optionale statt erforderliche Berechtigungen hinzufügt.

Schritt 2: Optionale Berechtigungen im Manifest angeben

Deklarieren Sie optionale Berechtigungen in Ihrem Manifest der Erweiterung 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, geben Sie "https://*/*" in das Feld optional_host_permissions Ihrer Erweiterung ein. So können Sie in "Permissions.origins" beliebige Ursprünge angeben, solange sie ein übereinstimmendes Schema haben.

Berechtigungen, die nicht als optional angegeben werden können

Die meisten Berechtigungen für Chrome-Erweiterungen können mit Ausnahme der folgenden als optional angegeben werden.

Weitere Informationen zu verfügbaren Berechtigungen und den zugehörigen Warnungen finden Sie unter Berechtigungen deklarieren.

Schritt 3: Optionale Berechtigungen anfordern

So fordern Sie die Berechtigungen über eine 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, wenn das Hinzufügen der Berechtigungen zu anderen Warnmeldungen führt, als er bereits gesehen und akzeptiert hat. Der vorherige Code kann beispielsweise zu einem Prompt wie diesem führen:

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 Berechtigungssatz 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. Wenn eine Berechtigung entfernt wurde, wird sie durch Aufrufen von permissions.request() in der Regel 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).
  }
});

chrome.permissions.addHostAccessRequest(
  request: object,
  callback?: function,
)

chrome.permissions.contains(
  permissions: Permissions,
  callback?: function,
)

chrome.permissions.getAll(
  callback?: function,
)

chrome.permissions.remove(
  permissions: Permissions,
  callback?: function,
)

chrome.permissions.removeHostAccessRequest(
  request: object,
  callback?: function,
)

chrome.permissions.request(
  permissions: Permissions,
  callback?: function,
)

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

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