Warnung:Diese Daten werden gemäß der Richtlinie zu Google-Nutzerdaten bereitgestellt. Bitte lesen Sie sich die Richtlinien durch und halten Sie sie ein. Andernfalls kann das zu einem Projekt oder einem Konto führen.

Google JavaScript-Autorisierungs-JavaScript-Bibliothek für Websites – API-Referenz

In dieser Referenz wird die Google 3P Authorization JavaScript Library API beschrieben, mit der Sie Autorisierungscodes oder Zugriffstokens von Google laden können.

Methode: google.accounts.oauth2.initCodeClient

Mit der Methode initCodeClient wird ein Codeclient mit den Konfigurationen im Parameter initialisiert und zurückgegeben.

google.accounts.oauth2.initCodeClient(config: CodeClientConfig)

Datentyp: CodeClientConfig

In der folgenden Tabelle sind die Properties des Datentyps CodeClientConfig aufgeführt.

Attribute
client_id Erforderlich. Die Client-ID für Ihre Anwendung. Sie finden diesen Wert in der API Console.
scope Erforderlich. Eine durch Leerzeichen getrennte Liste von Bereichen, die die Ressourcen identifizieren, auf die Ihre Anwendung im Namen des Nutzers zugreifen kann. Anhand dieser Werte wird der Zustimmungsbildschirm bestimmt, den Google dem Nutzer anzeigt.
redirect_uri Erforderlich für die Weiterleitung der Nutzerfreundlichkeit. Bestimmt, wohin der API-Server den Nutzer weiterleitet, nachdem der Nutzer den Autorisierungsvorgang abgeschlossen hat. Der Wert muss genau mit einem der autorisierten Weiterleitungs-URIs für den OAuth 2.0-Client übereinstimmen, den Sie in der API Console konfiguriert haben. Außerdem muss er unseren Validierungsregeln für Weiterleitungs-URIs entsprechen. Die Property wird von der UX des Pop-ups ignoriert.
callback Erforderlich für Pop-up-UX. Der JavaScript-Funktionsname, der die zurückgegebene Codeantwort verarbeitet. Die Property wird bei der Weiterleitung ignoriert.
state Optional. Empfohlen für die Nutzererfahrung der Weiterleitung. Gibt einen beliebigen Stringwert an, mit dem Ihre Anwendung den Status zwischen Ihrer Autorisierungsanfrage und der Antwort des Autorisierungsservers aufrechterhält.
enable_serial_consent Optional, wird standardmäßig true verwendet. Bei einer Einstellung von false werden detailliertere Google-Kontoberechtigungen für Kunden deaktiviert, die vor 2019 erstellt wurden. Dies hat keine Auswirkungen auf neuere Clients, da für sie immer detailliertere Berechtigungen aktiviert sind.
hint Optional. Wenn Ihre Anwendung weiß, welcher Nutzer die Anfrage autorisieren soll, kann sie über diese Property einen Hinweis an Google senden. Die E-Mail-Adresse des Zielnutzers. Weitere Informationen finden Sie in den OpenID Connect-Dokumenten im Feld login_hint.
hosted_domain Optional. Wenn Ihre Anwendung die Workspace-Domain des Nutzers kennt, können Sie Google darüber einen Hinweis geben. Weitere Informationen finden Sie in den OpenID Connect-Dokumenten im Feld hd.
ux_mode Optional. Der UX-Modus, der für den Autorisierungsablauf verwendet werden soll. Standardmäßig wird der Einwilligungsvorgang in einem Pop-up-Fenster geöffnet. Gültige Werte sind popup und redirect.
select_account Optional ist die Standardeinstellung 'false'. Boolescher Wert, mit dem der Nutzer aufgefordert wird, ein Konto auszuwählen.

Datentyp: CodeClient

Die Klasse hat nur einen öffentlichen requestCode, der den OAuth 2.0-Code-UX-Ablauf startet.

interface CodeClient {
  requestCode(): void;
}

Datentyp: CodeResponse

Ein CodeResponse-JavaScript-Objekt wird in der Pop-up-UX an Ihre callback-Methode übergeben. In der UX für die Weiterleitung wird CodeResponse als URL-Parameter übergeben.

In der folgenden Tabelle sind die Properties des Datentyps CodeResponse aufgeführt.

