HTML Service

HTML

此服务允许 Apps 脚本应用返回 HTML(通常作为界面)。如果您是首次使用此类,我们还建议您参阅 HTML 服务指南

名称简介
HtmlOutput可通过脚本提供的 HtmlOutput 对象。
HtmlOutputMetaTag一个对象,表示通过调用 HtmlOutput.addMetaTag(name, content) 添加到网页的元标记。
HtmlService用于从脚本返回 HTML 和其他文本内容的服务。
HtmlTemplate用于动态构建 HTML 的模板对象。
SandboxMode表示可用于客户端 HtmlService 脚本的沙盒模式的枚举。
XFrameOptionsMode表示可用于客户端 HtmlService 脚本的 X-Frame-Options 模式的枚举。

HtmlOutput

方法

方法返回类型简介
addMetaTag(name, content)HtmlOutput向网页添加元标记。
append(addedContent)HtmlOutput向此 HtmlOutput 的内容附加新内容。
appendUntrusted(addedContent)HtmlOutput使用上下文转义方式为此 HtmlOutput 的内容附加新内容。
asTemplate()HtmlTemplate返回由此 HtmlOutput 支持的 HtmlTemplate
clear()HtmlOutput清除当前内容。
getAs(contentType)Blob以转换为指定内容类型的 blob 形式返回此对象中的数据。
getBlob()Blob以 blob 的形式返回此对象中的数据。
getContent()String获取此 HtmlOutput 的内容。
getFaviconUrl()String通过调用 setFaviconUrl(iconUrl) 获取添加到网页的网站图标链接网址。
getHeight()Integer获取 Google 文档、表格或表单中自定义对话框的初始高度。
getMetaTags()HtmlOutputMetaTag[]通过调用 addMetaTag(name, content),获取代表添加到网页的元标记的对象数组。
getTitle()String获取输出页面的标题。
getWidth()Integer获取 Google 文档、表格或表单中自定义对话框的初始宽度。
setContent(content)HtmlOutput设置此 HtmlOutput 的内容。
setFaviconUrl(iconUrl)HtmlOutput将网页图标的链接标记添加到网页中。
setHeight(height)HtmlOutput设置 Google 文档、表格或表单中自定义对话框的初始高度。
setSandboxMode(mode)HtmlOutput此方法现在无效 - 之前,它会设置用于客户端脚本的 sandbox mode
setTitle(title)HtmlOutput设置输出页面的标题。
setWidth(width)HtmlOutput设置 Google 文档、表格或表单中自定义对话框的初始宽度。
setXFrameOptionsMode(mode)HtmlOutput设置网页的 X-Frame-Options 标头的状态,该标头用于控制点击劫持预防。

HtmlOutputMetaTag

方法

方法返回类型简介
getContent()String获取此元标记的内容。
getName()String获取此 HtmlOutputMetaTag 的名称。

HtmlService

属性

属性类型说明
SandboxModeSandboxMode表示可用于客户端 HtmlService 脚本的沙盒模式的枚举。
XFrameOptionsModeXFrameOptionsMode表示可用于客户端 HtmlService 脚本的 X-Frame-Options 模式的枚举。

方法

方法返回类型简介
createHtmlOutput()HtmlOutput创建可以从脚本返回的新 HtmlOutput 对象。
createHtmlOutput(blob)HtmlOutput通过 BlobSource 资源创建新的 HtmlOutput 对象。
createHtmlOutput(html)HtmlOutput创建可以从脚本返回的新 HtmlOutput 对象。
createHtmlOutputFromFile(filename)HtmlOutput从代码编辑器中的文件创建新的 HtmlOutput 对象。
createTemplate(blob)HtmlTemplate通过 BlobSource 资源创建新的 HtmlTemplate 对象。
createTemplate(html)HtmlTemplate创建可以从脚本返回的新 HtmlTemplate 对象。
createTemplateFromFile(filename)HtmlTemplate从代码编辑器中的文件创建新的 HtmlTemplate 对象。
getUserAgent()String获取当前浏览器的用户代理字符串。

HtmlTemplate

方法

方法返回类型简介
evaluate()HtmlOutput评估此模板并返回 HtmlOutput 对象。
getCode()String根据模板文件生成可评估的 JavaScript 代码字符串。
getCodeWithComments()String生成可求值的一组 JavaScript 代码,其中的每行代码都包含模板中的原始行作为注释。
getRawContent()String返回此模板的未处理内容。

SandboxMode

属性

属性类型说明
EMULATEDEnum旧版沙盒模式,仅使用 ECMAScript 3 中提供的功能来模拟 ECMAScript 5 严格模式。
IFRAMEEnum使用 iframe 沙盒而不是 EMULATEDNATIVE 模式使用的 Caja 沙盒技术的沙盒模式。
NATIVEEnum以 ECMAScript 5 严格模式为基础构建的沙盒模式。

XFrameOptionsMode

属性

属性类型说明
ALLOWALLEnum系统不会设置任何 X-Frame-Options 标头。
DEFAULTEnum设置 X-Frame-Options 标头的默认值,以保留常规安全假设。