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

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

Si vous rencontrez un problème avec la bibliothèque, veuillez le signaler 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 s'est déjà connecté, l'objet GoogleAuth restaure son état de connexion à partir de la session précédente.

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

GoogleAuth.then(onInit, onError)

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

Codes d'erreur

idpiframe_initialization_failed

Échec de l'initialisation d'un iFrame obligatoire 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 qui représente 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 de son profil Google, 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 actuellement connecté.

GoogleAuth.isSignedIn.listen(écouteur)

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

GoogleAuth.signIn().

Il connecte l'utilisateur avec les options spécifiées à gapi.auth2.init().

Codes d'erreur

Consultez les GoogleAuth.signIn(options).

GoogleAuth.signIn(options)

L'utilisateur se connecte à l'aide des options spécifiées.

Codes d'erreur

popup_closed_by_user

L'utilisateur a fermé le pop-up avant de terminer la procédure de connexion.

access_denied

L'utilisateur a refusé l'autorisation d'accès aux champs d'application requis.

immediate_failed

Aucun utilisateur ne peut être sélectionné automatiquement sans que le parcours d'autorisation ne s'affiche. Erreur générée lors de l'utilisation de signIn avec l'option prompt: 'none'. Cette option ne devrait pas être nécessaire, car gapi.auth2.init connectera automatiquement l'utilisateur s'il s'était précédemment connecté lors d'une session précédente.

gapi.auth2.SignInOptions

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

GoogleAuth.signOut()

Déconnexion du 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 hors connexion aux champs d'application spécifiés.

{
  scope: 'profile email'
}

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

Codes d'erreur

popup_closed_by_user

L'utilisateur a fermé le pop-up avant de terminer la procédure d'autorisation.

access_denied

L'utilisateur a refusé l'autorisation d'accès aux champs d'application requis.

immediate_failed

Aucun utilisateur ne peut être sélectionné automatiquement sans que le parcours d'autorisation ne s'affiche. Erreur générée lors de l'utilisation de signIn avec l'option prompt: 'none'. Cette option ne devrait pas être nécessaire, car gapi.auth2.init connectera automatiquement l'utilisateur s'il s'était précédemment connecté lors d'une session précédente.

gapi.auth2.OfflineAccessOptions

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

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

Attache 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 qui représente 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)

Écoutez 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()

Obtenez 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 accordés par l'utilisateur sous forme de chaîne délimitée par des espaces.

GoogleUser.getBasicProfile()

Obtenir les informations de base du profil de l'utilisateur

GoogleUser.getAuthResponse(includeAuthorizationData)

Récupérez 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 affiche une promesse pour la nouvelle réponse 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 champs d'application spécifiés.

GoogleUser.grant(options)

Demandez des champs d'application 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 hors connexion aux champs d'application spécifiés.

{
  scope: 'profile email'
}

GoogleUser.disconnect()

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

Éléments de l'interface utilisateur

gapi.signin2.render(id et options)

Il affiche un bouton de connexion dans l'élément ayant 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 dans le flux de connexion Google ou tente de charger la réponse demandée en mode silencieux, sans intervention de l'utilisateur.

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

• Votre application n'a besoin de 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 de session et ne requiert le jeton d'ID qu'une seule fois pour identifier l'utilisateur dans votre backend.
• Plusieurs ID client sont utilisés dans 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 obligatoire 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é le pop-up avant de terminer la procédure de connexion.

access_denied

L'utilisateur a refusé l'autorisation d'accès aux champs d'application requis.

immediate_failed

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

gapi.auth2.AuthorizeConfig

Interface qui représente 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.