插件可以访问其用户的语言区域和时区,并使用该信息自定义其界面和行为。您必须配置插件的清单,以允许插件访问此信息。
配置插件清单
您可以按照以下步骤配置插件,以访问用户语言区域和时区信息:
- 在插件的清单文件中,将
addOns.common.useLocaleFromApp
字段设为true
。 - 在清单的
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 和偏移量。
如需了解详情,请参阅事件对象。
当用户与您的插件互动时,系统会将事件对象传递给操作回调函数,以及主页和上下文触发器函数。每个回调或触发器函数都可以从事件对象中读取语言区域和时区信息,并根据需要使用。 例如,导航到新卡片的回调函数在决定向卡片中添加哪些文本时可以引用语言区域字符串。