此页面由 Cloud Translation API 翻译。

Script Service

此服务提供对脚本触发器和脚本发布的访问权限。

类

名称	简介
`AuthMode`	一个枚举，用于标识 Apps Script 能够通过触发的函数执行哪些类别的已获授权服务。
`AuthorizationInfo`	用于检查用户是否已授予脚本所需作用域的授权的对象。
`AuthorizationStatus`	用于表示脚本授权状态的枚举。
`CalendarTriggerBuilder`	日历触发器的构建器。
`ClockTriggerBuilder`	时钟触发器的构建器。
`DocumentTriggerBuilder`	文档触发器的构建器。
`EventType`	表示触发的事件类型的枚举。
`FormTriggerBuilder`	表单触发器的构建器。
`InstallationSource`	一个枚举，用于指示脚本是如何作为插件安装给当前用户的。
`ScriptApp`	访问和操作脚本发布和触发器。
`Service`	访问和操控脚本发布。
`SpreadsheetTriggerBuilder`	电子表格触发器的构建器。
`StateTokenBuilder`	允许脚本创建可在回调 API（例如 OAuth 流程）中使用的状态令牌。
`Trigger`	脚本触发器。
`TriggerBuilder`	适用于脚本触发器的通用构建器。
`TriggerSource`	一个枚举，表示导致触发器触发的事件的来源。

`AuthMode`

属性

属性	类型	说明
`NONE`	`Enum`	此模式不允许访问任何需要授权的服务。
`CUSTOM_FUNCTION`	`Enum`	此模式允许访问一小部分服务，以便在自定义电子表格函数中使用。
`LIMITED`	`Enum`	一种模式，允许访问一小部分服务。
`FULL`	`Enum`	一种模式，允许访问需要授权的所有服务。

`AuthorizationInfo`

方法

方法	返回类型	简介
`getAuthorizationStatus()`	`AuthorizationStatus`	获取一个值，该值表示用户是否需要授权此脚本使用一个或多个服务（例如 `ScriptApp.AuthorizationStatus.REQUIRED`）。
`getAuthorizationUrl()`	`String`	获取可用于授予对脚本的访问权限的授权网址。
`getAuthorizedScopes()`	`String[]`	获取脚本的已获授权范围列表。

`AuthorizationStatus`

属性

属性	类型	说明
`REQUIRED`	`Enum`	用户需要授权此脚本使用一项或多项服务。
`NOT_REQUIRED`	`Enum`	用户已向此脚本授予其当前所需的所有授权。

`CalendarTriggerBuilder`

方法

方法	返回类型	简介
`create()`	`Trigger`	创建触发器并将其返回。
`onEventUpdated()`	`CalendarTriggerBuilder`	指定在创建、更新或删除日历条目时触发的触发器。

`ClockTriggerBuilder`

方法

方法	返回类型	简介
`after(durationMilliseconds)`	`ClockTriggerBuilder`	指定触发器在当前时间之后运行的最短时长（以毫秒为单位）。
`at(date)`	`ClockTriggerBuilder`	指定触发器的运行时间。
`atDate(year, month, day)`	`ClockTriggerBuilder`	指定触发器在指定日期触发，默认情况下为午夜附近（+/- 15 分钟）。
`atHour(hour)`	`ClockTriggerBuilder`	指定触发器运行的时刻。
`create()`	`Trigger`	创建触发器。
`everyDays(n)`	`ClockTriggerBuilder`	指定每 `n` 天运行一次触发器。
`everyHours(n)`	`ClockTriggerBuilder`	指定每 `n` 小时运行一次触发器。
`everyMinutes(n)`	`ClockTriggerBuilder`	指定每 `n` 分钟运行一次触发器。
`everyWeeks(n)`	`ClockTriggerBuilder`	指定每 `n` 周运行一次触发器。
`inTimezone(timezone)`	`ClockTriggerBuilder`	指定触发器运行时指定日期/时间的时区。
`nearMinute(minute)`	`ClockTriggerBuilder`	指定触发器运行的分钟数（正负 15 分钟）。
`onMonthDay(day)`	`ClockTriggerBuilder`	指定触发器在月份中的运行日期。
`onWeekDay(day)`	`ClockTriggerBuilder`	指定触发器运行的星期几。

