Class Session

会话

Session 类提供对会话信息的访问权限，例如用户的电子邮件地址（在某些情况下）和语言设置。

方法

方法	返回类型	简介
getActiveUser()	User	获取有关当前用户的信息。
getActiveUserLocale()	String	以字符串的形式获取当前用户的语言设置，例如，en（英语）。
getEffectiveUser()	User	获取脚本在哪位用户的授权下运行的信息。
getScriptTimeZone()	String	获取脚本的时区。
getTemporaryActiveUserKey()	String	获取对活跃用户而言唯一的临时密钥，但不会泄露用户身份。

已弃用的方法

方法	返回类型	简介
getTimeZone()	String	获取脚本的时区。
getUser()	User	获取有关当前用户的信息。

详细文档

getActiveUser()

获取有关当前用户的信息。如果安全政策不允许访问用户的身份信息，User.getEmail() 会返回一个空字符串。电子邮件地址可供使用的情形各不相同：例如，在允许脚本在无需用户授权的情况下运行的任何情境中（例如简单的 onOpen(e) 或 onEdit(e) 触发器、Google 表格中的自定义函数，或部署为“以我的身份执行”（即由开发者而非用户授权）的 Web 应用），用户的电子邮件地址都不可用。不过，如果开发者自行运行脚本或与用户属于同一 Google Workspace 网域，这些限制通常不适用。

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

返回

User - 当前用户

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

---

getActiveUserLocale()

以字符串的形式获取当前用户的语言设置，例如，en（英语）。

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

返回

String - 表示用户语言设置的字符串

---

getEffectiveUser()

获取脚本在哪位用户的授权下运行的信息。如果脚本是设置为“以我的身份执行”（开发者）的 Web 应用，则会返回开发者的用户账号。如果脚本在可安装的触发器下运行，则会返回创建触发器的用户的账号。在大多数其他情况下，此方法会返回与 getActiveUser() 相同的账号。

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

返回

User - 脚本在哪位用户的授权下运行

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

---

getScriptTimeZone()

获取脚本的时区。新脚本默认采用所有者的时区，但您可以通过在脚本编辑器中依次点击 File > Project properties 来更改脚本的时区。请注意，电子表格具有单独的时区，您可以在 Google 表格中点击文件 > 电子表格设置来更改此时区。与脚本时区不同的电子表格时区是脚本 bug 的常见来源。

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

返回

String - 脚本的时区

---

getTemporaryActiveUserKey()

获取对活跃用户而言唯一但不会泄露用户身份的临时密钥。临时密钥每 30 天轮替一次，并且是脚本专有的。

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

返回

String - 临时有效的用户标识键

已弃用的方法

getTimeZone()

已弃用。此函数已废弃，不应在新脚本中使用。

获取脚本的时区。新脚本默认采用所有者的时区，但您可以通过在脚本编辑器中依次点击 File > Project properties 来更改脚本的时区。请注意，电子表格具有单独的时区，您可以在 Google 表格中点击文件 > 电子表格设置来更改此时区。与脚本时区不同的电子表格时区是脚本 bug 的常见来源。

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

返回

String - 脚本的时区

---

getUser()

已弃用。此函数已废弃，不应在新脚本中使用。

获取有关当前用户的信息。

返回

User - 当前登录的用户

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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