内置 Google 服务

Google Apps 脚本提供 30 多种内置服务,用于与用户数据、其他 Google 系统和外部系统进行交互。这些服务以全局对象的形式提供,类似于 JavaScript 的标准 Math 对象。例如,就像 Math 提供 random() 等方法和 PI 等常量一样,Apps 脚本的电子表格服务也提供 openById(id) 等方法、Range 等类(子对象)和 DataValidationCriteria 等枚举。

本网站边栏中“参考文档”标题下的“Google Workspace 服务”部分收集了控制Google Workspace 产品的服务的参考文档。实用程序服务(例如创建界面、解析 XML 或写入日志数据)收集在“脚本服务”部分中。

现代 JavaScript 功能

Apps 脚本支持两种 JavaScript 运行时:新型 V8 运行时,以及由 Mozilla 的 Rhino JavaScript 解释器提供支持的旧版运行时。

V8 运行时支持新型 ECMAScript 语法和功能。Rhino 运行时基于较旧的 JavaScript 1.6 标准,以及 1.71.8 中的一些功能。您可以自由选择要用于脚本的运行时,但强烈建议您使用 V8 运行时。

除了内置的和高级 Google 服务之外,每个运行时还支持适用于您的脚本的 JavaScript 类和对象。您的脚本可以使用 ArrayDateRegExp 等常见对象,以及 MathObject 全局对象。

使用自动补全功能

脚本编辑器提供“内容辅助”功能(通常称为“自动补全”),它会显示全局对象以及在该脚本的当前上下文中有效的方法和枚举。每当您在返回 Apps 脚本类的全局对象、枚举或方法调用后输入句点时,自动补全建议都会自动显示。例如:

  • 如果您输入全局对象的完整名称或从自动补全中选择一个对象,然后输入 .(英文句点),您将看到该类的所有方法和枚举。
  • 如果您输入一些字符,则会看到以这些字符开头的所有有效建议。

了解全局对象

每项服务都至少提供一个全局(顶级)对象;例如,仅通过 GmailApp 对象访问 Gmail 服务。某些服务提供多个全局对象;例如,基础服务包含四个全局对象:BrowserLoggerMimeTypeSession

调用方法

几乎所有内置或高级服务的全局对象均包括返回数据的方法或 Apps 脚本类。脚本按以下格式进行方法调用:

GlobalObjectName.methodName(argument1, argument2, ..., argumentN);

例如,脚本可以通过调用 Gmail 服务的 sendEmail(recipient, subject, body) 方法来发送电子邮件,如下所示:

GmailApp.sendEmail('claire@example.com', 'Subject line', 'This is the body.');

如果某个方法返回另一个 Apps 脚本类,您可以在一行中链接方法调用。(自动补全功能和方法的参考文档中都显示了返回类型。)例如,方法 DocumentApp.create() 会返回 Document;因此,以下两段代码是等效的:

var doc = DocumentApp.create('New document');
var body = doc.getBody();
body.appendParagraph('New paragraph.');

// Same result as above.
DocumentApp.create('New document').getBody().appendParagraph('New paragraph.');

访问子类

每项服务都包含一个或多个子类,这些子类不能像全局对象那样从顶级访问。您不能像使用 Date 等标准 JavaScript 类那样使用 new 关键字构造这些类;您只能通过调用返回子类的方法来访问子类。如果您不确定如何访问特定类,请访问相应服务参考文档的根页面,并查找返回所需类的方法。

处理接口

一些服务包含参考文档中标记为“接口”的特殊类。这些是通用类,用作无法提前确定精确类型的方法的返回值类型;例如,文档服务方法 Body.getChild(childIndex) 会返回一个通用的 Element 对象。Element 是表示其他某个类(可能是 ParagraphTable)的接口。接口对象本身用处不大;您通常需要调用 Element.asParagraph() 之类的方法,将对象转换回精确的类。

使用枚举

大多数服务都包括一些已命名值的枚举(枚举类型)。例如,云端硬盘服务使用枚举 AccessPermission 来确定哪些用户可以访问文件或文件夹。在几乎所有情况下,您都可以从全局对象访问这些枚举。例如,调用 Folder.setSharing(accessType, permissionType) 方法如下所示:

// Creates a folder that anyone on the Internet can read from and write to. (Domain administrators can
// prohibit this setting for Google Workspace users.)
var folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);