Referenz zum JavaScript-Client für Google Log-in

In dieser Referenz werden die JavaScript-Clientmethoden und ‑Attribute beschrieben, mit denen Sie Google Log-in in Ihren Webanwendungen implementieren.

Wenn bei der Verwendung der Bibliothek Probleme auftreten, melden Sie sie in unserem GitHub-Repository. .

Auth-Einrichtung

Laden Sie die Plattformbibliothek der Google APIs, um das gapi-Objekt zu erstellen:

<script src="https://apis.google.com/js/platform.js?onload=init" async defer></script>

Laden Sie danach die Bibliothek auth2:

function init() {
  gapi.load('auth2', function() {
    /* Ready. Make a call to gapi.auth2.init or some other API */
  });
}

gapi.auth2.init(params)

Initialisiert das GoogleAuth-Objekt. Sie müssen diese Methode vor dem Aufrufen der Methoden von gapi.auth2.GoogleAuth aufrufen.

Beim Initialisieren des GoogleAuth-Objekts konfigurieren Sie dieses mit Ihrer OAuth 2.0-Client-ID und den zusätzlichen Optionen, die Sie angeben möchten. Wenn sich der Nutzer bereits angemeldet hat, stellt das GoogleAuth-Objekt den Anmeldestatus des Nutzers aus der vorherigen Sitzung wieder her.

Argumente
params Ein Objekt mit Schlüssel/Wert-Paaren von Clientkonfigurationsdaten. Unter gapi.auth2.ClientConfig finden Sie die verschiedenen konfigurierbaren Eigenschaften. Beispiele: 
{
  client_id: 'CLIENT_ID.apps.googleusercontent.com'
}
Gibt Folgendes zurück:
gapi.auth2.GoogleAuth Das gapi.auth2.GoogleAuth-Objekt. Mit der Methode then() erhalten Sie ein Promise, das erfüllt wird, wenn die Initialisierung des gapi.auth2.GoogleAuth-Objekts abgeschlossen ist.

GoogleAuth.then(onInit, onError)

Ruft die Funktion onInit auf, wenn das GoogleAuth-Objekt vollständig initialisiert ist. Wenn bei der Initialisierung ein Fehler auftritt (was in alten, nicht unterstützten Browsern passieren kann), wird stattdessen die onError-Funktion aufgerufen.

Argumente
onInit Die Funktion, die mit dem GoogleAuth-Objekt aufgerufen wird, wenn es vollständig initialisiert ist.
onError Die Funktion, die mit einem Objekt mit einer error-Property aufgerufen wird, wenn GoogleAuth nicht initialisiert werden konnte.
Gibt Folgendes zurück:
Promise Ein Promise, das erfüllt wird, wenn die onInit-Funktion abgeschlossen ist, oder abgelehnt wird, wenn ein Initialisierungsfehler aufgetreten ist. Er wird mit dem Rückgabewert der onInit-Funktion aufgelöst, falls vorhanden.

Fehlercodes

idpiframe_initialization_failed
Ein erforderlicher iFrame von Google konnte nicht initialisiert werden, z. B. aufgrund einer nicht unterstützten Umgebung. Das Attribut details enthält weitere Informationen zum aufgetretenen Fehler.

gapi.auth2.ClientConfig

Benutzeroberfläche, die die verschiedenen Konfigurationsparameter für die Methode gapi.auth2.init darstellt.

