Google Apps Script

Class Session

The Session class provides access to session information, such as the user's email address (in some circumstances) and language setting.

Methods

MethodReturn typeBrief description
getActiveUser()UserGets information about the current user.
getActiveUserLocale()StringGets the language setting of the current user as a two-letter string — for example, en for English.
getEffectiveUser()UserGets information about the user under whose authority the script is running.
getScriptTimeZone()StringGets the time zone of the script.

Detailed documentation

getActiveUser()

Gets information about the current user. If security policies do not allow access to the user's identity, User.getEmail() returns a blank string. The circumstances in which the email address is available vary: for example, the user's email address is not available in any context that allows a script to run without that user's authorization, like a simple onOpen(e) or onEdit(e) trigger, a custom function in Google Sheets, or a web app deployed to "execute as me" (that is, authorized by the developer instead of the user). However, these restrictions generally do not apply if the developer and the user belong to the same Google Apps for Business domain.

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

Return

User — the current user


getActiveUserLocale()

Gets the language setting of the current user as a two-letter string — for example, en for English.

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

Return

String — a two-letter string that represents the user's language setting


getEffectiveUser()

Gets information about the user under whose authority the script is running. If the script is a web app set to "execute as me" (the developer), this returns the developer's user account. If the script is running under an installable trigger, this returns the account of the user who created the trigger. In most other scenarios, this returns the same account as getActiveUser().

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

Return

User — the user under whose authority the script is running


getScriptTimeZone()

Gets the time zone of the script. New scripts default to the owner's time zone, but the script's time zone can be changed by clicking File > Project properties in the script editor. Note that spreadsheets have a separate time zone, which can be changed by clicking File > Spreadsheet settings in Google Sheets. Spreadsheet time zones that differ from the script time zone are a frequent source of scripting bugs.

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

Return

String — the time zone of the script

Deprecated methods


Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.