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

In dieser Referenz werden die Methoden und Attribute des JavaScript-Clients beschrieben, mit denen du Google Log-in in deinen Webanwendungen implementieren kannst.

Wenn bei der Nutzung der Bibliothek ein Problem auftritt, melden Sie es bitte an unser GitHub-Repository.

Auth-Einrichtung

Laden Sie die Google API-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 es mit Ihrer OAuth 2.0-Client-ID und allen 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, das Schlüssel/Wert-Paare von Clientkonfigurationsdaten enthält. Unter gapi.auth2.ClientConfig finden Sie die verschiedenen konfigurierbaren Attribute. Beispiel:
{
  client_id: 'CLIENT_ID.apps.googleusercontent.com'
}
Rückgaben
gapi.auth2.GoogleAuth Das Objekt gapi.auth2.GoogleAuth. Verwenden Sie die Methode then(), um ein Versprechen abzurufen, 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 GoogleAuth-Objekt vollständig initialisiert wurde. Wenn während der Initialisierung ein Fehler auftritt (dies kann bei alten, nicht unterstützten Browsern passieren), wird stattdessen die Funktion onError aufgerufen.

Argumente
onInit Die Funktion, die mit dem GoogleAuth-Objekt aufgerufen wird, wenn es vollständig initialisiert wurde.
onError Die Funktion wurde mit einem Objekt aufgerufen, das ein error-Attribut enthält, wenn GoogleAuth nicht initialisiert werden konnte.
Rückgaben
Versprechen Ein Promise, der erfüllt wird, wenn die Funktion onInit abgeschlossen ist, oder abgelehnt wird, wenn ein Initialisierungsfehler aufgetreten ist. Es wird mit dem zurückgegebenen Wert der onInit-Funktion aufgelöst, falls vorhanden.

Fehlercodes

idpiframe_initialization_failed
Ein erforderlicher iFrame von Google konnte beispielsweise aufgrund einer nicht unterstützten Umgebung nicht initialisiert werden. Ein details-Attribut liefert weitere Informationen zum ausgegebenen 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 ein URI, single_host_origin oder none. Wenn kein Wert angegeben ist, 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“ gesetzt ist.
fetch_basic_profile boolean Allgemeine Profilinformationen der Nutzer bei der Anmeldung abrufen Fügt den angeforderten Bereichen „profile“, „email“ und „openid“ hinzu. „True“, wenn keine Angabe.
hosted_domain string Die G Suite-Domain, zu der Nutzer für die Anmeldung gehören müssen. Diese kann von Clients geändert werden. Prüfen Sie daher unbedingt die Property der gehosteten Domain des zurückgegebenen Nutzers. Verwende GoogleUser.getHostedDomain() auf dem Client und die hd-Anforderung im ID-Token auf dem Server, um zu bestätigen, dass die Domain deinen Erwartungen entspricht.
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 die standardmäßige redirect_uri überschreiben, die am Ende des Einwilligungsvorgangs verwendet wird. Die Standardeinstellung 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 Library verwendet werden. Neu erstellte Client-IDs werden jetzt standardmäßig für die Verwendung der Plattformbibliothek blockiert und müssen stattdessen die neuere Google Identity Services-Bibliothek verwenden. Sie können einen beliebigen Wert auswählen. Für eine einfache Identifizierung wird ein aussagekräftigen Namen 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 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 können.

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ückgaben
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.

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

GoogleAuth.isSignedIn.listen(listener)

Auf Änderungen im Anmeldestatus des aktuellen Nutzers warten.

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ückgaben
Versprechen Ein Promise, der mit der GoogleUser-Instanz ausgeführt wird, wenn der Nutzer erfolgreich authentifiziert und die angeforderten Bereiche gewährt, oder mit einem Objekt abgelehnt, das ein error-Attribut enthält, wenn ein Fehler aufgetreten ist (siehe Fehlercodes weiter unten).

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ückgaben
Versprechen Ein Promise, der mit der GoogleUser-Instanz ausgeführt wird, wenn der Nutzer erfolgreich authentifiziert und die angeforderten Bereiche gewährt, oder mit einem Objekt abgelehnt, das ein error-Attribut enthält, wenn ein Fehler aufgetreten ist (siehe Fehlercodes weiter unten).

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 verweigert.
immediate_failed
Es konnte kein Nutzer automatisch ausgewählt werden, ohne den Einwilligungsvorgang zu starten. Ein Fehler ist aufgetreten, wenn Sie signIn mit der Option prompt: 'none' verwenden. Diese Option sollte nicht erforderlich sein, da Nutzer mit gapi.auth2.init automatisch angemeldet werden, wenn sie sich in einer vorherigen Sitzung angemeldet haben.

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.
Mögliche 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. So kann ein Nutzer mit mehreren Konten aus mehreren Konten auswählen, für die er möglicherweise aktuelle Sitzungen hat.
  • none (nicht empfohlen)
    Der Autorisierungsserver zeigt keine Authentifizierungs- oder Nutzereinwilligungsbildschirme an. Wenn der Nutzer noch nicht authentifiziert ist und den angeforderten Bereichen noch nicht zugestimmt hat, wird ein Fehler zurückgegeben.
    Da ein zuvor angemeldeter Nutzer mit gapi.auth2.init automatisch bei der Anwendung angemeldet wird, schlägt der Aufruf von signIn({prompt: 'none'}) in der Regel fehl.