Parameter
client_id string Erforderlich. Die Client-ID der App, die in der Google API Console gefunden und erstellt wurde.
cookie_policy string Die Domains, für die Anmelde-Cookies erstellt werden sollen. Entweder ein URI, single_host_origin oder none. Wenn keine Angabe gemacht wird, ist der Standardwert single_host_origin.
scope string Die anzufordernden Bereiche als durch Leerzeichen getrennter String. Optional, wenn fetch_basic_profile nicht auf „false“ gesetzt ist.
fetch_basic_profile boolean Die grundlegenden Profilinformationen der Nutzer abrufen, wenn sie sich anmelden. Fügen Sie den angeforderten Bereichen „profil“, „email“ und „openid“ hinzu. „Wahr“, wenn nicht angegeben.
hosted_domain string Die G Suite-Domain, zu der Nutzer gehören müssen, um sich anzumelden. Dieser Wert kann von Kunden geändert werden. Prüfen Sie daher die gehostete Domain-Property des zurückgegebenen Nutzers. Verwende GoogleUser.getHostedDomain() auf dem Client und die hd-Anforderung im ID-Token auf dem Server, um zu prüfen, ob die Domain wie erwartet ist.
use_fedcm boolean Optional, Standardwert ist True. Aktivieren oder deaktivieren Sie die Verwendung von FedCM-APIs des Browsers während der Anmeldung.
ux_mode string Der UX-Modus, der für den Anmeldevorgang verwendet werden soll. Standardmäßig wird der Einwilligungsvorgang in einem Pop-up-Fenster geöffnet. Gültige Werte sind popup und redirect.
redirect_uri string Wenn Sie ux_mode='redirect' verwenden, können Sie mit diesem Parameter den Standardwert redirect_uri überschreiben, der am Ende des Einwilligungsvorgangs verwendet wird. Die Standard-redirect_uri ist die aktuelle URL ohne Suchparameter und Hash-Fragment.
enable_granular_consent boolean Optional. Sie können detaillierte Berechtigungen aktivieren. Wenn diese Option auf false festgelegt ist, werden die detaillierteren Google-Kontoberechtigungen für OAuth-Client-IDs deaktiviert, die vor 2019 erstellt wurden. Für OAuth-Client-IDs, die 2019 oder später erstellt wurden, hat dies keine Auswirkungen, da für diese immer detailliertere Berechtigungen aktiviert sind.
plugin_name string Optional. Wenn dieser Wert festgelegt ist, können neue Client-IDs, die vor dem 29. Juli 2022 erstellt wurden, die ältere Google Platform Library verwenden. Für neu erstellte Client-IDs ist die Verwendung der Plattformbibliothek jetzt standardmäßig blockiert. Stattdessen muss die neuere Google Identity Services-Bibliothek verwendet werden. Sie können einen beliebigen Wert auswählen. Für die Identifizierung wird jedoch ein beschreibender Name wie der Produkt- oder Plug-in-Name empfohlen. Beispiel: plugin_name: 'YOUR_STRING_HERE'

Authentifizierung

GoogleAuth ist eine Singleton-Klasse, die Methoden zum Anmelden des Nutzers mit einem Google-Konto, zum Abrufen des aktuellen Anmeldestatus des Nutzers, zum Abrufen bestimmter Daten aus dem Google-Profil des Nutzers, zum Anfordern zusätzlicher Bereiche und zum Abmelden vom aktuellen Konto bereitstellt.

gapi.auth2.getAuthInstance()

Gibt das GoogleAuth-Objekt zurück. Sie müssen das GoogleAuth-Objekt mit gapi.auth2.init() initialisieren, bevor Sie diese Methode aufrufen.

Gibt Folgendes zurück:
gapi.auth2.GoogleAuth Das gapi.auth2.GoogleAuth-Objekt. Mit diesem Objekt können Sie die Methoden von gapi.auth2.GoogleAuth aufrufen.

GoogleAuth.isSignedIn.get()

Gibt an, ob der aktuelle Nutzer angemeldet ist.

Gibt Folgendes zurück:
Boolesch true, wenn der Nutzer angemeldet ist, oder false, wenn der Nutzer abgemeldet ist oder das GoogleAuth-Objekt nicht initialisiert ist.

GoogleAuth.isSignedIn.listen(listener)

Auf Änderungen am Anmeldestatus des aktuellen Nutzers achten

Argumente
listener Eine Funktion, die einen booleschen Wert annimmt. listen() gibt true an diese Funktion weiter, wenn sich der Nutzer anmeldet, und false, wenn er sich abmeldet.

GoogleAuth.signIn()

Meldet den Nutzer mit den für gapi.auth2.init() angegebenen Optionen an.

Gibt Folgendes zurück:
Promise Eine Promise, die mit der GoogleUser-Instanz erfüllt wird, wenn sich der Nutzer erfolgreich authentifiziert und die angeforderten Bereiche gewährt, oder mit einem Objekt abgelehnt wird, das die Property error enthält, wenn ein Fehler aufgetreten ist. Im nächsten Abschnitt finden Sie Informationen zu Fehlercodes.

Fehlercodes

Weitere Informationen finden Sie unter GoogleAuth.signIn(options).

GoogleAuth.signIn(options)

Der Nutzer wird mit den angegebenen Optionen angemeldet.

