Die JavaScript-Plattformbibliothek für die Google Log-in wird für das Web eingestellt. Die Mediathek steht nach dem 31. März 2023 nicht mehr zum Download zur Verfügung. Verwenden Sie stattdessen die neuen Google Identity-Dienste für Web.
Standardmäßig hat die Erstellung neuer Client-IDs aufgrund der früheren Plattformbibliothek keine Auswirkungen. Bestehende Client-IDs sind davon nicht betroffen. Bei neuen Client-IDs, die vor dem 29. Juli 2022 erstellt wurden, kann `plugin_name` festgelegt werden, damit die Bibliothek verwendet werden kann.

Referenz zu Google Log-in-JavaScript-Clients

In dieser Referenz werden die JavaScript-Clientmethoden und -attribute beschrieben, die du zur Implementierung von Google Log-in in deinen Webanwendungen verwendest.

Wenn Sie ein Problem mit der Bibliothek feststellen, melden Sie dies bitte an unser GitHub-Repository.

Authentifizierung einrichten

Rufe die Google APIs-Plattformbibliothek auf, 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, lade 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 Objekt GoogleAuth. Sie müssen diese Methode aufrufen, bevor die Methoden von gapi.auth2.GoogleAuth aufgerufen werden.

Wenn Sie das GoogleAuth-Objekt initialisieren, konfigurieren Sie das Objekt mit Ihrer OAuth 2.0-Client-ID und allen zusätzlichen Optionen, die Sie angeben möchten. Wenn der Nutzer sich bereits angemeldet hat, wird der Anmeldestatus des Nutzers durch das Objekt GoogleAuth aus der vorherigen Sitzung wiederhergestellt.

Argumente
params Ein Objekt, das Schlüssel/Wert-Paare von Client-Konfigurationsdaten enthält. Informationen zu den verschiedenen konfigurierbaren Attributen findest du unter gapi.auth2.ClientConfig. Beispiel:
{
  client_id: 'CLIENT_ID.apps.googleusercontent.com'
}
Returns
gapi.auth2.GoogleAuth Das Objekt gapi.auth2.GoogleAuth Verwenden Sie die Methode then(), um ein Versprechen abzurufen, das aufgelöst wird, wenn das Initialisieren des Objekts gapi.auth2.GoogleAuth abgeschlossen ist.

GoogleAuth.then(onInit, onError)

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

Argumente
onInit Die Funktion, die mit dem Objekt GoogleAuth aufgerufen wird, wenn es vollständig initialisiert wurde.
onError Die Funktion, die mit einem Objekt aufgerufen wird, das eine error-Property enthält, wenn GoogleAuth nicht initialisiert werden konnte.
Returns
Partner Ein Promise, der ausgeführt wird, wenn die onInit-Funktion abgeschlossen ist, oder abgelehnt wird, wenn ein Initialisierungsfehler ausgelöst wird. Der Wert wird mit dem zurückgegebenen Wert der Funktion onInit zurückgegeben, falls vorhanden.

Fehlercodes

idpiframe_initialization_failed
Der erforderliche iFrame von Google konnte nicht initialisiert werden, z. B. wegen einer nicht unterstützten Umgebung. Eine details-Property enthält weitere Informationen zum ausgelösten 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 App, die in der Google Developers Console gefunden und erstellt wurde
cookie_policy string Die Domains, für die Anmeldecookies erstellt werden sollen. Entweder URI, single_host_origin oder none. Wenn keine Angabe erfolgt, wird der Standardwert single_host_origin verwendet.
scope string Die anzufordernden Bereiche als durch Leerzeichen getrennter String. Optional, wenn fetch_basic_profile nicht auf „false“ gesetzt ist.
fetch_basic_profile boolean Allgemeine Profilinformationen der Nutzer abrufen, wenn sie sich anmelden Fügt „profile“, „email“ und „openid“ zu den angeforderten Bereichen hinzu. „True“, wenn nicht angegeben.
hosted_domain string Die G Suite-Domain, zu der Nutzer gehören müssen. Diese Änderung ist anfällig für Clients, also musst du die Property der gehosteten Domain des zurückgegebenen Nutzers prüfen. Verwenden Sie GoogleUser.getHostedDomain() auf dem Client und die hd-Anforderung im ID-Token auf dem Server, um zu prüfen, ob die Domain Ihren Erwartungen entspricht.
ux_mode string Der UX-Modus, der für den Anmeldevorgang verwendet werden soll. Standardmäßig wird der Einwilligungsablauf in einem Pop-up-Fenster geöffnet. Gültige Werte sind popup und redirect.
redirect_uri string Wenn du ux_mode='redirect' verwendest, kannst du mit diesem Parameter den Standard-redirect_uri überschreiben, der am Ende des Einwilligungsablaufs verwendet wird. Der Standardwert für redirect_uri ist die aktuelle URL ohne Suchparameter und Hash-Fragment.
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. Die Erstellung der Platform Library für neu erstellte Client-IDs ist jetzt standardmäßig blockiert. Die neue Bibliothek muss die neue Google Identity Services-Bibliothek verwenden. Sie können einen beliebigen Wert auswählen. Zur Identifizierung wird ein beschreibender Name wie ein Produkt- oder Plug-in-Name empfohlen. Beispiel: plugin_name: 'YOUR_STRING_HERE'

Authentifizierung

GoogleAuth ist eine Singleton-Klasse. Sie bietet Methoden, mit denen sich Nutzer mit einem Google-Konto anmelden können. Außerdem wird der aktuelle Anmeldestatus des Nutzers abgerufen, bestimmte Daten aus dem Google-Profil des Nutzers abgerufen, weitere Bereiche angefordert und sich aus dem aktuelles Konto.

gapi.auth2.getAuthInstance()

Gibt das Objekt GoogleAuth zurück. Du musst das Objekt GoogleAuth mit gapi.auth2.init() initialisieren, bevor du diese Methode aufrufst.

Returns
gapi.auth2.GoogleAuth Das Objekt gapi.auth2.GoogleAuth Verwenden Sie dieses Objekt, um die Methoden von gapi.auth2.GoogleAuth aufzurufen.

GoogleAuth.isSignedIn.get()

Gibt an, ob der aktuelle Nutzer derzeit angemeldet ist.

Returns
Boolescher Wert true, wenn der Nutzer angemeldet ist, oder false, wenn der Nutzer abgemeldet ist oder das GoogleAuth-Objekt nicht initialisiert wurde.

GoogleAuth.isSignedIn.listen(Listener)

Achten Sie auf Änderungen im Anmeldestatus des aktuellen Nutzers.

Argumente
listener Eine Funktion, die einen booleschen Wert verwendet. listen() übergibt true an diese Funktion, wenn sich der Nutzer anmeldet, und false, wenn sich der Nutzer abmeldet.

GoogleAuth.signIn()

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

