OAuth konfigurieren

Wenn Sie Ihre App veröffentlichen, müssen Sie vier Hauptaufgaben für die Authentifizierung und Autorisierung ausführen:

  1. Füllen Sie den OAuth-Zustimmungsbildschirm aus.
  2. Erstellen Sie Ihre OAuth 2.0-Anmeldedaten.
  3. Alle Bereiche konfigurieren, in denen die App im Google Workspace Marketplace SDK ausgeführt werden muss
  4. Reichen Sie Ihre App zur OAuth-Überprüfung ein.

Die Zuständigkeitsbereiche, die Sie den einzelnen Orten hinzufügen, müssen übereinstimmen und werden auf folgende Weise verwendet:

  • Die dem OAuth-Zustimmungsbildschirm hinzugefügten Zugriffsbereiche werden für die OAuth-Bestätigung verwendet.
  • Die dem Google Workspace Marketplace SDK hinzugefügten Bereiche werden für domainweite und individuelle Installationen verwendet, um Ihre App zu autorisieren, wenn sie über den Google Workspace Marketplace installiert wird.
  • Die dem Manifest hinzugefügten Bereiche sind erforderlich, damit Ihre App ordnungsgemäß funktioniert.

Wenn Sie beispielsweise eine App veröffentlichen, die ein Google Tabellen-Add-on und ein Google Docs-Add-on enthält, enthält das Apps Script-Manifest jedes Add-ons nur die für das Add-on spezifischen Bereiche. In Ihrem Google Cloud-Projekt enthalten der OAuth-Zustimmungsbildschirm und das Google Workspace Marketplace SDK die Bereiche für beide Add-ons.

Vorbereitung

Der OAuth-Zustimmungsbildschirm ist eine Eingabeaufforderung, die Nutzer darüber informiert, wer Zugriff auf ihre Daten anfordert und welche Art von Daten Nutzern Ihre Anwendung erlaubt.

  1. Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü  > APIs und Dienste > OAuth-Zustimmungsbildschirm.

    Zum OAuth-Zustimmungsbildschirm

  2. Wählen Sie den Nutzertyp für Ihre App aus und klicken Sie auf Erstellen.
  3. Füllen Sie das Formular zur App-Registrierung aus und klicken Sie dann auf Speichern und fortfahren.

  4. Wenn Sie eine App für die Verwendung außerhalb Ihrer Google Workspace-Organisation erstellen, klicken Sie auf Umfang hinzufügen oder entfernen. Wir empfehlen die folgenden Best Practices für die Auswahl von Bereichen:

    • Wählen Sie die Bereiche aus, die die für Ihre App erforderliche Mindestzugriffsebene bieten. Eine Liste der verfügbaren Bereiche finden Sie unter OAuth 2.0-Bereiche für Google APIs.
    • Sehen Sie sich die Bereiche in den drei Abschnitten an: Nicht vertrauliche Bereiche, vertrauliche Bereiche und eingeschränkte Bereiche. Versuchen Sie, für alle Bereiche, die in den Abschnitten „Meine vertraulichen Bereiche“ oder „Meine eingeschränkten Bereiche“ aufgeführt sind, alternative nicht vertrauliche Bereiche zu finden, um unnötige zusätzliche Überprüfungen zu vermeiden.
    • Für einige Zugriffsbereiche ist eine zusätzliche Überprüfung durch Google erforderlich. Bei Apps, die nur intern von Ihrer Google Workspace-Organisation verwendet werden, sind die Bereiche nicht auf dem Einwilligungsbildschirm aufgeführt. Die Verwendung eingeschränkter oder vertraulicher Bereiche erfordert keine weitere Überprüfung durch Google. Weitere Informationen finden Sie unter Kategorien für den Geltungsbereich.
  5. Wählen Sie die für Ihre App erforderlichen Bereiche aus und klicken Sie auf Speichern und fortfahren.
  6. Wenn Sie als Nutzertyp Extern ausgewählt haben, fügen Sie Testnutzer hinzu:
    1. Klicken Sie unter Testnutzer auf Nutzer hinzufügen.
    2. Geben Sie Ihre E-Mail-Adresse und die E-Mail-Adressen aller anderen autorisierten Testnutzer ein und klicken Sie auf Speichern und fortfahren.
  7. Überprüfen Sie die Zusammenfassung der App-Registrierung. Wenn Sie Änderungen vornehmen möchten, klicken Sie auf Bearbeiten. Wenn die App-Registrierung korrekt ist, klicken Sie auf Zurück zum Dashboard.

2. OAuth 2.0-Anmeldedaten erstellen

