Sucher

Nutzer müssen Add-ons und andere Anwendungen autorisieren, die auf ihre Daten zugreifen oder in dessen Namen handeln. Wenn ein Nutzer ein Add-on zum ersten Mal ausführt, wird auf der Add-on-Benutzeroberfläche eine Autorisierungsaufforderung angezeigt, um den Autorisierungsablauf zu starten.

Während dieses Vorgangs teilt die Eingabeaufforderung dem Nutzer mit, was die Anwendung möchte zu erteilen. Beispiel: Ein Add-on benötigt die Berechtigung zum Lesen eines E-Mail-Nachricht eines Nutzers senden oder Termine in seinem Kalender erstellen. Im Script-Projekt des Add-ons werden diese individuellen Berechtigungen als OAuth-Bereiche definiert.

Sie deklarieren Bereiche in Ihrem Manifest mithilfe von URL-Strings. Während des Autorisierungsvorgangs wird dem Nutzer in Apps Script eine visuell lesbare Beschreibung des Bereichs angezeigt. Ihr Google Workspace-Add-on kann beispielsweise den Umfang „Aktuelle Nachricht lesen“ verwenden, der in Ihrem Manifest als https://www.googleapis.com/auth/gmail.addons.current.message.readonly geschrieben ist. Währenddessen wird der Nutzer von einem Add-on mit diesem Geltungsbereich aufgefordert, Add-on: E-Mails abrufen, wenn das Add-on ausgeführt wird

Bereiche anzeigen

Sie können die Bereiche sehen, die Ihr Skriptprojekt derzeit benötigt, indem Sie Folgendes:

1. Öffnen Sie das Script-Projekt.
2. Klicken Sie links auf Übersicht info_outline.
3. Sehen Sie sich die Bereiche unter „OAuth-Bereiche des Projekts“ an.

Die aktuellen Bereiche des Skriptprojekts finden Sie auch im Projektmanifest. im Rahmen der oauthScopes aber nur, wenn Sie diese Bereiche explizit festgelegt haben.

Explizite Bereiche festlegen

Apps Script erkennt automatisch, welche Bereiche ein Script benötigt, indem es gescannt wird seinen Code für Funktionsaufrufe, die diese erfordern. Für die meisten Scripts ist das ausreichend und spart Zeit. Bei veröffentlichten Add-ons sollten Sie jedoch die Berechtigungen direkter verwalten.

So kann Apps Script einem Add-on-Scriptprojekt standardmäßig den sehr weitreichenden Umfang https://mail.google.com zuweisen. Wenn ein Nutzer ein Scriptprojekt mit diesem Umfang autorisiert, erhält das Projekt vollen Zugriff auf das Gmail-Konto des Nutzers. Bei veröffentlichten Add-ons müssen Sie diesen Umfang durch einen eingeschränkteren ersetzen, der nur die Anforderungen der Add-ons erfüllt.

Sie können die Bereiche, die in Ihrem Scriptprojekt verwendet werden, explizit festlegen, indem Sie die Manifestdatei bearbeiten. Das Feld „manifest“ oauthScopes ist ein Array. aller vom Add-on verwendeten Bereiche. So legen Sie die Bereiche Ihres Projekts fest:

1. Aktuell vom Add-on verwendete Bereiche ansehen Bestimmen Sie, was erforderlich sind, z. B. durch die Verwendung eines engeren Rahmens.
2. Öffnen Sie die Manifestdatei des Add-ons.
3. Suchen Sie das oberste Feld mit der Bezeichnung oauthScopes. Ist dies nicht der Fall, können Sie es hinzufügen.

4. Im Feld oauthScopes wird ein Array von Strings angegeben. Bereiche festlegen die Ihr Projekt verwendet, ersetzen Sie den Inhalt dieses Arrays durch die Bereiche, verwenden möchten. Für ein Google Workspace-Add-on, das Gmail erweitert, könnte das beispielsweise so aussehen:

   {
     ...
     "oauthScopes": [
       "https://www.googleapis.com/auth/gmail.addons.current.message.metadata",
       "https://www.googleapis.com/auth/userinfo.email"
     ],
     ...
   }
   

5. Speichern Sie die Änderungen an der Manifestdatei.

OAuth-Überprüfung

