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

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

Methode: google.accounts.oauth2.initCodeClient

Die Methode initCodeClient initialisiert und gibt einen Codeclient mit dem Parameter Konfigurationen im Parameter.

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 könnte. Diese Werte bilden die Grundlage für den Zustimmungsbildschirm, den Google dem Nutzer anzeigt.
include_granted_scopes Optional, der Standardwert ist true. Ermöglicht Anwendungen die Verwendung inkrementeller Autorisierung zum Anfordern des Zugriffs auf zusätzliche Bereiche im Kontext. Wenn Sie Wert dieses Parameters auf false fest und die Autorisierungsanfrage wird gewährt. Das neue Zugriffstoken deckt nur Bereiche ab, für die der scope angefordert hat. in diesem CodeClientConfig.
redirect_uri Erforderlich für Weiterleitungs-UX. Legt fest, wohin der API-Server den Nutzer weiterleitet, nachdem der Nutzer den Autorisierungsvorgang abgeschlossen hat. Der Wert muss genau mit einer der autorisierten Weiterleitungs-URIs für den OAuth 2.0-Client übereinstimmen, die Sie in der API-Konsole konfiguriert haben. Außerdem muss er unseren Validierungsregeln für Weiterleitungs-URIs entsprechen. Die Eigenschaft wird von der Pop-up-UX ignoriert.
callback Erforderlich für Pop-up-UX. Die JavaScript-Funktion, die die zurückgegebene Codeantwort verarbeitet. Die Eigenschaft wird von der Weiterleitungs-UX ignoriert.
state Optional. Empfohlen für Weiterleitungs-UX. Gibt einen beliebigen Zeichenfolgenwert an, mit dem Ihre Anwendung den Status zwischen Ihrer Autorisierungsanfrage und der Antwort des Autorisierungsservers aufrechterhält.
enable_granular_consent Optional, der Standardwert ist true. Wenn false festgelegt ist, detailliertere Berechtigungen für das Google-Konto wird für OAuth-Client-IDs deaktiviert, die vor 2019 erstellt wurden. Wenn sowohl enable_granular_consent als auch enable_serial_consent festgelegt sind, wird nur enable_granular_consent wird der Wert wirksam und der Wert enable_serial_consent wird ignoriert.

Keine Auswirkungen auf neuere OAuth-Client-IDs, da detailliertere Berechtigungen immer für sie aktiviert sind.
enable_serial_consent Eingestellt. Verwende stattdessen enable_granular_consent. Dieses hat denselben Effekt wie enable_granular_consent. Vorhandene Anwendungen die enable_serial_consent verwenden, können dies auch weiterhin tun. Sie sind jedoch wird empfohlen, Ihren Code zu aktualisieren, um enable_granular_consent in auf das nächste App-Update.
login_hint Optional. Wenn Ihre Anwendung weiß, welcher Nutzer die Anfrage autorisieren soll, kann sie mithilfe dieser Eigenschaft einen Anmeldehinweis an Google senden. Wenn der Vorgang erfolgreich war, wird die Kontoauswahl übersprungen. Die E-Mail-Adresse oder der ID-Token-Feldwert sub für den Zielnutzer. Weitere Informationen finden Sie in der Dokumentation zu OpenID Connect im Feld login_hint.
hd Optional. Wenn Ihre Anwendung die Workspace-Domain kennt, zu der der Nutzer gehört, können Sie damit einen Hinweis an Google senden. Wenn der Vorgang erfolgreich war, werden Nutzerkonten auf die angegebene Domain beschränkt oder vorab ausgewählt. Weitere Informationen finden Sie in der Dokumentation zu OpenID Connect im Feld hd.
ux_mode Optional. Der UX-Modus, der für den Autorisierungsvorgang verwendet werden soll. Standardmäßig wird der Einwilligungsvorgang in einem Pop-up geöffnet. Gültige Werte sind popup und redirect.
select_account Optional, der Standardwert ist 'false'. Boolescher Wert, der den Nutzer zur Auswahl eines Kontos auffordert.
error_callback Optional. Die JavaScript-Funktion, die einige Nicht-OAuth-Fehler verarbeitet, z. B. Pop-up-Fenster konnte nicht geöffnet werden; oder geschlossen, bevor eine OAuth-Antwort zurückgegeben.

Das Feld „type“ des Eingabeparameters gibt den genauen Grund an.
  • popup_failed_to_open Das Pop-up-Fenster konnte nicht geöffnet werden.
  • popup_closed: Das Pop-up-Fenster wird vor einem OAuth geschlossen. -Antwort zurückgegeben.
  • unknown Platzhalter für andere Fehler

Datentyp: CodeClient

Die Klasse hat nur eine öffentliche Methode requestCode, mit der OAuth 2.0 gestartet wird. UX-Ablauf programmieren

interface CodeClient {
  requestCode(): void;
}

