可通过脚本提供的 HtmlOutput
对象。出于安全方面的考虑,脚本无法直接将 HTML 返回给浏览器。相反,他们必须对其进行清理,使其无法执行恶意操作。您可以返回经过净化的 HTML,如下所示:
function doGet() { return HtmlService.createHtmlOutput('<b>Hello, world!</b>'); }
HtmlOutput
中的代码可以包含嵌入式 JavaScript 和 CSS。(这是操控 DOM 的标准客户端 JavaScript,不是 Apps 脚本)。所有这些内容均使用 iframe 沙盒进行了沙盒化。如需了解详情,请参阅 HTML 服务限制指南。方法
详细文档
addMetaTag(name, content)
向网页添加元标记。系统会忽略直接包含在 Apps 脚本 HTML 文件中的元标记。只允许使用以下元标记:
<meta name="apple-mobile-web-app-capable" content="..."/> <meta name="google-site-verification" content="..."/> <meta name="mobile-web-app-capable" content="..."/> <meta name="viewport" content="..."/>
var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>'); output.addMetaTag('viewport', 'width=device-width, initial-scale=1');
参数
名称 | 类型 | 说明 |
---|---|---|
name | String | 元标记的 name 属性值。 |
content | String | 元标记的内容属性的值。 |
弃踢回攻
HtmlOutput
- 此输出,用于串联。
append(addedContent)
将新内容附加到此 HtmlOutput
的内容。请仅将此选项用于可信来源的内容,因为此类来源不会进行转义。
// Log "<b>Hello, world!</b><p>Hello again, world.</p>" var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>'); output.append('<p>Hello again, world.</p>'); Logger.log(output.getContent());
参数
名称 | 类型 | 说明 |
---|---|---|
addedContent | String | 要附加的内容。 |
弃踢回攻
HtmlOutput
- 此输出,用于串联。
抛出
Error
- 如果 HTML 格式有误
另请参阅
appendUntrusted(addedContent)
使用上下文转义,将新内容附加到此 HtmlOutput
的内容中。
此方法会根据 HtmlOutput
的当前状态正确转义内容,以便结果是没有标记或附带影响的安全字符串。每当您要添加来自不可信来源(例如来自用户)的内容时,都应该使用这种方法,而不要使用“附加”,以免意外允许出现跨站脚本攻击 (XSS) bug,即您附加的内容或标记会导致意外的代码执行。
// Log "<b>Hello, world!</b><p>Hello again, world.</p>" var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>'); output.appendUntrusted('<p>Hello again, world.</p>'); Logger.log(output.getContent());
参数
名称 | 类型 | 说明 |
---|---|---|
addedContent | String | 要附加的内容。 |
弃踢回攻
HtmlOutput
- 此输出,用于串联。
抛出
Error
- 如果 HTML 非常格式错误
另请参阅
asTemplate()
返回由此 HtmlOutput
支持的 HtmlTemplate
。此方法可用于逐步构建模板。将来对 HtmlOutput
的更改也会影响 HtmlTemplate
的内容。
var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>'); var template = output.asTemplate();
弃踢回攻
HtmlTemplate
- 新的 HtmlTemplate
。
clear()
清除当前内容。
var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>'); output.clear();
弃踢回攻
HtmlOutput
- 此输出,用于串联。
getAs(contentType)
返回此对象内的数据,并将其作为 blob 转换为指定内容类型。此方法会为文件名添加适当的扩展名,例如“myfile.pdf”。不过,它假设最后一个英文句点后面的文件名部分(如果有)是应该替换的现有扩展名。因此,“ShoppingList.12.25.2014”将变为“ShoppingList.12.25.pdf”。
如需查看转化次数的每日配额,请参阅 Google 服务的配额。新创建的 Google Workspace 网域可能会暂时受到更严格的配额限制。
参数
名称 | 类型 | 说明 |
---|---|---|
contentType | String | 要转换为的 MIME 类型。对于大多数 blob,'application/pdf' 是唯一有效的选项。对于 BMP、GIF、JPEG 或 PNG 格式的图片,'image/bmp' 、'image/gif' 、'image/jpeg' 或 'image/png' 中的任何一个也都有效。 |
弃踢回攻
Blob
- 作为 blob 的数据。
getBlob()
getContent()
获取此 HtmlOutput
的内容。
// Log "<b>Hello, world!</b>" var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>'); Logger.log(output.getContent());
弃踢回攻
String
- 提供的内容。
getFaviconUrl()
通过调用 setFaviconUrl(iconUrl)
获取添加到网页的网站图标链接标记的网址。系统会忽略直接包含在 Apps 脚本 HTML 文件中的网站图标链接标记。
var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>'); output.setFaviconUrl('http://www.example.com/image.png'); Logger.log(output.getFaviconUrl());
弃踢回攻
String
- 网站图标图片的网址。
getHeight()
获取 Google 文档、表格或表单中自定义对话框的初始高度。如果 HtmlOutput
改为作为 Web 应用发布,此方法会返回 null
。如需调整已经打开的对话框的大小,请在客户端代码中调用
google.script.host.setHeight(height)
。
var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>'); output.setHeight(200); Logger.log(output.getHeight());
弃踢回攻
Integer
- 高度(以像素为单位)。
getMetaTags()
获取一个对象数组,这些对象表示通过调用 addMetaTag(name, content)
添加到网页的元标记。系统会忽略直接包含在 Apps 脚本 HTML 文件中的元标记。
var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>'); output.addMetaTag('viewport', 'width=device-width, initial-scale=1'); var tags = output.getMetaTags(); Logger.log('<meta name="%s" content="%s"/>', tags[0].getName(), tags[0].getContent());
弃踢回攻
HtmlOutputMetaTag[]
- 一组对象,表示通过调用 addMetaTag(name, content)
添加到网页的元标记。
getTitle()
获取输出页面的标题。请注意,系统会忽略 <title> HTML 元素。
var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>'); Logger.log(output.getTitle());
弃踢回攻
String
- 页面的标题。
getWidth()
获取 Google 文档、表格或表单中自定义对话框的初始宽度。如果 HtmlOutput
改为作为 Web 应用发布,此方法会返回 null
。如需调整已经打开的对话框的大小,请在客户端代码中调用
google.script.host.setWidth(width)
。
var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>'); output.setWidth(200); Logger.log(output.getWidth());
弃踢回攻
Integer
- 宽度(以像素为单位)。
setContent(content)
设置此 HtmlOutput
的内容。
var output = HtmlService.createHtmlOutput(); output.setContent('<b>Hello, world!</b>');
参数
名称 | 类型 | 说明 |
---|---|---|
content | String | 要提供的内容。 |
弃踢回攻
HtmlOutput
- 此输出,用于串联。
抛出
Error
- 如果 HTML 格式有误
setFaviconUrl(iconUrl)
向网页添加网站图标的链接标记。直接包含在 Apps 脚本 HTML 文件中的网站图标链接标记会被忽略。
var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>'); output.setFaviconUrl('http://www.example.com/image.png');
参数
名称 | 类型 | 说明 |
---|---|---|
iconUrl | String | 网站图标图片的网址,以图片扩展名指明图片类型。 |
弃踢回攻
HtmlOutput
- 此输出,用于串联。
setHeight(height)
设置 Google 文档、表格或表单中自定义对话框的初始高度。如果将 HtmlOutput
作为 Web 应用发布,则此方法不会产生任何影响。如需调整已经打开的对话框的大小,请在客户端代码中调用
google.script.host.setHeight(height)
。
var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>'); output.setHeight(200);
参数
名称 | 类型 | 说明 |
---|---|---|
height | Integer | 新高度(以像素为单位);null 会生成默认值。 |
弃踢回攻
HtmlOutput
- 此输出,用于串联。
setSandboxMode(mode)
此方法现在不起作用,之前它会设置用于客户端脚本的 sandbox
mode
。为了防止向用户投放恶意 HTML 或 JavaScript 代码,由 HTML 服务提供的客户端代码会在对代码施加限制的安全沙盒中执行。最初,此方法允许脚本作者在不同版本的沙盒之间进行选择,但现在,无论设置何种沙盒模式,所有脚本现在都会使用 IFRAME
模式。如需了解详情,请参阅 HTML 服务限制指南。
与其他沙盒模式相比,IFRAME
模式施加的限制更少,并且运行速度最快,但在某些旧版浏览器(包括 Internet Explorer 9)中根本不起作用。可以通过检查 google.script.sandbox.mode
在客户端脚本中读取沙盒模式。请注意,此属性会返回客户端上的实际模式,如果用户的浏览器不支持请求的模式,该模式可能与在服务器上请求的模式不同。
<!-- Read the sandbox mode (in a client-side script). --> <script> alert(google.script.sandbox.mode); </script>
参数
名称 | 类型 | 说明 |
---|---|---|
mode | SandboxMode | 要使用的沙盒模式。 |
弃踢回攻
HtmlOutput
- 此输出,用于串联。
setTitle(title)
设置输出页面的标题。对于 Web 应用,这是整个页面的标题,而对于 Google 表格中显示的 HtmlOutput
,则是对话框标题。
var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>'); output.setTitle('My First Page');
参数
名称 | 类型 | 说明 |
---|---|---|
title | String | 新标题。 |
弃踢回攻
HtmlOutput
- 此输出,用于串联。
setWidth(width)
设置 Google 文档、表格或表单中自定义对话框的初始宽度。如果将 HtmlOutput
作为 Web 应用发布,则此方法不会产生任何影响。如需调整已经打开的对话框的大小,请在客户端代码中调用
google.script.host.setWidth(width)
。
var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>'); output.setWidth(200);
参数
名称 | 类型 | 说明 |
---|---|---|
width | Integer | 新宽度(以像素为单位);null 会生成默认值。 |
弃踢回攻
HtmlOutput
- 此输出,用于串联。
setXFrameOptionsMode(mode)
设置网页的 X-Frame-Options
标头的状态,该标头用于控制点击劫持防范。
设置 XFrameOptionsMode.ALLOWALL
可让任何网站通过 iframe 嵌入网页,因此开发者应自行实现针对点击劫持的防护措施。
如果脚本未设置 X-Frame-Options
模式,Apps 脚本会使用 XFrameOptionsMode.DEFAULT
模式作为默认模式。
// Serve HTML with no X-Frame-Options header (in Apps Script server-side code). var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>'); output.setXFrameOptionsMode(HtmlService.XFrameOptionsMode.ALLOWALL);
参数
名称 | 类型 | 说明 |
---|---|---|
mode | XFrameOptionsMode | 要设置的 XFrame 选项模式。 |
弃踢回攻
HtmlOutput
- 此输出,用于串联。