Class HtmlService

HtmlService

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

出于安全考虑，脚本无法直接向浏览器返回内容。相反，他们必须清理 HTML，使其无法执行恶意操作。如需了解此参数对可返回的内容有何限制，请参阅 HtmlOutput 的说明。

属性

属性	类型	说明
SandboxMode	SandboxMode	一种枚举，表示可用于客户端 HtmlService 脚本的沙盒模式。
XFrameOptionsMode	XFrameOptionsMode	一个枚举，表示可用于客户端 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 对象。

const output = HtmlService.createHtmlOutput();

返回

HtmlOutput - 新的 HtmlOutput 对象

---

createHtmlOutput(blob)

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

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

参数

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

返回

HtmlOutput - 新的 HtmlOutput 对象

抛出

Error - 如果 blob 不包含 HTML 或 HTML 格式有误

---

createHtmlOutput(html)

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

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

参数

名称	类型	说明
html	String	要提供的内容

返回

HtmlOutput - 新的 HtmlOutput 对象

抛出

Error - 如果 HTML 格式错误

---

createHtmlOutputFromFile(filename)

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

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

参数

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

返回

HtmlOutput - 新的 HtmlOutput 对象

抛出

Error - 如果找不到文件或其中的 HTML 格式错误

---

createTemplate(blob)

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

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

参数

名称	类型	说明
blob	BlobSource	要从中获取 HTML 的对象。

返回

HtmlTemplate - 新的 HtmlTemplate 对象

抛出

Error - 如果 blob 不包含 HTML

---

createTemplate(html)

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

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

参数

名称	类型	说明
html	String	模板的内容

返回

HtmlTemplate - 新的 HtmlTemplate 对象

---

createTemplateFromFile(filename)

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

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

参数

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

返回

HtmlTemplate - 新的 HtmlTemplate 对象

抛出

Error - 如果找不到文件

---

getUserAgent()

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

返回

String - 用户代理字符串