`DocumentTriggerBuilder`

方法

方法	返回类型	简介
`create()`	`Trigger`	创建并返回新触发器。
`onOpen()`	`DocumentTriggerBuilder`	指定在文档打开时触发的触发器。

`EventType`

属性

属性	类型	说明
`CLOCK`	`Enum`	当基于时间的事件达到特定时间时，触发器会触发。
`ON_OPEN`	`Enum`	当用户打开 Google 文档、表格或表单文件时，触发器会触发。
`ON_EDIT`	`Enum`	当用户修改 Google 表格文件（例如，在单元格中输入新值，这会计为修改而非更改）时，触发器就会触发。
`ON_FORM_SUBMIT`	`Enum`	当用户回复 Google 表单时，触发器会触发。
`ON_CHANGE`	`Enum`	当用户更改 Google 表格文件（例如，通过添加行，这会计为更改而非修改）时，触发器就会触发。
`ON_EVENT_UPDATED`	`Enum`	在指定 Google 日历上创建、更新或删除活动后，触发器就会触发。

`FormTriggerBuilder`

方法

方法	返回类型	简介
`create()`	`Trigger`	创建并返回新触发器。
`onFormSubmit()`	`FormTriggerBuilder`	指定在向表单提交回答时触发的触发器。
`onOpen()`	`FormTriggerBuilder`	指定在打开表单的修改视图时触发的触发器。

`InstallationSource`

属性

属性	类型	说明
`APPS_MARKETPLACE_DOMAIN_ADD_ON`	`Enum`	插件是由管理员为用户的网域安装的。
`NONE`	`Enum`	脚本未作为插件运行。
`WEB_STORE_ADD_ON`	`Enum`	用户从 Chrome 应用商店安装了该插件。

`ScriptApp`

属性

属性	类型	说明
`AuthMode`	`AuthMode`	一个枚举，用于确定 Apps Script 能够通过触发的函数执行哪些类别的已获授权服务。
`AuthorizationStatus`	`AuthorizationStatus`	用于表示脚本授权状态的枚举。
`EventType`	`EventType`	一个枚举，表示触发的事件类型。
`InstallationSource`	`InstallationSource`	一个枚举，表示脚本是如何作为插件安装给用户的。
`TriggerSource`	`TriggerSource`	一个枚举，表示导致触发器触发的事件的来源。
`WeekDay`	`Weekday`	表示星期几的枚举。

方法

方法	返回类型	简介
`deleteTrigger(trigger)`	`void`	移除给定触发器，使其不再运行。
`getAuthorizationInfo(authMode)`	`AuthorizationInfo`	获取一个对象，用于检查用户是否已授予对所有脚本要求的授权。
`getAuthorizationInfo(authMode, oAuthScopes)`	`AuthorizationInfo`	获取一个用于检查用户是否已授予所请求的范围的授权的对象。
`getIdentityToken()`	`String`	如果已授予 `openid` 范围，则为有效用户获取 OpenID Connect 身份令牌。
`getInstallationSource()`	`InstallationSource`	返回一个枚举值，用于指明脚本是如何作为插件安装给当前用户的（例如，用户是通过 Chrome 网上应用店自行安装的，还是域名管理员为所有用户安装的）。
`getOAuthToken()`	`String`	获取有效用户的 OAuth 2.0 访问令牌。
`getProjectTriggers()`	`Trigger[]`	获取与当前项目和当前用户关联的所有可安装的触发器。
`getScriptId()`	`String`	获取脚本项目的唯一 ID。
`getService()`	`Service`	获取用于控制将脚本发布为 Web 应用的对象。
`getUserTriggers(document)`	`Trigger[]`	获取给定文档中此用户拥有的所有可安装触发器，仅限此脚本或插件。
`getUserTriggers(form)`	`Trigger[]`	获取给定表单中此用户拥有的所有可安装触发器，仅限此脚本或插件。
`getUserTriggers(spreadsheet)`	`Trigger[]`	仅获取给定电子表格中此用户拥有的所有可安装触发器（仅限此脚本或插件）。
`invalidateAuth()`	`void`	使有效用户执行当前脚本的授权失效。
`newStateToken()`	`StateTokenBuilder`	为状态令牌创建构建器，以便在回调 API（例如 OAuth 流程）中使用。
`newTrigger(functionName)`	`TriggerBuilder`	开始创建可安装的触发器，该触发器在触发时会调用给定函数。
`requireAllScopes(authMode)`	`void`	验证用户是否已同意授予脚本请求的所有权限范围。
`requireScopes(authMode, oAuthScopes)`	`void`	验证用户是否已同意授予所请求的范围。

