Riferimento client JavaScript per Accedi con Google

Questo riferimento descrive i metodi e gli attributi client JavaScript che utilizzerai per implementare Accedi con Google nelle tue applicazioni web.

Se riscontri problemi durante l'utilizzo della libreria, segnalali al nostro repository GitHub.

Configurazione dell'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>

Una volta caricata la 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 inizializzi l'oggetto GoogleAuth, lo configuri con il tuo ID client OAuth 2.0 e le eventuali opzioni aggiuntive che vuoi specificare. Quindi, se l'utente ha già eseguito l'accesso, l'oggetto GoogleAuth ripristina lo stato di accesso dell'utente dalla sessione precedente.

Argomenti
params Un oggetto contenente coppie chiave-valore di dati di configurazione client. Consulta gapi.auth2.ClientConfig per conoscere 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 durante l'inizializzazione viene segnalato un errore (può verificarsi nei browser precedenti non supportati), verrà 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
Promessa Un valore Promise che viene completato quando la funzione onInit è stata completata o viene rifiutato 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 richiesto da Google, ad esempio a causa di un ambiente non supportato. Una proprietà details fornirà ulteriori informazioni sull'errore segnalato.

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 in Google Developers Console.
cookie_policy string I domini per i quali creare cookie di accesso. Può essere un URI, single_host_origin o none. Se non specificato, il valore predefinito è single_host_origin.
scope string Gli ambiti da richiedere, sotto forma di stringa delimitata da spazi. Facoltativo se fetch_basic_profile non è impostato su false.
fetch_basic_profile boolean Recupera le informazioni di base del profilo degli utenti quando accedono. Aggiunge "profilo", "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 è suscettibile a modifiche da parte dei client, quindi assicurati di verificare la proprietà del dominio ospitato dell'utente restituito. Utilizza GoogleUser.getHostedDomain() sul client e la rivendicazione hd nel token ID sul server per verificare che il dominio corrisponda a quanto previsto.
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 parametri di ricerca e frammento hash.
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, gli ID client appena creati non possono utilizzare la libreria di piattaforma e devono invece usare la libreria dei Servizi di identità di Google più recenti. Puoi scegliere qualsiasi valore. Per una facile identificazione, si consiglia 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 è disconnesso o se l'oggetto GoogleAuth non è inizializzato.

GoogleAuth.isSignedIn.listen(listener)

Esamina le modifiche allo stato di accesso dell'utente corrente.

Argomenti
listener Una funzione che accetta un valore booleano. listen() passa true a questa funzione quando l'utente accede e false quando l'utente esce.

GoogleAuth.signIn()

Esegue l'accesso dell'utente con le opzioni specificate in gapi.auth2.init().

Valori restituiti
Promessa Un Promise completato con l'istanza GoogleUser quando l'utente autentica e concede correttamente gli ambiti richiesti o viene rifiutato con un oggetto contenente una proprietà error se si è verificato un errore (vedi i codici di errore di seguito).

Codici di errore

Leggi i GoogleAuth.signIn(options).

GoogleAuth.signIn(options)

Consente di accedere all'utente utilizzando le opzioni specificate.

Argomenti
options Una di queste soglie:
  • Un oggetto gapi.auth2.SignInOptions contenente coppie chiave-valore di parametri di accesso. Ad esempio: 
    {
  scope: 'profile email'
}
  • Un'istanza di gapi.auth2.SigninOptionsBuilder. Ad esempio:
    options = new gapi.auth2.SigninOptionsBuilder();
options.setAppPackageName('com.example.app');
options.setFetchBasicProfile(True);
options.setPrompt('select_account');
options.setScope('profile').setScope('email');
Valori restituiti
Promessa Un Promise completato con l'istanza GoogleUser quando l'utente autentica e concede correttamente gli ambiti richiesti o viene rifiutato con un oggetto contenente una proprietà error se si è verificato un errore (vedi i codici di errore di seguito).

Codici di errore

popup_closed_by_user
L'utente ha chiuso il popup prima di completare 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 segnalato quando si utilizza signIn con l'opzione prompt: 'none'. Non è necessario utilizzare questa opzione, poiché gapi.auth2.init farà accedere automaticamente l'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:
  • consent
    Il server di autorizzazione chiede all'utente il consenso prima di restituire informazioni all'applicazione.
  • select_account
    Il server di autorizzazione chiede all'utente di selezionare un Account Google. Ciò consente a un utente che ha più account di selezionare tra i vari account per cui potrebbe avere sessioni correnti.
  • none (non consigliato)
    Il server di autorizzazione non mostrerà alcuna schermata di autenticazione o di consenso dell'utente; restituirà un errore se l'utente non è già autenticato e non ha precedentemente acconsentito agli ambiti richiesti.
    Poiché gapi.auth2.init farà accedere automaticamente un utente all'applicazione se ha eseguito l'accesso in precedenza, in genere la chiamata a signIn({prompt: 'none'}) non andrà a buon fine.