Datentyp: CodeResponse

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

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

Attribute
code Der Autorisierungscode einer erfolgreichen Tokenantwort.
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 aufrechtzuerhalten.
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 menschenlesbare Webseite mit Informationen zum Fehler identifiziert und dem Cliententwickler zusätzliche Informationen zum Fehler bereitstellt.

Methode: google.accounts.oauth2.initTokenClient

Die Methode initTokenClient initialisiert einen Tokenclient und gibt ihn zurück. Dabei enthält die Methode Konfigurationen im Parameter.

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 könnte. Diese Werte bilden die Grundlage für den Zustimmungsbildschirm, den Google dem Nutzer anzeigt.
include_granted_scopes Optional, der Standardwert ist true. Ermöglicht Anwendungen die Verwendung inkrementeller Autorisierung zum Anfordern des Zugriffs auf zusätzliche Bereiche im Kontext. Wenn Sie Wert dieses Parameters auf false fest und die Autorisierungsanfrage wird gewährt. Das neue Zugriffstoken deckt nur Bereiche ab, für die der scope angefordert hat. in diesem TokenClientConfig.
prompt Optional: Der Standardwert ist 'select_account'. Ein durch Leerzeichen getrenntes eine Liste von Prompts, die der Nutzer eingeblendet wird. Beachten Sie dabei die Groß- und Kleinschreibung. Mögliche Werte sind: <ph type="x-smartling-placeholder">
    </ph>
  • leerer String Der Nutzer wird nur dann dazu aufgefordert, wenn Ihre App zum ersten Mal Zugriff anfordert. 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 seine Einwilligung gebeten.
  • 'select_account': Der Nutzer wird aufgefordert, ein Konto auszuwählen.
enable_granular_consent Optional, der Standardwert ist true. Wenn false festgelegt ist, detailliertere Berechtigungen für das Google-Konto wird für OAuth-Client-IDs deaktiviert, die vor 2019 erstellt wurden. Wenn sowohl enable_granular_consent als auch enable_serial_consent festgelegt sind, wird nur enable_granular_consent wird der Wert wirksam und der Wert enable_serial_consent wird ignoriert.

Keine Auswirkungen auf neuere OAuth-Client-IDs, da detailliertere Berechtigungen immer für sie aktiviert sind.
enable_serial_consent Eingestellt. Verwende stattdessen enable_granular_consent. Dieses hat denselben Effekt wie enable_granular_consent. Vorhandene Anwendungen die enable_serial_consent verwenden, können dies auch weiterhin tun. Sie sind jedoch wird empfohlen, Ihren Code zu aktualisieren, um enable_granular_consent in auf das nächste App-Update.
login_hint Optional. Wenn Ihre Anwendung weiß, welcher Nutzer die Anfrage autorisieren soll, kann sie mithilfe dieser Eigenschaft einen Anmeldehinweis an Google senden. Wenn der Vorgang erfolgreich war, wird die Kontoauswahl übersprungen. Die E-Mail-Adresse oder der ID-Token-Feldwert sub für den Zielnutzer. Weitere Informationen finden Sie in der Dokumentation zu OpenID Connect im Feld login_hint.
hd Optional. Wenn Ihre Anwendung die Workspace-Domain kennt, zu der der Nutzer gehört, können Sie damit einen Hinweis an Google senden. Wenn der Vorgang erfolgreich war, werden Nutzerkonten auf die angegebene Domain beschränkt oder vorab ausgewählt. Weitere Informationen finden Sie in der Dokumentation zu OpenID Connect im Feld hd.
state Optional. Nicht empfohlen Gibt einen beliebigen Zeichenfolgenwert an, mit dem Ihre Anwendung den Status zwischen Ihrer Autorisierungsanfrage und der Antwort des Autorisierungsservers aufrechterhält.
error_callback Optional. Die JavaScript-Funktion, die einige Nicht-OAuth-Fehler verarbeitet, z. B. Pop-up-Fenster konnte nicht geöffnet werden; oder geschlossen, bevor eine OAuth-Antwort zurückgegeben.

Das Feld „type“ des Eingabeparameters gibt den genauen Grund an.
  • popup_failed_to_open Das Pop-up-Fenster konnte nicht geöffnet werden.
  • popup_closed: Das Pop-up-Fenster wird vor einem OAuth geschlossen. -Antwort zurückgegeben.
  • unknown Platzhalter für andere Fehler

Datentyp: TokenClient