`Service`

方法

方法	返回类型	简介
`getUrl()`	`String`	返回 Web 应用的网址（如果已部署）；否则返回 `null`。
`isEnabled()`	`Boolean`	如果脚本可作为 Web 应用访问，则返回 `true`。

`SpreadsheetTriggerBuilder`

方法

方法	返回类型	简介
`create()`	`Trigger`	创建触发器并将其返回。
`onChange()`	`SpreadsheetTriggerBuilder`	指定在电子表格的内容或结构发生变化时触发的触发器。
`onEdit()`	`SpreadsheetTriggerBuilder`	指定在电子表格被修改时触发的触发器。
`onFormSubmit()`	`SpreadsheetTriggerBuilder`	指定在有表单提交到电子表格时触发的触发器。
`onOpen()`	`SpreadsheetTriggerBuilder`	指定在打开电子表格时触发的触发器。

`StateTokenBuilder`

方法

方法	返回类型	简介
`createToken()`	`String`	构造状态令牌的加密字符串表示形式。
`withArgument(name, value)`	`StateTokenBuilder`	向令牌添加参数。
`withMethod(method)`	`StateTokenBuilder`	设置回调函数。
`withTimeout(seconds)`	`StateTokenBuilder`	设置令牌的有效时长（以秒为单位）。

`Trigger`

方法

方法	返回类型	简介
`getEventType()`	`EventType`	返回触发器触发的事件类型。
`getHandlerFunction()`	`String`	返回触发器触发时要调用的函数。
`getTriggerSource()`	`TriggerSource`	返回会触发触发器的事件的来源。
`getTriggerSourceId()`	`String`	返回特定于来源的 ID。
`getUniqueId()`	`String`	返回一个唯一标识符，可用于区分触发器。

`TriggerBuilder`

方法

方法	返回类型	简介
`forDocument(document)`	`DocumentTriggerBuilder`	创建并返回与给定文档相关联的 `DocumentTriggerBuilder`。
`forDocument(key)`	`DocumentTriggerBuilder`	创建并返回与具有指定 ID 的文档相关联的 `DocumentTriggerBuilder`。
`forForm(form)`	`FormTriggerBuilder`	创建并返回与给定表单相关联的 `FormTriggerBuilder`。
`forForm(key)`	`FormTriggerBuilder`	创建并返回与具有指定 ID 的表单相关联的 `FormTriggerBuilder`。
`forSpreadsheet(sheet)`	`SpreadsheetTriggerBuilder`	创建并返回与给定电子表格相关联的 `SpreadsheetTriggerBuilder`。
`forSpreadsheet(key)`	`SpreadsheetTriggerBuilder`	创建并返回与具有给定 ID 的电子表格相关联的 `SpreadsheetTriggerBuilder`。
`forUserCalendar(emailId)`	`CalendarTriggerBuilder`	返回用于构建日历触发器的构建器。
`timeBased()`	`ClockTriggerBuilder`	创建并返回 `ClockTriggerBuilder`，以构建基于时间的触发器。

`TriggerSource`

属性

属性	类型	说明
`SPREADSHEETS`	`Enum`	Google 表格会触发该触发器。
`CLOCK`	`Enum`	时间驱动型事件会触发触发器。
`FORMS`	`Enum`	Google 表单会触发该触发器。
`DOCUMENTS`	`Enum`	Google 文档会触发该触发器。
`CALENDAR`	`Enum`	Google 日历会触发该触发器。

如未另行说明，那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可，并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情，请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。

最后更新时间 (UTC)：2025-01-08。

博客
阅读 Google Workspace 开发者博客
Stack Overflow
在 google-apps-script 标签下提问
代码示例
浏览我们的代码示例，或复制代码示例以构建您自己的代码示例
视频
观看 Apps 脚本教程