Wenn Sie bestimmte vertrauliche OAuth-Bereiche verwenden, muss Ihr Add-on möglicherweise OAuth-Clientbestätigung bevor Sie sie veröffentlichen können. Weitere Informationen finden Sie in folgenden Leitfäden:

• OAuth-Client-Überprüfung für Apps Script
• Nicht überprüfte Apps
• Häufig gestellte Fragen zur OAuth-Verifizierung
• Google APIs-Dienst: Richtlinie zu Nutzerdaten

Eingeschränkter Geltungsbereich

Bestimmte Bereiche sind eingeschränkt und unterliegen zusätzlichen Regeln, die Nutzerdaten zu schützen. Wenn Sie ein Gmail- oder Editor-Add-on veröffentlichen möchten, das einen oder mehrere eingeschränkte Bereiche haben, muss das Add-on allen Einschränkungen vor der Veröffentlichung.

Sehen Sie sich die vollständige Liste der eingeschränkten Bereiche an. bevor Sie die App veröffentlichen. Wenn Ihr Add-on eine dieser APIs verwendet, müssen Sie vor der Veröffentlichung die zusätzlichen Anforderungen für bestimmte API-Bereiche erfüllen.

Kalenderbereiche

Im Folgenden finden Sie häufig verwendete Bereiche für Google Workspace-Add-ons, die Google Kalender erweitern.

Drive-Bereiche

Im Folgenden finden Sie häufig verwendete Bereiche für Google Workspace-Add-ons, die Google Drive erweitern.

Gmail-Add-on-Bereiche

Es gibt einige Bereiche, die speziell für Google Workspace-Add-ons entwickelt wurden, um die Gmail-Daten der Nutzer zu schützen. Du musst diese Bereiche explizit hinzufügen in Ihrem Add-on-Manifest und allen anderen, Add-on-Code benötigt wird.

Im Folgenden finden Sie häufig verwendete Bereiche für Google Workspace-Add-ons, die Gmail erweitern: müssen Sie die mit Erforderlich gekennzeichneten Einträge Ihrem Manifest für Google Workspace-Add-on, wenn das Add-on erweitert wird Gmail:

Ersetzen Sie außerdem den sehr weit gefassten Bereich https://mail.google.com in Ihrem Add-on durch einen engeren Bereich, der nur die Interaktionen zulässt, die für Ihr Add-on erforderlich sind.

Zugriffstokens

Zum Schutz von Nutzerdaten gewähren die Gmail-Bereiche, die in Google Workspace-Add-ons verwendet werden, nur vorübergehenden Zugriff auf Nutzerdaten. Wenn Sie den vorübergehenden Zugriff aktivieren möchten, müssen Sie die Funktion GmailApp.setCurrentMessageAccessToken(accessToken) mit einem Zugriffstoken als Argument aufrufen. Du musst ein Zugriffstoken von einem Ereignisobjekt vom Typ „Aktion“ abrufen.

Im folgenden Beispiel wird ein Zugriffstoken festgelegt, um den Zugriff auf die Metadaten einer Nachricht zu ermöglichen. Für dieses Beispiel ist nur https://www.googleapis.com/auth/gmail.addons.current.message.metadata erforderlich.

function readSender(e) {
  var accessToken = e.gmail.accessToken;
  var messageId = e.gmail.messageId;

  // The following function enables short-lived access to the current
  // message in Gmail. Access to other Gmail messages or data isn't
  // permitted.
  GmailApp.setCurrentMessageAccessToken(accessToken);
  var mailMessage = GmailApp.getMessageById(messageId);
  return mailMessage.getFrom();
}

Editor-Bereiche

Im Folgenden finden Sie häufig verwendete Bereiche für Google Workspace-Add-ons, die Google Docs, Google Tabellen, und Google Präsentationen.

Andere Umfänge

Wenn Ihr Add-on andere Apps Script-Dienste verwendet, sind möglicherweise zusätzliche Bereiche erforderlich. In den meisten Fällen können Sie zulassen, dass Apps Script diese Bereiche erkennt und den automatisch Manifest erstellen. Entfernen Sie beim Bearbeiten der Liste der Geltungsbereiche Ihres Manifests nicht Bereiche zu entfernen, es sei denn, Sie ersetzen sie durch eine geeignetere Alternative. z. B. ein enger gefasstes Projektumfang.

Hier eine Liste der Apps Script-Bereiche, die häufig in Verbindung mit Google Workspace-Add-ons verwendet werden: