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

In dieser Referenz werden die JavaScript-Clientmethoden und -attribute beschrieben, mit denen du Google Log-in in deinen Webanwendungen implementierst.

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

Auth-Einrichtung

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

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

Nachdem die Plattformbibliothek geladen wurde, laden Sie die auth2-Bibliothek:

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 aufrufen, bevor Sie die Methoden von gapi.auth2.GoogleAuth aufrufen.

Beim Initialisieren des GoogleAuth-Objekts konfigurieren Sie das Objekt mit Ihrer OAuth 2.0-Client-ID und zusätzlichen Optionen, die Sie angeben möchten. Wenn sich der Nutzer dann 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. Weitere Informationen zu den verschiedenen konfigurierbaren Eigenschaften finden Sie unter gapi.auth2.ClientConfig. Beispiele: 
{
  client_id: 'CLIENT_ID.apps.googleusercontent.com'
}
Rückgabe
gapi.auth2.GoogleAuth Das gapi.auth2.GoogleAuth-Objekt. Verwenden Sie die Methode then(), um ein Promise zu erhalten, das aufgelöst wird, wenn die Initialisierung des gapi.auth2.GoogleAuth-Objekts abgeschlossen ist.

GoogleAuth.then(onInit, onError)

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

Argumente
onInit Die Funktion, die mit dem GoogleAuth-Objekt aufgerufen wird, wenn sie vollständig initialisiert wurde.
onError Die Funktion, die mit einem Objekt aufgerufen wird, das eine error-Eigenschaft enthält, wenn GoogleAuth nicht initialisiert werden konnte.
Rückgabe
Versprechen Ein Promise, das erfüllt ist, wenn die Funktion onInit abgeschlossen ist, oder abgelehnt wird, wenn ein Initialisierungsfehler aufgetreten ist. Sie wird mit dem zurückgegebenen Wert der onInit-Funktion aufgelöst, sofern 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 liefert weitere Informationen zum gemeldeten Fehler.

gapi.auth2.ClientConfig

Schnittstelle, die die verschiedenen Konfigurationsparameter für die Methode gapi.auth2.init darstellt.

Parameter
client_id string Erforderlich. Die Client-ID der Anwendung, die in der Google API Console gefunden und erstellt wurde.
cookie_policy string Die Domains, für die Anmeldecookies erstellt werden sollen. Entweder ein URI, single_host_origin oder none. Wenn kein Wert angegeben wird, wird standardmäßig single_host_origin verwendet.
scope string Die anzufordernden Bereiche als durch Leerzeichen getrennter String. Optional, wenn fetch_basic_profile nicht auf „false“ festgelegt ist.
fetch_basic_profile boolean Grundlegende Profilinformationen von Nutzern bei der Anmeldung abrufen Fügt den angeforderten Bereichen „profile“, „email“ und „openid“ hinzu. "True", wenn nicht angegeben.
hosted_domain string Die G Suite-Domain, zu der Nutzer gehören müssen, um sich anzumelden. Diese kann von Clients geändert werden. Achten Sie daher darauf, das Attribut der gehosteten Domain des zurückgegebenen Nutzers zu überprüfen. Verwenden Sie GoogleUser.getHostedDomain() auf dem Client und die hd-Anforderung im ID-Token auf dem Server, um zu überprüfen, ob die Domain Ihren Erwartungen entspricht.
use_fedcm boolean Optional, der Standardwert ist True. Verwendung der FedCM APIs des Browsers während der Anmeldung aktivieren oder deaktivieren.
ux_mode string Der UX-Modus, der für den Anmeldevorgang verwendet werden soll. Standardmäßig wird der Einwilligungsvorgang in einem Pop-up geöffnet. Gültige Werte sind popup und redirect.
redirect_uri string Wenn Sie ux_mode='redirect' verwenden, können Sie mit diesem Parameter die Standardeinstellung redirect_uri überschreiben, die am Ende des Einwilligungsvorgangs verwendet wird. Die Standardeinstellung redirect_uri ist die aktuelle URL ohne Abfrageparameter und Hash-Fragment.
enable_granular_consent boolean Optional. Sie können detaillierte Berechtigungen aktivieren. Wenn false festgelegt ist, werden die detaillierteren Berechtigungen des Google-Kontos für OAuth-Client-IDs deaktiviert, die vor 2019 erstellt wurden. Keine Auswirkungen auf OAuth-Client-IDs, die 2019 oder danach erstellt wurden, da detailliertere Berechtigungen für sie immer aktiviert sind.
plugin_name string Optional. Wenn dieser Wert festgelegt ist, kann für neue Client-IDs, die vor dem 29. Juli 2022 erstellt wurden, die ältere Google Platform-Bibliothek verwendet werden. Neu erstellte Client-IDs dürfen die Plattformbibliothek standardmäßig nicht mehr verwenden. Stattdessen muss die neuere Google Identity Services-Bibliothek verwendet werden. Sie können einen beliebigen Wert auswählen. Zur Identifizierung wird ein aussagekräftigen Name wie ein Produkt- oder Plug-in-Name empfohlen. Beispiel: plugin_name: 'YOUR_STRING_HERE'

Authentifizierung

GoogleAuth ist eine Singleton-Klasse, die Methoden bereitstellt, mit denen sich der Nutzer mit einem Google-Konto anmelden, den aktuellen Anmeldestatus des Nutzers abrufen, bestimmte Daten aus dem Google-Profil des Nutzers abrufen, zusätzliche Bereiche anfordern und sich vom aktuellen Konto abmelden kann.

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.

Rückgabe
gapi.auth2.GoogleAuth Das gapi.auth2.GoogleAuth-Objekt. Verwenden Sie dieses Objekt, um die Methoden von gapi.auth2.GoogleAuth aufzurufen.

GoogleAuth.isSignedIn.get()

Gibt an, ob der aktuelle Nutzer angemeldet ist.

Rückgabe
Boolesch true, wenn der Nutzer angemeldet ist, oder false, wenn der Nutzer abgemeldet ist oder das GoogleAuth-Objekt nicht initialisiert wird.

GoogleAuth.isSignedIn.listen(listener)

Beobachten Sie Änderungen am Anmeldestatus des aktuellen Nutzers.

Argumente
listener Eine Funktion, die einen booleschen Wert annimmt. listen() übergibt true an diese Funktion, 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.

Rückgabe
Versprechen Ein Promise, der mit der Instanz GoogleUser ausgeführt wird, wenn sich der Nutzer erfolgreich authentifiziert und die angeforderten Bereiche zuweist, oder bei einem Fehler mit einem Objekt mit einem error-Attribut abgelehnt wird. Die Fehlercodes finden Sie im nächsten Abschnitt.

Fehlercodes

GoogleAuth.signIn(options) ansehen.

GoogleAuth.signIn(options)

Meldet den Nutzer mit den angegebenen Optionen an.

Argumente
options Sie haben folgende Möglichkeiten:
  • Ein gapi.auth2.SignInOptions-Objekt, das Schlüssel/Wert-Paare von Anmeldeparametern enthält. 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');
Rückgabe
Versprechen Ein Promise, das mit der Instanz GoogleUser ausgeführt wird, wenn sich der Nutzer erfolgreich authentifiziert und die angeforderten Bereiche zuweist, oder mit einem Objekt abgelehnt wird, das ein error-Attribut enthält, wenn ein Fehler aufgetreten ist (Fehlercodes siehe unten).

Fehlercodes

popup_closed_by_user
Der Nutzer hat das Pop-up geschlossen, bevor er die Anmeldung abgeschlossen hat.
access_denied
Der Nutzer hat die Berechtigung für die erforderlichen Bereiche abgelehnt.
immediate_failed
Es konnte kein Nutzer automatisch ausgewählt werden, ohne den Einwilligungsvorgang auszulösen. Bei der Verwendung von signIn mit der Option prompt: 'none' ist ein Fehler aufgetreten. Diese Option sollte nicht erforderlich sein, da der Nutzer von gapi.auth2.init automatisch angemeldet wird, wenn er zuvor während einer vorherigen Sitzung angemeldet war.

gapi.auth2.SignInOptions

Schnittstelle, die die verschiedenen Konfigurationsparameter für die Methode GoogleAuth.signIn(options) darstellt.

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

GoogleAuth.signOut()

Hiermit wird das aktuelle Konto aus der Anwendung abgemeldet.

Rückgabe
Versprechen Eine Promise, die ausgeführt wird, wenn der Nutzer abgemeldet wurde.

GoogleAuth.disconnect()

Hebt alle Bereiche auf, die der Nutzer gewährt hat.

GoogleAuth.grantOfflineAccess(options)

Berechtigung vom Nutzer einholen, um offline auf die angegebenen Bereiche zuzugreifen.

Argumente
options Ein gapi.auth2.OfflineAccessOptions-Objekt mit Schlüssel/Wert-Paaren von Parametern. Beispiel: 
{
  scope: 'profile email'
}
Rückgabe
Versprechen Ein Promise, das erfüllt wird, wenn der Nutzer die angeforderten Bereiche zuweist und ein Objekt mit dem Autorisierungscode an den Auftragsausführungs-Handler der Promise ü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 konnte kein Nutzer automatisch ausgewählt werden, ohne den Einwilligungsvorgang auszulösen. Bei der Verwendung von signIn mit der Option prompt: 'none' ist ein Fehler aufgetreten. Diese Option sollte nicht erforderlich sein, da der Nutzer von gapi.auth2.init automatisch angemeldet wird, wenn er zuvor während einer vorherigen Sitzung angemeldet war.

gapi.auth2.OfflineAccessOptions

Schnittstelle, die die verschiedenen Konfigurationsparameter für die Methode GoogleAuth.grantOfflineAccess(options) darstellt.

Parameter
prompt string Erzwingt einen bestimmten Modus für den Einwilligungsvorgang. Optional.
Folgende Werte sind möglich:
  • consent
    Der Autorisierungsserver fordert den Nutzer um seine Zustimmung, bevor Informationen an die Anwendung zurückgegeben werden.
  • select_account
    Der Autorisierungsserver fordert den Nutzer auf, ein Google-Konto auszuwählen. So kann ein Nutzer mit mehreren Konten aus den verschiedenen Konten auswählen, für die er aktuelle Sitzungen haben kann.
scope string Die anzufordernden Bereiche als durch Leerzeichen getrennter String zusätzlich zu den in den Parametern gapi.auth2.init definierten Bereichen. Optional, wenn fetch_basic_profile nicht auf „false“ festgelegt 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 Element div, an das der Klick-Handler angehängt werden soll.
options Ein Objekt, das Schlüssel/Wert-Paare von Parametern enthält. Weitere Informationen finden Sie unter GoogleAuth.signIn().
onsuccess Die nach der Anmeldung aufzurufende Funktion.
onfailure Die aufzurufende Funktion, 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. In einer neu initialisierten GoogleAuth-Instanz wurde der aktuelle Nutzer nicht festgelegt. Verwenden Sie die Methode currentUser.listen() oder GoogleAuth.then(), um eine initialisierte GoogleAuth-Instanz abzurufen.

Rückgabe
GoogleUser Der aktuelle Nutzer

GoogleAuth.currentUser.listen(listener)

Beobachten Sie Änderungen in currentUser.

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

GoogleUser.getId()

Rufen Sie den eindeutigen ID-String des Nutzers ab.

Rückgabe
String Die eindeutige ID des Nutzers

GoogleUser.isSignedIn()

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

Rückgabe
Boolesch „True“, wenn der Nutzer angemeldet ist

GoogleUser.getHostedDomain()

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

Rückgabe
String Die G Suite-Domain des Nutzers

GoogleUser.getGrantedScopes()

Die vom Nutzer zugewiesenen Bereiche als durch Leerzeichen getrennter String abrufen.

Rückgabe
String Die vom Nutzer gewährten Bereiche

GoogleUser.getBasicProfile()

Grundlegende Profilinformationen des Nutzers abrufen

Rückgabe
gapi.auth2.BasicProfile Sie können die Attribute von gapi.auth2.BasicProfile mit den folgenden Methoden abrufen:
  • BasicProfile.getId()
  • BasicProfile.getName()
  • BasicProfile.getGivenName()
  • BasicProfile.getFamilyName()
  • BasicProfile.getImageUrl()
  • BasicProfile.getEmail()

GoogleUser.getAuthResponse(includeAuthorizationData)

Ruft 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 den Wert „true“ hat (Standardwert) und keine zusätzlichen Bereiche angefordert werden.
Rückgabe
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.

Rückgabe
Promise Ein Promise, der beim erneuten Laden 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 ID-Token wurde gewährt.
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 Bereiche erstmals gewährt hat.
expires_at number Der Zeitstempel, zu dem das Zugriffstoken abläuft.

GoogleUser.hasGrantedScopes(scopes)

Gibt "true" zurück, wenn der Nutzer die angegebenen Bereiche gewährt hat.

Argumente
scopes Ein durch Leerzeichen getrennter String von Bereichen.
Rückgabe
Boolesch „True“, wenn die Bereiche gewährt wurden

GoogleUser.grant(options)

Fordern Sie zusätzliche Bereiche an den Nutzer an.

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

GoogleUser.grantOfflineAccess(options)

Berechtigung vom Nutzer einholen, um 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()

Hebt alle Bereiche auf, 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 bei der Anmeldung des Nutzers angefordert werden sollen (Standardeinstellung: profile).
width Die Breite der Schaltfläche in Pixeln (Standard: 120).
height Höhe der Schaltfläche in Pixeln (Standard: 36).
LangerTitel Zeigt lange Labels wie „Über Google anmelden“ anstelle von „Anmelden“ an (Standardeinstellung: false). Wenn Sie lange Titel verwenden, sollten Sie die Breite der Schaltfläche gemäß der Standardeinstellung vergrößern.
Design Das Farbdesign der Schaltfläche: entweder light oder dark (Standardeinstellung: light).
bei Erfolg Die Callback-Funktion, die aufgerufen wird, wenn sich ein Nutzer erfolgreich anmeldet. Diese Funktion muss ein Argument verwenden: eine Instanz von gapi.auth2.GoogleUser (Standardeinstellung: kein).
bei Fehlern Die Callback-Funktion, die aufgerufen wird, wenn die Anmeldung fehlschlägt. Diese Funktion akzeptiert keine Argumente (Standardeinstellung: keine).

Profi

gapi.auth2.authorized(params, callback)

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

Einige Anwendungsfälle, in denen diese Methode nützlich ist:

  • Ihre Anwendung muss einen Google API-Endpunkt nur einmal anfordern, um beispielsweise die YouTube-Lieblingsvideos des Nutzers bei der ersten Anmeldung zu laden.
  • Ihre Anwendung hat eine eigene Infrastruktur für die Sitzungsverwaltung und benötigt das ID-Token nur einmal, um den Nutzer in Ihrem Back-End zu identifizieren.
  • Innerhalb einer Seite werden mehrere Client-IDs verwendet.
Argumente
params Ein Objekt mit Schlüssel/Wert-Paaren von Konfigurationsdaten. Weitere Informationen zu den verschiedenen konfigurierbaren Eigenschaften finden Sie unter gapi.auth2.AuthorizeConfig. 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
Fehler beim Initialisieren eines erforderlichen iFrames von Google aufgrund einer nicht unterstützten Umgebung. Das Attribut details liefert weitere Informationen zum gemeldeten Fehler.
popup_closed_by_user
Der Nutzer hat das Pop-up geschlossen, bevor er die Anmeldung abgeschlossen hat.
access_denied
Der Nutzer hat die Berechtigung für die erforderlichen Bereiche abgelehnt.
immediate_failed
Es konnte kein Nutzer automatisch ausgewählt werden, ohne den Einwilligungsvorgang auszulösen. Bei der Verwendung von signIn mit der Option prompt: 'none' ist ein Fehler aufgetreten.

