获取用户语言区域和时区

Google Workspace 插件可以访问用户所在的语言区域和时区,并使用这些信息自定义其界面和行为。您必须配置插件的清单,以允许插件访问此类信息。

配置插件清单

您可以按照以下步骤配置您的插件,以访问用户语言区域和时区信息:

  1. 在您的插件清单文件中,将 addOns.common.useLocaleFromApp 字段设置为 true
  2. 如果尚不存在,请在清单的 oauthScopes 列表中添加以下显式作用域:https://www.googleapis.com/auth/script.locale

如果您向插件 oauthScope 列表添加了范围,则用户在下次打开该插件时必须重新授权

获取语言区域和时区信息

事件对象在正确配置后会携带用户语言区域信息。事件对象的 commonEventObject 子结构中会显示以下字段:

  • commonEventObject.userLocale - 用户的语言和国家/地区标识符。例如 en-US
  • commonEventObject.timeZone.offset - 用户的时区偏移量(以毫秒为单位),相对于世界协调时间 (UTC)。
  • commonEventObject.timeZone.id - 用户的时区标识符。 例如 America/New_York
  • commonEventObject.timeZone - 用户的时区 ID 和偏移量。

如需了解详情,请参阅事件对象

当用户与您的插件互动时,事件对象会传递给操作回调函数,以及首页和内容相关触发器函数。每个回调或触发器函数都可以从事件对象读取语言区域和时区信息,并根据需要使用这些信息。例如,导航到新卡片的回调函数在决定向卡片添加哪些文本时,可以引用语言区域字符串。