Argumente
options Sie haben folgende Möglichkeiten:
  • Ein gapi.auth2.SignInOptions-Objekt mit Schlüssel/Wert-Paaren von Anmeldeparametern. Beispiel: 
    {
  scope: 'profile email'
}
  • Eine Instanz von gapi.auth2.SigninOptionsBuilder. Beispiel:
    options = new gapi.auth2.SigninOptionsBuilder();
options.setAppPackageName('com.example.app');
options.setFetchBasicProfile(True);
options.setPrompt('select_account');
options.setScope('profile').setScope('email');
Gibt Folgendes zurück:
Promise Eine Promise, die mit der GoogleUser-Instanz erfüllt wird, wenn sich der Nutzer erfolgreich authentifiziert und die angeforderten Bereiche gewährt, oder mit einem Objekt abgelehnt wird, das eine error-Eigenschaft enthält, wenn ein Fehler aufgetreten ist (siehe unten für Fehlercodes).

Fehlercodes

popup_closed_by_user
Der Nutzer hat das Pop-up geschlossen, bevor er den Anmeldevorgang abgeschlossen hat.
access_denied
Der Nutzer hat die Berechtigung für die erforderlichen Bereiche abgelehnt.
immediate_failed
Es kann kein Nutzer automatisch ausgewählt werden, ohne dass der Einwilligungsvorgang gestartet wird. Fehler bei Verwendung von signIn mit der Option prompt: 'none' Diese Option sollte nicht erforderlich sein, da gapi.auth2.init den Nutzer automatisch anmeldet, wenn er sich in einer vorherigen Sitzung angemeldet hat.

gapi.auth2.SignInOptions

Benutzeroberfläche, die die verschiedenen Konfigurationsparameter für die Methode GoogleAuth.signIn(options) darstellt.

Parameter
prompt string Erzwingt einen bestimmten Modus für den Einwilligungsablauf. Optional.
Mögliche Werte sind:
  • consent
    Der Autorisierungsserver fordert den Nutzer zur Einwilligung auf, bevor er Informationen an die Anwendung zurückgibt.
  • select_account
    Der Autorisierungsserver fordert den Nutzer auf, ein Google-Konto auszuwählen. So kann ein Nutzer mit mehreren Konten aus den Konten auswählen, für die er aktuelle Sitzungen hat.
  • none (nicht empfohlen)
    Der Autorisierungsserver zeigt keine Authentifizierungs- oder Nutzereinwilligungsbildschirme an. Er gibt einen Fehler zurück, wenn der Nutzer noch nicht authentifiziert ist und den angeforderten Bereichen nicht zuvor zugestimmt hat.
    Da gapi.auth2.init einen Nutzer automatisch in der Anwendung anmeldet, wenn er zuvor angemeldet war, schlägt der Aufruf von signIn({prompt: 'none'}) in der Regel fehl.
scope string Die anzufordernden Bereiche als durch Leerzeichen getrennter String zusätzlich zu den in den gapi.auth2.init-Parametern definierten Bereichen. Optional, wenn fetch_basic_profile nicht auf „false“ gesetzt ist.
ux_mode string Der UX-Modus, der für den Anmeldevorgang verwendet werden soll. Standardmäßig wird der Einwilligungsvorgang in einem Pop-up-Fenster geöffnet. Gültige Werte sind popup und redirect.
redirect_uri string Wenn Sie ux_mode='redirect' verwenden, können Sie mit diesem Parameter den Standardwert redirect_uri überschreiben, der am Ende des Einwilligungsvorgangs verwendet wird. Die Standard-redirect_uri ist die aktuelle URL ohne Abfrageparameter und Hash-Fragment.

GoogleAuth.signOut()

Meldet das aktuelle Konto von der Anwendung ab.

Gibt Folgendes zurück:
Promise Eine Promise, die erfüllt ist, wenn der Nutzer abgemeldet ist.

GoogleAuth.disconnect()

Hiermit werden alle vom Nutzer gewährten Berechtigungen widerrufen.

GoogleAuth.grantOfflineAccess(options)

Sie müssen vom Nutzer die Berechtigung erhalten, offline auf die angegebenen Bereiche zuzugreifen.

