Documentation de référence du client JavaScript Google Sign-In

Cette documentation de référence décrit les méthodes et attributs du client JavaScript que vous utiliserez pour implémenter Google Sign-In dans vos applications Web.

Si vous rencontrez un problème lors de l'utilisation de la bibliothèque, signalez-le dans notre dépôt GitHub. .

Configuration de l'authentification

Chargez la bibliothèque de la plate-forme d'API Google pour créer l'objet gapi:

<script src="https://apis.google.com/js/platform.js?onload=init" async defer></script>

Une fois la bibliothèque de la plate-forme chargée, chargez la bibliothèque auth2:

function init() {
  gapi.load('auth2', function() {
    /* Ready. Make a call to gapi.auth2.init or some other API */
  });
}

gapi.auth2.init(params)

Initialise l'objet GoogleAuth. Vous devez appeler cette méthode avant d'appeler les méthodes de gapi.auth2.GoogleAuth.

Lorsque vous initialisez l'objet GoogleAuth, vous le configurez avec votre ID client OAuth 2.0 et toute autre option que vous souhaitez spécifier. Ensuite, si l'utilisateur est déjà connecté, l'objet GoogleAuth restaure l'état de connexion de l'utilisateur à partir de la session précédente.

{
  client_id: 'CLIENT_ID.apps.googleusercontent.com'
}

GoogleAuth.then(onInit, onError)

Appelle la fonction onInit lorsque l'objet GoogleAuth est entièrement initialisé. Si une erreur est générée lors de l'initialisation (cela peut se produire dans les anciens navigateurs non compatibles), la fonction onError est appelée à la place.

Codes d'erreur

idpiframe_initialization_failed

Échec de l'initialisation d'un iFrame requis à partir de Google, par exemple en raison d'un environnement non compatible. Une propriété details fournit plus d'informations sur l'erreur générée.

gapi.auth2.ClientConfig

Interface représentant les différents paramètres de configuration de la méthode gapi.auth2.init.

Authentification

GoogleAuth est une classe singleton qui fournit des méthodes permettant à l'utilisateur de se connecter avec un compte Google, d'obtenir l'état de connexion actuel de l'utilisateur, d'obtenir des données spécifiques à partir du profil Google de l'utilisateur, de demander des champs d'application supplémentaires et de se déconnecter du compte actuel.

gapi.auth2.getAuthInstance()

Renvoie l'objet GoogleAuth. Vous devez initialiser l'objet GoogleAuth avec gapi.auth2.init() avant d'appeler cette méthode.

GoogleAuth.isSignedIn.get()

Indique si l'utilisateur actuel est connecté.

GoogleAuth.isSignedIn.listen(listener)

Écoutez les modifications de l'état de connexion de l'utilisateur actuel.

GoogleAuth.signIn()

Connecte l'utilisateur avec les options spécifiées pour gapi.auth2.init().

Codes d'erreur

Voir GoogleAuth.signIn(options).

GoogleAuth.signIn(options)

Connecte l'utilisateur à l'aide des options spécifiées.

Codes d'erreur

popup_closed_by_user

L'utilisateur a fermé la fenêtre pop-up avant de terminer le processus de connexion.

access_denied

L'utilisateur a refusé l'autorisation pour les champs d'application requis.

immediate_failed

Aucun utilisateur ne peut être sélectionné automatiquement sans déclencher le flux de consentement. Erreur générée lors de l'utilisation de signIn avec l'option prompt: 'none'. Cette option ne devrait pas être requise, car gapi.auth2.init connecte automatiquement l'utilisateur s'il était déjà connecté lors d'une session précédente.

gapi.auth2.SignInOptions

Interface représentant les différents paramètres de configuration de la méthode GoogleAuth.signIn(options).

GoogleAuth.signOut()

Déconnecte le compte actuel de l'application.

GoogleAuth.disconnect()

Révoque tous les champs d'application accordés par l'utilisateur.

GoogleAuth.grantOfflineAccess(options)

Obtenez l'autorisation de l'utilisateur pour accéder aux champs d'application spécifiés hors connexion.

{
  scope: 'profile email'
}

auth2.grantOfflineAccess().then(function(resp) {
  var auth_code = resp.code;
});

Codes d'erreur

popup_closed_by_user

L'utilisateur a fermé la fenêtre pop-up avant de terminer le parcours de consentement.

access_denied

L'utilisateur a refusé l'autorisation pour les champs d'application requis.

immediate_failed

Aucun utilisateur ne peut être sélectionné automatiquement sans déclencher le flux de consentement. Erreur générée lors de l'utilisation de signIn avec l'option prompt: 'none'. Cette option ne devrait pas être requise, car gapi.auth2.init connecte automatiquement l'utilisateur s'il était déjà connecté lors d'une session précédente.

gapi.auth2.OfflineAccessOptions

