此页面由 Cloud Translation API 翻译。

Base Service

此服务可提供对电子邮件地址和用户名等用户信息的访问权限。它还可控制 Google Workspace 应用中的脚本日志和对话框。

类

名称	简介
`Blob`	Apps 脚本服务的数据交换对象。
`BlobSource`	用于可将其数据导出为 `Blob` 的对象的接口。
`Browser`	此类提供对特定于 Google 表格的对话框的访问权限。
`Button`	一种枚举，表示 `alert` 或 `PromptResponse.getSelectedButton()` 返回的预定本地化对话框按钮，用于指示用户点击了对话框中的哪个按钮。
`ButtonSet`	一种枚举，表示预先确定的本地化对话框按钮集（包含一个或多个按钮），可添加到 `alert` 或 `prompt`。
`ColorType`	颜色类型
`Logger`	如果脚本与标准 Cloud 项目相关联，开发者可以使用此类写入执行日志和 Google Cloud Logging。
`Menu`	Google 应用界面实例中的自定义菜单。
`MimeType`	一种枚举，用于提供对 MIME 类型声明的访问权限，而无需显式输入字符串。
`Month`	表示一年中各个月份的枚举。
`PromptResponse`	在 Google 应用的用户界面环境中显示的对 `prompt` 对话框的响应。
`RgbColor`	由红色、绿色、蓝色颜色通道定义的颜色。
`Session`	Session 类可用于访问会话信息，例如用户的电子邮件地址（在某些情况下）和语言设置。
`Ui`	Google 应用的用户界面环境的实例，允许脚本添加菜单、对话框和边栏等功能。
`User`	适合用于脚本的用户表示形式。
`Weekday`	表示星期几的枚举。
`console`	如果脚本与标准 Cloud 项目相关联，开发者可以使用此类写入执行日志和 Google Cloud Logging。

`Blob`

方法

方法	返回类型	简介
`copyBlob()`	`Blob`	返回相应 blob 的副本。
`getAs(contentType)`	`Blob`	以转换为指定内容类型的 blob 形式返回此对象内的数据。
`getBytes()`	`Byte[]`	获取存储在此 blob 中的数据。
`getContentType()`	`String`	获取相应 blob 中字节的内容类型。
`getDataAsString()`	`String`	以 UTF-8 编码获取相应 blob 的数据（以字符串形式）。
`getDataAsString(charset)`	`String`	以指定编码获取相应 Blob 的数据（以字符串形式）。
`getName()`	`String`	获取相应 blob 的名称。
`isGoogleType()`	`Boolean`	返回相应 Blob 是否为 Google Workspace 文件（Google 表格、Google 文档等）。
`setBytes(data)`	`Blob`	设置此 blob 中存储的数据。
`setContentType(contentType)`	`Blob`	设置相应 blob 中字节的内容类型。
`setContentTypeFromExtension()`	`Blob`	根据文件扩展名设置相应 blob 中字节的内容类型。
`setDataFromString(string)`	`Blob`	根据采用 UTF-8 编码的字符串设置相应 blob 的数据。
`setDataFromString(string, charset)`	`Blob`	根据具有指定编码的字符串设置相应 blob 的数据。
`setName(name)`	`Blob`	设置相应 blob 的名称。

`BlobSource`

方法

方法	返回类型	简介
`getAs(contentType)`	`Blob`	以转换为指定内容类型的 blob 形式返回此对象内的数据。
`getBlob()`	`Blob`	以 blob 形式返回此对象内的数据。

`Browser`

属性

属性	类型	说明
`Buttons`	`ButtonSet`

方法

方法	返回类型	简介
`inputBox(prompt)`	`String\|null`	在用户的浏览器中弹出一个包含文本输入框的对话框。
`inputBox(prompt, buttons)`	`String\|null`	在用户的浏览器中弹出一个包含文本输入框的对话框。
`inputBox(title, prompt, buttons)`	`String\|null`	在用户的浏览器中弹出一个包含文本输入框的对话框。
`msgBox(prompt)`	`String\|null`	在用户的浏览器中弹出一个对话框，其中包含指定的消息和一个“确定”按钮。
`msgBox(prompt, buttons)`	`String\|null`	在用户的浏览器中弹出一个包含指定消息和按钮的对话框。
`msgBox(title, prompt, buttons)`	`String\|null`	在用户的浏览器中弹出一个对话框，其中包含指定的标题、消息和按钮。