scope string Die Bereiche, die zusätzlich zu den in den gapi.auth2.init-Parametern definierten Bereichen angefordert werden sollen, als durch Leerzeichen getrennter String. 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 die standardmäßige redirect_uri überschreiben, die am Ende des Einwilligungsvorgangs verwendet wird. Die Standardeinstellung redirect_uri ist die aktuelle URL ohne Abfrageparameter und Hash-Fragment.

GoogleAuth.signOut()

Das aktuelle Konto wird aus der Anwendung abgemeldet.

Rückgaben
Versprechen Ein Promise, der erfüllt ist, wenn der Nutzer abgemeldet wurde.

GoogleAuth.disconnect()

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

GoogleAuth.grantOfflineAccess(options)

Holen Sie die Berechtigung vom Nutzer ein, 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'
}
Rückgaben
Versprechen Ein Promise, der ausgeführt wird, wenn der Nutzer die angeforderten Bereiche zuweist und ein Objekt mit dem Autorisierungscode an den Auftragsausführungs-Handler von 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 verweigert.
immediate_failed
Es konnte kein Nutzer automatisch ausgewählt werden, ohne den Einwilligungsvorgang zu starten. Ein Fehler ist aufgetreten, wenn Sie signIn mit der Option prompt: 'none' verwenden. Diese Option sollte nicht erforderlich sein, da Nutzer mit gapi.auth2.init automatisch angemeldet werden, wenn sie sich in einer vorherigen Sitzung angemeldet haben.

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.
Mögliche 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. So kann ein Nutzer mit mehreren Konten aus mehreren Konten auswählen, für die er möglicherweise aktuelle Sitzungen hat.
scope string Die Bereiche, die zusätzlich zu den in den gapi.auth2.init-Parametern definierten Bereichen angefordert werden sollen, als durch Leerzeichen getrennter String. 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 der Anmeldung aufgerufen werden soll.
onfailure Die Funktion, die aufgerufen werden soll, wenn die Anmeldung fehlschlägt.

Nutzende

Ein GoogleUser-Objekt steht für ein Nutzerkonto. GoogleUser-Objekte werden normalerweise 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ückgaben
GoogleUser Der aktuelle Nutzer

GoogleAuth.currentUser.listen(listener)

Auf Änderungen in currentUser warten.

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

GoogleUser.getId()

Ruft den eindeutigen ID-String des Nutzers ab.

Rückgaben
String Eindeutige ID des Nutzers

GoogleUser.isSignedIn()

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

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

GoogleUser.getHostedDomain()

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

Rückgaben
String G Suite-Domain des Nutzers

GoogleUser.getGrantedScopes()

Rufen Sie die vom Nutzer gewährten Bereiche als durch Leerzeichen getrennte Zeichenfolge ab.

Rückgaben
String Vom Nutzer gewährte Bereiche

GoogleUser.getBasicProfile()

Allgemeine Profilinformationen des Nutzers abrufen

Rückgaben
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)

Rufen Sie 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“ (Standardwert) ist und keine zusätzlichen Bereiche angefordert werden.
Rückgaben
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ückgaben
Promise Ein Promise, das mit dem neu geladenen gapi.auth2.AuthResponse beim Neuladen des OAuth-Tokens ausgeführt wird, ist abgeschlossen.

gapi.auth2.AuthResponse

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

Attribute
access_token string Der gewährte Zugriffstoken.
id_token string Das zugewiesene 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 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ückgaben
Boolesch True, wenn die Bereiche gewährt wurden

GoogleUser.grant(options)

Fordern Sie zusätzliche Bereiche für den Nutzer an.

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

GoogleUser.grantOfflineAccess(options)

Holen Sie die Berechtigung vom Nutzer ein, 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()

Hebt alle Bereiche auf, die der Nutzer der 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. 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 (Standardwert: profile).
width Die Breite der Schaltfläche in Pixeln (Standardwert: 120).
height Die Höhe der Schaltfläche in Pixeln (Standardwert: 36).
Langtitel Zeige lange Labels wie „Über Google anmelden“ anstelle von „Anmelden“ an (Standardeinstellung: false). Wenn du lange Titel verwendest, solltest du die Breite der Schaltfläche gegenüber der Standardeinstellung erhöhen.
Design Das Farbdesign der Schaltfläche: entweder light oder dark (Standardwert: light).
onsuccess Die Callback-Funktion, die aufgerufen wird, wenn sich ein Nutzer erfolgreich anmeldet. Diese Funktion muss ein Argument annehmen: eine Instanz von gapi.auth2.GoogleUser (Standardwert: keine).
OnFailure Die Callback-Funktion, die aufgerufen werden soll, wenn die Anmeldung fehlschlägt. Diese Funktion verwendet keine Argumente (Standardeinstellung: keine).

Erweitert

gapi.auth2.Authorize(params, callback)

Führt eine einmalige OAuth 2.0-Autorisierung aus. Abhängig von den verwendeten Parametern wird ein Pop-up für den Google-Anmeldevorgang geöffnet oder es wird versucht, die angeforderte Antwort automatisch und ohne Nutzerinteraktion zu laden.

Diese Methode ist unter anderem für folgende Anwendungsfälle nützlich:

  • Ihre Anwendung muss nur einmal einen Google API-Endpunkt anfordern, um beispielsweise die Lieblingsvideos des Nutzers bei der ersten Anmeldung zu laden.
  • Ihre Anwendung verfügt über eine eigene Infrastruktur zur Sitzungsverwaltung und benötigt das ID-Token nur einmal, um den Nutzer in Ihrem Back-End zu identifizieren.
  • Auf derselben Seite werden mehrere Client-IDs verwendet.
Argumente
params Ein Objekt, das Schlüssel/Wert-Paare von Konfigurationsdaten enthält. Unter gapi.auth2.AuthorizeConfig finden Sie die verschiedenen konfigurierbaren Attribute. Beispiel:
{
  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 fehlgeschlagen).

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 beispielsweise aufgrund einer nicht unterstützten Umgebung nicht initialisiert werden. Ein details-Attribut liefert weitere Informationen zum ausgegebenen 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 verweigert.
immediate_failed
Es konnte kein Nutzer automatisch ausgewählt werden, ohne den Einwilligungsvorgang zu starten. Ein Fehler ist aufgetreten, wenn Sie signIn mit der Option prompt: 'none' verwenden.

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 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 des Antworttyps, der durch Leerzeichen getrennt ist. Die Standardeinstellung ist 'permission'. Folgende Werte sind möglich:
  • 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. 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. So kann ein Nutzer mit mehreren Konten aus mehreren Konten auswählen, für die er möglicherweise aktuelle Sitzungen hat.
  • none
    Auf dem Autorisierungsserver werden keine Bildschirme zur Authentifizierung oder zur Nutzereinwilligung angezeigt. Wenn der Nutzer noch nicht authentifiziert ist und den angeforderten Bereichen noch nicht zugestimmt hat, wird ein Fehler zurückgegeben.
    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 ist, wird standardmäßig single_host_origin verwendet.
hosted_domain string Die G Suite-Domain, zu der Nutzer für die Anmeldung gehören müssen. Da dies anfällig für Änderungen durch Clients ist, müssen Sie die Property der gehosteten Domain des zurückgegebenen Nutzers bestätigen.
login_hint string Die E-Mail-Adresse oder User-ID eines Nutzers, der bei der Anmeldung vorab ausgewählt werden soll. Sie 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 umfasst, die der Nutzer zuvor der Anwendung gewährt hat, oder nur die beim aktuellen Aufruf angeforderten Bereiche. Die Standardeinstellung ist true.
plugin_name string Optional. Wenn festgelegt, kann die Google Platform Library für Client-IDs verwendet werden, die vor dem 29. Juli 2022 erstellt wurden. Standardmäßig wird die Verwendung der Plattformbibliothek durch neu erstellte Client-IDs blockiert. Stattdessen müssen sie die neuere Google Identity Services-Bibliothek verwenden. Sie können einen beliebigen Wert auswählen. Für die einfache Identifizierung wird ein aussagekräftigen Namen wie ein Produkt- oder Plug-in-Name empfohlen. 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 Der gewährte Zugriffstoken. Ist nur vorhanden, wenn permission oder token in der response_type angegeben wurde.
id_token string Das zugewiesene ID-Token. Ist nur vorhanden, wenn id_token in response_type angegeben wurde.
code string Der erteilte 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 in der response_type angegeben wurde.
expires_in number Die Anzahl der Sekunden, bis das Zugriffstoken abläuft. Ist nur vorhanden, wenn permission oder token in der 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 permission oder token in response_type angegeben wurde.
expires_at number Der Zeitstempel, zu dem das Zugriffstoken abläuft. Ist nur vorhanden, wenn permission oder token in der 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 dieser zusätzliche Informationen zum zurückgegebenen Fehlercode enthalten.