本指南介绍了插件如何获取用户的语言区域和时区,然后利用这些信息自定义其界面和行为。如需获取特定于 Google Apps 脚本的指南,请参阅 Apps 脚本开发者文档中的获取用户语言区域和时区。
配置插件的部署资源
如要允许插件获取用户的语言区域和时区,请配置该插件的部署资源:
- 在该插件的部署资源中,将
addOns.common.useLocaleFromApp
字段设置为true
。 - 将
https://www.googleapis.com/auth/script.locale
授权范围添加到部署资源的oauthScopes
列表中。此范围授予插件用户查看其国家/地区、语言和时区的权限。 - 保存更新后的部署资源。
将范围添加到插件的 oauthScopes
列表后,用户必须在下次使用该插件时重新授权。
获取语言区域和时区信息
事件对象包含用户语言区域信息,您可以从以下 commonEventObject
属性中获取这些信息:
commonEventObject.userLocale
- 用户语言和国家或地区标识符。例如,en-US
表示美国通用的英语语言。commonEventObject.timeZone.offset
- 用户时区相对于世界协调时间 (UTC) 的偏移量(以毫秒为单位)。commonEventObject.timeZone.id
- 用户的时区标识符。例如America/New_York
。commonEventObject.timeZone
- 用户的时区 ID 和偏移量。
当用户与插件互动时(例如点击按钮),事件对象会传递到 action
回调函数、homepageTrigger
函数和 contextualTrigger
函数。每个回调或触发器函数都可以从事件对象中获取语言区域和时区信息,并根据需要使用这些信息。例如,导航到新卡片的回调函数可以在确定要向卡片中添加哪些文本时引用语言区域字符串。