Base Service

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

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

名称简介
BlobApps 脚本服务的数据交换对象。
BlobSource可作为 Blob 导出数据的对象接口。
Browser该类提供对 Google 表格专用对话框的访问权限。
Button表示由 alertPromptResponse.getSelectedButton() 返回的预定本地化对话框按钮的枚举,用于指示用户点击了对话框中的哪个按钮。
ButtonSet表示可以添加到 alertprompt 的一个或多个本地化按钮的预定本地化集的枚举。
ColorType颜色类型
Logger开发者可通过该类将文本写入调试日志。
MenuGoogle 应用界面实例中的自定义菜单。
MimeType提供对 MIME 类型声明的访问权限的枚举,而无需明确输入字符串。
Month表示一年中的月份的枚举。
PromptResponseprompt 对话框的响应,该对话框显示在 Google 应用的界面环境中。
RgbColor由红色、绿色和蓝色通道定义的颜色。
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 文件(表格、文档等)。
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一个“取消”按钮,表示操作不应继续。
YESEnum一个“是”按钮,表示对问题的积极回答。
NOEnum“否”按钮,表示对问题的否定回答。

ButtonSet

属性

属性类型说明
OKEnum一个“确定”按钮,用于指示只能关闭的信息性消息。
OK_CANCELEnum一个“确定”按钮和一个“取消”按钮,可让用户继续或暂停某项操作。
YES_NOEnum一个“是”按钮和一个“否”按钮,允许用户回答“是/否”问题。
YES_NO_CANCELEnum一个“是”按钮、一个“否”按钮和一个“取消”按钮,允许用户回答“是/否”问题或暂停操作。

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_SCRIPTEnum表示 Google Apps 脚本项目的 MIME 类型。
GOOGLE_DRAWINGSEnumGoogle 绘图文件的 MIME 类型表示。
GOOGLE_DOCSEnumGoogle 文档文件的 MIME 类型表示。
GOOGLE_FORMSEnumGoogle 表单文件的 MIME 类型表示。
GOOGLE_SHEETSEnumGoogle 表格文件的 MIME 类型表示。
GOOGLE_SITESEnumGoogle 协作平台文件的 MIME 类型表示法。
GOOGLE_SLIDESEnumGoogle 幻灯片文件的 MIME 类型表示。
FOLDEREnum表示 Google 云端硬盘文件夹的 MIME 类型。
SHORTCUTEnum表示 Google 云端硬盘快捷方式的 MIME 类型。
BMPEnum表示 BMP 图片文件的 MIME 类型(通常为 .bmp)。
GIFEnum表示 GIF 图片文件(通常为 .gif)的 MIME 类型。
JPEGEnum表示 JPEG 图片文件的 MIME 类型(通常为 .jpg)。
PNGEnumPNG 图片文件(通常为 .png)的 MIME 类型表示法。
SVGEnumSVG 图片文件的 MIME 类型(通常为 .svg)。
PDFEnumPDF 文件的 MIME 类型(通常为 .pdf)。
CSSEnumCSS 文本文件(通常为 .css)的 MIME 类型表示法。
CSVEnum表示 CSV 文本文件(通常为 .csv)的 MIME 类型。
HTMLEnumHTML 文本文件的 MIME 类型(通常为 .html)。
JAVASCRIPTEnumJavaScript 文本文件(通常为 .js)的 MIME 类型表示法。
PLAIN_TEXTEnum表示纯文本文件的 MIME 类型(通常为 .txt)。
RTFEnum富文本文件的 MIME 类型(通常为 .rtf)。
OPENDOCUMENT_GRAPHICSEnumOpenDocument 图形文件的 MIME 类型(通常为 .odg)。
OPENDOCUMENT_PRESENTATIONEnumOpenDocument 演示文稿文件的 MIME 类型(通常为 .odp)。
OPENDOCUMENT_SPREADSHEETEnumOpenDocument 电子表格文件的 MIME 类型(通常为 .ods)。
OPENDOCUMENT_TEXTEnum表示 OpenDocument 文字处理文件的 MIME 类型(通常为 .odt)。
MICROSOFT_EXCELEnumMicrosoft Excel 电子表格文件的 MIME 类型(通常为 .xlsx)。
MICROSOFT_EXCEL_LEGACYEnum表示 Microsoft Excel 旧版文件(通常为 .xls)的 MIME 类型。
MICROSOFT_POWERPOINTEnumMicrosoft PowerPoint 演示文稿文件的 MIME 类型(通常为 .pptx)。
MICROSOFT_POWERPOINT_LEGACYEnumMicrosoft PowerPoint 旧版文件的 MIME 类型(通常为 .ppt)。
MICROSOFT_WORDEnumMicrosoft Word 文档文件的 MIME 类型(通常为 .docx)。
MICROSOFT_WORD_LEGACYEnumMicrosoft Word 旧文件的 MIME 类型(通常为 .doc)。
ZIPEnumZIP 归档文件的 MIME 类型(通常为 .zip)。

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表示由提醒PromptResponse.getSelectedButton() 返回的预定本地化对话框对话框的枚举,用于指示用户点击了对话框中的哪个按钮。
ButtonSetButtonSet表示一个或多个可添加到提醒提示的对话框按钮的已预先确定本地化的枚举。

方法

方法返回类型简介
alert(prompt)Button使用给定消息和一个“OK”按钮,在用户的编辑器中打开一个对话框。
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

属性

属性类型说明
SUNDAYEnum周日
MONDAYEnum星期一。
TUESDAYEnum周二。
WEDNESDAYEnum星期三。
THURSDAYEnum周四
FRIDAYEnum星期五。
SATURDAYEnum星期六。

console

方法

方法返回类型简介
error()void向 Stackdriver Logging 输出一条空白的 ERROR 级别消息。
error(formatOrObject, values)void向 Stackdriver Logging 输出 ERROR 级别的消息。
info()void将空白的 INFO 级消息输出到 Stackdriver Logging。
info(formatOrObject, values)void将 INFO 级消息输出到 Stackdriver Logging。
log()void将空白的调试级别消息输出到 Stackdriver Logging。
log(formatOrObject, values)void将 DEBUG 级消息输出到 Stackdriver Logging。
time(label)void启动可用于跟踪操作所用时间的计时器。
timeEnd(label)void停止之前通过调用 console.time() 启动的计时器。
warn()void向 Stackdriver Logging 输出一条空白的 WARNING 级别消息。
warn(formatOrObject, values)void向 Stackdriver Logging 输出 WARNING 级别的消息。