scope string Gli ambiti da richiedere, sotto forma di stringa delimitata da spazi, sopra gli 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 predefinito redirect_uri che verrà utilizzato al termine del flusso di consenso. Il valore predefinito redirect_uri è l'URL corrente senza parametri di ricerca e frammento hash.

GoogleAuth.signOut()

Disconnette l'account corrente dall'applicazione.

Valori restituiti
Promessa Un Promise che viene completato quando l'utente è stato disconnesso.

GoogleAuth.disconnect()

Revoca tutti gli ambiti concessi dall'utente.

GoogleAuth.grantOfflineAccess(options)

Chiedi 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
Promessa Un Promise che viene completato quando l'utente concede gli ambiti richiesti, passando un oggetto contenente il codice di autorizzazione al gestore di fulfillment di 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 completare 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 segnalato quando si utilizza signIn con l'opzione prompt: 'none'. Non è necessario utilizzare questa opzione, poiché gapi.auth2.init farà accedere automaticamente l'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:
  • consent
    Il server di autorizzazione chiede all'utente il consenso prima di restituire informazioni all'applicazione.
  • select_account
    Il server di autorizzazione chiede all'utente di selezionare un Account Google. Ciò consente a un utente che ha più account di selezionare tra i vari account per cui potrebbe avere sessioni correnti.
scope string Gli ambiti da richiedere, sotto forma di stringa delimitata da spazi, sopra gli ambiti definiti nei parametri gapi.auth2.init. Facoltativo se fetch_basic_profile non è impostato su false.

