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 - 用户代理字符串