Interface représentant les différents paramètres de configuration de la méthode GoogleAuth.grantOfflineAccess(options).

GoogleAuth.attachClickHandler(container, options, onsuccess, onfailure)

Associe le flux de connexion au gestionnaire de clics du conteneur spécifié.

Utilisateurs

Un objet GoogleUser représente un compte utilisateur. Les objets GoogleUser sont généralement obtenus en appelant GoogleAuth.currentUser.get().

GoogleAuth.currentUser.get()

Renvoie un objet GoogleUser représentant l'utilisateur actuel. Notez que dans une instance GoogleAuth nouvellement initialisée, l'utilisateur actuel n'a pas été défini. Utilisez la méthode currentUser.listen() ou GoogleAuth.then() pour obtenir une instance GoogleAuth initialisée.

GoogleAuth.currentUser.listen(listener)

Écouter les modifications apportées à currentUser

GoogleUser.getId()

Obtenez la chaîne d'ID unique de l'utilisateur.

GoogleUser.isSignedIn()

Renvoie la valeur "true" si l'utilisateur est connecté.

GoogleUser.getHostedDomain()

Récupérez le domaine G Suite de l'utilisateur s'il s'est connecté avec un compte G Suite.

GoogleUser.getGrantedScopes()

Récupérez les champs d'application que l'utilisateur a accordés sous forme de chaîne délimitée par des espaces.

GoogleUser.getBasicProfile()

Obtenez les informations de profil de base de l'utilisateur.

GoogleUser.getAuthResponse(includeAuthorizationData)

Obtenez l'objet de réponse à partir de la session d'authentification de l'utilisateur.

GoogleUser.reloadAuthResponse()

Force l'actualisation du jeton d'accès, puis renvoie une promesse pour la nouvelle AuthResponse.

gapi.auth2.AuthResponse

Réponse renvoyée lors de l'appel des méthodes GoogleUser.getAuthResponse(includeAuthorizationData) ou GoogleUser.reloadAuthResponse().

GoogleUser.hasGrantedScopes(scopes)

Renvoie la valeur "true" si l'utilisateur a accordé les portées spécifiées.

GoogleUser.grant(options)

Demandez des portées supplémentaires à l'utilisateur.

Consultez GoogleAuth.signIn() pour obtenir la liste des paramètres et le code d'erreur.

GoogleUser.grantOfflineAccess(options)

Obtenez l'autorisation de l'utilisateur pour accéder aux champs d'application spécifiés hors connexion.

{
  scope: 'profile email'
}

GoogleUser.disconnect()

Révoque tous les champs d'application que l'utilisateur a accordés à l'application.

Éléments d'interface utilisateur

gapi.signin2.render(id, options)

Affiche un bouton de connexion dans l'élément avec l'ID donné, à l'aide des paramètres spécifiés par l'objet options.

{
  scope: 'email',
  width: 200,
  height: 50,
  longtitle: true,
  theme: 'dark',
  onsuccess: handleSuccess,
  onfailure: handleFailure
}

Avancé

gapi.auth2.authorize(params, callback)

Effectue une autorisation OAuth 2.0 unique. Selon les paramètres utilisés, une fenêtre pop-up s'ouvre pour le flux de connexion Google ou tente de charger la réponse demandée de manière silencieuse, sans interaction de l'utilisateur.

Voici quelques cas d'utilisation où cette méthode est utile:

• Votre application ne doit demander un point de terminaison d'API Google qu'une seule fois, par exemple pour charger les vidéos YouTube préférées de l'utilisateur lors de sa première connexion.
• Votre application dispose de sa propre infrastructure de gestion des sessions et n'a besoin du jeton d'ID qu'une seule fois pour identifier l'utilisateur dans votre backend.
• Plusieurs ID client sont utilisés sur la même page.

{
  client_id: 'CLIENT_ID.apps.googleusercontent.com',
  scope: 'email profile openid',
  response_type: 'id_token permission'
}

Exemple

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.
});

Codes d'erreur

idpiframe_initialization_failed

Échec de l'initialisation d'un iFrame requis à partir de Google, par exemple en raison d'un environnement non compatible. Une propriété details fournit plus d'informations sur l'erreur générée.

popup_closed_by_user

L'utilisateur a fermé la fenêtre pop-up avant de terminer le processus de connexion.

access_denied

L'utilisateur a refusé l'autorisation pour les champs d'application requis.

immediate_failed

Aucun utilisateur ne peut être sélectionné automatiquement sans déclencher le flux de consentement. Erreur générée lors de l'utilisation de signIn avec l'option prompt: 'none'.

gapi.auth2.AuthorizeConfig

Interface représentant les différents paramètres de configuration de la méthode gapi.auth2.authorize.

gapi.auth2.AuthorizeResponse

Réponse renvoyée au rappel de la méthode gapi.auth2.authorize.