Je nachdem, wie Sie Ihre App erstellt haben, gibt es zwei Möglichkeiten, Ihre OAuth 2.0-Anmeldedaten zu erstellen.

Wenn Sie Ihre App in Apps Script erstellt haben

Wechseln Sie Ihr Apps Script-Projekt vom Google Cloud-Standardprojekt zu Ihrem neuen Standardprojekt. Weitere Informationen finden Sie unter Zu einem anderen Standardprojekt wechseln.

Nachdem Sie Ihr Apps Script-Projekt mit dem Google Cloud-Projekt verknüpft haben, werden Ihre OAuth 2.0-Anmeldedaten automatisch erstellt.

Wenn Sie Ihre App nicht mit Apps Script erstellt haben

Informationen zum Erstellen Ihrer OAuth 2.0-Anmeldedaten finden Sie unter Anmeldedaten mit OAuth-Client-ID erstellen.

3. Bereiche konfigurieren

Geben Sie eine vollständige Liste der OAuth-Bereiche an, die für Ihre App erforderlich sind. Verwenden Sie immer den möglichst eng gefassten Bereich.

Um die Zugriffsebene für Ihre App zu definieren, müssen Sie Autorisierungsbereiche angeben. Ein Autorisierungsbereich ist ein OAuth 2.0-URI-String, der den Namen der Google Workspace-App, die Art der Daten, auf die zugegriffen wird, und die Zugriffsebene enthält. Bereiche sind die Anfragen Ihrer App zur Verarbeitung von Google Workspace-Daten, einschließlich der Google-Kontodaten der Nutzer.

Wenn Ihre App installiert wird, wird ein Nutzer aufgefordert, die von der App verwendeten Bereiche zu bestätigen. Im Allgemeinen sollten Sie den möglichst eng gefassten Bereich auswählen und Bereiche vermeiden, die für Ihre App nicht erforderlich sind. Nutzer gewähren eher Zugriff auf eingeschränkte, klar beschriebene Bereiche.

4. OAuth-Überprüfung beantragen (nur öffentliche Apps)

Wenn eine öffentliche App vertrauliche oder eingeschränkte Bereiche verwendet, muss sie einer OAuth-Bestätigungsüberprüfung unterzogen werden.

  • Für die OAuth-Bestätigung müssen Sie ein Demovideo einreichen, in dem der Ablauf veranschaulicht wird und die Verwendung der angeforderten Bereiche oder Daten für Nutzer erklärt wird.
  • Wenn Ihre App eingeschränkte Bereiche verwendet, muss sie möglicherweise auch einer Sicherheitsbewertung unterzogen werden. Weitere Informationen finden Sie unter Warum ist die Sicherheitsbewertung erforderlich?

So reichen Sie Ihre Unterlagen zur Überprüfung ein:

  1. Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü  > APIs und Dienste > OAuth-Zustimmungsbildschirm.

    Zum OAuth-Zustimmungsbildschirm

  2. Klicken Sie auf Projektauswahl und wählen Sie Ihr Projekt aus.
  3. Klicken Sie auf App bearbeiten.
  4. Geben Sie die erforderlichen Informationen ein und klicken Sie auf Zur Überprüfung einreichen.
  5. Geben Sie im Dialogfeld Bestätigung erforderlich die entsprechenden Begründungen ein und klicken Sie dann auf Senden, um den Bestätigungsprozess zu starten.

Wenn Sie Ihre App so aktualisieren, dass sie andere Bereiche verwendet, die vertraulich oder eingeschränkt sind, müssen Sie sie noch einmal zur OAuth-Überprüfung einreichen. Sie müssen sie nicht noch einmal zur App-Überprüfung einreichen.

Unterschiede zwischen der OAuth-Überprüfung und der App-Überprüfung

Die OAuth-Bestätigung ist ein separater Vorgang von der App-Überprüfung. Dabei wird darauf geachtet, dass der Einwilligungsbildschirm die Identität und den Zweck Ihrer App korrekt darstellt und dass Ihre App keine Nutzerdaten missbraucht. Ihr App-Eintrag kann erst genehmigt werden, wenn die OAuth-Bestätigung Ihrer App abgeschlossen ist. Weitere Informationen zur OAuth-Überprüfung finden Sie in den häufig gestellten Fragen zur Bestätigung der OAuth API.

Bei der App-Überprüfung liegt der Schwerpunkt auf den Informationen, die Sie in der Google Workspace Marketplace API angeben, sowie auf der Funktionalität und Nutzerfreundlichkeit Ihrer App. Weitere Informationen zu den Kriterien für die App-Überprüfung finden Sie unter App-Überprüfung.