Argumente
options Ein gapi.auth2.OfflineAccessOptions Objekt mit Schlüssel/Wert-Paaren von Parametern. Beispiel: 
{
  scope: 'profile email'
}
Gibt Folgendes zurück:
Promise Eine Promise, die erfüllt wird, wenn der Nutzer die angeforderten Bereiche gewährt und dem Promise-Ausführungs-Handler ein Objekt mit dem Autorisierungscode übergibt. Beispiel: 
auth2.grantOfflineAccess().then(function(resp) {
  var auth_code = resp.code;
});

Fehlercodes

popup_closed_by_user
Der Nutzer hat das Pop-up geschlossen, bevor er den Einwilligungsvorgang abgeschlossen hat.
access_denied
Der Nutzer hat die Berechtigung für die erforderlichen Bereiche abgelehnt.
immediate_failed
Es kann kein Nutzer automatisch ausgewählt werden, ohne dass der Einwilligungsvorgang gestartet wird. Fehler bei Verwendung von signIn mit der Option prompt: 'none' Diese Option sollte nicht erforderlich sein, da gapi.auth2.init den Nutzer automatisch anmeldet, wenn er in einer vorherigen Sitzung angemeldet war.

gapi.auth2.OfflineAccessOptions

Benutzeroberfläche, die die verschiedenen Konfigurationsparameter für die Methode GoogleAuth.grantOfflineAccess(options) darstellt.

Parameter
prompt string Erzwingt einen bestimmten Modus für den Einwilligungsablauf. Optional.
Mögliche Werte sind:
  • consent
    Der Autorisierungsserver fordert den Nutzer zur Einwilligung auf, bevor er Informationen an die Anwendung zurückgibt.
  • select_account
    Der Autorisierungsserver fordert den Nutzer auf, ein Google-Konto auszuwählen. So kann ein Nutzer mit mehreren Konten aus den Konten auswählen, für die er aktuelle Sitzungen hat.
scope string Die anzufordernden Bereiche als durch Leerzeichen getrennter String zusätzlich zu den in den gapi.auth2.init-Parametern definierten Bereichen. Optional, wenn fetch_basic_profile nicht auf „false“ gesetzt ist.

GoogleAuth.attachClickHandler(container, options, onsuccess, onfailure)

Hängt den Anmeldevorgang an den Klick-Handler des angegebenen Containers an.

Argumente
container Die ID oder ein Verweis auf das div-Element, an das der Klick-Handler angehängt werden soll.
options Ein Objekt mit Schlüssel/Wert-Paaren von Parametern. Weitere Informationen finden Sie unter GoogleAuth.signIn().
onsuccess Die Funktion, die nach Abschluss der Anmeldung aufgerufen werden soll.
onfailure Die Funktion, die aufgerufen werden soll, wenn die Anmeldung fehlschlägt.

Nutzer

Ein GoogleUser-Objekt steht für ein Nutzerkonto. GoogleUser-Objekte werden in der Regel durch Aufrufen von GoogleAuth.currentUser.get() abgerufen.

GoogleAuth.currentUser.get()

Gibt ein GoogleUser-Objekt zurück, das den aktuellen Nutzer darstellt. Hinweis: In einer neu initialisierten GoogleAuth-Instanz wurde der aktuelle Nutzer noch nicht festgelegt. Verwenden Sie die Methode currentUser.listen() oder GoogleAuth.then(), um eine initialisierte GoogleAuth-Instanz abzurufen.

Gibt Folgendes zurück:
GoogleUser Der aktuelle Nutzer

GoogleAuth.currentUser.listen(listener)

Änderungen an „currentUser“ beobachten

Argumente
listener Eine Funktion, die einen GoogleUser-Parameter verwendet. listen übergibt dieser Funktion bei jeder Änderung, die currentUser beeinflusst, eine GoogleUser-Instanz.

GoogleUser.getId()

Rufe den eindeutigen ID-String des Nutzers ab.

Gibt Folgendes zurück:
String Die eindeutige ID des Nutzers

GoogleUser.isSignedIn()

Gibt „true“ zurück, wenn der Nutzer angemeldet ist.

Gibt Folgendes zurück:
Boolesch „Wahr“, wenn der Nutzer angemeldet ist

GoogleUser.getHostedDomain()

G Suite-Domain des Nutzers abrufen, wenn er sich mit einem G Suite-Konto angemeldet hat

Gibt Folgendes zurück:
String Die G Suite-Domain des Nutzers

GoogleUser.getGrantedScopes()

Die vom Nutzer gewährten Bereiche als durch Leerzeichen getrennten String abrufen.

