In questo riferimento vengono descritti gli attributi e i metodi del client JavaScript che utilizzerai per implementare Accedi con Google nelle tue applicazioni web.
Se riscontri problemi nell'utilizzo della libreria, segnalali al nostro repository GitHub.
Configurazione di autenticazione
Carica la libreria della piattaforma API di Google per creare l'oggetto gapi
:
<script src="https://apis.google.com/js/platform.js?onload=init" async defer></script>
Al termine del caricamento della libreria della piattaforma, carica la libreria auth2
:
function init() {
gapi.load('auth2', function() {
/* Ready. Make a call to gapi.auth2.init or some other API */
});
}
gapi.auth2.init(params)
Inizializza l'oggetto GoogleAuth
. Devi chiamare questo metodo prima di chiamare i metodi di gapi.auth2.GoogleAuth
.
Quando si inizializza l'oggetto GoogleAuth
, si configura l'oggetto con l'ID client OAuth 2.0 ed eventuali opzioni aggiuntive da specificare. Quindi, se l'utente ha già eseguito l'accesso, l'oggetto GoogleAuth
ripristina lo stato di accesso dell'utente della sessione precedente.
Argomenti | |
---|---|
params |
Un oggetto contenente coppie chiave-valore di dati di configurazione del client. Consulta
gapi.auth2.ClientConfig per le diverse
proprietà configurabili. Ad esempio:
{ client_id: 'CLIENT_ID.apps.googleusercontent.com' } |
Valori restituiti | |
---|---|
gapi.auth2.GoogleAuth |
L'oggetto gapi.auth2.GoogleAuth . Utilizza il metodo then() per ottenere una promessa che viene risolta al termine dell'inizializzazione dell'oggetto gapi.auth2.GoogleAuth .
|
GoogleAuth.then(onInit, onError)
Richiama la funzione onInit quando l'oggetto GoogleAuth
è completamente
inizializzato. Se viene generato un errore durante l'inizializzazione (può verificarsi nei vecchi browser non supportati),
viene chiamata la funzione onError.
Argomenti | |
---|---|
onInit |
La funzione chiamata con l'oggetto GoogleAuth quando è completamente inizializzata.
|
onError |
La funzione chiamata con un oggetto contenente una proprietà error ,
se l'inizializzazione di GoogleAuth non è riuscita.
|
Valori restituiti | |
---|---|
Promesso | Una Promise che è soddisfatta quando la funzione onInit
è stata completata o rifiutata se è stato generato un errore di inizializzazione. Viene risolto con il
valore restituito dalla funzione onInit, se presente. |
Codici di errore
idpiframe_initialization_failed
-
Impossibile inizializzare un iframe obbligatorio da Google, ad esempio a causa di un ambiente non supportato. Una proprietà
details
fornirà ulteriori informazioni sull'errore generato.
gapi.auth2.ClientConfig
Interfaccia che rappresenta i diversi parametri di configurazione per il metodo gapi.auth2.init
.
Parametri | ||
---|---|---|
client_id |
string |
Obbligatorio. L'ID client dell'app, trovato e creato nella console API di Google. |
cookie_policy |
string |
I domini per i quali creare cookie di accesso. Un URI, single_host_origin o none . Se non specificato, il valore predefinito è
single_host_origin . |
scope |
string |
Gli ambiti da richiedere, come stringa delimitata da spazi. Facoltativo se il valore fetch_basic_profile non è impostato su false. |
fetch_basic_profile |
boolean |
Recupera le informazioni di base del profilo di un utente al momento dell'accesso. Aggiunge "profile", "email" e "openid" agli ambiti richiesti. True se non specificato. |
hosted_domain |
string |
Il dominio G Suite a cui gli utenti devono appartenere per accedere. Questo
è soggetto a modifiche da parte del client, quindi assicurati di verificare
la proprietà del dominio ospitato dell'utente restituito. Utilizza
GoogleUser.getHostedDomain() sul
client e la richiesta hd nel token ID sul
server per verificare che il dominio sia quello previsto.
|
use_fedcm |
boolean |
Facoltativo, il valore predefinito è True . Abilita o disabilita l'utilizzo delle API FedCM del browser durante l'accesso. |
ux_mode |
string |
La modalità UX da utilizzare per il flusso di accesso. Per impostazione predefinita, il flusso di consenso si aprirà in un popup. I valori validi sono popup e redirect . |
redirect_uri |
string |
Se utilizzi ux_mode='redirect' , questo parametro ti consente di eseguire l'override del valore predefinito redirect_uri che verrà utilizzato al termine del flusso di consenso. Il valore predefinito redirect_uri è l'URL corrente senza i parametri di query e il frammento hash.
|
enable_granular_consent |
boolean |
Campo facoltativo. Indica se abilitare le autorizzazioni granulari. Se impostato su false , le autorizzazioni più granulari dell'Account Google verranno disattivate per gli ID client OAuth creati prima del
2019. Nessun effetto per gli ID client OAuth creati durante o dopo il 2019, dal momento che
sono sempre abilitate autorizzazioni più granulari.
|
plugin_name |
string |
Campo facoltativo. Se questo valore è impostato, i nuovi ID client creati prima del 29 luglio 2022 possono utilizzare la libreria della piattaforma Google precedente.
Per impostazione predefinita, agli ID client appena creati viene impedito l'utilizzo della libreria della piattaforma, ma devono utilizzare la più recente libreria di Google Identity Services. Puoi scegliere qualsiasi valore, ma per l'identificazione è consigliato un nome descrittivo come il nome del prodotto o del plug-in.
Esempio: plugin_name: 'YOUR_STRING_HERE'
|
Autenticazione
GoogleAuth
è una classe singleton che fornisce metodi per consentire all'utente di accedere con un Account Google, ottenere lo stato di accesso attuale dell'utente, ottenere dati specifici dal profilo Google dell'utente, richiedere ambiti aggiuntivi e uscire dall'account corrente.
gapi.auth2.getAuthInstance()
Restituisce l'oggetto GoogleAuth
. Devi inizializzare l'oggetto GoogleAuth
con gapi.auth2.init()
prima di chiamare questo metodo.
Valori restituiti | |
---|---|
gapi.auth2.GoogleAuth |
L'oggetto gapi.auth2.GoogleAuth . Utilizza questo oggetto per chiamare i metodi di gapi.auth2.GoogleAuth .
|
GoogleAuth.isSignedIn.get()
Indica se l'utente corrente ha eseguito l'accesso.
Valori restituiti | |
---|---|
Booleano |
true se l'utente ha eseguito l'accesso o false se
l'utente non ha eseguito l'accesso o l'oggetto GoogleAuth non è
inizializzato.
|
GoogleAuth.isSignedIn.listen(listener)
Monitora i cambiamenti nello stato di accesso dell'utente corrente.
Argomenti | |
---|---|
listener |
Una funzione che prende un valore booleano. listen() passa
true a questa funzione quando l'utente accede e
false quando l'utente esce.
|
GoogleAuth.signIn()
Accede all'utente con le opzioni specificate su gapi.auth2.init()
.
Valori restituiti | |
---|---|
Promesso | Un Promise che viene completato con l'istanza GoogleUser quando
l'utente autentica e concede gli ambiti richiesti correttamente oppure viene rifiutato con un oggetto
contenente una proprietà error se si è verificato un errore. Consulta la
sezione successiva per conoscere i codici di errore. |
Codici di errore
Leggi i GoogleAuth.signIn(options)
.
GoogleAuth.signIn(options)
Esegue l'accesso dell'utente utilizzando le opzioni specificate.
Argomenti | |
---|---|
options |
Una di queste soglie:
|
Valori restituiti | |
---|---|
Promesso | Un Promise che viene completato con l'istanza GoogleUser quando
l'utente autentica e concede gli ambiti richiesti oppure viene rifiutato con un oggetto
contenente una proprietà error in caso di errore (vedi di seguito i codici di errore). |
Codici di errore
popup_closed_by_user
- L'utente ha chiuso il popup prima di terminare il flusso di accesso.
access_denied
- L'utente ha negato l'autorizzazione per gli ambiti richiesti.
immediate_failed
-
Nessun utente può essere selezionato automaticamente senza richiedere il flusso di consenso. Errore generato quando si utilizza
signIn
con l'opzioneprompt: 'none'
. Non è necessario utilizzare questa opzione, in quantogapi.auth2.init
eseguirà automaticamente l'accesso dell'utente se ha eseguito l'accesso in precedenza durante una sessione precedente.
gapi.auth2.SignInOptions
Interfaccia che rappresenta i diversi parametri di configurazione per il
metodo GoogleAuth.signIn(options)
.
Parametri | ||
---|---|---|
prompt |
string |
Forza una modalità specifica per il flusso di consenso. Campo facoltativo. I valori possibili sono:
|
scope |
string |
Gli ambiti da richiedere, come stringa delimitata da spazi, oltre agli ambiti definiti nei
parametri gapi.auth2.init . Facoltativo se fetch_basic_profile non è impostato su false.
|
ux_mode |
string |
La modalità UX da utilizzare per il flusso di accesso. Per impostazione predefinita, il flusso di consenso si aprirà in un popup. I valori validi sono popup e redirect . |
redirect_uri |
string |
Se utilizzi ux_mode='redirect' , questo parametro ti consente di eseguire l'override
del valore redirect_uri predefinito che verrà utilizzato al termine del flusso
di consenso. Il valore predefinito redirect_uri è l'URL corrente senza i parametri di query e il frammento hash.
|
GoogleAuth.signOut()
Disconnette l'account corrente dall'applicazione.
Valori restituiti | |
---|---|
Promesso | Un Promise che viene completato quando l'utente è stato disconnesso. |
GoogleAuth.disconnect()
Revoca tutti gli ambiti concessi dall'utente.
GoogleAuth.grantOfflineAccess(options)
Richiedere all'utente l'autorizzazione per accedere offline agli ambiti specificati.
Argomenti | |
---|---|
options |
Un oggetto gapi.auth2.OfflineAccessOptions contenente coppie chiave-valore di parametri. Ad esempio: { scope: 'profile email' } |
Valori restituiti | |
---|---|
Promesso | Un Promise che viene completato quando l'utente concede gli
ambiti richiesti, passando un oggetto contenente il codice di autorizzazione al
gestore di fulfillment Promise .
Ad esempio: auth2.grantOfflineAccess().then(function(resp) { var auth_code = resp.code; }); |
Codici di errore
popup_closed_by_user
- L'utente ha chiuso il popup prima di terminare il flusso di consenso.
access_denied
- L'utente ha negato l'autorizzazione per gli ambiti richiesti.
immediate_failed
-
Nessun utente può essere selezionato automaticamente senza richiedere il flusso di consenso. Errore generato quando si utilizza
signIn
con l'opzioneprompt: 'none'
. Non dovrebbe essere necessario utilizzare questa opzione, in quantogapi.auth2.init
eseguirà automaticamente l'accesso dell'utente se ha eseguito l'accesso in precedenza durante una sessione precedente.
gapi.auth2.OfflineAccessOptions
Interfaccia che rappresenta i diversi parametri di configurazione per il metodo GoogleAuth.grantOfflineAccess(options)
.
Parametri | ||
---|---|---|
prompt |
string |
Forza una modalità specifica per il flusso di consenso. Campo facoltativo. I valori possibili sono:
|
scope |
string |
Gli ambiti da richiedere, come stringa delimitata da spazi, oltre agli ambiti definiti nei
parametri gapi.auth2.init . Facoltativo se fetch_basic_profile non è impostato su false.
|
GoogleAuth.attachClickGestori(container, options, onsuccess, onfailure)
Collega il flusso di accesso al gestore dei clic del contenitore specificato.
Argomenti | |
---|---|
container | L'ID o un riferimento all'elemento div a cui
collegare il gestore dei clic. |
options | Un oggetto contenente coppie chiave-valore di parametri. Vedi GoogleAuth.signIn(). |
onsuccess | La funzione da chiamare al termine dell'accesso. |
onfailure | La funzione da chiamare se l'accesso non riesce. |
Utenti
Un oggetto GoogleUser
rappresenta un account utente.
Gli oggetti GoogleUser
sono generalmente ottenuti chiamando
GoogleAuth.currentUser.get().
GoogleAuth.currentUser.get()
Restituisce un oggetto GoogleUser
che rappresenta l'utente corrente. Tieni presente che in un'istanza GoogleAuth
appena inizializzata, l'utente corrente non è stato impostato. Utilizza il metodo currentUser.listen()
o GoogleAuth.then()
per ottenere un'istanza GoogleAuth
inizializzata.
Valori restituiti | |
---|---|
GoogleUser |
L'utente corrente |
GoogleAuth.currentUser.listen(listener)
Monitora le modifiche nell'utente corrente.
Argomenti | |
---|---|
listener |
Una funzione che richiede un parametro GoogleUser .
listen passa questa funzione a un'istanza GoogleUser
a ogni modifica che modifica currentUser .
|
GoogleUser.getId()
Recupera la stringa dell'ID univoco dell'utente.
Valori restituiti | |
---|---|
String | L'ID univoco dell'utente |
GoogleUser.isSignedIn()
Restituisce true se l'utente ha eseguito l'accesso.
Valori restituiti | |
---|---|
Booleano | True se l'utente ha eseguito l'accesso |
GoogleUser.getHostedDomain()
Recupera il dominio G Suite dell'utente se quest'ultimo ha eseguito l'accesso con un account G Suite.
Valori restituiti | |
---|---|
String | Il dominio G Suite dell'utente |
GoogleUser.getGrantedScopes()
Recupera gli ambiti concessi dall'utente come stringa delimitata da spazi.
Valori restituiti | |
---|---|
String | Gli ambiti concessi dall'utente |
GoogleUser.getBasicProfile()
Recupera le informazioni di base del profilo dell'utente.
Valori restituiti | |
---|---|
gapi.auth2.BasicProfile |
Puoi recuperare le proprietà di gapi.auth2.BasicProfile
con i seguenti metodi:
|
GoogleUser.getAuthResponse(includeAuthorizationData)
Recupera l'oggetto risposta dalla sessione di autenticazione dell'utente.
Argomenti | |
---|---|
includeAuthorizationData | Facoltativo:un valore booleano che specifica se restituire sempre un token di accesso e
gli ambiti. Per impostazione predefinita, il token di accesso e gli ambiti richiesti non vengono restituiti quando fetch_basic_profile è impostato su true (il valore predefinito) e non vengono richiesti ambiti aggiuntivi. |
Valori restituiti | |
---|---|
gapi.auth2.AuthResponse |
Un oggetto gapi.auth2.AuthResponse . |
GoogleUser.reloadAuthResponse()
Forza l'aggiornamento del token di accesso e restituisce una Promise per la nuova risposta AuthResponse.
Valori restituiti | |
---|---|
Promise |
Un Promise che viene completato con il gapi.auth2.AuthResponse ricaricato quando viene completato il ricaricamento del token OAuth.
|
gapi.auth2.AuthResponse
La risposta restituita durante la chiamata ai metodi
GoogleUser.getAuthResponse(includeAuthorizationData)
o
GoogleUser.reloadAuthResponse()
.
Proprietà | ||
---|---|---|
access_token |
string |
Il token di accesso concesso. |
id_token |
string |
Il token ID concesso. |
scope |
string |
Gli ambiti concessi nel token di accesso. |
expires_in |
number |
Il numero di secondi prima della scadenza del token di accesso. |
first_issued_at |
number |
Timestamp in corrispondenza del quale l'utente ha concesso per la prima volta gli ambiti richiesti. |
expires_at |
number |
Timestamp della scadenza del token di accesso. |
GoogleUser.hasGrantedScopes(scopes)
Restituisce true se l'utente ha concesso gli ambiti specificati.
Argomenti | |
---|---|
scopes | Una stringa di ambiti delimitata da spazi. |
Valori restituiti | |
---|---|
Booleano | True se gli ambiti sono stati concessi |
GoogleUser.grant(options)
Richiedi ambiti aggiuntivi all'utente.
Vedi GoogleAuth.signIn()
per l'elenco dei parametri e il codice di errore.
GoogleUser.grantOfflineAccess(options)
Richiedere all'utente l'autorizzazione per accedere offline agli ambiti specificati.
Argomenti | |
---|---|
options |
Un oggetto gapi.auth2.OfflineAccessOptions contenente coppie chiave-valore di parametri. Ad esempio: { scope: 'profile email' } |
GoogleUser.disconnect()
Revoca tutti gli ambiti concessi dall'utente per l'applicazione.
Elementi UI
gapi.signin2.render(id; options)
Visualizza un pulsante di accesso nell'elemento con l'ID specificato, utilizzando le impostazioni specificate dall'oggetto options.
Argomenti | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | L'ID dell'elemento in cui visualizzare il pulsante di accesso. | ||||||||||||||||
options |
Un oggetto contenente le impostazioni da utilizzare per eseguire il rendering del pulsante. Ad esempio:
{ scope: 'email', width: 200, height: 50, longtitle: true, theme: 'dark', onsuccess: handleSuccess, onfailure: handleFailure }Puoi specificare le opzioni seguenti:
|
Avanzata
gapi.auth2.PERMISSION(params, callback)
Esegue un'autorizzazione OAuth 2.0 una tantum. A seconda dei parametri utilizzati, si aprirà un popup del flusso di accesso a Google o proverà a caricare la risposta richiesta in modalità invisibile, senza interazione dell'utente.
Ecco alcuni casi d'uso in cui questo metodo è utile:
- L'applicazione deve richiedere un endpoint API di Google una sola volta, ad esempio per caricare i video di YouTube preferiti dall'utente al primo accesso.
- L'applicazione ha una propria infrastruttura di gestione delle sessioni e richiede il token ID una sola volta per identificare l'utente nel backend.
- All'interno della stessa pagina vengono utilizzati più ID cliente.
Argomenti | |
---|---|
params |
Un oggetto contenente coppie chiave-valore di dati di configurazione. Consulta
gapi.auth2.AuthorizeConfig per le
diverse proprietà configurabili. Ad esempio:
{ client_id: 'CLIENT_ID.apps.googleusercontent.com', scope: 'email profile openid', response_type: 'id_token permission' } |
callback |
Una funzione chiamata con un
oggetto gapi.auth2.AuthorizeResponse
dopo il completamento della richiesta (con esito positivo o con un errore).
|
Esempio
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.
});
Codici di errore
idpiframe_initialization_failed
-
Impossibile inizializzare un iframe obbligatorio da Google, ad esempio a causa di un ambiente non supportato. Una proprietà
details
fornirà ulteriori informazioni sull'errore generato. popup_closed_by_user
- L'utente ha chiuso il popup prima di terminare il flusso di accesso.
access_denied
- L'utente ha negato l'autorizzazione per gli ambiti richiesti.
immediate_failed
-
Nessun utente può essere selezionato automaticamente senza richiedere il flusso di consenso. Errore generato quando si utilizza
signIn
con l'opzioneprompt: 'none'
.
gapi.auth2.AuthorizeConfig
Interfaccia che rappresenta i diversi parametri di configurazione per il
metodo gapi.auth2.authorize
.
Proprietà | ||
---|---|---|
client_id |
string |
Obbligatorio. L'ID client dell'app, trovato e creato nella console API di Google. |
scope |
string |
Obbligatorio. Gli ambiti da richiedere, come stringa delimitata da spazi. |
response_type |
string |
Un elenco di tipi di risposta delimitati da spazi. Il valore predefinito è 'permission' . I valori possibili sono:
|
prompt |
string |
Forza una modalità specifica per il flusso di consenso. I valori possibili sono:
|
cookie_policy |
string |
I domini per i quali creare cookie di accesso. Un URI, single_host_origin o none . Se non specificato, il valore predefinito è
single_host_origin .
|
hosted_domain |
string |
Il dominio G Suite a cui gli utenti devono appartenere per accedere. Questo è suscettibile di modifiche da parte del client, quindi assicurati di verificare la proprietà del dominio ospitato dell'utente restituito. |
login_hint |
string |
L'email o lo User-ID di un utente da preselezionare nel flusso di accesso. Questo può essere soggetto a
modifiche da parte dell'utente, a meno che non venga utilizzato prompt: "none" .
|
include_granted_scopes |
boolean |
Indica se richiedere un token di accesso che includa tutti gli ambiti concessi in precedenza dall'utente all'app o solo gli ambiti richiesti nella chiamata attuale. Il valore predefinito è true .
|
enable_granular_consent |
boolean |
Campo facoltativo. Indica se abilitare le autorizzazioni granulari. Se impostato su false , le autorizzazioni più granulari dell'Account Google verranno disattivate per gli ID client OAuth creati prima del
2019. Nessun effetto per gli ID client OAuth creati durante o dopo il 2019, dal momento che
sono sempre abilitate autorizzazioni più granulari.
|
plugin_name |
string |
Campo facoltativo. Se impostati, gli ID client creati prima del 29 luglio 2022 possono utilizzare la
libreria della piattaforma Google. Per impostazione predefinita, agli ID client appena creati viene impedito l'utilizzo della libreria della piattaforma, ma devono utilizzare la più recente libreria dei Servizi di identità Google. Puoi scegliere qualsiasi valore; ti consigliamo di usare un nome descrittivo come il nome del prodotto o del plug-in per una facile identificazione.
Esempio: plugin_name: 'YOUR_STRING_HERE'
|
gapi.auth2.AuthorizeResponse
La risposta restituita al callback del metodo gapi.auth2.authorize
.
Proprietà | ||
---|---|---|
access_token |
string |
Il token di accesso concesso. Presente solo se permission o token
è stato specificato in response_type .
|
id_token |
string |
Il token ID concesso. Presente solo se id_token è stato specificato in
response_type .
|
code |
string |
Il codice di autorizzazione concesso. Presente solo se code è stato specificato in
response_type .
|
scope |
string |
Gli ambiti concessi nel token di accesso. Presente solo se permission o
token è stato specificato in response_type .
|
expires_in |
number |
Il numero di secondi prima della scadenza del token di accesso. Presente solo se permission
o token è stato specificato in response_type .
|
first_issued_at |
number |
Timestamp in corrispondenza del quale l'utente ha concesso per la prima volta gli ambiti richiesti. Presente solo se
permission o token è stato specificato in response_type .
|
expires_at |
number |
Timestamp della scadenza del token di accesso. Presente solo se permission
o token è stato specificato in response_type .
|
error |
string |
Se la richiesta non è andata a buon fine, contiene il codice di errore. |
error_subtype |
string |
Quando la richiesta non è andata a buon fine, queste informazioni possono contenere anche informazioni aggiuntive rispetto al codice di errore restituito. |