Class HtmlService

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

用于从脚本返回 HTML 和其他文本内容的服务。

出于安全方面的考虑,脚本无法直接将内容返回浏览器。它们必须清理 HTML,才能执行恶意操作。请参阅 HtmlOutput 的说明,了解这意味着什么限制才能返回哪些内容。

属性

属性类型说明
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获取当前浏览器的用户代理字符串。

详细文档

createHtmlOutput()

创建可从脚本返回的新 HtmlOutput 对象。

var output = HtmlService.createHtmlOutput();

返回

HtmlOutput - 新的 HTMLOutput 对象


createHtmlOutput(blob)

根据 BlobSource 资源创建新的 HtmlOutput 对象。

function createFromBlob(blob) {
  var output = HtmlService.createHtmlOutput(blob);
  return output;
}

参数

名称类型说明
blobBlobSource要从中获取 HTML 的对象

返回

HtmlOutput - 新的 HtmlOutput 对象

抛出

Error - 如果 blob 不包含 HTML 或 HTML 格式不正确


createHtmlOutput(html)

创建可从脚本返回的新 HtmlOutput 对象。

var output = HtmlService.createHtmlOutput('<b>Hello world!</b>');

参数

名称类型说明
htmlString要投放的内容

返回

HtmlOutput - 新的 HTMLOutput 对象

抛出

Error - 如果 HTML 格式不正确


createHtmlOutputFromFile(filename)

从代码编辑器中的文件创建新的 HtmlOutput 对象。

var output = HtmlService.createHtmlOutputFromFile('myPage');

参数

名称类型说明
filenameString要使用的文件的名称

返回

HtmlOutput - 新的 HtmlOutput 对象

抛出

Error - 如果未找到该文件或该文件中的 HTML 格式不正确


createTemplate(blob)

根据 BlobSource 资源创建新的 HtmlTemplate 对象。

function createFromBlob(blob) {
  var template = HtmlService.createTemplate(blob);
  return output;
}

参数

名称类型说明
blobBlobSource要从中导出 HTML 的对象。

返回

HtmlTemplate - 新的 HtmlTemplate 对象

抛出

Error - 如果 blob 未包含 HTML


createTemplate(html)

创建可从脚本返回的新 HtmlTemplate 对象。

var template = HtmlService.createTemplate('<b>The time is &lt;?= new Date() ?&gt;</b>');

参数

名称类型说明
htmlString模板的内容

返回

HtmlTemplate - 新的 HtmlTemplate 对象


createTemplateFromFile(filename)

从代码编辑器中的文件创建新的 HtmlTemplate 对象。

var template = HtmlService.createTemplateFromFile('myTemplate');

参数

名称类型说明
filenameString要使用的文件的名称

返回

HtmlTemplate - 新的 HtmlTemplate 对象

抛出

Error - 如果未找到文件


getUserAgent()

获取当前浏览器的用户代理字符串。如果未在 Web 应用的 doGet()doPost() 函数中使用,会针对大多数脚本执行返回 null

返回

String - 用户代理字符串