GoogleAuth.attachClickHandler(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 associare il gestore di clic.
options Un oggetto contenente coppie chiave-valore di parametri. Vedi GoogleAuth.signIn().
onsuccess La funzione da chiamare dopo il completamento dell'accesso.
onfailure La funzione da chiamare se l'accesso non va a buon fine.

Utenti

Un oggetto GoogleUser rappresenta un account utente. In genere gli oggetti GoogleUser vengono 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 in currentUser.

Argomenti
listener Una funzione che accetta un parametro GoogleUser. listen passa questa funzione a un'istanza GoogleUser a ogni modifica che modifica currentUser.

GoogleUser.getId()

Recupera la stringa ID univoca dell'utente.

Valori restituiti
Stringa 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()

Recuperare il dominio G Suite dell'utente se quest'ultimo ha eseguito l'accesso con un account G Suite.

Valori restituiti
Stringa Il dominio G Suite dell'utente.

GoogleUser.getGrantedScopes()

Recupera gli ambiti concessi dall'utente come stringa delimitata da spazi.

Valori restituiti
Stringa 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:
  • BasicProfile.getId()
  • BasicProfile.getName()
  • BasicProfile.getGivenName()
  • BasicProfile.getFamilyName()
  • BasicProfile.getImageUrl()
  • BasicProfile.getEmail()

GoogleUser.getAuthResponse(includeAuthorizationData)

Recupera l'oggetto di 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 è true (il valore predefinito) e non vengono richiesti ambiti aggiuntivi.
Valori restituiti
gapi.auth2.AuthResponse Un oggetto gapi.auth2.AuthResponse.

GoogleUser.reloadAuthResponse()

Forza un aggiornamento del token di accesso, quindi restituisce un valore Promise per la nuova AuthResponse.

Valori restituiti
Promise Un Promise completato con gapi.auth2.AuthResponse ricaricato al termine del ricaricamento del token OAuth.

gapi.auth2.AuthResponse

La risposta restituita durante la chiamata dei 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 Il timestamp in cui l'utente ha concesso per la prima volta gli ambiti richiesti.
expires_at number Il timestamp di 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.

Consulta GoogleAuth.signIn() per l'elenco dei parametri e il codice di errore.

GoogleUser.grantOfflineAccess(options)

Chiedi 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 il rendering del pulsante. Ad esempio: 
{
  scope: 'email',
  width: 200,
  height: 50,
  longtitle: true,
  theme: 'dark',
  onsuccess: handleSuccess,
  onfailure: handleFailure
}
Puoi specificare le seguenti opzioni:
Parametri
ambito Gli ambiti da richiedere quando l'utente accede (valore predefinito: profile).
width La larghezza del pulsante in pixel (valore predefinito: 120).
altezza L'altezza del pulsante in pixel (valore predefinito: 36).
titolo lungo Mostra etichette lunghe, come "Accedi con Google" anziché "Accedi" (valore predefinito: false). Quando utilizzi titoli lunghi, dovresti aumentare la larghezza del pulsante rispetto all'impostazione predefinita.
tema Il tema a colori del pulsante: light o dark (valore predefinito: light).
insuccesso La funzione di callback da chiamare quando un utente esegue l'accesso. Questa funzione deve assumere un argomento: un'istanza di gapi.auth2.GoogleUser (valore predefinito: nessuno).
guasto La funzione di callback da chiamare quando un accesso non va a buon fine. Questa funzione non accetta argomenti (valore predefinito: nessuno).

Avanzato

gapi.auth2.authorized(params, callback)

Esegue un'autorizzazione OAuth 2.0 una tantum. A seconda dei parametri utilizzati, si aprirà un popup nel flusso di accesso con Google o si tenterà di caricare la risposta richiesta in modalità invisibile, senza interazione da parte dell'utente.

Ecco alcuni casi d'uso in cui questo metodo è utile:

  • L'applicazione deve richiedere un endpoint API di Google solo una volta, ad esempio per caricare i video di YouTube preferiti dell'utente al primo accesso.
  • L'applicazione ha la propria infrastruttura di gestione delle sessioni e richiede il token ID solo una volta per identificare l'utente nel backend.
  • Nella stessa pagina vengono utilizzati diversi ID client.
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 che la richiesta è stata completata (riuscita 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 richiesto da Google, ad esempio a causa di un ambiente non supportato. Una proprietà details fornirà ulteriori informazioni sull'errore segnalato.
popup_closed_by_user
L'utente ha chiuso il popup prima di completare 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 segnalato quando si utilizza signIn con l'opzione prompt: 'none'.

gapi.auth2.AutorizzaConfig

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 in Google Developers Console.
scope string Obbligatorio. Gli ambiti da richiedere, sotto forma di stringa delimitata da spazi.
response_type string Un elenco di tipi di risposta delimitati da spazi. Il valore predefinito è 'permission'. I valori possibili sono:
  • id_token, per recuperare un token ID
  • permission (o token), per recuperare un token di accesso
  • code, per recuperare un codice di autorizzazione
prompt string Forza una modalità specifica per il flusso di consenso. I valori possibili sono:
  • consent
    Il server di autorizzazione chiede all'utente il consenso prima di restituire informazioni all'applicazione.
  • select_account
    Il server di autorizzazione chiede all'utente di selezionare un Account Google. Ciò consente a un utente che ha più account di selezionare tra i vari account per cui potrebbe avere sessioni correnti.
  • none
    Il server di autorizzazione non mostrerà alcuna schermata di autenticazione o di consenso dell'utente; restituirà un errore se l'utente non è già autenticato e non ha precedentemente acconsentito agli ambiti richiesti.
    Se code viene richiesto come tipo di risposta, il codice restituito sarà scambiabile solo con access_token, non con refresh_token.
cookie_policy string I domini per i quali creare cookie di accesso. Può essere 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 a modifiche da parte dei client, quindi assicurati di verificare la proprietà del dominio ospitato dell'utente restituito.
login_hint string L'indirizzo email, o ID utente, di un utente da preselezionare nel flusso di accesso. Questa opzione è soggetta 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 corrente. Il valore predefinito è true.
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, gli ID client appena creati non possono utilizzare la libreria della piattaforma, ma devono utilizzare la libreria dei Servizi di identità Google più recenti. Puoi scegliere qualsiasi valore. Per una facile identificazione, si consiglia un nome descrittivo, come il nome del prodotto o del plug-in. Esempio: plugin_name: 'YOUR_STRING_HERE'

gapi.auth2.AutorizzaResponse

La risposta è stata 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 nel 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 Il timestamp in cui 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 Il timestamp di scadenza del token di accesso. Presente solo se permission o token è stato specificato in response_type.
error string Se la richiesta non va a buon fine, contiene il codice di errore.
error_subtype string Se la richiesta non è andata a buon fine, questo può contenere informazioni aggiuntive rispetto al codice di errore restituito.