Attribute
code Der Autorisierungscode einer erfolgreichen Tokenantwort.
scope Eine durch Leerzeichen getrennte Liste der Bereiche, die vom Nutzer genehmigt wurden.
state Der Stringwert, mit dem Ihre Anwendung den Status zwischen Ihrer Autorisierungsanfrage und der Antwort aufrechterhält.
error Ein einzelner ASCII-Fehlercode.
error_description Für Menschen lesbarer ASCII-Text mit zusätzlichen Informationen, der dem Cliententwickler hilft, den aufgetretenen Fehler zu verstehen.
error_uri Ein URI, der eine von Menschen lesbare Webseite mit Informationen über den Fehler identifiziert, mit der dem Cliententwickler zusätzliche Informationen zum Fehler bereitgestellt werden.

Methode: google.accounts.oauth2.initTokenClient

Die Methode initTokenClient initialisiert und gibt einen Token-Client mit den Konfigurationen im Parameter zurück.

google.accounts.oauth2.initTokenClient(config: TokenClientConfig)

Datentyp: TokenClientConfig

In der folgenden Tabelle sind die Properties des Datentyps TokenClientConfig aufgeführt.

Attribute
client_id Erforderlich. Die Client-ID für Ihre Anwendung. Sie finden diesen Wert in der API Console.
callback Erforderlich. Der JavaScript-Funktionsname, der die zurückgegebene Tokenantwort verarbeitet.
scope Erforderlich. Eine durch Leerzeichen getrennte Liste von Bereichen, die die Ressourcen identifizieren, auf die Ihre Anwendung im Namen des Nutzers zugreifen kann. Anhand dieser Werte wird der Zustimmungsbildschirm bestimmt, den Google dem Nutzer anzeigt.
prompt Optional ist die Standardeinstellung 'select_account'. Eine durch Leerzeichen getrennte Liste mit Aufforderungen, bei denen der Nutzer die Groß-/Kleinschreibung beachten muss. Mögliche Werte sind:
  • leerer String: Der Nutzer wird nur bei der ersten Anfrage Ihrer App aufgefordert. Kann nicht mit anderen Werten angegeben werden.
  • 'none' Keine Authentifizierungs- oder Einwilligungsbildschirme anzeigen. Darf nicht mit anderen Werten angegeben werden.
  • 'consent' Nutzer um Einwilligung bitten.
  • 'select_account' Nutzer auffordern, ein Konto auszuwählen
enable_serial_consent Optional, wird standardmäßig true verwendet. Bei einer Einstellung von false werden detailliertere Google-Kontoberechtigungen für Kunden deaktiviert, die vor 2019 erstellt wurden. Dies hat keine Auswirkungen auf neuere Clients, da für sie immer detailliertere Berechtigungen aktiviert sind.
hint Optional. Wenn Ihre Anwendung weiß, welcher Nutzer die Anfrage autorisieren soll, kann sie über diese Property einen Hinweis an Google senden. Die E-Mail-Adresse des Zielnutzers. Weitere Informationen finden Sie in den OpenID Connect-Dokumenten im Feld login_hint.
hosted_domain Optional. Wenn Ihre Anwendung die Workspace-Domain des Nutzers kennt, können Sie Google darüber einen Hinweis geben. Weitere Informationen finden Sie in den OpenID Connect-Dokumenten im Feld hd.
state Optional. Nicht empfohlen Gibt einen beliebigen Stringwert an, mit dem Ihre Anwendung den Status zwischen Ihrer Autorisierungsanfrage und der Antwort des Autorisierungsservers aufrechterhält.

Datentyp: TokenClient

Die Klasse hat nur eine öffentliche Methode requestAccessToken, die den OAuth 2.0-Token-UX-Ablauf startet.

interface TokenClient {
  requestAccessToken(overrideConfig?: OverridableTokenClientConfig): void;
}
Argumente
overrideConfig OverridableTokenClientConfig Optional. Die Konfigurationen, die in dieser Methode überschrieben werden sollen.

Datentyp: OverridableTokenClientConfig

In der folgenden Tabelle sind die Properties des Datentyps OverridableTokenClientConfig aufgeführt.