Gibt Folgendes zurück:
String Die vom Nutzer gewährten Bereiche

GoogleUser.getBasicProfile()

Rufen Sie die grundlegenden Profilinformationen des Nutzers ab.

Gibt Folgendes zurück:
gapi.auth2.BasicProfile Sie können die Eigenschaften von gapi.auth2.BasicProfile mit den folgenden Methoden abrufen:
  • BasicProfile.getId()
  • BasicProfile.getName()
  • BasicProfile.getGivenName()
  • BasicProfile.getFamilyName()
  • BasicProfile.getImageUrl()
  • BasicProfile.getEmail()

GoogleUser.getAuthResponse(includeAuthorizationData)

Rufe das Antwortobjekt aus der Authentifizierungssitzung des Nutzers ab.

Argumente
includeAuthorizationData Optional:Ein boolescher Wert, der angibt, ob immer ein Zugriffstoken und Bereiche zurückgegeben werden sollen. Standardmäßig werden das Zugriffstoken und die angeforderten Bereiche nicht zurückgegeben, wenn fetch_basic_profile wahr ist (Standardwert) und keine zusätzlichen Bereiche angefordert werden.
Gibt Folgendes zurück:
gapi.auth2.AuthResponse Ein gapi.auth2.AuthResponse-Objekt.

GoogleUser.reloadAuthResponse()

Erzwingt eine Aktualisierung des Zugriffstokens und gibt dann ein Promise für die neue AuthResponse zurück.

Gibt Folgendes zurück:
Promise Ein Promise, das nach dem Aktualisieren des OAuth-Tokens mit dem neu geladenen gapi.auth2.AuthResponse erfüllt wird.

gapi.auth2.AuthResponse

Die Antwort, die beim Aufrufen der Methoden GoogleUser.getAuthResponse(includeAuthorizationData) oder GoogleUser.reloadAuthResponse() zurückgegeben wird.

Attribute
access_token string Das Zugriffstoken wurde gewährt.
id_token string Das gewährte ID-Token.
scope string Die im Zugriffstoken gewährten Bereiche.
expires_in number Die Anzahl der Sekunden, bis das Zugriffstoken abläuft.
first_issued_at number Der Zeitstempel, zu dem der Nutzer die angeforderten Berechtigungen erteilt hat.
expires_at number Der Zeitstempel, zu dem das Zugriffstoken abläuft.

GoogleUser.hasGrantedScopes(scopes)

Gibt „true“ zurück, wenn der Nutzer die angegebenen Berechtigungen gewährt hat.

Argumente
scopes Ein durch Leerzeichen getrennter String mit Bereichen.
Gibt Folgendes zurück:
Boolesch „True“, wenn die Bereiche gewährt wurden

GoogleUser.grant(options)

Fordere vom Nutzer zusätzliche Berechtigungen an.

Eine Liste der Parameter und den Fehlercode finden Sie unter GoogleAuth.signIn().

GoogleUser.grantOfflineAccess(options)

Sie müssen vom Nutzer die Berechtigung erhalten, offline auf die angegebenen Bereiche zuzugreifen.

Argumente
options Ein gapi.auth2.OfflineAccessOptions Objekt mit Schlüssel/Wert-Paaren von Parametern. Beispiel: 
{
  scope: 'profile email'
}

GoogleUser.disconnect()

Hiermit werden alle Bereiche widerrufen, die der Nutzer der Anwendung gewährt hat.

UI-Elemente

gapi.signin2.render(id, options)

Rendert eine Anmeldeschaltfläche im Element mit der angegebenen ID unter Verwendung der vom options-Objekt angegebenen Einstellungen.

