Script Service

脚本

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

类

名称	简介
AuthMode	一种枚举，用于标识 Apps 脚本能够通过触发的函数执行哪些类别的授权服务。
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|null	获取可用于授予脚本访问权限的授权网址。
getAuthorizedScopes()	String[]|null	获取脚本的授权范围列表。

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 脚本能够通过触发的函数执行哪些类别的授权服务。
AuthorizationStatus	AuthorizationStatus	一种枚举，用于表示脚本的授权状态。
EventType	EventType	一个枚举，用于表示触发的事件的类型。
InstallationSource	InstallationSource	一种枚举，用于表示脚本作为插件安装到用户的方式。
TriggerSource	TriggerSource	一个枚举，用于表示导致触发器触发的事件的来源。
WeekDay	Weekday	一个枚举，表示星期几。

方法

方法	返回类型	简介
deleteTrigger(trigger)	void	移除指定触发器，使其不再运行。
getAuthorizationInfo(authMode)	AuthorizationInfo	获取一个对象，用于检查用户是否已授予所有脚本要求的授权。
getAuthorizationInfo(authMode, oAuthScopes)	AuthorizationInfo	获取一个对象，用于检查用户是否已授予对所请求范围的授权。
getIdentityToken()	String|null	如果已授予 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 日历导致触发器触发。