Die Klasse hat nur eine öffentliche Methode requestAccessToken, die den UX-Vorgang für OAuth 2.0-Tokens.

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 Attribute von OverridableTokenClientConfig aufgeführt. Datentyp.

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 den Zustimmungsbildschirm informieren, den Google dem Nutzer anzeigt.
include_granted_scopes Optional, der Standardwert ist true. Ermöglicht Anwendungen die Verwendung inkrementeller Autorisierung zum Anfordern des Zugriffs auf zusätzliche Bereiche im Kontext. Wenn Sie diesem Parameterwert auf false setzen und die Autorisierungsanfrage gewährt wird, dann Das neue Zugriffstoken deckt nur Bereiche ab, für die der scope angefordert hat. in diesem OverridableTokenClientConfig.
prompt Optional. Eine durch Leerzeichen getrennte Liste von Eingabeaufforderungen, die dem Nutzer angezeigt werden. Beachten Sie dabei die Groß- und Kleinschreibung.
enable_granular_consent Optional, der Standardwert ist true. Wenn false festgelegt ist, werden detailliertere Berechtigungen für das Google-Konto benötigt. wird für OAuth-Client-IDs deaktiviert, die vor 2019 erstellt wurden.Wenn sowohl enable_granular_consent als auch enable_serial_consent festgelegt sind, werden nur enable_granular_consent wirksam und der Wert enable_serial_consent wird ignoriert.

Keine Auswirkungen auf neuere OAuth-Client-IDs, da detailliertere Berechtigungen immer für sie aktiviert sind.
enable_serial_consent Eingestellt. Verwende stattdessen enable_granular_consent. Dieses hat denselben Effekt wie enable_granular_consent. Vorhandene Anwendungen die enable_serial_consent verwenden, können dies auch weiterhin tun. Sie sind jedoch wird empfohlen, Ihren Code zu aktualisieren, um enable_granular_consent in auf das nächste App-Update.
login_hint Optional. Wenn Ihre Anwendung weiß, welcher Nutzer die Anfrage autorisieren soll, kann sie mithilfe dieser Eigenschaft einen Anmeldehinweis an Google senden. Wenn der Vorgang erfolgreich war, wird die Kontoauswahl übersprungen. Die E-Mail-Adresse oder der ID-Token-Feldwert sub für den Zielnutzer. Weitere Informationen finden Sie in der Dokumentation zu OpenID Connect im Feld login_hint.
state Optional. Nicht empfohlen Gibt einen beliebigen Zeichenfolgenwert 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 Ihre Callback-Methode übergeben in die Pop-up-UX.

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 Prompt-Wert, der aus der möglichen Liste von Werten verwendet wurde, die von TokenClientConfig oder OverridableTokenClientConfig angegeben werden.
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 aufrechtzuerhalten.
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 URI, der eine menschenlesbare Webseite mit Informationen zum Fehler identifiziert und dem Cliententwickler zusätzliche Informationen zum Fehler bereitstellt.

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. TokenResponse -Objekt enthält.
firstScope String Erforderlich. Der zu prüfende Bereich.
restScopes String[] Optional. Andere zu prüfende Bereiche.
Gibt Folgendes zurück:
boolean "True", wenn alle Bereiche gewährt wurden.

Methode: google.accounts.oauth2.hasGrantedAnyScope

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

google.accounts.oauth2.hasGrantedAnyScope(
                                           tokenResponse: TokenResponse,
                                           firstScope: string, ...restScopes: string[]
                                         ): boolean;
Argumente
tokenResponse TokenResponse Erforderlich. TokenResponse -Objekt enthält.
firstScope String Erforderlich. Der zu prüfende Bereich.
restScopes String[] Optional. Andere zu prüfende Bereiche.
Gibt Folgendes zurück:
boolean "True", wenn einer der Bereiche gewährt wird.

Methode: google.accounts.oauth2.revoke

Die Methode revoke widerruft alle Bereiche, die der Nutzer der App zugewiesen 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 abrufen.

Datentyp: RevocationResponse

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

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

Attribute
successful Boolescher Wert. true bei erfolgreich, false bei Fehler.
error String. Bei Erfolg nicht definiert. Ein einzelner ASCII-Fehlercode. Dazu gehört unter anderem das Standard-OAuth 2.0-Fehlercodes. Häufige Fehler bei der Methode revoke: <ph type="x-smartling-placeholder">
    </ph>
  • invalid_token: Das Token ist bereits abgelaufen oder wurde widerrufen, bevor die Methode revoke aufgerufen wird. In den meisten Fällen können Sie die mit Ihrer accessToken wurde widerrufen.
  • invalid_request – Das Token kann nicht widerrufen werden. Achten Sie darauf, accessToken sind gültige Anmeldedaten für Google OAuth 2.0.
error_description String. Bei Erfolg nicht definiert. Lesbarer ASCII-Text bietet zusätzliche Informationen zu error-Property. Entwickler können so besser verstehen, den aufgetretenen Fehler. Der String error_description ist nur auf Englisch verfügbar. Für die häufigen Fehler, die in error aufgeführt sind, ist die entsprechende error_description: <ph type="x-smartling-placeholder">
    </ph>
  • invalid_token – Das Token ist abgelaufen oder wurde widerrufen.
  • invalid_request – Das Token kann nicht widerrufen werden.