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, Add-on-UI zeigt eine Autorisierungsaufforderung an, um den Autorisierungsvorgang 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. Skript des Add-ons diese einzelnen Berechtigungen als OAuth-Bereiche definiert.

Sie deklarieren Bereiche in Ihrem Manifest mithilfe von URL-Strings. Während des Autorisierungsvorgangs zeigt Apps Script eine menschenlesbare Beschreibung des Umfangs. Beispiel: Ihr Google Workspace-Add-on die Option „Aktuelle Nachricht lesen“ Gültigkeitsbereich, der in Ihrem Manifest als https://www.googleapis.com/auth/gmail.addons.current.message.readonly 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 Skriptprojekt.
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. Bei den meisten Skripts ist dies ausreichend ist und Ihnen Zeit spart. Für veröffentlichte Add-ons sollten Sie jedoch eine direktere Kontrolle über den Umfang.

So kann Apps Script einem Add-on-Skriptprojekt beispielsweise Bereich https://mail.google.com. Wenn ein Nutzer ein Script autorisiert Projekt dieses Umfangs hat, wird dem Projekt uneingeschränkter Zugriff auf das Gmail-Konto des Nutzers gewährt, Konto. Bei veröffentlichten Add-ons müssen Sie diesen Bereich durch einen die die Anforderungen der Add-ons abdeckt.

Sie können die Bereiche, die Ihr Skriptprojekt verwendet, explizit festlegen, indem Sie die zugehörige Manifestdatei. Das Feld „manifest“ oauthScopes ist ein Array. aller vom Add-on verwendeten Bereiche. Um die Bereiche Ihres Projekts festzulegen, führen Sie die Folgendes:

1. Aktuell vom Add-on verwendete Bereiche ansehen Bestimmen Sie, was müssen Änderungen vorgenommen werden, z. B. 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. Die oauthScopes Feld gibt ein Array von Zeichenfolgen an. Bereiche festlegen die Ihr Projekt verwendet, ersetzen Sie den Inhalt dieses Arrays durch die Bereiche, verwenden möchten. Ein Google Workspace-Add-on zur Erweiterung von Gmail könnte beispielsweise Folgendes enthalten:

   {
     ...
     "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-Bestätigung
• Google APIs-Dienst: Nutzerdatenrichtlinie

Eingeschränkte Bereiche

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 in Ihrem Add-on eines davon verwendet wird, müssen Sie mit dem Zusätzliche Anforderungen für bestimmte API-Bereiche vor der Veröffentlichung.

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

Einige Bereiche wurden speziell für Google Workspace-Add-ons zum Schutz von Gmail-Nutzern Daten. 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 Google Mail.

Ersetzen Sie auch den sehr breit gefassten https://mail.google.com-Bereich in Ihrem enger gefassten Gültigkeitsbereichen hinzu, die die Interaktionen und nicht mehr.

Zugriffstokens

Zum Schutz der Nutzerdaten werden die in Gewährung nur für Google Workspace-Add-ons vorübergehenden Zugriff auf Nutzerdaten. Um den temporären Zugriff zu ermöglichen, müssen Sie die Methode Funktion GmailApp.setCurrentMessageAccessToken(accessToken) mit einem Zugriffstoken als Argument. Sie erhalten ein Zugriffstoken von einer action-Ereignisobjekt.

Im Folgenden sehen Sie ein Beispiel für das Festlegen eines Zugriffstokens, um den Zugriff auf die Metadaten einer Nachricht. Der einzige Umfang, der für dieses Beispiel notwendig ist, ist https://www.googleapis.com/auth/gmail.addons.current.message.metadata

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 finden Sie eine Liste mit Apps Script-Bereichen, die häufig in in Verbindung mit Google Workspace-Add-ons: