In dieser Referenz werden die JavaScript-Clientmethoden und -attribute beschrieben, die du zur Implementierung von Google Log-in in deinen Webanwendungen verwendest.
Wenn bei der Verwendung der Bibliothek Probleme auftreten, melden Sie diese bitte an unser GitHub-Repository.
Authentifizierung einrichten
Laden Sie die Google APIs-Plattformbibliothek, um das gapi
-Objekt zu erstellen:
<script src="https://apis.google.com/js/platform.js? 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 etwaigen 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. Informationen zu den verschiedenen konfigurierbaren Attributen finden Sie 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 Promise-Objekt 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 onError-Funktion aufgerufen.
Argumente | |
---|---|
onInit |
Die Funktion, die mit dem Objekt GoogleAuth aufgerufen wird, wenn es vollständig initialisiert wurde.
|
onError |
Die Funktion wurde mit einem Objekt aufgerufen, das das Attribut error enthält, wenn GoogleAuth nicht initialisiert werden konnte.
|
Returns | |
---|---|
Versprechen | Ein Promise , der erfüllt ist, wenn die onInit-Funktion abgeschlossen ist, oder abgelehnt wird, wenn ein Initialisierungsfehler aufgetreten ist. Sie wird mit dem von der onInit-Funktion zurückgegebenen Wert aufgelöst, sofern vorhanden. |
Fehlercodes
idpiframe_initialization_failed
-
Ein erforderlicher iFrame von Google konnte beispielsweise aufgrund einer nicht unterstützten Umgebung nicht initialisiert werden. Das Attribut
details
liefert weitere Informationen zum aufgetretenen 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 wird, wird standardmäßig single_host_origin verwendet. |
scope |
string |
Die anzufragenden Bereiche als durch Leerzeichen getrennter String. Optional, wenn fetch_basic_profile nicht auf „false“ gesetzt ist. |
fetch_basic_profile |
boolean |
Allgemeine Profilinformationen von Nutzern 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 zur Anmeldung gehören müssen. Da es anfällig für Änderungen durch Clients ist, müssen Sie die Property der gehosteten Domain des zurückgegebenen Nutzers überprüfen. Verwenden Sie GoogleUser.getHostedDomain() auf dem Client und die hd -Anforderung im ID-Token auf dem Server, um zu bestätigen, dass die Domain Ihren 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 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 Standard-redirect_uri überschreiben, die am Ende des Einwilligungsvorgangs verwendet wird. Der Standard-redirect_uri ist die aktuelle URL ohne Abfrageparameter und Hash-Fragment.
|
enable_granular_consent |
boolean |
Optional. Gibt an, ob detaillierte Berechtigungen aktiviert werden sollen. Wenn false festgelegt ist, werden die detaillierteren Google-Kontoberechtigungen für OAuth-Client-IDs deaktiviert, die vor 2019 erstellt wurden. Dies hat keine Auswirkungen auf OAuth-Client-IDs, die in oder nach 2019 erstellt wurden, da für sie immer detailliertere Berechtigungen aktiviert sind.
|
plugin_name |
string |
Optional. Wenn dieser Wert festgelegt ist, können neue Client-IDs, die vor dem 29. Juli 2022 erstellt wurden, die ältere Google Platform Library verwenden.
Neu erstellte Client-IDs dürfen die Platform Library jetzt nicht mehr verwenden. Stattdessen müssen sie die neuere Google Identity Services-Bibliothek verwenden. Sie können einen beliebigen Wert auswählen. Ein aussagekräftiger Name wie ein Produkt- oder Plug-in-Name wird für eine einfache Identifizierung 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.
Returns | |
---|---|
gapi.auth2.GoogleAuth |
Das Objekt gapi.auth2.GoogleAuth . Verwende dieses Objekt, um die Methoden von gapi.auth2.GoogleAuth aufzurufen.
|
GoogleAuth.isSignedIn.get()
Gibt an, ob der aktuelle Nutzer derzeit angemeldet ist
Returns | |
---|---|
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.
Returns | |
---|---|
Versprechen | Ein Promise , der mit der GoogleUser -Instanz ausgeführt wird, wenn 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 (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:
|
Returns | |
---|---|
Versprechen | Ein Promise , der mit der GoogleUser -Instanz ausgeführt wird, wenn 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 (siehe Fehlercodes weiter 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 verweigert.
immediate_failed
-
Es kann kein Nutzer automatisch ausgewählt werden, ohne dass der Einwilligungsvorgang ausgelöst wird. Ein Fehler ist aufgetreten, wenn
signIn
mit der Optionprompt: 'none'
verwendet wird. Diese Option sollte nicht erforderlich sein, da Nutzer mitgapi.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:
|
scope |
string |
Die anzufordernden Bereiche als durch Leerzeichen getrennter String zusätzlich zu den in den gapi.auth2.init -Parametern definierten Bereichen. Optional, wenn fetch_basic_profile nicht auf „false“ gesetzt ist.
|
ux_mode |
string |
Der UX-Modus, der für den Anmeldevorgang verwendet werden soll. Standardmäßig wird der Einwilligungsvorgang in einem Pop-up 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 Standard-redirect_uri überschreiben, die am Ende des Einwilligungsvorgangs verwendet wird. Der Standard-redirect_uri ist die aktuelle URL ohne Suchparameter und Hash-Fragment.
|
GoogleAuth.signOut()
Das aktuelle Konto wird aus der Anwendung abgemeldet.
Returns | |
---|---|
Versprechen | Ein Promise , das erfüllt ist, wenn der Nutzer abgemeldet wurde. |
GoogleAuth.disconnect()
Hebt alle vom Nutzer gewährten Bereiche auf.
GoogleAuth.grantOfflineAccess(options)
Bitten Sie den Nutzer, 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 | |
---|---|
Versprechen | Ein Promise , das ausgeführt wird, wenn der Nutzer die angeforderten Bereiche zugibt 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 der Einwilligungsvorgang abgeschlossen wurde.
access_denied
- Der Nutzer hat die Berechtigung für die erforderlichen Bereiche verweigert.
immediate_failed
-
Es kann kein Nutzer automatisch ausgewählt werden, ohne dass der Einwilligungsvorgang ausgelöst wird. Ein Fehler ist aufgetreten, wenn
signIn
mit der Optionprompt: 'none'
verwendet wird. Diese Option sollte nicht erforderlich sein, da Nutzer mitgapi.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:
|
scope |
string |
Die anzufordernden Bereiche als durch Leerzeichen getrennter String zusätzlich zu den in den gapi.auth2.init -Parametern definierten Bereichen. Optional, wenn fetch_basic_profile nicht auf „false“ gesetzt ist.
|
GoogleAuth.attachClickHandler(container, options, onsuccess, onfailure)
Hängt den Anmeldevorgang an den Klick-Handler des angegebenen Containers an.
Argumente | |
---|---|
container | Die ID oder ein Verweis auf das div -Element, an das der Klick-Handler angehängt werden soll. |
options | Ein Objekt, 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. |
Nutzer
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.
Returns | |
---|---|
GoogleUser |
Der aktuelle Nutzer |
GoogleAuth.currentUser.listen(listener)
Beobachten Sie Änderungen in currentUser.
Argumente | |
---|---|
listener |
Eine Funktion, die einen GoogleUser -Parameter annimmt.
listen übergibt dieser Funktion bei jeder Änderung, die currentUser ändert, eine GoogleUser -Instanz.
|
GoogleUser.getId()
Rufen Sie den eindeutigen ID-String des Nutzers ab.
Returns | |
---|---|
String | Eindeutige ID des Nutzers |
GoogleUser.isSignedIn()
Gibt „true“ zurück, wenn der Nutzer angemeldet ist.
Returns | |
---|---|
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.
Returns | |
---|---|
String | G Suite-Domain des Nutzers |
GoogleUser.getGrantedScopes()
Rufen Sie die vom Nutzer gewährten Bereiche als durch Leerzeichen getrennte Zeichenfolge ab.
Returns | |
---|---|
String | Vom Nutzer gewährte Bereiche |
GoogleUser.getBasicProfile()
Allgemeine Profilinformationen des Nutzers abrufen
Returns | |
---|---|
gapi.auth2.BasicProfile |
Sie können die Attribute von gapi.auth2.BasicProfile mit den folgenden Methoden abrufen:
|
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. |
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 erneuten Laden des OAuth-Tokens mit dem neu geladenen gapi.auth2.AuthResponse ausgefüllt 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 |
Das 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. |
Returns | |
---|---|
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)
Bitten Sie den Nutzer, 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 für die Anwendung erteilt hat.
UI-Elemente
gapi.signin2.render(id, options)
Rendert eine Anmeldeschaltfläche im Element mit der angegebenen ID. Dazu 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:
|
Erweitert
gapi.auth2.authorized(params, callback)
Führt eine einmalige OAuth 2.0-Autorisierung durch. Abhängig von den verwendeten Parametern wird dadurch ein Pop-up-Fenster für die Google-Anmeldung geöffnet oder es wird versucht, die angeforderte Antwort stumm und ohne Nutzerinteraktion zu laden.
Diese Methode eignet sich unter anderem für folgende Anwendungsfälle:
- Ihre Anwendung muss nur einmal einen Google API-Endpunkt anfordern, um beispielsweise die Lieblingsvideos eines Nutzers bei der ersten Anmeldung zu laden.
- Ihre Anwendung hat 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 Eigenschaften. 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. Das Attribut
details
liefert weitere Informationen zum aufgetretenen 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 verweigert.
immediate_failed
-
Es kann kein Nutzer automatisch ausgewählt werden, ohne dass der Einwilligungsvorgang ausgelöst wird. Ein Fehler ist aufgetreten, wenn
signIn
mit der Optionprompt: 'none'
verwendet wird.
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 anzufragenden Bereiche als durch Leerzeichen getrennter String. |
response_type |
string |
Eine Liste eines durch Leerzeichen getrennten Antworttyps. Die Standardeinstellung ist 'permission' . Mögliche Werte sind:
|
prompt |
string |
Erzwingt einen bestimmten Modus für den Einwilligungsablauf. Folgende Werte sind möglich:
|
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 zur Anmeldung gehören müssen. Da es anfällig für Änderungen durch Clients ist, müssen Sie die Property der gehosteten Domain des zurückgegebenen Nutzers überprüfen. |
login_hint |
string |
Die E-Mail-Adresse oder User-ID eines Nutzers, der bei der Anmeldung vorab ausgewählt werden soll. Diese kann vom Nutzer geändert werden, es sei denn, prompt: "none" wird verwendet.
|
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 im aktuellen Aufruf angeforderten Bereiche. Die Standardeinstellung ist true .
|
enable_granular_consent |
boolean |
Optional. Gibt an, ob detaillierte Berechtigungen aktiviert werden sollen. Wenn false festgelegt ist, werden die detaillierteren Google-Kontoberechtigungen für OAuth-Client-IDs deaktiviert, die vor 2019 erstellt wurden. Dies hat keine Auswirkungen auf OAuth-Client-IDs, die in oder nach 2019 erstellt wurden, da für sie immer detailliertere Berechtigungen aktiviert sind.
|
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. Neu erstellte Client-IDs dürfen die Plattformbibliothek standardmäßig nicht verwenden. Sie müssen stattdessen die neuere Google Identity Services-Bibliothek verwenden. Sie können einen beliebigen Wert auswählen. Ein aussagekräftiger Name wie ein Produkt- oder Plug-in-Name wird für eine einfache Identifizierung 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 |
Das 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 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 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 ebenfalls zurückgegebenen Fehlercode enthalten. |