Base Service

基准组

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

名称简介
BlobApps 脚本服务的数据交换对象。
BlobSource用于将数据导出为 Blob 的对象的接口。
Browser此类提供对 Google 表格专用对话框的访问权限。
Button此枚举表示由 alertPromptResponse.getSelectedButton() 返回的预定的本地化对话框按钮,用于指示用户点击了对话框中的哪个按钮。
ButtonSet此枚举表示可添加到 alertprompt 中的一个或多个对话框按钮的预定本地化集合。
ColorType颜色类型
Logger此类允许开发者将文本写入调试日志。
MenuGoogle 应用界面实例中的自定义菜单。
MimeType一个枚举,提供对 MIME 类型声明的访问权限,而无需明确输入字符串。
Month表示一年中的月份的枚举。
PromptResponse对 Google 应用界面环境中显示的 prompt 对话框的响应。
RgbColor一种由红、绿、蓝通道定义的颜色。
SessionSession 类提供对会话信息的访问权限,例如用户的电子邮件地址(在某些情况下)和语言设置。
UiGoogle 应用的界面环境实例,允许脚本添加菜单、对话框和边栏等功能。
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

属性

媒体资源类型说明
ButtonsButtonSet

方法

方法返回类型简介
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

属性

媒体资源类型说明
CLOSEEnum每个对话框标题栏中显示的标准关闭按钮。
OKEnum“确定”按钮,表示应执行某项操作。
CANCELEnum“Cancel”按钮,表示某项操作不应继续。
YESEnum“是”按钮,表示某个问题的正面回复。
NOEnum“否”按钮,表示对某个问题的负面回答。

ButtonSet

属性

媒体资源类型说明
OKEnum一个“确定”按钮,表示一条只能关闭的信息性消息。
OK_CANCELEnum一个“确定”按钮和一个“取消”按钮,让用户可以继续或停止操作。
YES_NOEnum一个“是”按钮和一个“否”按钮,以便用户回答是/否问题。
YES_NO_CANCELEnum一个“Yes”(是)按钮、一个“No”(否)按钮和一个“Cancel”(取消)按钮,以便用户回答是/否问题或停止操作。

ColorType

属性

媒体资源类型说明
UNSUPPORTEDEnum一种颜色类型不受支持。
RGBEnum一种由红、绿、蓝通道定义的颜色。
THEMEEnum一种颜色,用于引用主题配色方案中的条目。

Logger

方法

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

方法

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

MimeType

属性

媒体资源类型说明
GOOGLE_APPS_SCRIPTEnumGoogle Apps 脚本项目的 MIME 类型的表示。
GOOGLE_DRAWINGSEnumGoogle 绘图文件 MIME 类型的表示。
GOOGLE_DOCSEnumGoogle 文档文件的 MIME 类型的表示。
GOOGLE_FORMSEnumGoogle 表单文件的 MIME 类型的表示。
GOOGLE_SHEETSEnumGoogle 表格文件的 MIME 类型的表示。
GOOGLE_SITESEnumGoogle 协作平台文件 MIME 类型的表示。
GOOGLE_SLIDESEnumGoogle 幻灯片文件的 MIME 类型的表示。
FOLDEREnumGoogle 云端硬盘文件夹 MIME 类型的表示。
SHORTCUTEnumGoogle 云端硬盘快捷方式 MIME 类型的表示。
BMPEnumBMP 图片文件 MIME 类型的表示(通常为 .bmp)。
GIFEnumGIF 图片文件(通常为 .gif)的 MIME 类型表示。
JPEGEnumJPEG 图片文件 MIME 类型的表示形式(通常为 .jpg)。
PNGEnumPNG 图片文件(通常为 .png)的 MIME 类型表示。
SVGEnumSVG 图片文件(通常为 .svg)的 MIME 类型的表示。
PDFEnumPDF 文件 MIME 类型的表示(通常为 .pdf)。
CSSEnumCSS 文本文件 MIME 类型的表示(通常为 .css)。
CSVEnumCSV 文本文件(通常为 .csv)的 MIME 类型表示。
HTMLEnumHTML 文本文件 MIME 类型的表示(通常为 .html)。
JAVASCRIPTEnumJavaScript 文本文件(通常为 .js)的 MIME 类型表示。
PLAIN_TEXTEnum纯文本文件 MIME 类型的表示(通常为 .txt)。
RTFEnum富文本文件(通常为 .rtf)的 MIME 类型表示。
OPENDOCUMENT_GRAPHICSEnumOpenDocument 图形文件 MIME 类型的表示(通常为 .odg)。
OPENDOCUMENT_PRESENTATIONEnumOpenDocument 演示文稿文件 MIME 类型的表示(通常为 .odp)。
OPENDOCUMENT_SPREADSHEETEnumOpenDocument 电子表格文件 MIME 类型的表示(通常为 .ods)。
OPENDOCUMENT_TEXTEnumOpenDocument 文字处理文件 MIME 类型的表示(通常为 .odt)。
MICROSOFT_EXCELEnumMicrosoft Excel 电子表格文件的 MIME 类型表示形式(通常为 .xlsx)。
MICROSOFT_EXCEL_LEGACYEnumMicrosoft Excel 旧版文件 MIME 类型的表示(通常为 .xls)。
MICROSOFT_POWERPOINTEnumMicrosoft PowerPoint 演示文稿文件 MIME 类型的表示(通常为 .pptx)。
MICROSOFT_POWERPOINT_LEGACYEnumMicrosoft PowerPoint 旧版文件 MIME 类型的表示(通常为 .ppt)。
MICROSOFT_WORDEnumMicrosoft Word 文档文件 MIME 类型的表示(通常为 .docx)。
MICROSOFT_WORD_LEGACYEnumMicrosoft Word 旧版文件 MIME 类型的表示(通常为 .doc)。
ZIPEnumZIP 归档文件(通常为 .zip)MIME 类型的表示。

Month

属性

媒体资源类型说明
JANUARYEnum1 月(第 1 个月)。
FEBRUARYEnum2 月(第 2 个月)。
MARCHEnum3 月(第 3 个月)。
APRILEnum4 月(第 4 个月)。
MAYEnum5 月(第 5 个月)。
JUNEEnum6 月(第 6 个月)。
JULYEnum7 月(第 7 个月)。
AUGUSTEnum8 月(第 8 个月)。
SEPTEMBEREnum9 月(第 9 个月)。
OCTOBEREnum10 月(第 10 个月)。
NOVEMBEREnum11 月(第 11 个月)。
DECEMBEREnum12 月(第 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

属性

媒体资源类型说明
ButtonButton此枚举表示由 alertPromptResponse.getSelectedButton() 返回的预定的本地化对话框按钮,以指示用户点击的对话框中的按钮。
ButtonSetButtonSet一个枚举,表示由可添加到提醒提示中的一个或多个对话框按钮预定的本地化集。

方法

方法返回类型简介
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

属性

媒体资源类型说明
SUNDAYEnum星期日。
MONDAYEnum星期一。
TUESDAYEnum星期二。
WEDNESDAYEnum周三。
THURSDAYEnum星期四。
FRIDAYEnum星期五。
SATURDAYEnum星期六。

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 级别的消息。