触发器可让 Apps 脚本在发生特定事件(如打开文档)时自动运行函数。简单触发器是一组内置于 Apps 脚本中的预留函数,例如 onOpen(e)
函数,会在用户打开 Google 文档、表格、幻灯片或表单文件时执行。可安装的触发器比简单触发器提供更多功能,但必须在使用前激活。对于这两种触发器,Apps 脚本都会向触发的函数传递事件对象,其中包含有关事件发生的上下文的信息。
使用入门
若要使用简单触发器,只需创建一个使用以下预留函数名称的函数即可:
onOpen(e)
会在用户打开用户有权编辑的电子表格、文档、演示文稿或表单时运行。- 当用户从 Google 文档、表格、幻灯片或表单中安装编辑器插件时,系统会运行
onInstall(e)
。 onEdit(e)
会在用户更改电子表格中的值时运行。onSelectionChange(e)
会在用户更改电子表格中的选择时运行。doGet(e)
在用户访问 Web 应用或某个程序向 Web 应用发送 HTTPGET
请求时运行。doPost(e)
在程序向 Web 应用发送 HTTPPOST
请求时运行。
上述函数名称中的 e
参数是传递给函数的事件对象。该对象包含有关导致触发器触发的上下文的信息,但您可以自行选择是否使用该对象。
限制
由于简单触发器会自动触发而无需用户授权,因此它们会受到以下几项限制:
- 该脚本必须绑定到 Google 表格、幻灯片、文档或表单文件,或者是扩展其中一个应用的插件。
- 即使文件在只读(查看或评论)模式下打开,它们也不会运行。
- 脚本执行和 API 请求不会导致触发器运行。例如,调用
Range.setValue()
来修改单元格不会导致电子表格的onEdit
触发器运行。 - 它们无法访问需要授权的服务。例如,简单触发器无法发送电子邮件,因为 Gmail 服务需要授权,但简单触发器可以转换包含语言服务的匿名短语。
- 他们可以修改绑定到的文件,但无法访问其他文件,因为这需要授权。
- 他们不一定能确定当前用户的身份,具体取决于一组复杂的安全限制。
- 投放时间不能超过 30 秒。
- 在某些情况下,编辑器插件会在无需授权模式下运行其
onOpen(e)
和onEdit(e)
简单触发器,而这会造成一些额外的复杂功能。如需了解详情,请参阅插件授权生命周期指南。 - 简单触发器受 Apps 脚本触发器配额限制的约束。
这些限制不适用于 doGet(e)
或 doPost(e)
。
onOpen(e)
当用户打开他们有权编辑的电子表格、文档、演示文稿或表单时,onOpen(e)
触发器会自动运行。(在响应表单时,触发器不会运行,只会在打开表单以进行修改时运行。)onOpen(e)
最常用于将自定义菜单项添加到 Google 表格、幻灯片、文档或表单中。
onInstall(e)
当用户从 Google 文档、表格、幻灯片或表单中安装编辑器插件时,onInstall(e)
触发器会自动运行。当用户从 Google Workspace Marketplace 网站安装该插件时,触发器不会运行。请注意,onInstall(e)
可以执行的操作存在特定限制,请详细了解授权。onInstall(e)
的最常见用途是直接调用 onOpen(e)
来添加自定义菜单。毕竟,在安装插件时,该文件已经打开,因此除非重新打开该文件,否则 onOpen(e)
不会自行运行。
onEdit(e)
当用户更改电子表格中任何单元格的值时,onEdit(e)
触发器会自动运行。大多数 onEdit(e)
触发器使用事件对象中的信息进行适当响应。例如,下面的 onEdit(e)
函数在记录了上次编辑时间的单元格上设置注释。
onSelectionChange(e)
当用户更改电子表格中的选择时,onSelectionChange(e)
触发器会自动运行。如需启用此触发器,您必须在添加触发器后以及每次打开电子表格时刷新电子表格。
如果选择范围短时间内在多个单元之间移动,系统可能会跳过某些选择更改事件,以缩短延迟时间。例如,如果在相距两秒内进行多项选择更改,则只有第一项和最后一项选择更改才会激活 onSelectionChange(e)
触发器。
在以下示例中,如果选择了一个空单元格,onSelectionChange(e)
函数会将该单元格的背景设置为红色。
doGet(e)
和doPost(e)
在用户访问 Web 应用或某个程序向 Web 应用发送 HTTP GET
请求时,doGet(e)
触发器会自动运行。当某个程序向 Web 应用发送 HTTP POST
请求时,doPost(e)
会运行。Web 应用、HTML 服务和内容服务的指南对这些触发器进行了详细介绍。请注意,doGet(e)
和 doPost(e)
不受上述限制的约束。
可用的触发器类型
如果对简单触发器的限制导致它们无法满足您的需求,则可以改用可安装的触发器。下表总结了适用于每种事件类型的触发器类型。例如,Google 表格、幻灯片、表单和文档都支持简单的打开触发器,但只有表格、文档和表单支持可安装的打开触发器。
事件 | 简单触发器 | 可安装的触发器 |
---|---|---|
打开 |
|
|
修改 |
|
|
选择变更 |
|
|
安装 |
|
|
换乘 |
|
|
表单提交 |
|
|
时间驱动(时钟) |
|
|
获取 |
|
|
帖子 |
|
* Google 表单的打开事件不会在用户打开表单进行回复时发生,而是在编辑者打开表单进行修改时发生。