`Button`

属性

属性	类型	说明
`CLOSE`	`Enum`	显示在每个对话框标题栏中的标准关闭按钮。
`OK`	`Enum`	一个“确定”按钮，表示应继续执行操作。
`CANCEL`	`Enum`	“取消”按钮，表示不应继续执行操作。
`YES`	`Enum`	“是”按钮，表示对问题的肯定回答。
`NO`	`Enum`	“否”按钮，表示对问题的否定回答。

`ButtonSet`

属性

属性	类型	说明
`OK`	`Enum`	一个“确定”按钮，表示只能关闭的信息性消息。
`OK_CANCEL`	`Enum`	一个“确定”按钮和一个“取消”按钮，允许用户继续或停止操作。
`YES_NO`	`Enum`	“是”按钮和“否”按钮，可让用户回答是/否问题。
`YES_NO_CANCEL`	`Enum`	一个“是”按钮、一个“否”按钮和一个“取消”按钮，让用户能够回答是/否问题或停止操作。

`ColorType`

属性

属性	类型	说明
`UNSUPPORTED`	`Enum`	不支持的颜色类型。
`RGB`	`Enum`	由红色、绿色、蓝色颜色通道定义的颜色。
`THEME`	`Enum`	指主题配色方案中某个条目的颜色。

`Logger`

方法

方法	返回类型	简介
`clear()`	`void`	清除日志。
`getLog()`	`String`	返回当前日志中的完整消息列表。
`log(data)`	`Logger`	将数据写入日志。
`log(format, values)`	`Logger`	使用提供的格式和值将格式化字符串写入日志记录控制台。

`Menu`

方法

方法	返回类型	简介
`addItem(caption, functionName)`	`Menu`	向菜单添加项。
`addSeparator()`	`Menu`	向菜单添加视觉分隔符。
`addSubMenu(menu)`	`Menu`	向菜单添加子菜单。
`addToUi()`	`void`	将菜单插入到编辑器用户界面的实例中。

`MimeType`

属性

