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

<ph type="x-smartling-placeholder">

In dieser Referenz werden die JavaScript-Clientmethoden und -attribute beschrieben, die Sie verwenden, um Google Log-in in deinen Webanwendungen zu implementieren.

Wenn du Probleme bei der Nutzung der Bibliothek feststellst, melde sie an 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 finden Sie unter gapi.auth2.ClientConfig für die verschiedenen Eigenschaften konfiguriert werden. Beispiel: 
{
  client_id: 'CLIENT_ID.apps.googleusercontent.com'
}
Gibt Folgendes zurück:
gapi.auth2.GoogleAuth Das gapi.auth2.GoogleAuth-Objekt. Verwenden Sie die Methode then()-Methode zum Abrufen eines Promise-Objekts das aufgelöst wird, wenn das gapi.auth2.GoogleAuth-Objekt fertig ist. die Initialisierung bei.

GoogleAuth.then(onInit, onError)

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

Argumente
onInit Die Funktion, die mit dem GoogleAuth-Objekt aufgerufen wird, wenn es vollständig ist initialisiert.
onError Die Funktion, die mit einem Objekt aufgerufen wird, das eine error-Eigenschaft enthält GoogleAuth konnte nicht initialisiert werden.
Gibt Folgendes zurück:
Versprechen Eine Promise, die erfüllt ist, wenn die onInit abgeschlossen oder abgelehnt wurde, wenn ein Initialisierungsfehler ausgelöst wurde. Es löst sich mit dem wird von der Funktion onInit zurückgegeben, falls vorhanden.
<ph type="x-smartling-placeholder">

Fehlercodes

idpiframe_initialization_failed
Ein erforderlicher iFrame von Google konnte nicht initialisiert werden, z. B. aufgrund eines nicht unterstützten iFrames. zu verbessern. Das Attribut details liefert weitere Informationen zum gemeldeten Fehler.

gapi.auth2.ClientConfig

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

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. Standardeinstellung: single_host_origin, falls nicht angegeben.
scope string Die anzufordernden Bereiche als durch Leerzeichen getrennter String. Optional, wenn fetch_basic_profile ist nicht auf „false“ gesetzt.
fetch_basic_profile boolean Nutzer abrufen grundlegende Profilinformationen zu erhalten. Fügt „profile“, „email“ hinzu und „openid“ auf die angeforderten Bereiche. "True", wenn nicht angegeben.
hosted_domain string Die G Suite-Domain, zu der Nutzer gehören müssen, um sich anzumelden. Dieses ist anfällig für Änderungen durch Kunden. Überprüfen Sie daher gehostete Domain des zurückgegebenen Nutzers. Verwenden Sie GoogleUser.getHostedDomain() auf und die hd-Anforderung im ID-Token auf der um zu bestätigen, dass die Domain Ihren Erwartungen entspricht. <ph type="x-smartling-placeholder">
use_fedcm boolean Optional, der Standardwert ist True. Die Verwendung von Browser-FedCM APIs bei der Anmeldung.
ux_mode string Der UX-Modus, der für den Anmeldevorgang verwendet werden soll. Standardmäßig wird der Zustimmungsvorgang geöffnet. in einem Pop-up-Fenster öffnen. Gültige Werte sind popup und redirect.
redirect_uri string Bei Verwendung von ux_mode='redirect' können Sie mit diesem Parameter den Parameter Standardmäßiges redirect_uri, das am Ende des Einwilligungsvorgangs verwendet wird. Die Der Standardwert von redirect_uri ist die aktuelle URL ohne Suchparameter und Hash Fragment.
enable_granular_consent boolean Optional. Aktivieren Granular Berechtigungen Wenn false festgelegt ist, gilt: Je detaillierter Google Kontoberechtigungen werden für OAuth-Client-IDs deaktiviert, die erstellt wurden vor dem 2019 Keine Auswirkungen auf OAuth-Client-IDs, die 2019 oder danach erstellt wurden. für sie immer aktiviert sind.
plugin_name string Optional. Wenn dieser Wert festgelegt ist, werden neue Client-IDs verwendet, die vor Juli erstellt wurden. Ab dem 29. Juli 2022 kann die ältere Google Platform-Bibliothek verwendet werden. Standardmäßig wird die Verwendung von neu erstellten Client-IDs blockiert. die Plattformbibliothek verwenden. Stattdessen muss die neuere Google Identity-Version verwendet werden. Dienstbibliothek. Sie können einen beliebigen Wert auswählen, z. B. einen aussagekräftigen Namen wie Produkt- oder Plug-in-Name zur Identifizierung 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.

