OAuth konfigurieren

Wenn Sie Ihre App veröffentlichen, müssen Sie drei Hauptaufgaben für die Authentifizierung und Autorisierung erledigen:

  1. Füllen Sie den OAuth-Zustimmungsbildschirm aus.
  2. Erstellen Sie Ihre OAuth 2.0-Anmeldedaten.
  3. Reichen Sie Ihre App zur OAuth-Überprüfung ein.

OAuth-Bereiche

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.

Geben Sie eine vollständige Liste der OAuth-Bereiche an, die für Ihre App erforderlich sind. Die Zuständigkeitsbereiche, die Sie den einzelnen Standorten hinzufügen, müssen übereinstimmen und werden auf folgende Weise verwendet:

  • Die dem OAuth-Zustimmungsbildschirm hinzugefügten Bereiche werden für die OAuth-Bestätigung verwendet.

  • Bereiche, die dem Google Workspace Marketplace SDK hinzugefügt werden, 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 Google Apps Script-Manifest jedes Add-ons nur die für das jeweilige Add-on spezifischen Bereiche. In Ihrem Google Cloud-Projekt enthalten der OAuth-Zustimmungsbildschirm und das Marketplace SDK die Bereiche für beide Add-ons.

Nicht bestätigte OAuth-Bereiche korrigieren

Wenn Sie eine neue App, einen gespeicherten Entwurf oder eine veröffentlichte öffentliche App mit nicht bestätigten sensiblen oder eingeschränkten Bereichen haben, wird beim Bearbeiten der App im Marketplace SDK die folgende Fehlermeldung angezeigt:

OAuth verification is required for sensitive or restricted scopes. You can still save your app as a draft, but you're not able to publish your draft app listing.

Weitere Informationen finden Sie unter Zugriffsebene für Ihre App angeben.

So können Sie diesen Fehler umgehen:

  • Sie nehmen Änderungen an einem App-Eintrag mit nicht bestätigten sensiblen oder eingeschränkten Bereichen vor und speichern den Eintrag als Entwurf.

  • Veröffentlichen Sie die App, wenn keine neuen nicht bestätigten vertraulichen oder eingeschränkten Bereiche hinzugefügt werden.

  • Die App veröffentlichen, wenn nur nicht bestätigte sensible oder eingeschränkte Bereiche entfernt werden

Bei einigen Umgehungslösungen wird Nutzern möglicherweise der Bildschirm „Nicht überprüfte App“ angezeigt. Weitere Informationen finden Sie unter Nicht bestätigte Apps.

Reichen Sie Ihre App zur OAuth-Bestätigung ein, um diesen Fehler zu beheben.

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ü  > > Branding.

    Zu „Branding“

  2. Wenn Sie die bereits konfiguriert haben, können Sie die folgenden Einstellungen für den OAuth-Zustimmungsbildschirm unter Branding, Zielgruppe und Datenzugriff konfigurieren. Wenn Sie die Meldung Noch nicht konfiguriert sehen, klicken Sie auf Jetzt starten:
    1. Geben Sie unter App-Informationen im Feld App-Name einen App-Namen ein.
    2. Wählen Sie unter E-Mail-Adresse des Nutzersupports eine Support-E-Mail-Adresse aus, über die Nutzer Sie mit Fragen zu ihrer Einwilligung kontaktieren können.
    3. Klicken Sie auf Weiter.
    4. Wählen Sie unter Zielgruppe den Nutzertyp für Ihre App aus.
    5. Klicken Sie auf Weiter.
    6. Geben Sie unter Kontaktinformationen eine E-Mail-Adresse ein, unter der Sie über Änderungen an Ihrem Projekt informiert werden können.
    7. Klicken Sie auf Weiter.
    8. Lesen Sie unter Fertigstellen die Nutzerdatenrichtlinie für Google API-Dienste und wählen Sie dann Ich akzeptiere die Richtlinie zu Nutzerdaten für Google API-Dienste aus, wenn Sie zustimmen.
    9. Klicken Sie auf Weiter.
    10. Klicken Sie auf Erstellen.
    11. Wenn Sie als Nutzertyp Extern ausgewählt haben, fügen Sie Testnutzer hinzu:
      1. Klicken Sie auf Zielgruppe.
      2. Klicken Sie unter Testnutzer auf Nutzer hinzufügen.
      3. Geben Sie Ihre E-Mail-Adresse und die E-Mail-Adressen aller anderen autorisierten Testnutzer ein und klicken Sie auf Speichern.

  3. Wenn Sie eine App für die Verwendung außerhalb Ihrer Google Workspace-Organisation erstellen, klicken Sie auf Datenzugriff > 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, werden 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.
  4. Wählen Sie die für Ihre App erforderlichen Bereiche aus und klicken Sie auf Speichern.

Weitere Informationen zum Konfigurieren der OAuth-Einwilligung finden Sie unter Einführung in .

2. OAuth 2.0-Anmeldedaten erstellen

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

Wenn Sie Ihre App in Apps Script erstellt haben

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

Nachdem Sie Ihr Apps Script-Projekt mit dem 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. OAuth-Überprüfung beantragen (nur öffentliche Apps)

Wenn Ihre App Google APIs verwendet, um auf Google-Nutzerdaten zuzugreifen, wird sie möglicherweise vor der Veröffentlichung überprüft.

Vor dem Absenden

Sie sollten die Schritte 1 und 2 auf dieser Seite ausführen können. Möglicherweise können Sie Ihre App jedoch erst zur OAuth-Bestätigung einreichen, wenn Sie einige zusätzliche Schritte zur Marktplatzveröffentlichung ausgeführt haben, die parallel zu diesem Vorgang erfolgen.

Wenn Sie beispielsweise ein Google Classroom-Add-on erstellen möchten, müssen Sie im Marketplace SDK einen App-Entwurf erstellen. Folgen Sie dazu der Anleitung unter App im Google Workspace Marketplace SDK konfigurieren . Anschließend können Sie mit dem App-Eintrag im Entwurfsstatus das für die OAuth-Bestätigung erforderliche Demovideo erstellen. Sobald die Bestätigung abgeschlossen ist, können Sie den App-Eintrag als Entwurf zur Überprüfung einreichen.

Eine Übersicht über die Einreichungsschritte finden Sie unter App veröffentlichen.

Überprüfung der OAuth-Überprüfung

Wenn Ihre 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. Weitere Informationen finden Sie im Demovideo.

  • Wenn Ihre App eingeschränkte Bereiche verwendet, muss sie möglicherweise auch einer Sicherheitsbewertung unterzogen werden.

  • Weitere Informationen finden Sie in der Google Ads-Hilfe zur OAuth-Anwendungsüberprüfung.

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-Überprüfung ist ein separater Prozess 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 zu OAuth.

Bei der App-Überprüfung liegt der Schwerpunkt auf den Informationen, die Sie im Google Workspace Marketplace SDK angeben, sowie auf den Funktionen und der Nutzerfreundlichkeit Ihrer App. Weitere Informationen zu den Kriterien für die App-Überprüfung finden Sie unter App-Überprüfungsprozess und Anforderungen für den Google Workspace Marketplace.