Diese Seite wurde von der Cloud Translation API übersetzt.

JavaScript API-Referenz für die Google-Kontoautorisierung

In dieser Referenz wird die Google Account Authorization JavaScript API beschrieben, mit der Autorisierungscodes oder Zugriffstokens von Google abgerufen werden.

Methode: google.accounts.oauth2.initCodeClient

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

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

Datentyp: CodeClientConfig

In der folgenden Tabelle sind die Attribute 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. Diese Werte werden auf dem Zustimmungsbildschirm angezeigt, den Google dem Nutzer präsentiert.
`include_granted_scopes`	Optional; der Standardwert ist `true`. Ermöglicht Anwendungen, die schrittweise Autorisierung zu verwenden, um im Kontext Zugriff auf zusätzliche Bereiche anzufordern. Wenn Sie den Wert dieses Parameters auf `false` setzen und die Autorisierungsanfrage genehmigt wird, deckt das neue Zugriffstoken nur Bereiche ab, für die die `scope` in dieser `CodeClientConfig` angefordert wurde.
`redirect_uri`	Erforderlich für die Weiterleitungs-UX. Bestimmt, wohin der API-Server den Nutzer weiterleitet, nachdem dieser 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, und unseren Validierungsregeln für Weiterleitungs-URIs entsprechen. Das Attribut wird von der Pop-up-Benutzeroberfläche ignoriert.
`callback`	Für die Pop-up-Benutzeroberfläche erforderlich. Die JavaScript-Funktion, die die zurückgegebene Codeantwort verarbeitet. Das Attribut wird von der Weiterleitungs-Benutzeroberfläche ignoriert.
`state`	Optional. Für die Redirect-Benutzerfreundlichkeit empfohlen. Gibt einen beliebigen Stringwert an, den Ihre Anwendung verwendet, um den Status zwischen Ihrer Autorisierungsanfrage und der Antwort des Autorisierungsservers beizubehalten.
`enable_granular_consent`	Veraltet, hat keine Auswirkungen, wenn sie festgelegt ist. Weitere Informationen zum Einwilligungsverhalten finden Sie unter Granulare Berechtigungen.
`enable_serial_consent`	Veraltet, hat keine Auswirkungen, wenn sie festgelegt ist. Weitere Informationen zum Einwilligungsverhalten finden Sie unter Granulare Berechtigungen.
`login_hint`	Optional. Wenn Ihre Anwendung weiß, welcher Nutzer die Anfrage autorisieren soll, kann sie diese Eigenschaft verwenden, um Google einen Anmeldehinweis zu geben. Wenn die Anmeldung erfolgreich ist, wird die Kontoauswahl übersprungen. Die E-Mail-Adresse oder der Wert des sub-Felds des ID-Tokens für den Zielnutzer. Weitere Informationen finden Sie im Feld `login_hint` in der OpenID Connect-Dokumentation.
`hd`	Optional. Wenn Ihre Anwendung die Workspace-Domain kennt, zu der der Nutzer gehört, können Sie Google einen Hinweis geben. Wenn die Einrichtung erfolgreich ist, sind Nutzerkonten auf die angegebene Domain beschränkt oder für diese vorausgewählt. Weitere Informationen finden Sie im Feld `hd` in der OpenID Connect-Dokumentation.
`ux_mode`	Optional. Der UX-Modus, der für den Autorisierungsablauf verwendet werden soll. Standardmäßig wird der Einwilligungsablauf in einem Pop-up-Fenster geöffnet. Gültige Werte sind `popup` und `redirect`.
`select_account`	Optional, der Standardwert ist false. Boolescher Wert, der den Nutzer auffordert, ein Konto auszuwählen.
`error_callback`	Optional. Die JavaScript-Funktion, die einige Nicht-OAuth-Fehler verarbeitet, z. B. wenn das Pop-up-Fenster nicht geöffnet werden konnte oder geschlossen wurde, bevor eine OAuth-Antwort zurückgegeben wurde. Das Feld „type“ des Eingabeparameters enthält den detaillierten Grund. popup_failed_to_open: Das Pop‑up-Fenster konnte nicht geöffnet werden. popup_closed: Das Pop‑up-Fenster wird geschlossen, bevor eine OAuth-Antwort zurückgegeben wird. unknown: Platzhalter für andere Fehler.

Datentyp: CodeClient

Die Klasse hat nur eine öffentliche Methode, requestCode, die den OAuth 2.0-Code-UX-Vorgang startet.

interface CodeClient {   requestCode(): void; }

Datentyp: CodeResponse

Ein CodeResponse-JavaScript-Objekt wird in der Popup-Benutzeroberfläche an Ihre callback-Methode übergeben. In der Weiterleitungs-Benutzeroberfläche wird CodeResponse als URL-Parameter übergeben.

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

Attribute
`code`	Der Autorisierungscode einer erfolgreichen Token-Antwort.
`scope`	Eine durch Leerzeichen getrennte Liste von Bereichen, die vom Nutzer genehmigt wurden.
`state`	Der Stringwert, den Ihre Anwendung verwendet, um den Status zwischen Ihrer Autorisierungsanfrage und der Antwort beizubehalten.
`error`	Ein einzelner ASCII-Fehlercode.
`error_description`	Von Menschen lesbarer ASCII-Text mit zusätzlichen Informationen, der dem Cliententwickler helfen soll, den aufgetretenen Fehler zu verstehen.
`error_uri`	Ein URI, der auf eine für Menschen lesbare Webseite mit Informationen zum Fehler verweist. Er wird verwendet, um dem Cliententwickler zusätzliche Informationen zum Fehler bereitzustellen.

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 Attribute 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. Die JavaScript-Funktion, die 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. Diese Werte werden auf dem Zustimmungsbildschirm angezeigt, den Google dem Nutzer präsentiert.
`include_granted_scopes`	Optional; der Standardwert ist `true`. Ermöglicht Anwendungen, die schrittweise Autorisierung zu verwenden, um im Kontext Zugriff auf zusätzliche Bereiche anzufordern. Wenn Sie den Wert dieses Parameters auf `false` setzen und die Autorisierungsanfrage genehmigt wird, deckt das neue Zugriffstoken nur Bereiche ab, für die die `scope` in dieser `TokenClientConfig` angefordert wurde.
`prompt`	Optional, Standardwert ist 'select_account'. Eine durch Leerzeichen getrennte Liste von Aufforderungen, die dem Nutzer präsentiert werden sollen. Bei der Liste wird zwischen Groß- und Kleinschreibung unterschieden. Mögliche Werte: Leerer String: Der Nutzer wird nur beim ersten Zugriff auf die Berechtigung durch Ihre App aufgefordert. Kann nicht mit anderen Werten angegeben werden. none: Es werden keine Authentifizierungs- oder Zustimmungsbildschirme angezeigt. Darf nicht mit anderen Werten angegeben werden. consent: Der Nutzer wird um Einwilligung gebeten. select_account: Der Nutzer wird aufgefordert, ein Konto auszuwählen.
`enable_granular_consent`	Veraltet, hat keine Auswirkungen, wenn sie festgelegt ist. Weitere Informationen zum Einwilligungsverhalten finden Sie unter Granulare Berechtigungen.
`enable_serial_consent`	Veraltet, hat keine Auswirkungen, wenn sie festgelegt ist. Weitere Informationen zum Einwilligungsverhalten finden Sie unter Granulare Berechtigungen.
`login_hint`	Optional. Wenn Ihre Anwendung weiß, welcher Nutzer die Anfrage autorisieren soll, kann sie diese Eigenschaft verwenden, um Google einen Anmeldehinweis zu geben. Wenn die Anmeldung erfolgreich ist, wird die Kontoauswahl übersprungen. Die E-Mail-Adresse oder der Wert des sub-Felds des ID-Tokens für den Zielnutzer. Weitere Informationen finden Sie im Feld `login_hint` in der OpenID Connect-Dokumentation.
`hd`	Optional. Wenn Ihre Anwendung die Workspace-Domain kennt, zu der der Nutzer gehört, können Sie Google einen Hinweis geben. Wenn die Einrichtung erfolgreich ist, sind Nutzerkonten auf die angegebene Domain beschränkt oder für diese vorausgewählt. Weitere Informationen finden Sie im Feld `hd` in der OpenID Connect-Dokumentation.
`state`	Optional. Nicht empfohlen. Gibt einen beliebigen Stringwert an, den Ihre Anwendung verwendet, um den Status zwischen Ihrer Autorisierungsanfrage und der Antwort des Autorisierungsservers beizubehalten.
`error_callback`	Optional. Die JavaScript-Funktion, die einige Nicht-OAuth-Fehler verarbeitet, z. B. wenn das Pop-up-Fenster nicht geöffnet werden konnte oder geschlossen wurde, bevor eine OAuth-Antwort zurückgegeben wurde. Das Feld „type“ des Eingabeparameters enthält den detaillierten Grund. popup_failed_to_open: Das Pop‑up-Fenster konnte nicht geöffnet werden. popup_closed: Das Pop‑up-Fenster wird geschlossen, bevor eine OAuth-Antwort zurückgegeben wird. unknown: Platzhalter für andere Fehler.

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 in dieser Methode zu überschreibenden Konfigurationen.