Argumente
id Die ID des Elements, in dem die Anmeldeschaltfläche gerendert werden soll.
options Ein Objekt mit den Einstellungen, die zum Rendern der Schaltfläche verwendet werden sollen. Beispiel: 
{
  scope: 'email',
  width: 200,
  height: 50,
  longtitle: true,
  theme: 'dark',
  onsuccess: handleSuccess,
  onfailure: handleFailure
}
Sie können die folgenden Optionen angeben:
Parameter
Bereich Die Bereiche, die angefordert werden sollen, wenn sich der Nutzer anmeldet (Standard: profile).
Breite Die Breite der Schaltfläche in Pixeln (Standard: 120).
Höhe Die Höhe der Schaltfläche in Pixeln (Standard: 36).
longtitle Verwenden Sie lange Labels wie „Über Google anmelden“ anstelle von „Anmelden“ (Standard: false). Wenn Sie lange Titel verwenden, sollten Sie die Breite der Schaltfläche über den Standardwert hinaus erhöhen.
Design Das Farbdesign der Schaltfläche: entweder light oder dark (Standardeinstellung: light).
onsuccess Die Callback-Funktion, die aufgerufen wird, wenn sich ein Nutzer erfolgreich angemeldet hat. Diese Funktion muss ein Argument haben: eine Instanz von gapi.auth2.GoogleUser (Standard: keine).
onfailure Die Callback-Funktion, die aufgerufen werden soll, wenn die Anmeldung fehlschlägt. Diese Funktion akzeptiert keine Argumente (Standard: keine).

Erweitert

gapi.auth2.authorize(params, callback)

Führt eine einmalige OAuth 2.0-Autorisierung aus. Je nach verwendeten Parametern wird ein Pop-up für den Google-Anmeldevorgang geöffnet oder versucht, die angeforderte Antwort ohne Nutzerinteraktion im Hintergrund zu laden.

Beispiele für Anwendungsfälle, in denen diese Methode nützlich ist:

  • Ihre Anwendung muss einen Google API-Endpunkt nur einmal anfordern, z. B. um die Lieblings-YouTube-Videos des Nutzers beim ersten Anmelden zu laden.
  • Ihre Anwendung hat eine eigene Infrastruktur zur Sitzungsverwaltung und benötigt das ID-Token nur einmal, um den Nutzer in Ihrem Backend zu identifizieren.
  • Auf derselben Seite werden mehrere Client-IDs verwendet.
Argumente
params Ein Objekt mit Schlüssel/Wert-Paaren von Konfigurationsdaten. Unter gapi.auth2.AuthorizeConfig finden Sie die verschiedenen konfigurierbaren Eigenschaften. Beispiele: 
{
  client_id: 'CLIENT_ID.apps.googleusercontent.com',
  scope: 'email profile openid',
  response_type: 'id_token permission'
}
callback Eine Funktion, die mit einem gapi.auth2.AuthorizeResponse-Objekt aufgerufen wird, nachdem die Anfrage abgeschlossen wurde (entweder erfolgreich oder mit einem Fehler).

Beispiel

gapi.auth2.authorize({
  client_id: 'CLIENT_ID.apps.googleusercontent.com',
  scope: 'email profile openid',
  response_type: 'id_token permission'
}, function(response) {
  if (response.error) {
    // An error happened!
    return;
  }
  // The user authorized the application for the scopes requested.
  var accessToken = response.access_token;
  var idToken = response.id_token;
  // You can also now use gapi.client to perform authenticated requests.
});

Fehlercodes

idpiframe_initialization_failed
Ein erforderlicher iFrame von Google konnte nicht initialisiert werden, z. B. aufgrund einer nicht unterstützten Umgebung. Das Attribut details enthält weitere Informationen zum aufgetretenen Fehler.
popup_closed_by_user
Der Nutzer hat das Pop-up geschlossen, bevor er den Anmeldevorgang abgeschlossen hat.
access_denied
Der Nutzer hat die Berechtigung für die erforderlichen Bereiche abgelehnt.
immediate_failed
Es kann kein Nutzer automatisch ausgewählt werden, ohne dass der Einwilligungsvorgang gestartet wird. Fehler bei Verwendung von signIn mit der Option prompt: 'none'

gapi.auth2.AuthorizeConfig

Benutzeroberfläche, die die verschiedenen Konfigurationsparameter für die Methode gapi.auth2.authorize darstellt.

Attribute
client_id string Erforderlich. Die Client-ID der App, die in der Google API Console gefunden und erstellt wurde.
scope string Erforderlich. Die anzufordernden Bereiche als durch Leerzeichen getrennter String.
response_type string Eine Liste mit durch Leerzeichen voneinander getrennten Antworttypen. Die Standardeinstellung ist 'permission'. Die möglichen Werte sind:
  • id_token, um ein ID-Token abzurufen
  • permission (oder token), um ein Zugriffstoken abzurufen
  • code, um einen Autorisierungscode abzurufen
