OAuth konfigurieren

Wenn Sie Ihre Anwendung veröffentlichen, müssen Sie vier Hauptaufgaben zur Authentifizierung und Autorisierung ausführen:

  1. Füllen Sie den OAuth-Zustimmungsbildschirm aus.
  2. OAuth 2.0-Anmeldedaten erstellen
  3. Alle Bereiche konfigurieren, die die App im Google Workspace Marketplace SDK ausführen muss
  4. Reichen Sie Ihre Anwendung zur OAuth-Überprüfung ein.

Die Bereiche, die Sie jedem Ort hinzufügen, müssen übereinstimmen und werden folgendermaßen verwendet:

  • Die Bereiche, die dem OAuth-Zustimmungsbildschirm hinzugefügt wurden, werden für die OAuth-Überprüfung verwendet.
  • Die Bereiche, die dem Google Workspace Marketplace SDK hinzugefügt wurden, werden für domainweite und einzelne Installationen verwendet, um Ihre Anwendung zu autorisieren, wenn sie über den Google Workspace Marketplace installiert wird.
  • Die Bereiche, die dem Manifest hinzugefügt wurden, sind erforderlich, damit Ihre App ordnungsgemäß funktioniert.

Wenn Sie beispielsweise eine Anwendung 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 spezifischen Bereiche des Add-ons. In Ihrem Google Cloud-Projekt enthalten der OAuth-Zustimmungsbildschirm und das Google Workspace Marketplace SDK die Bereiche für beide Add-ons.

Voraussetzungen

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. Rufen Sie in der Google Cloud Console das Menü auf > 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 App-Registrierungsformular aus und klicken Sie dann auf Speichern und fortfahren.

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

    • Wählen Sie die Bereiche mit der für die Anwendung erforderlichen Mindestzugriffsebene aus. Eine Liste der verfügbaren Bereiche finden Sie unter OAuth 2.0-Bereiche für Google APIs.
    • Überprüfen Sie die Bereiche, die in jedem der drei Abschnitte aufgeführt sind: nicht vertrauliche Bereiche, sensible Bereiche und eingeschränkte Bereiche. Versuchen Sie für alle Bereiche, die in den Abschnitten „Meine vertraulichen Bereiche“ oder „Ihre eingeschränkten Bereiche“ aufgeführt sind, alternative, nicht vertrauliche Bereiche zu ermitteln, um unnötige zusätzliche Prüfungen zu vermeiden.
    • Einige Bereiche erfordern eine zusätzliche Überprüfung durch Google. Bei Anwendungen, die nur intern von Ihrer Google Workspace-Organisation verwendet werden, werden Bereiche auf dem Zustimmungsbildschirm nicht aufgeführt und die Verwendung von eingeschränkten oder vertraulichen Bereichen erfordert keine weitere Prüfung von Google. Weitere Informationen finden Sie unter Bereichskategorien.
  5. Nachdem Sie die für Ihre Anwendung erforderlichen Bereiche ausgewählt haben, 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 alle weiteren autorisierten Testnutzer ein und klicken Sie dann auf Speichern und fortfahren.
  7. Prüfen Sie die Zusammenfassung der App-Registrierung. Wenn Sie Änderungen vornehmen möchten, klicken Sie auf Bearbeiten. Wenn die Anwendungsregistrierung in Ordnung ist, klicken Sie auf Zurück zum Dashboard.

2. OAuth 2.0-Anmeldedaten erstellen

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

Wenn Sie Ihre App in Apps Script erstellt haben

Stellen Sie Ihr Apps Script-Projekt vom Google Cloud-Standardprojekt auf das neue Standardprojekt um. 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 von OAuth 2.0-Anmeldedaten findest du unter OAuth-Client-ID-Anmeldedaten.

3. Bereiche konfigurieren

Geben Sie eine vollständige Liste der OAuth-Bereiche an, die für Ihre Anwendung erforderlich sind. Verwenden Sie immer möglichst kleine Bereiche.

Zum Definieren der Zugriffsebene für Ihre Anwendung müssen Sie Autorisierungsbereiche identifizieren und deklarieren. Ein Autorisierungsbereich ist ein OAuth 2.0-URI-String, der den Namen der Google Workspace-Anwendung, die Art der Daten, auf die sie zugreift, und die Zugriffsebene enthält. Bereiche sind die Anfragen Ihrer Anwendung zur Arbeit mit Google Workspace-Daten, einschließlich der Google-Kontodaten der Nutzer.

Bei der Installation Ihrer Anwendung wird ein Nutzer aufgefordert, die von der Anwendung verwendeten Bereiche zu validieren. Im Allgemeinen sollten Sie den Bereich mit sehr eng gefasster Ausrichtung auswählen und vermeiden, Bereiche anzufordern, die Ihre Anwendung nicht benötigt. Nutzer gewähren leichter Zugriff auf begrenzte, klar beschriebene Bereiche.

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

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

  • Für die OAuth-Überprüfung müssen Sie ein Demovideo einreichen, das den Prozess oder den Ablauf zeigt, in dem Nutzern die Verwendung der angeforderten Bereiche oder Daten erklärt wird.
  • Wenn Ihre Anwendung eingeschränkte Bereiche verwendet, muss sie möglicherweise auch einer Sicherheitsprüfung unterzogen werden. Weitere Informationen finden Sie unter Warum ist die Sicherheitsbewertung erforderlich?.

So reichen Sie die Informationen zur Überprüfung ein:

  1. Rufen Sie in der Google Cloud Console das Menü auf > 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 Anwendung so aktualisieren, dass andere vertrauliche oder restriktive Bereiche verwendet werden, müssen Sie die Anwendung noch einmal zur OAuth-Überprüfung einreichen. Du musst sie nicht noch einmal zur App-Überprüfung einreichen.

Unterschied zwischen OAuth-Überprüfung und App-Überprüfung

Die OAuth-Überprüfung ist ein anderer Prozess als die App-Überprüfung. Wichtig ist, dass Ihr Zustimmungsbildschirm die Identität und Absicht Ihrer App korrekt wiedergibt und dafür sorgt, dass Nutzerdaten nicht in der App missbraucht werden. Ihr Anwendungseintrag kann erst genehmigt werden, wenn die OAuth-Bestätigung Ihrer Anwendung abgeschlossen ist. Weitere Informationen zur OAuth-Überprüfung finden Sie unter Häufig gestellte Fragen zur OAuth API-Überprüfung.

Im Mittelpunkt der App-Überprüfung stehen die Informationen, die Sie in der Google Workspace Marketplace API zur Verfügung stellen, sowie die Funktionalität und Nutzerfreundlichkeit Ihrer Anwendung. Weitere Informationen zu den Kriterien der App-Überprüfung finden Sie unter App-Überprüfung.