Attribute
prompt Optional. Eine durch Leerzeichen getrennte Liste mit Aufforderungen, bei denen der Nutzer die Groß-/Kleinschreibung beachten muss.
enable_serial_consent Optional. Bei einer Einstellung von false werden detailliertere Google-Kontoberechtigungen für Kunden deaktiviert, die vor 2019 erstellt wurden. Dies hat keine Auswirkungen auf neuere Clients, da für sie immer detailliertere Berechtigungen aktiviert sind.
hint Optional. Wenn Ihre Anwendung weiß, welcher Nutzer die Anfrage autorisieren soll, kann sie über diese Property einen Hinweis an Google senden. Die E-Mail-Adresse des Zielnutzers. Weitere Informationen finden Sie in den OpenID Connect-Dokumenten im Feld login_hint.
state Optional. Nicht empfohlen Gibt einen beliebigen Stringwert an, mit dem Ihre Anwendung den Status zwischen Ihrer Autorisierungsanfrage und der Antwort des Autorisierungsservers aufrechterhält.

Datentyp: TokenResponse

Ein TokenResponse-JavaScript-Objekt wird an die Callback-Methode im Pop-up-UX-Element übergeben.

In der folgenden Tabelle sind die Properties des Datentyps TokenResponse aufgeführt.

Attribute
access_token Das Zugriffstoken einer erfolgreichen Tokenantwort.
expires_in Die Lebensdauer des Zugriffstokens in Sekunden.
hd Die gehostete Domain, zu der der angemeldete Nutzer gehört.
prompt Der Wert der Eingabeaufforderung, der aus der möglichen Liste von Werten verwendet wurde, die von TokenClientConfig oder OverridableTokenClientConfig angegeben wurden.
token_type Der Typ des ausgestellten Tokens.
scopes Eine durch Leerzeichen getrennte Liste der Bereiche, die vom Nutzer genehmigt wurden.
state Der Stringwert, mit dem Ihre Anwendung den Status zwischen Ihrer Autorisierungsanfrage und der Antwort aufrechterhält.
error Ein einzelner ASCII-Fehlercode.
error_description Für Menschen lesbarer ASCII-Text mit zusätzlichen Informationen, der dem Cliententwickler hilft, den aufgetretenen Fehler zu verstehen.
error_uri Ein URI, der eine von Menschen lesbare Webseite mit Informationen über den Fehler identifiziert, mit der dem Cliententwickler zusätzliche Informationen zum Fehler bereitgestellt werden.

Methode: google.accounts.oauth2.hasGrantedAllScopes

Prüft, ob der Nutzer alle angegebenen Umfänge gewährt hat.

google.accounts.oauth2.hasGrantedAllScopes(
                                            tokenResponse: TokenResponse,
                                            firstScope: string, ...restScopes: string[]
                                          ): boolean;
Argumente
tokenResponse string Erforderlich. Ein gültiges Zugriffstoken.
firstScope string Erforderlich. Der zu prüfende Bereich.
restScopes String[] Optional. Weitere zu prüfende Bereiche.
Rückgabe:
boolean Dieser Wert ist „True“, wenn alle Bereiche gewährt wurden.

Methode: google.accounts.oauth2.hasGrantedAnyScope

Überprüft, ob der Nutzer einen oder mehrere der angegebenen Bereiche zugewiesen hat.

google.accounts.oauth2.hasGrantedAnyScope(
                                           tokenResponse: TokenResponse,
                                           firstScope: string, ...restScopes: string[]
                                         ): boolean;
Argumente
tokenResponse string Erforderlich. Ein gültiges Zugriffstoken.
firstScope string Erforderlich. Der zu prüfende Bereich.
restScopes String[] Optional. Weitere zu prüfende Bereiche.
Rückgabe:
boolean Dieser Wert ist „True“, wenn einer der Bereiche gewährt wurde.

Methode: google.accounts.oauth2.revoke

Mit der Methode revoke werden alle Bereiche aufgehoben, die der Nutzer der App gewährt hat. Zum Widerrufen der Berechtigung ist ein gültiges Zugriffstoken erforderlich.

google.accounts.oauth2.revoke(accessToken: string, done: () => void): void;
Argumente
accessToken string Erforderlich. Ein gültiges Zugriffstoken.
done Funktion Optional. Callback-Funktion, sobald die Widerrufsaktion abgeschlossen ist.