prompt string Erzwingt einen bestimmten Modus für den Einwilligungsablauf. Die möglichen Werte sind:
  • consent
    Der Autorisierungsserver fordert den Nutzer zur Einwilligung auf, bevor er Informationen an die Anwendung zurückgibt.
  • select_account
    Der Autorisierungsserver fordert den Nutzer auf, ein Google-Konto auszuwählen. So kann ein Nutzer mit mehreren Konten aus den Konten auswählen, für die er aktuelle Sitzungen hat.
  • none
    Der Autorisierungsserver zeigt keine Authentifizierungs- oder Nutzereinwilligungsbildschirme an. Er gibt einen Fehler zurück, wenn der Nutzer noch nicht authentifiziert ist und nicht bereits seine Einwilligung für die angeforderten Bereiche gegeben hat.
    Wenn code als Antworttyp angefordert wird, kann der zurückgegebene Code nur gegen einen access_token eingetauscht werden, nicht gegen einen refresh_token.
cookie_policy string Die Domains, für die Anmelde-Cookies erstellt werden sollen. Entweder ein URI, single_host_origin oder none. Wenn keine Angabe gemacht wird, ist der Standardwert single_host_origin.
hosted_domain string Die G Suite-Domain, zu der Nutzer gehören müssen, um sich anzumelden. Dieser Wert kann von Kunden geändert werden. Prüfen Sie daher die gehostete Domain-Property des zurückgegebenen Nutzers.
login_hint string Die E-Mail-Adresse oder Nutzer-ID eines Nutzers, die im Anmeldevorgang vorab ausgewählt werden soll. Dieser Wert kann vom Nutzer geändert werden, es sei denn, prompt: "none" wird verwendet.
include_granted_scopes boolean Gibt an, ob ein Zugriffstoken mit allen zuvor vom Nutzer der App gewährten Bereichen oder nur mit den im aktuellen Aufruf angeforderten Bereichen angefordert werden soll. Die Standardeinstellung ist true.
enable_granular_consent boolean Optional. Sie können detaillierte Berechtigungen aktivieren. Wenn diese Option auf false festgelegt ist, werden die detaillierteren Google-Kontoberechtigungen für OAuth-Client-IDs deaktiviert, die vor 2019 erstellt wurden. Keine Auswirkungen auf OAuth-Client-IDs, die 2019 oder später erstellt wurden, da für diese immer detailliertere Berechtigungen aktiviert sind.
plugin_name string Optional. Wenn diese Option festgelegt ist, können Client-IDs, die vor dem 29. Juli 2022 erstellt wurden, die Google Platform Library verwenden. Standardmäßig ist die Verwendung der Plattformbibliothek für neu erstellte Client-IDs blockiert. Stattdessen muss die neuere Google Identity Services-Bibliothek verwendet werden. Sie können einen beliebigen Wert auswählen. Für eine einfache Identifizierung wird jedoch ein beschreibender Name wie der Produkt- oder Plug-in-Name empfohlen. Beispiel: plugin_name: 'YOUR_STRING_HERE'

gapi.auth2.AuthorizeResponse

Die Antwort, die an den Callback der Methode gapi.auth2.authorize zurückgegeben wurde.

Attribute
access_token string Das Zugriffstoken wurde gewährt. Nur vorhanden, wenn in response_type permission oder token angegeben wurde.
id_token string Das gewährte ID-Token. Nur vorhanden, wenn id_token in response_type angegeben wurde.
code string Der Autorisierungscode wurde gewährt. Nur vorhanden, wenn code in response_type angegeben wurde.
scope string Die im Zugriffstoken gewährten Bereiche. Nur vorhanden, wenn in response_type permission oder token angegeben wurde.
expires_in number Die Anzahl der Sekunden, bis das Zugriffstoken abläuft. Nur vorhanden, wenn in response_type permission oder token angegeben wurde.
first_issued_at number Der Zeitstempel, zu dem der Nutzer die angeforderten Berechtigungen erteilt hat. Nur vorhanden, wenn in der response_type permission oder token angegeben wurde.
expires_at number Der Zeitstempel, zu dem das Zugriffstoken abläuft. Nur vorhanden, wenn in response_type permission oder token angegeben wurde.
error string Wenn die Anfrage fehlgeschlagen ist, enthält dieser Parameter den Fehlercode.
error_subtype string Wenn die Anfrage fehlgeschlagen ist, kann dies zusätzliche Informationen zum zurückgegebenen Fehlercode enthalten.