Datentyp: OverridableTokenClientConfig

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

Attribute
`scope`	Optional. Eine durch Leerzeichen getrennte Liste von Bereichen, die die Ressourcen identifizieren, auf die Ihre Anwendung im Namen des Nutzers zugreifen kann. Diese Werte werden auf dem Zustimmungsbildschirm angezeigt, den Google dem Nutzer präsentiert.
`include_granted_scopes`	Optional; der Standardwert ist `true`. Ermöglicht Anwendungen, die schrittweise Autorisierung zu verwenden, um im Kontext Zugriff auf zusätzliche Bereiche anzufordern. Wenn Sie den Wert dieses Parameters auf `false` setzen und die Autorisierungsanfrage genehmigt wird, deckt das neue Zugriffstoken nur Bereiche ab, für die die `scope` in dieser `OverridableTokenClientConfig` angefordert wurde.
`prompt`	Optional. Eine durch Leerzeichen getrennte Liste von Aufforderungen, die dem Nutzer präsentiert werden sollen. Bei den Aufforderungen wird zwischen Groß- und Kleinschreibung unterschieden.
`enable_granular_consent`	Veraltet, hat keine Auswirkungen, wenn sie festgelegt ist. Weitere Informationen zum Einwilligungsverhalten finden Sie unter Granulare Berechtigungen.
`enable_serial_consent`	Veraltet, hat keine Auswirkungen, wenn sie festgelegt ist. Weitere Informationen zum Einwilligungsverhalten finden Sie unter Granulare Berechtigungen.
`login_hint`	Optional. Wenn Ihre Anwendung weiß, welcher Nutzer die Anfrage autorisieren soll, kann sie diese Eigenschaft verwenden, um Google einen Anmeldehinweis zu geben. Wenn die Anmeldung erfolgreich ist, wird die Kontoauswahl übersprungen. Die E-Mail-Adresse oder der Wert des sub-Felds des ID-Tokens für den Zielnutzer. Weitere Informationen finden Sie im Feld `login_hint` in der OpenID Connect-Dokumentation.
`state`	Optional. Nicht empfohlen. Gibt einen beliebigen Stringwert an, den Ihre Anwendung verwendet, um den Status zwischen Ihrer Autorisierungsanfrage und der Antwort des Autorisierungsservers beizubehalten.

Datentyp: TokenResponse

Ein TokenResponse-JavaScript-Objekt wird in der Pop-up-Benutzeroberfläche an Ihre Callback-Methode übergeben.