属性	类型	说明
`GOOGLE_APPS_SCRIPT`	`Enum`	Google Apps 脚本项目的 MIME 类型表示形式。
`GOOGLE_DRAWINGS`	`Enum`	Google 绘图文件的 MIME 类型表示形式。
`GOOGLE_DOCS`	`Enum`	Google 文档文件的 MIME 类型表示形式。
`GOOGLE_FORMS`	`Enum`	Google 表单文件的 MIME 类型表示形式。
`GOOGLE_SHEETS`	`Enum`	Google 表格文件的 MIME 类型表示形式。
`GOOGLE_SITES`	`Enum`	Google Sites 文件的 MIME 类型表示形式。
`GOOGLE_SLIDES`	`Enum`	Google 幻灯片文件的 MIME 类型表示形式。
`FOLDER`	`Enum`	Google 云端硬盘文件夹的 MIME 类型表示形式。
`SHORTCUT`	`Enum`	Google 云端硬盘快捷方式的 MIME 类型表示形式。
`BMP`	`Enum`	BMP 图片文件（通常为 .bmp）的 MIME 类型表示形式。
`GIF`	`Enum`	GIF 图片文件（通常为 .gif）的 MIME 类型表示形式。
`JPEG`	`Enum`	JPEG 图片文件（通常为 .jpg）的 MIME 类型表示形式。
`PNG`	`Enum`	PNG 图片文件（通常为 .png）的 MIME 类型表示形式。
`SVG`	`Enum`	SVG 图像文件（通常为 .svg）的 MIME 类型表示形式。
`PDF`	`Enum`	PDF 文件（通常为 .pdf）的 MIME 类型表示形式。
`CSS`	`Enum`	CSS 文本文件（通常为 .css）的 MIME 类型表示形式。
`CSV`	`Enum`	CSV 文本文件（通常为 .csv）的 MIME 类型表示形式。
`HTML`	`Enum`	HTML 文本文件（通常为 .html）的 MIME 类型表示形式。
`JAVASCRIPT`	`Enum`	JavaScript 文本文件（通常为 .js）的 MIME 类型表示形式。
`PLAIN_TEXT`	`Enum`	纯文本文件（通常为 .txt）的 MIME 类型表示形式。
`RTF`	`Enum`	富文本文件（通常为 .rtf）的 MIME 类型表示形式。
`OPENDOCUMENT_GRAPHICS`	`Enum`	OpenDocument 图形文件（通常为 .odg）的 MIME 类型表示形式。
`OPENDOCUMENT_PRESENTATION`	`Enum`	OpenDocument 演示文稿文件（通常为 .odp）的 MIME 类型表示形式。
`OPENDOCUMENT_SPREADSHEET`	`Enum`	OpenDocument 电子表格文件（通常为 .ods）的 MIME 类型表示形式。
`OPENDOCUMENT_TEXT`	`Enum`	OpenDocument 字处理文件的 MIME 类型表示形式（通常为 .odt）。
`MICROSOFT_EXCEL`	`Enum`	Microsoft Excel 电子表格文件（通常为 .xlsx）的 MIME 类型表示形式。
`MICROSOFT_EXCEL_LEGACY`	`Enum`	Microsoft Excel 旧版文件（通常为 .xls）的 MIME 类型表示形式。
`MICROSOFT_POWERPOINT`	`Enum`	Microsoft PowerPoint 演示文稿文件（通常为 .pptx）的 MIME 类型表示形式。
`MICROSOFT_POWERPOINT_LEGACY`	`Enum`	Microsoft PowerPoint 旧版文件（通常为 .ppt）的 MIME 类型表示形式。
`MICROSOFT_WORD`	`Enum`	Microsoft Word 文档文件（通常为 .docx）的 MIME 类型表示形式。
`MICROSOFT_WORD_LEGACY`	`Enum`	Microsoft Word 旧版文件（通常为 .doc）的 MIME 类型表示形式。
`ZIP`	`Enum`	ZIP 归档文件（通常为 .zip）的 MIME 类型表示形式。

`Month`

属性

属性	类型	说明
`JANUARY`	`Enum`	1 月（第 1 个月）。
`FEBRUARY`	`Enum`	2 月（第 2 个月）。
`MARCH`	`Enum`	3 月（第 3 个月）。
`APRIL`	`Enum`	4 月（第 4 个月）。
`MAY`	`Enum`	5 月（第 5 个月）。
`JUNE`	`Enum`	6 月（第 6 个月）。
`JULY`	`Enum`	7 月（第 7 个月）。
`AUGUST`	`Enum`	8 月（第 8 个月）。
`SEPTEMBER`	`Enum`	9 月（第 9 个月）。
`OCTOBER`	`Enum`	10 月（月份 10）。
`NOVEMBER`	`Enum`	11 月（第 11 个月）。
`DECEMBER`	`Enum`	12 月（月份 12）。

`PromptResponse`

方法

方法	返回类型	简介
`getResponseText()`	`String`	获取用户在对话框的输入字段中输入的文本。
`getSelectedButton()`	`Button`	获取用户点击以关闭对话框的按钮。

`RgbColor`

方法