Gibt Folgendes zurück:
gapi.auth2.GoogleAuth Das Objekt gapi.auth2.GoogleAuth. Verwenden Sie dieses Objekt für den Aufruf Methoden von gapi.auth2.GoogleAuth.

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 Der Nutzer ist abgemeldet oder das GoogleAuth-Objekt ist nicht initialisiert.

GoogleAuth.isSignedIn.listen(listener)

Beobachten Sie Änderungen am Anmeldestatus des aktuellen Nutzers.

Argumente
listener Eine Funktion, die einen booleschen Wert annimmt. listen() Karten/Tickets true an diese Funktion senden, wenn sich der Nutzer anmeldet, und false, wenn sich der Nutzer abmeldet.

GoogleAuth.signIn()

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

Gibt Folgendes zurück:
Versprechen Ein Promise, der mit der Instanz GoogleUser ausgeführt wird, wenn der Der Nutzer authentifiziert sich und gewährt die angeforderten Bereiche oder wird mit einem Objekt abgelehnt error-Eigenschaft enthält, wenn ein Fehler aufgetreten ist. Weitere Informationen finden Sie in der im nächsten Abschnitt für Fehlercodes.

Fehlercodes

GoogleAuth.signIn(options) ansehen.

GoogleAuth.signIn(options)

Meldet den Nutzer mit den angegebenen Optionen an.

Argumente
options Dazu haben Sie zwei Möglichkeiten: <ph type="x-smartling-placeholder">
    </ph>
  • Ein gapi.auth2.SignInOptions-Objekt mit Schlüssel/Wert-Paaren von Anmeldeparametern. Beispiel: 
    {
  scope: 'profile email'
}
  • Eine Instanz von gapi.auth2.SigninOptionsBuilder. Hier ein 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:
Versprechen Ein Promise, der mit der Instanz GoogleUser ausgeführt wird, wenn der Der Nutzer authentifiziert sich und gewährt die angeforderten Bereiche oder wird mit einem Objekt abgelehnt error-Eigenschaft enthalten, 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 aufzurufen. Fehler aufgetreten, wenn mit signIn mit der Option prompt: 'none'. Diese Option sollte nicht erforderlich, da gapi.auth2.init den Nutzer automatisch anmeldet, wenn während einer vorherigen Sitzung angemeldet waren.

gapi.auth2.SignInOptions

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

Parameter
prompt string Erzwingt einen bestimmten Modus für den Einwilligungsvorgang. Optional.
Folgende Werte sind möglich: <ph type="x-smartling-placeholder">
    </ph>
  • consent
    Der Autorisierungsserver fordert den Nutzer vor der Rückgabe auf an die Anwendung senden.
  • select_account
    Der Autorisierungsserver fordert den Nutzer auf, ein Google-Konto auszuwählen. Dieses ermöglicht es einem Nutzer mit mehreren Konten, aus den verschiedenen Konten auszuwählen. für die aktuelle Sitzungen vorliegen.
  • none (nicht empfohlen)
    Der Autorisierungsserver zeigt keine Authentifizierung oder Nutzereinwilligung an Bildschirmen; wird ein Fehler zurückgegeben, wenn der Nutzer noch nicht authentifiziert ist hat den angeforderten Bereichen noch nicht zugestimmt.
    Da gapi.auth2.init einen Nutzer automatisch in der wenn Sie zuvor angemeldet waren, ruft der signIn({prompt: 'none'}) schlägt in der Regel fehl.
scope string Die anzufragenden Bereiche als durch Leerzeichen getrennter String, zusätzlich zu den in den gapi.auth2.init Parameter. Optional, wenn fetch_basic_profile nicht festgelegt ist auf false setzen.
ux_mode string Der UX-Modus, der für den Anmeldevorgang verwendet werden soll. Standardmäßig wird der Zustimmungsvorgang geöffnet. in einem Pop-up-Fenster öffnen. Gültige Werte sind popup und redirect.
redirect_uri string Bei Verwendung von ux_mode='redirect' können Sie mit diesem Parameter die standardmäßige redirect_uri, die am Ende der Einwilligung verwendet wird Ablauf. Der Standardwert für redirect_uri ist die aktuelle URL ohne die Suchanfrage. Parameter und Hash-Fragment.

GoogleAuth.signOut()

Hiermit wird das aktuelle Konto aus der Anwendung abgemeldet.

Gibt Folgendes zurück:
Versprechen Eine Promise, die erfüllt ist, wenn der Nutzer signiert wurde aus.

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, das Schlüssel/Wert-Paare von Parametern enthält. Beispiel: 
{
  scope: 'profile email'
}
Gibt Folgendes zurück:
Versprechen Eine Promise, die erfüllt ist, wenn der Nutzer den angefragten Bereichen und übergeben ein Objekt, das den Autorisierungscode enthält, an Auftragsausführungs-Handler des Promise. 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 aufzurufen. Fehler aufgetreten, wenn mit signIn mit der Option prompt: 'none'. Diese Option sollte nicht erforderlich, da gapi.auth2.init den Nutzer automatisch anmeldet, wenn während einer vorherigen Sitzung angemeldet waren.

gapi.auth2.OfflineAccessOptions

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

Parameter
prompt string Erzwingt einen bestimmten Modus für den Einwilligungsvorgang. Optional.
Folgende Werte sind möglich: <ph type="x-smartling-placeholder">
    </ph>
  • consent
    Der Autorisierungsserver fordert den Nutzer vor der Rückgabe auf an die Anwendung senden.
  • select_account
    Der Autorisierungsserver fordert den Nutzer auf, ein Google-Konto auszuwählen. Dieses ermöglicht es einem Nutzer mit mehreren Konten, aus den verschiedenen Konten auszuwählen. für die aktuelle Sitzungen vorliegen.
<ph type="x-smartling-placeholder">
scope string Die anzufragenden Bereiche als durch Leerzeichen getrennter String, zusätzlich zu den in den gapi.auth2.init Parameter. Optional, wenn fetch_basic_profile nicht festgelegt ist auf false setzen.

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, auf das verwiesen werden soll den Klick-Handler anhängen.
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()

GoogleAuth.currentUser.get()

Gibt ein GoogleUser-Objekt zurück das den aktuellen Nutzer darstellt. Beachten Sie, dass in einem neu initialisierten GoogleAuth vorhanden ist, wurde der aktuelle Nutzer nicht festgelegt. Verwenden Sie die Methode Methode currentUser.listen() oder GoogleAuth.then() zum Abrufen einer initialisierten GoogleAuth-Instanz.

Gibt Folgendes zurück:
GoogleUser Der aktuelle Nutzer

GoogleAuth.currentUser.listen(listener)

Beobachten Sie Änderungen in currentUser.

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

GoogleUser.getId()

Rufen Sie 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 „True“, 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 zugewiesenen Bereiche als durch Leerzeichen getrennter String abrufen.

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

GoogleUser.getBasicProfile()

Grundlegende Profilinformationen des Nutzers abrufen

Gibt Folgendes zurück:
gapi.auth2.BasicProfile Sie können die Attribute von gapi.auth2.BasicProfile abrufen. mithilfe der folgenden Methoden: <ph type="x-smartling-placeholder">
    </ph>
  • 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 zurückgegeben und Bereiche. Standardmäßig werden das Zugriffstoken und die angeforderten Bereiche nicht zurückgegeben, wenn fetch_basic_profile ist „true“ (Standardwert) und es werden keine zusätzlichen Bereiche angefordert.
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, der mit dem neu geladenen Element erfüllt wird gapi.auth2.AuthResponse, wenn die OAuth-Token abgeschlossen.

gapi.auth2.AuthResponse

Die beim Aufruf zurückgegebene Antwort GoogleUser.getAuthResponse(includeAuthorizationData) oder GoogleUser.reloadAuthResponse() .

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.
Gibt Folgendes zurück:
Boolesch „True“, wenn die Bereiche gewährt wurden

GoogleUser.grant(options)

Fordern Sie zusätzliche Bereiche an den Nutzer an.

Unter GoogleAuth.signIn() finden Sie eine Liste der und Fehlercodes enthält.

GoogleUser.grantOfflineAccess(options)

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

Rendert eine Anmeldeschaltfläche im Element mit der angegebenen ID mithilfe von Die vom Objekt options 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 festlegen:
Parameter
Bereich Die Bereiche, die bei der Anmeldung des Nutzers angefordert werden sollen (Standardeinstellung: profile.
Breite Die Breite der Schaltfläche in Pixeln (Standard: 120).
Höhe Höhe der Schaltfläche in Pixeln (Standard: 36).
LangerTitel Lange Labels wie „Über Google anmelden“ anzeigen statt „Anmelden“ (Standardeinstellung: false). Wenn Sie lange Titel verwenden, sollten Sie die Breite der Schaltfläche im Vergleich zur 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 annehmen: eine Instanz von gapi.auth2.GoogleUser (Standardeinstellung: keiner).
bei Fehlern Die Callback-Funktion, die aufgerufen werden soll, wenn die Anmeldung fehlschlägt. Diese Funktion nimmt keine Argumente an (Standardeinstellung: keine).

Erweitert

<ph type="x-smartling-placeholder">

gapi.auth2.authorized(params, callback)

Führt eine einmalige OAuth 2.0-Autorisierung durch. Je nach den verwendeten Parametern wird dabei ein Pop-up-Fenster zum Google-Anmeldevorgang hinzufügen oder versuchen, die angeforderte Antwort im Hintergrund und ohne Interaktion des Nutzers zu laden.

Diese Methode kann unter anderem in folgenden Anwendungsfällen nützlich sein:

  • Ihre Anwendung muss nur einmal einen Google API-Endpunkt anfordern, z. B. um Lieblingsvideos des Nutzers bei der ersten Anmeldung aufrufen
  • Ihre Anwendung verfügt über eine eigene Sitzungsverwaltungsinfrastruktur und benötigt nur die ID-Token einmal, um den Nutzer in Ihrem Backend zu identifizieren.
  • Innerhalb einer Seite werden mehrere Client-IDs verwendet.
<ph type="x-smartling-placeholder">
Argumente
params Ein Objekt mit Schlüssel/Wert-Paaren von Konfigurationsdaten. Weitere Informationen finden Sie unter gapi.auth2.AuthorizeConfig für den verschiedene Eigenschaften konfigurieren. 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 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
Beispielsweise konnte ein erforderlicher iFrame von Google nicht initialisiert werden, da er nicht unterstützt wird. zu verbessern. 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 aufzurufen. Fehler aufgetreten, wenn mit signIn mit der Option prompt: 'none'.

gapi.auth2.AuthorizeConfig

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

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'. Die möglichen Werte sind: <ph type="x-smartling-placeholder">
    </ph>
  • 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: <ph type="x-smartling-placeholder">
    </ph>
  • consent
    Der Autorisierungsserver fordert den Nutzer vor der Rückgabe auf an die Anwendung senden.
  • select_account
    Der Autorisierungsserver fordert den Nutzer auf, ein Google-Konto auszuwählen. Dieses ermöglicht es einem Nutzer mit mehreren Konten, aus den verschiedenen Konten auszuwählen. für die aktuelle Sitzungen vorliegen.
  • none
    Der Autorisierungsserver zeigt keine Authentifizierung oder Nutzereinwilligung an Bildschirmen; wird ein Fehler zurückgegeben, wenn der Nutzer noch nicht authentifiziert ist hat den angeforderten Bereichen noch nicht zugestimmt.
    Wenn code als Antworttyp angefordert wird, wird der zurückgegebene Code nur kann gegen access_token ausgetauscht werden, nicht gegen refresh_token. <ph type="x-smartling-placeholder">
cookie_policy string Die Domains, für die Anmeldecookies erstellt werden sollen. Entweder ein URI, single_host_origin oder none. Standardeinstellung: single_host_origin, falls nicht angegeben.
hosted_domain string Die G Suite-Domain, zu der Nutzer gehören müssen, um sich anzumelden. Diese sind anfällig für Modifizierungen. von Clients gesendet werden. 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 ist anfällig für Änderungen durch den Nutzer, es sei denn, prompt: "none" wird verwendet.
include_granted_scopes boolean Gibt an, ob ein Zugriffstoken angefordert werden soll, das alle zuvor vom Nutzer gewährten Bereiche enthält an die Anwendung oder nur auf die Bereiche, die im aktuellen Aufruf angefordert wurden. Die Standardeinstellung ist true.
enable_granular_consent boolean Optional. Aktivieren Granular Berechtigungen Wenn false festgelegt ist, gilt: Je detaillierter Google Kontoberechtigungen werden für OAuth-Client-IDs deaktiviert, die erstellt wurden vor dem 2019 Keine Auswirkungen auf OAuth-Client-IDs, die 2019 oder danach erstellt wurden. für sie immer aktiviert sind.
plugin_name string Optional. Falls für Client-IDs, die vor dem 29. Juli 2022 erstellt wurden, Folgendes festgelegt ist: Google Platform-Bibliothek. Neu erstellte Client-IDs werden standardmäßig blockiert. Plattformbibliothek verwenden. Stattdessen muss die neuere Google Identity Services-Bibliothek. Sie können einen beliebigen Wert wählen, einen aussagekräftigen Namen wie der Produkt- oder Plug-in-Name, werden empfohlen, um die Identifizierung zu erleichtern. Beispiel: plugin_name: 'YOUR_STRING_HERE'

gapi.auth2.AuthorizeResponse

Die an die Callback-Funktion des gapi.auth2.authorize-Methode.

Attribute
access_token string Das Zugriffstoken wurde gewährt. Nur vorhanden, wenn permission oder token war in response_type angegeben.
id_token string Das ID-Token wurde gewährt. Nur vorhanden, wenn id_token im Feld response_type.
code string Der gewährte Autorisierungscode. Nur vorhanden, wenn code im Feld response_type.
scope string Die im Zugriffstoken gewährten Bereiche. Nur vorhanden, wenn permission oder token wurde in response_type angegeben.
expires_in number Die Anzahl der Sekunden, bis das Zugriffstoken abläuft. Nur vorhanden, wenn permission oder token wurde in response_type angegeben.
first_issued_at number Der Zeitstempel, zu dem der Nutzer die angeforderten Bereiche erstmals gewährt hat. Nur vorhanden, wenn permission oder token wurde in response_type angegeben.
expires_at number Der Zeitstempel, zu dem das Zugriffstoken abläuft. Nur vorhanden, wenn permission oder token wurde in response_type angegeben.
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 Fehlercode enthalten. zurückgegeben.