In der folgenden Tabelle sind die Attribute 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 Aufforderungswert, der aus der möglichen Liste von Werten verwendet wurde, die von TokenClientConfig oder OverridableTokenClientConfig angegeben wurden.
`token_type`	Der Typ des ausgestellten Tokens.
`scope`	Eine durch Leerzeichen getrennte Liste von Bereichen, die vom Nutzer genehmigt wurden.
`state`	Der Stringwert, den Ihre Anwendung verwendet, um den Status zwischen Ihrer Autorisierungsanfrage und der Antwort beizubehalten.
`error`	Ein einzelner ASCII-Fehlercode.
`error_description`	Für Menschen lesbarer ASCII-Text mit zusätzlichen Informationen, der dem Cliententwickler helfen soll, den aufgetretenen Fehler zu verstehen.
`error_uri`	Ein URI, der auf eine für Menschen lesbare Webseite mit Informationen zum Fehler verweist. Er wird verwendet, um dem Cliententwickler zusätzliche Informationen zum Fehler bereitzustellen.

Methode: google.accounts.oauth2.hasGrantedAllScopes

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

google.accounts.oauth2.hasGrantedAllScopes(                                             tokenResponse: TokenResponse,                                             firstScope: string, ...restScopes: string[]                                           ): boolean;

Argumente
`tokenResponse`	`TokenResponse`	Erforderlich. Ein `TokenResponse`-Objekt.
`firstScope`	String	Erforderlich. Der zu prüfende Bereich.
`restScopes`	String[]	Optional. Weitere Bereiche, die geprüft werden sollen.

Ausgabe
boolean	„True“, wenn alle Bereiche gewährt werden.

Methode: google.accounts.oauth2.hasGrantedAnyScope

Prüft, ob der Nutzer einen der angegebenen Bereiche gewährt hat.

google.accounts.oauth2.hasGrantedAnyScope(                                            tokenResponse: TokenResponse,                                            firstScope: string, ...restScopes: string[]                                          ): boolean;

Argumente
`tokenResponse`	`TokenResponse`	Erforderlich. Ein `TokenResponse`-Objekt.
`firstScope`	String	Erforderlich. Der zu prüfende Bereich.
`restScopes`	String[]	Optional. Weitere Bereiche, die geprüft werden sollen.

Ausgabe
boolean	„True“, wenn einer der Bereiche gewährt wird.

Methode: google.accounts.oauth2.revoke

Mit der Methode revoke werden alle Bereiche widerrufen, 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.
`callback`	Funktion	Optional. RevocationResponse-Handler.

Datentyp: RevocationResponse

Ein RevocationResponse-JavaScript-Objekt wird an Ihre Callback-Methode übergeben.

In der folgenden Tabelle sind die Attribute des Datentyps RevocationResponse aufgeführt.

Attribute
`successful`	Boolescher Wert. `true` bei Erfolg, `false` bei Fehler.
`error`	String. Bei Erfolg nicht definiert. Ein einzelner ASCII-Fehlercode. Dazu gehören unter anderem die Standard-OAuth 2.0-Fehlercodes. Häufige Fehler bei der `revoke`-Methode: `invalid_token` – Das Token ist bereits abgelaufen oder wurde widerrufen, bevor die Methode `revoke` aufgerufen wurde. In den meisten Fällen kann die mit dem `accessToken` verknüpfte Einwilligung als widerrufen betrachtet werden. `invalid_request`: Das Token kann nicht widerrufen werden. `accessToken` muss eine gültige Google OAuth 2.0-Anmeldedaten sein.
`error_description`	String. Bei Erfolg nicht definiert. Von Menschen lesbarer ASCII-Text mit zusätzlichen Informationen zum Attribut `error`. Entwickler können so die Ursache des Fehlers besser nachvollziehen. Der String `error_description` ist nur auf Englisch verfügbar. Für die in `error` aufgeführten häufigen Fehler die entsprechenden `error_description`: `invalid_token`: Das Token ist abgelaufen oder wurde widerrufen. `invalid_request`: Das Token kann nicht widerrufen werden.

JavaScript API-Referenz für die Google-Kontoautorisierung Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.