Base Service

基础

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

类

名称	简介
Blob	适用于 Apps Script 服务的数据交换对象。
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 文件（表格、文档等）。
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	在用户的浏览器中弹出一个包含文本输入框的对话框。
inputBox(prompt, buttons)	String	在用户的浏览器中弹出一个包含文本输入框的对话框。
inputBox(title, prompt, buttons)	String	在用户的浏览器中弹出一个包含文本输入框的对话框。
msgBox(prompt)	String	在用户的浏览器中弹出一个包含给定消息和“确定”按钮的对话框。
msgBox(prompt, buttons)	String	在用户的浏览器中弹出一个包含给定消息和指定按钮的对话框。
msgBox(title, prompt, buttons)	String	在用户的浏览器中弹出包含指定标题、消息和指定按钮的对话框。

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 协作平台文件的 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 图片文件的 MIME 类型表示法（通常为 .png）。
SVG	Enum	SVG 图片文件（通常为 .svg）的 MIME 类型表示法。
PDF	Enum	PDF 文件的 MIME 类型表示（通常为 .pdf）。
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 文档处理文件（通常为 .odt）的 MIME 类型表示法。
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 月。
SEPTEMBER	Enum	9 月（第 9 个月）。
OCTOBER	Enum	10 月（第 10 个月）。
NOVEMBER	Enum	11 月。
DECEMBER	Enum	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	一个枚举，表示提醒或 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	将 ERROR 级别消息输出到 Stackdriver Logging。
info()	void	向 Stackdriver Logging 输出空白 INFO 级别消息。
info(formatOrObject, values)	void	将 INFO 级别消息输出到 Stackdriver Logging。
log()	void	向 Stackdriver Logging 输出空白的 DEBUG 级别消息。
log(formatOrObject, values)	void	将 DEBUG 级别消息输出到 Stackdriver Logging。
time(label)	void	启动一个计时器，您可以使用该计时器跟踪操作所需的时间。
timeEnd(label)	void	停止之前通过调用 console.time() 启动的计时器。
warn()	void	向 Stackdriver Logging 输出空白的 WARNING 级别消息。
warn(formatOrObject, values)	void	将 WARNING 级别消息输出到 Stackdriver Logging。