Base Service

基准组

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

类

名称	简介
Blob	Apps 脚本服务的数据交换对象。
BlobSource	用于将数据导出为 Blob 的对象的接口。
Browser	此类提供对 Google 表格专用对话框的访问权限。
Button	此枚举表示由 alert 或 PromptResponse.getSelectedButton() 返回的预定的本地化对话框按钮，用于指示用户点击了对话框中的哪个按钮。
ButtonSet	此枚举表示可添加到 alert 或 prompt 中的一个或多个对话框按钮的预定本地化集合。
ColorType	颜色类型
Logger	此类允许开发者将文本写入调试日志。
Menu	Google 应用界面实例中的自定义菜单。
MimeType	一个枚举，提供对 MIME 类型声明的访问权限，而无需明确输入字符串。
Month	表示一年中的月份的枚举。
PromptResponse	对 Google 应用界面环境中显示的 prompt 对话框的响应。
RgbColor	一种由红、绿、蓝通道定义的颜色。
Session	Session 类提供对会话信息的访问权限，例如用户的电子邮件地址（在某些情况下）和语言设置。
Ui	Google 应用的界面环境实例，允许脚本添加菜单、对话框和边栏等功能。
User	代表用户，适合编写脚本。
Weekday	表示周几的枚举。
console	开发者可以使用此类将日志写入 Google Cloud Platform 的 Stackdriver 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	在用户浏览器中弹出带有文本输入框的对话框。
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	“Cancel”按钮，表示某项操作不应继续。
YES	Enum	“是”按钮，表示某个问题的正面回复。
NO	Enum	“否”按钮，表示对某个问题的负面回答。

ButtonSet

属性

媒体资源	类型	说明
OK	Enum	一个“确定”按钮，表示一条只能关闭的信息性消息。
OK_CANCEL	Enum	一个“确定”按钮和一个“取消”按钮，让用户可以继续或停止操作。
YES_NO	Enum	一个“是”按钮和一个“否”按钮，以便用户回答是/否问题。
YES_NO_CANCEL	Enum	一个“Yes”（是）按钮、一个“No”（否）按钮和一个“Cancel”（取消）按钮，以便用户回答是/否问题或停止操作。

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 图片文件 MIME 类型的表示（通常为 .bmp）。
GIF	Enum	GIF 图片文件（通常为 .gif）的 MIME 类型表示。
JPEG	Enum	JPEG 图片文件 MIME 类型的表示形式（通常为 .jpg）。
PNG	Enum	PNG 图片文件（通常为 .png）的 MIME 类型表示。
SVG	Enum	SVG 图片文件（通常为 .svg）的 MIME 类型的表示。
PDF	Enum	PDF 文件 MIME 类型的表示（通常为 .pdf）。
CSS	Enum	CSS 文本文件 MIME 类型的表示（通常为 .css）。
CSV	Enum	CSV 文本文件（通常为 .csv）的 MIME 类型表示。
HTML	Enum	HTML 文本文件 MIME 类型的表示（通常为 .html）。
JAVASCRIPT	Enum	JavaScript 文本文件（通常为 .js）的 MIME 类型表示。
PLAIN_TEXT	Enum	纯文本文件 MIME 类型的表示（通常为 .txt）。
RTF	Enum	富文本文件（通常为 .rtf）的 MIME 类型表示。
OPENDOCUMENT_GRAPHICS	Enum	OpenDocument 图形文件 MIME 类型的表示（通常为 .odg）。
OPENDOCUMENT_PRESENTATION	Enum	OpenDocument 演示文稿文件 MIME 类型的表示（通常为 .odp）。
OPENDOCUMENT_SPREADSHEET	Enum	OpenDocument 电子表格文件 MIME 类型的表示（通常为 .ods）。
OPENDOCUMENT_TEXT	Enum	OpenDocument 文字处理文件 MIME 类型的表示（通常为 .odt）。
MICROSOFT_EXCEL	Enum	Microsoft Excel 电子表格文件的 MIME 类型表示形式（通常为 .xlsx）。
MICROSOFT_EXCEL_LEGACY	Enum	Microsoft Excel 旧版文件 MIME 类型的表示（通常为 .xls）。
MICROSOFT_POWERPOINT	Enum	Microsoft PowerPoint 演示文稿文件 MIME 类型的表示（通常为 .pptx）。
MICROSOFT_POWERPOINT_LEGACY	Enum	Microsoft PowerPoint 旧版文件 MIME 类型的表示（通常为 .ppt）。
MICROSOFT_WORD	Enum	Microsoft Word 文档文件 MIME 类型的表示（通常为 .docx）。
MICROSOFT_WORD_LEGACY	Enum	Microsoft Word 旧版文件 MIME 类型的表示（通常为 .doc）。
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	创建一个构建器，该构建器可用于将子菜单插入编辑器的“Extensions”菜单中。
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 输出“调试”级消息。
time(label)	void	启动一个计时器，您可以使用该计时器来跟踪操作所需的时间。
timeEnd(label)	void	停止之前通过调用 console.time() 启动的计时器。
warn()	void	向 Stackdriver Logging 输出一条空白的 WARNING 级别的消息。
warn(formatOrObject, values)	void	向 Stackdriver Logging 输出一条 WARNING 级别的消息。