Returns
Partner Ein Promise, der mit der Instanz GoogleUser ausgeführt wird, wenn sich der Nutzer authentifiziert und die angeforderten Bereiche gewährt hat, oder wenn ein Objekt mit dem Attribut error abgelehnt wird, wenn ein Fehler aufgetreten ist (siehe .

Fehlercodes

Weitere Informationen findest du in den GoogleAuth.signIn(options).

GoogleAuth.signIn(options)

Nutzer wird mit den angegebenen Optionen angemeldet.

Argumente
options Entweder:
  • 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');
Returns
Partner Ein Promise, der mit der Instanz GoogleUser ausgeführt wird, wenn sich der Nutzer authentifiziert und die angeforderten Bereiche gewährt hat, oder wenn ein Objekt mit dem Attribut error abgelehnt wird, wenn ein Fehler aufgetreten ist (siehe .

Fehlercodes

popup_closed_by_user
Der Nutzer hat das Pop-up geschlossen, bevor die Anmeldung abgeschlossen wurde.
access_denied
Der Nutzer hat die Berechtigung für die erforderlichen Bereiche verweigert.
immediate_failed
Es konnte kein Nutzer automatisch ausgewählt werden, ohne dass die Einwilligung erteilt wird. Fehler bei der Verwendung von signIn mit der Option prompt: 'none'. Diese Option sollte nicht verwendet werden, da gapi.auth2.init den Nutzer automatisch anmeldet, wenn er 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 Einwilligungsablauf. Optional.
Folgende Werte sind möglich:
  • consent
    Der Autorisierungsserver fordert den Nutzer zur Einwilligung auf, bevor Informationen an die Anwendung zurückgegeben werden.
  • select_account
    Der Autorisierungsserver fordert den Nutzer auf, ein Google-Konto auszuwählen. Dadurch können Nutzer mit mehreren Konten aus mehreren Konten auswählen, für die sie möglicherweise aktuelle Sitzungen haben.
  • none (nicht empfohlen)
    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.
    Da gapi.auth2.init sich automatisch bei der jeweiligen Anwendung anmeldet, schlägt der Aufruf von signIn({prompt: 'none'}) normalerweise fehl.
scope string Die anzufordernden Bereiche als durch Leerzeichen getrennter String über den in den Parametern gapi.auth2.init 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 Einwilligungsablauf in einem Pop-up-Fenster geöffnet. Gültige Werte sind popup und redirect.
redirect_uri string Bei Nutzung vonux_mode='redirect' können Sie den Standardwertredirect_uri die am Ende des Einwilligungsprozesses verwendet wird. Der Standard-redirect_uri ist die aktuelle URL, die aus Suchparametern und Hash-Fragmenten entfernt wurde.

GoogleAuth.signOut()

Dadurch wird das aktuelle Konto von der Anwendung abgemeldet.

Returns
Partner Ein Promise, der ausgeführt wird, wenn der Nutzer abgemeldet ist.

GoogleAuth.disconnect()

Widerruft alle vom Nutzer gewährten Bereiche.

GoogleAuth.grantOfflineAccess(options)

Fordern Sie die Berechtigung des Nutzers an, offline auf die angegebenen Bereiche zuzugreifen.

Argumente
options Ein gapi.auth2.OfflineAccessOptions-Objekt, das Schlüssel/Wert-Paare von Parametern enthält. Beispiel:
{
  scope: 'profile email'
}
Returns
Partner Ein Promise, der ausgeführt wird, wenn der Nutzer die angeforderten Bereiche gewährt, indem ein Objekt mit dem Autorisierungscode an den Fulfillment-Handler Promise übergeben wird. 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 verweigert.
immediate_failed
Es konnte kein Nutzer automatisch ausgewählt werden, ohne dass die Einwilligung erteilt wird. Fehler bei der Verwendung von signIn mit der Option prompt: 'none'. Diese Option sollte nicht verwendet werden, da gapi.auth2.init den Nutzer automatisch anmeldet, wenn er 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 Einwilligungsablauf. Optional.
Folgende Werte sind möglich:
  • consent
    Der Autorisierungsserver fordert den Nutzer zur Einwilligung auf, bevor Informationen an die Anwendung zurückgegeben werden.
  • select_account
    Der Autorisierungsserver fordert den Nutzer auf, ein Google-Konto auszuwählen. Dadurch können Nutzer mit mehreren Konten aus mehreren Konten auswählen, für die sie möglicherweise aktuelle Sitzungen haben.
scope string Die anzufordernden Bereiche als durch Leerzeichen getrennter String über den in den Parametern gapi.auth2.init 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, das Schlüssel/Wert-Paare von Parametern enthält. Siehe GoogleAuth.signIn().
onsuccess Die Funktion, die nach Abschluss der Anmeldung aufgerufen werden soll.
onfailure Funktion, die aufgerufen wird, wenn bei der Anmeldung ein Fehler auftritt.

Nutzer

Ein GoogleUser-Objekt stellt ein Nutzerkonto dar. GoogleUser-Objekte werden in der Regel durch den Aufruf von GoogleAuth.currentUser.get() abgerufen.

GoogleAuth.currentUser.get()

Gibt ein GoogleUser-Objekt zurück, das den aktuellen Nutzer darstellt. Beachten Sie, dass in einer neu initialisierten GoogleAuth-Instanz der aktuelle Nutzer nicht festgelegt ist. Verwende die Methode currentUser.listen() oder GoogleAuth.then(), um eine initialisierte GoogleAuth-Instanz abzurufen.

Returns
GoogleUser Der aktuelle Nutzer

GoogleAuth.currentUser.listen(listener)

Achten Sie auf Änderungen am aktuellen Nutzer.

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

GoogleUser.getId()

Eindeutigen ID-String des Nutzers abrufen.

Returns
String Die eindeutige ID des Nutzers

GoogleUser.isSignedIn()

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

Returns
Boolescher Wert True, wenn der Nutzer angemeldet ist

GoogleUser.getHostedDomain()

Rufen Sie die G Suite-Domain des Nutzers auf, wenn er sich mit einem G Suite-Konto angemeldet hat.

Returns
String Die G Suite-Domain des Nutzers

GoogleUser.getGrantedScopes()

Rufen Sie die Bereiche ab, die der Nutzer als durch Leerzeichen getrennte Zeichenfolge erhalten hat.

Returns
String Die vom Nutzer gewährten Bereiche

GoogleUser.getBasicProfile()

Allgemeine Profilinformationen des Nutzers abrufen

Returns
gapi.auth2.BasicProfile Du kannst die Properties von gapi.auth2.BasicProfile mit den folgenden Methoden abrufen:
  • BasicProfile.getId()
  • BasicProfile.getName()
  • BasicProfile.getBiddingnName()
  • BasicProfile.getFamilyName()
  • BasicProfile.getImageUrl()
  • BasicProfile.getEmail()

GoogleUser.getAuthResponse(includeAutorisierungData)

Rufen Sie das Antwortobjekt aus der Authentifizierungssitzung des Nutzers ab.

Argumente
includeAuthorizationData Optional:Ein boolescher Wert, mit dem angegeben wird, ob ein Zugriffstoken und ein Bereich immer zurückgegeben werden sollen. Standardmäßig werden das Zugriffstoken und die angeforderten Bereiche nicht zurückgegeben, wenn fetch_basic_profile den Wert „true“ hat und keine zusätzlichen Bereiche angefordert werden.
Returns
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.

Returns
Promise Ein Promise, das beim Aktualisieren des OAuth-Tokens mit dem aktualisierten gapi.auth2.AuthResponse ausgeführt 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, das gewährt wurde.
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 zum ersten Mal die angeforderten Bereiche gewährt hat.
expires_at number Der Zeitstempel, nach 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.
Returns
Boolescher Wert True, wenn die Bereiche gewährt wurden

GoogleUser.grant(options)

Fordern Sie dem Nutzer weitere Bereiche an.

Unter GoogleAuth.signIn() finden Sie eine Liste der Parameter und des Fehlercodes.

GoogleUser.grantOfflineAccess(options)

Fordern Sie die Berechtigung des Nutzers an, offline auf die angegebenen Bereiche zuzugreifen.

Argumente
options Ein gapi.auth2.OfflineAccessOptions-Objekt, das Schlüssel/Wert-Paare von Parametern enthält. Beispiel:
{
  scope: 'profile email'
}

GoogleUser.disconnect()

Widerruft alle Umfänge, die der Nutzer für die Anwendung gewährt hat.

UI-Elemente

gapi.signin2.render(id, options)

Stellt eine Anmeldeschaltfläche im Element mit der angegebenen ID dar. Dabei werden die vom options-Objekt angegebenen Einstellungen verwendet.

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. Beispiele:
{
  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 beim Anmelden des Nutzers angefordert werden (Standard: profile).
width Breite der Schaltfläche in Pixeln (Standardeinstellung: 120).
Höhe Höhe der Schaltfläche in Pixeln (Standardeinstellung: 36).
Langtitel Lange Labels wie „Über Google anmelden“ statt „Anmelden“ anzeigen (Standardeinstellung: false). Bei langen Titeln sollten Sie die Standardbreite der Schaltfläche erhöhen.
Thema Das Farbdesign der Schaltfläche: entweder light oder dark (Standardeinstellung: light).
erfolgreich Die Callback-Funktion, die aufgerufen wird, wenn sich ein Nutzer erfolgreich anmeldet. Diese Funktion muss ein Argument übernehmen: eine Instanz von gapi.auth2.GoogleUser (Standardeinstellung: keine).
Fehler Die Callback-Funktion, die aufgerufen wird, wenn bei der Anmeldung ein Fehler auftritt. Diese Funktion verwendet keine Argumente (Standardeinstellung: keine).

Erweitert

gapi.auth2.authorized(params, callback)

Führt eine einmalige OAuth 2.0-Autorisierung durch. Je nachdem, welche Parameter verwendet werden, wird ein Pop-up-Fenster für den Google Log-in-Vorgang geöffnet oder es wird versucht, die angeforderte Antwort ohne weitere Interaktion im Hintergrund zu laden.

Hier einige Anwendungsfälle:

  • Ihre Anwendung muss einen Google API-Endpunkt nur einmal anfordern, z. B. um die Lieblingsvideos von YouTube bei der ersten Anmeldung zu laden.
  • Ihre Anwendung verfügt über eine eigene Sitzungsverwaltungsinfrastruktur und benötigt das ID-Token nur einmal, um den Nutzer in Ihrem Back-End zu identifizieren.
  • Mehrere Client-IDs werden auf derselben Seite verwendet.
Argumente
params Ein Objekt, das Schlüssel/Wert-Paare von Konfigurationsdaten enthält. Unter gapi.auth2.AuthorizeConfig finden Sie weitere Informationen zu den verschiedenen konfigurierbaren Attributen. Beispiel:
{
  client_id: 'CLIENT_ID.apps.googleusercontent.com',
  scope: 'email profile openid',
  response_type: 'id_token permission'
}
callback Eine Funktion, die nach Abschluss der Anfrage mit einem gapi.auth2.AuthorizeResponse-Objekt aufgerufen wird (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
Der erforderliche iFrame von Google konnte nicht initialisiert werden, z. B. wegen einer nicht unterstützten Umgebung. Eine details-Property enthält weitere Informationen zum ausgelösten Fehler.
popup_closed_by_user
Der Nutzer hat das Pop-up geschlossen, bevor die Anmeldung abgeschlossen wurde.
access_denied
Der Nutzer hat die Berechtigung für die erforderlichen Bereiche verweigert.
immediate_failed
Es konnte kein Nutzer automatisch ausgewählt werden, ohne dass die Einwilligung erteilt wird. Fehler bei der Verwendung von signIn mit der Option prompt: 'none'.

gapi.auth2.AutorisierenConfig

Schnittstelle, 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 Developers 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 Antworttyp. 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 Informationen an die Anwendung zurückgegeben werden.
  • select_account
    Der Autorisierungsserver fordert den Nutzer auf, ein Google-Konto auszuwählen. Dadurch können Nutzer mit mehreren Konten aus mehreren Konten auswählen, für die sie möglicherweise aktuelle Sitzungen haben.
  • 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, wird der zurückgegebene Code nur gegen einen access_token und nicht gegen einen refresh_token ausgetauscht.
cookie_policy string Die Domains, für die Anmeldecookies erstellt werden sollen. Entweder URI, single_host_origin oder none. Wenn keine Angabe erfolgt, wird der Standardwert single_host_origin verwendet.
hosted_domain string Die G Suite-Domain, zu der Nutzer gehören müssen. Das ist anfällig für Änderungen von Clients. Prüfen Sie daher die Property der gehosteten Domain des zurückgegebenen Nutzers.
login_hint string Die E-Mail-Adresse oder Nutzer-ID eines Nutzers, der im Anmeldevorgang vorab ausgewählt werden soll. Dieses ist anfällig für Änderungen durch den Nutzer, sofern prompt: "none" nicht verwendet wird.
include_granted_scopes boolean Gibt an, ob ein Zugriffstoken angefordert werden soll, das alle zuvor vom Nutzer der Anwendung gewährten Bereiche oder nur die im aktuellen Aufruf angeforderten Bereiche enthält. Die Standardeinstellung ist true.
plugin_name string Optional. Wenn die Einstellung aktiviert ist, können für Client-IDs, die vor dem 29. Juli 2022 erstellt wurden, die Google Platform-Bibliothek verwendet werden. Standardmäßig wird die Verwendung der Plattformbibliothek für neu erstellte Client-IDs blockiert und muss stattdessen die neue Bibliothek von Google Identity Services verwenden. Sie können einen beliebigen Wert auswählen. Zur Identifizierung wird ein beschreibender Name wie ein Produkt- oder Plug-in-Name empfohlen. Beispiel: plugin_name: 'YOUR_STRING_HERE'

gapi.auth2.AuthorizeResponse

Die Antwort wird auf den Callback der Methode gapi.auth2.authorize zurückgegeben.

Attribute
access_token string Das Zugriffstoken wurde gewährt. Nur vorhanden, wenn permission oder token in response_type angegeben wurde.
id_token string Das ID-Token, das gewährt wurde. Ist nur vorhanden, wenn id_token in response_type angegeben wurde.
code string Der Autorisierungscode wurde gewährt. 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 in response_type angegeben wurde.
expires_in number Die Anzahl der Sekunden, bis das Zugriffstoken abläuft. Ist nur vorhanden, wenn permission oder token in response_type angegeben wurde.
first_issued_at number Der Zeitstempel, zu dem der Nutzer zum ersten Mal die angeforderten Bereiche gewährt hat. Ist nur vorhanden, wenn permission oder token in response_type angegeben wurde.
expires_at number Der Zeitstempel, nach dem das Zugriffstoken abläuft. Ist nur vorhanden, wenn permission oder token in response_type angegeben wurde.
error string Wenn die Anfrage fehlgeschlagen ist, enthält sie den Fehlercode.
error_subtype string Wenn die Anfrage fehlgeschlagen ist, kann diese auch zusätzliche Informationen zum Fehlercode enthalten, der ebenfalls zurückgegeben wurde.