方法	返回类型	简介
`asHexString()`	`String`	以 CSS 样式的 7 字符十六进制字符串 (#rrggbb) 或 9 字符十六进制字符串 (#aarrggbb) 形式返回颜色。
`getBlue()`	`Integer`	相应颜色的蓝色通道，以介于 0 到 255 之间的数字表示。
`getColorType()`	`ColorType`	获取相应颜色的类型。
`getGreen()`	`Integer`	相应颜色的绿色通道，以介于 0 到 255 之间的数字表示。
`getRed()`	`Integer`	相应颜色的红色通道，以介于 0 到 255 之间的数字表示。

`Session`

方法

方法	返回类型	简介
`getActiveUser()`	`User`	获取有关当前用户的信息。
`getActiveUserLocale()`	`String`	以字符串形式获取当前用户的语言设置，例如 `en` 表示英语。
`getEffectiveUser()`	`User`	获取脚本正在运行的用户的相关信息。
`getScriptTimeZone()`	`String`	获取脚本的时区。
`getTemporaryActiveUserKey()`	`String`	获取对活跃用户而言是唯一的临时密钥，但不会泄露用户身份。

`Ui`

属性

属性	类型	说明
`Button`	`Button`	一种枚举，表示由 alert 或 `PromptResponse.getSelectedButton()` 返回的预定本地化对话框按钮，用于指示用户点击了对话框中的哪个按钮。
`ButtonSet`	`ButtonSet`	一种枚举，表示预定的本地化的一组或多组对话框按钮，可添加到提醒或提示中。

方法

方法	返回类型	简介
`alert(prompt)`	`Button`	在用户的编辑器中打开一个对话框，其中包含指定的消息和一个“确定”按钮。
`alert(prompt, buttons)`	`Button`	在用户的编辑器中打开一个对话框，其中包含指定的消息和一组按钮。
`alert(title, prompt, buttons)`	`Button`	在用户的编辑器中打开一个对话框，其中包含指定的标题、消息和一组按钮。
`createAddonMenu()`	`Menu`	创建一个构建器，可用于将子菜单插入编辑器的“扩展程序”菜单中。
`createMenu(caption)`	`Menu`	创建一个构建器，可用于向编辑器的界面添加菜单。
`prompt(prompt)`	`PromptResponse`	在用户的编辑器中打开一个输入对话框，其中包含指定的消息和一个“确定”按钮。
`prompt(prompt, buttons)`	`PromptResponse`	在用户的编辑器中打开一个输入对话框，其中包含指定的消息和一组按钮。
`prompt(title, prompt, buttons)`	`PromptResponse`	在用户的编辑器中打开一个输入对话框，其中包含指定的标题、消息和一组按钮。
`showModalDialog(userInterface, title)`	`void`	在用户的编辑器中打开一个包含自定义客户端内容的模态对话框。
`showModelessDialog(userInterface, title)`	`void`	在用户的编辑器中打开一个包含自定义客户端内容的无模式对话框。
`showSidebar(userInterface)`	`void`	在用户的编辑器中打开一个包含自定义客户端内容的边栏。

`User`

方法

方法	返回类型	简介
`getEmail()`	`String`	获取用户的电子邮件地址（如果有）。

`Weekday`

属性

属性	类型	说明
`SUNDAY`	`Enum`	周日。
`MONDAY`	`Enum`	周一。
`TUESDAY`	`Enum`	星期二。
`WEDNESDAY`	`Enum`	星期三。
`THURSDAY`	`Enum`	星期四。
`FRIDAY`	`Enum`	星期五。
`SATURDAY`	`Enum`	星期六。

`console`

方法

方法	返回类型	简介
`error()`	`void`	向 Stackdriver Logging 输出空白的 ERROR 级别消息。
`error(formatOrObject, values)`	`void`	向 Stackdriver Logging 输出 ERROR 级消息。
`info()`	`void`	向 Stackdriver Logging 输出空白的 INFO 级消息。
`info(formatOrObject, values)`	`void`	向 Stackdriver Logging 输出 INFO 级消息。
`log()`	`void`	向 Stackdriver Logging 输出空白的 DEBUG 级别消息。
`log(formatOrObject, values)`	`void`	向 Stackdriver Logging 输出 DEBUG 级消息。
`time(label)`	`void`	启动一个计时器，您可以使用该计时器来跟踪操作所需的时间。
`timeEnd(label)`	`void`	停止之前通过调用 `console.time()` 启动的计时器。
`warn()`	`void`	向 Stackdriver Logging 输出空白的警告级别消息。
`warn(formatOrObject, values)`	`void`	向 Stackdriver Logging 输出 WARNING 级别消息。

Base Service 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

类

方法

方法

属性

方法

属性

属性

属性

方法

方法

属性

属性

方法

方法

方法

属性

方法

方法

属性

方法

Base Service