Class Session

Session

La classe Session permet d'accéder aux informations de session, telles que l'adresse e-mail de l'utilisateur (dans certaines circonstances) et le paramètre linguistique.

Méthodes

MéthodeType renvoyéBrève description
getActiveUser()UserRécupère des informations sur l'utilisateur actuel.
getActiveUserLocale()StringRécupère le paramètre de langue de l'utilisateur actuel sous forme de chaîne (par exemple, en pour l'anglais).
getEffectiveUser()UserRécupère des informations sur l'utilisateur sous l'autorité duquel le script est exécuté.
getScriptTimeZone()StringRécupère le fuseau horaire du script.
getTemporaryActiveUserKey()StringPermet d'obtenir une clé temporaire propre à l'utilisateur actif, mais qui ne révèle pas son identité.

Documentation détaillée

getActiveUser()

Récupère des informations sur l'utilisateur actuel. Si les règles de sécurité n'autorisent pas l'accès à l'identité de l'utilisateur, User.getEmail() renvoie une chaîne vide. Les situations dans lesquelles l'adresse e-mail est disponible varient: par exemple, l'adresse e-mail de l'utilisateur n'est pas disponible dans un contexte qui permet à un script de s'exécuter sans l'autorisation de cet utilisateur, comme un simple déclencheur onOpen(e) ou onEdit(e), une fonction personnalisée dans Google Sheets, ou une application Web déployée pour s'exécuter en tant que moi (c'est-à-dire autorisée par le développeur plutôt que par l'utilisateur). Toutefois, ces restrictions ne s'appliquent généralement pas si le développeur exécute le script lui-même ou s'il appartient au même domaine Google Workspace que l'utilisateur.

// Log the email address of the person running the script.
var email = Session.getActiveUser().getEmail();
Logger.log(email);

Renvois

User : utilisateur actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/userinfo.email

getActiveUserLocale()

Récupère le paramètre de langue de l'utilisateur actuel sous forme de chaîne (par exemple, en pour l'anglais).

// Log the language setting of the person running the script.
Logger.log(Session.getActiveUserLocale());

Renvois

String : chaîne représentant le paramètre linguistique de l'utilisateur


getEffectiveUser()

Récupère des informations sur l'utilisateur sous l'autorité duquel le script est exécuté. Si le script est une application Web définie pour "Exécuter en tant que moi" (le développeur), le compte utilisateur du développeur s'affiche. Si le script s'exécute sous un déclencheur installable, le compte de l'utilisateur qui a créé le déclencheur est renvoyé. Dans la plupart des autres scénarios, cette méthode renvoie le même compte que getActiveUser().

// Log the email address of the user under whose authority the script is running.
var email = Session.getEffectiveUser().getEmail();
Logger.log(email);

Renvois

User : utilisateur sous l'autorité duquel le script est exécuté.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/userinfo.email

getScriptTimeZone()

Récupère le fuseau horaire du script. Les nouveaux scripts utilisent par défaut le fuseau horaire du propriétaire, mais vous pouvez le modifier en cliquant sur Fichier > Propriétés du projet dans l'éditeur de scripts. Notez que les feuilles de calcul ont un fuseau horaire distinct, que vous pouvez modifier en cliquant sur Fichier > Paramètres de la feuille de calcul dans Google Sheets. Les fuseaux horaires des feuilles de calcul différents de ceux du script provoquent fréquemment des bugs dans les scripts.

// Log the time zone of the script.
var timeZone = Session.getScriptTimeZone();
Logger.log(timeZone);

Renvois

String : fuseau horaire du script


getTemporaryActiveUserKey()

Permet d'obtenir une clé temporaire propre à l'utilisateur actif, mais qui ne révèle pas son identité. La clé temporaire est alternée tous les 30 jours et est propre au script.

// Log the temporary key of the person running the script.
Logger.log(Session.getTemporaryActiveUserKey());

Renvois

String : clé utilisateur active temporaire

Méthodes obsolètes