借助简单触发器和可安装的触发器,在特定事件发生时,Apps 脚本可以自动运行函数。当触发器触发时,Apps 脚本会将事件对象作为参数(通常称为 e
)传递给该函数。事件对象包含有关导致触发器触发的上下文的信息。例如,以下示例代码显示了针对 Google 表格脚本的简单 onEdit(e)
触发器,该脚本使用事件对象来确定修改的是哪个单元格。
function onEdit(e){
// Set a comment on the edited cell to indicate when it was changed.
var range = e.range;
range.setNote('Last modified: ' + new Date());
}
本页针对不同类型的触发器详细介绍了事件对象中的字段。
Google 表格事件
借助各种 Google 表格专用的触发器,脚本可以响应用户在电子表格中的操作。
打开(简单且可安装) |
|
---|---|
authMode |
来自 LIMITED |
source |
Spreadsheet |
triggerUid |
生成此事件的触发器的 ID(仅限可安装的触发器)。 4034124084959907503 |
user |
amin@example.com |
换乘(可安装) |
|
---|---|
authMode |
来自 FULL |
changeType |
更改类型( INSERT_ROW |
source |
Spreadsheet |
triggerUid |
生成此事件的触发器的 ID。 4034124084959907503 |
user |
amin@example.com |
修改(简单且可安装) |
|
---|---|
authMode |
来自 LIMITED |
oldValue |
修改之前的单元格值(如果有)。仅当编辑范围是单个单元格时,此字段才可用。如果单元格之前没有内容,则未定义。 1234 |
range |
Range |
source |
Spreadsheet |
triggerUid |
生成此事件的触发器的 ID(仅限可安装的触发器)。 4034124084959907503 |
user |
amin@example.com |
value |
修改后的新单元格值。仅当编辑范围是单个单元格时,此字段才可用。 10 |
表单提交(可安装) |
|
---|---|
authMode |
来自 FULL |
namedValues |
一个包含表单提交内容中的问题名称和值的对象。 { 'First Name': ['Jane'], 'Timestamp': ['6/7/2015 20:54:13'], 'Last Name': ['Doe'] } |
range |
Range |
triggerUid |
生成此事件的触发器的 ID。 4034124084959907503 |
values |
包含值在电子表格中按其显示顺序排列的数组。 ['2015/05/04 15:00', 'amin@example.com', 'Bob', '27', 'Bill', '28', 'Susan', '25'] |
Google 文档活动
触发器可让 Google 文档在用户打开文档时进行响应。
打开(简单且可安装) |
|
---|---|
authMode |
来自 LIMITED |
source |
Document |
triggerUid |
生成此事件的触发器的 ID(仅限可安装的触发器)。 4034124084959907503 |
user |
amin@example.com |
Google 幻灯片活动
触发器可让 Google 幻灯片在用户打开演示文稿时进行响应。
打开(简单) |
|
---|---|
authMode |
来自 LIMITED |
source |
Presentation |
user |
amin@example.com |
Google 表单活动
借助 Google 表单专用的触发器,脚本可以在用户修改表单或提交响应时进行响应。
打开*(简单且可安装) |
|
---|---|
authMode |
来自 LIMITED |
source |
Form |
triggerUid |
生成此事件的触发器的 ID(仅限可安装的触发器)。 4034124084959907503 |
user |
amin@example.com |
* 此事件不会在用户打开表单进行回复时发生,而是在编辑者打开表单进行修改时发生。
表单提交(可安装) |
|
---|---|
authMode |
来自 FULL |
response |
FormResponse |
source |
Form |
triggerUid |
生成此事件的触发器的 ID。 4034124084959907503 |
Google 日历活动
日历触发器会在用户的日历活动更新(创建、修改或删除)时触发。
这些触发器不会告知您哪个事件发生了更改或者更改的方式。而是表示您的代码需要执行增量同步操作才能获取日历的近期更改。有关此过程的完整说明,请参阅 Calendar API 的同步资源指南。
要在 Apps 脚本中与 Google 日历同步,请执行以下步骤:
- 为脚本项目启用日历高级服务。内置的 Google 日历服务不足以完成此工作流。
- 确定应同步的日历。对于每个此类日历,请使用日历高级服务的 Events.list() 方法执行初始同步操作。
- 初始同步的结果会针对该日历返回一个
nextSyncToken
。 存储此令牌以供日后使用。 - 当 Apps 脚本
EventUpdated
触发器触发指示日历活动发生更改时,使用存储的nextSyncToken
对受影响的日历执行增量同步。这本质上是另一个 Events.list() 请求,但提供nextSyncToken
会将响应限制为自上次同步后更改的事件。 - 检查同步的响应,了解哪些事件已更新,并让您的代码相应地做出响应。例如,您可以记录更改、更新电子表格、发送电子邮件通知或执行其他操作。
- 使用增量同步请求返回的日历更新您为该日历存储的
nextSyncToken
。这会强制下一次同步操作仅返回最新更改。
EventUpdated(可安装) |
|
---|---|
authMode |
来自 FULL |
calendarId |
发生活动更新的日历的字符串 ID。 susan@example.com |
triggerUid |
生成此事件的触发器的 ID。 4034124084959907503 |
Google Workspace 插件活动
当用户安装插件时,onInstall()
触发器会自动运行。
安装(简单) |
|
---|---|
authMode |
来自 FULL |
Google Chat 应用事件
如需了解 Google Chat 中的事件对象,请参阅接收和响应与您的 Google Chat 应用的互动情况。
时间驱动的事件
时间驱动的触发器(也称为时钟触发器)允许脚本在特定时间或按周期性间隔执行。
时间驱动(可安装) | |
---|---|
authMode |
来自 FULL |
day-of-month |
介于 由于此属性名称包含短划线,必须通过 31 |
day-of-week |
介于 由于此属性名称包含短划线,必须通过 7 |
hour |
介于 23 |
minute |
介于 59 |
month |
介于 12 |
second |
介于 59 |
timezone |
时区。 UTC |
triggerUid |
生成此事件的触发器的 ID。 4034124084959907503 |
week-of-year |
介于 由于此属性名称包含短划线,必须通过 52 |
year |
本年。 2015 |