gapi.auth2.AuthorizeConfig

Schnittstelle, die die verschiedenen Konfigurationsparameter für die Methode gapi.auth2.authorize darstellt.

Attribute
client_id string Erforderlich. Die Client-ID der Anwendung, 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 getrennten Antworttypen. Die Standardeinstellung ist 'permission'. Folgende Werte sind möglich:
  • id_token, zum Abrufen eines ID-Tokens
  • permission (oder token), um ein Zugriffstoken abzurufen
  • code, zum Abrufen eines Autorisierungscodes
prompt string Erzwingt einen bestimmten Modus für den Einwilligungsvorgang. Folgende Werte sind möglich:
  • consent
    Der Autorisierungsserver fordert den Nutzer um seine Zustimmung, bevor Informationen an die Anwendung zurückgegeben werden.
  • select_account
    Der Autorisierungsserver fordert den Nutzer auf, ein Google-Konto auszuwählen. So kann ein Nutzer mit mehreren Konten aus den verschiedenen Konten auswählen, für die er aktuelle Sitzungen haben kann.
  • none
    Der Autorisierungsserver zeigt keine Authentifizierungs- oder Nutzereinwilligungsbildschirme an. Es wird ein Fehler zurückgegeben, wenn der Nutzer noch nicht authentifiziert ist und noch nicht in die angeforderten Bereiche eingewilligt hat.
    Wenn code als Antworttyp angefordert wird, kann der zurückgegebene Code nur gegen access_token und nicht gegen refresh_token ausgetauscht werden.
cookie_policy string Die Domains, für die Anmeldecookies erstellt werden sollen. Entweder ein URI, single_host_origin oder none. Wenn kein Wert angegeben wird, wird standardmäßig single_host_origin verwendet.
hosted_domain string Die G Suite-Domain, zu der Nutzer gehören müssen, um sich anzumelden. Dieser ist anfällig für Änderungen durch Clients. Achten Sie daher darauf, das Attribut der gehosteten Domain des zurückgegebenen Nutzers zu überprüfen.
login_hint string Die E-Mail-Adresse oder User-ID eines Nutzers, die während des Anmeldevorgangs vorab ausgewählt werden soll. Dies kann vom Nutzer geändert werden, sofern nicht prompt: "none" verwendet wird.
include_granted_scopes boolean Gibt an, ob ein Zugriffstoken angefordert werden soll, das alle Bereiche enthält, die der Nutzer zuvor der Anwendung gewährt hat, oder nur die beim aktuellen Aufruf angeforderten Bereiche. Die Standardeinstellung ist true.
enable_granular_consent boolean Optional. Sie können detaillierte Berechtigungen aktivieren. Wenn false festgelegt ist, werden die detaillierteren Berechtigungen des Google-Kontos für OAuth-Client-IDs deaktiviert, die vor 2019 erstellt wurden. Keine Auswirkungen auf OAuth-Client-IDs, die 2019 oder danach erstellt wurden, da detailliertere Berechtigungen für sie immer aktiviert sind.
plugin_name string Optional. Falls festgelegt, können Client-IDs, die vor dem 29. Juli 2022 erstellt wurden, die Google Platform-Bibliothek verwenden. Neu erstellte Client-IDs dürfen die Plattformbibliothek standardmäßig nicht verwenden. Stattdessen muss die neuere Google Identity Services-Bibliothek verwendet werden. Sie können einen beliebigen Wert auswählen. Wir empfehlen einen aussagekräftigen Namen wie einen Produkt- oder Plug-in-Namen, damit Sie ihn leicht identifizieren können. Beispiel: plugin_name: 'YOUR_STRING_HERE'

gapi.auth2.AuthorizeResponse

Die an den Callback der Methode gapi.auth2.authorize zurückgegebene Antwort.

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