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 - if the file wasn't found or the HTML in it is malformed

---

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()

取得目前瀏覽器的使用者代理程式字串。如果未在網頁應用程式的 doGet() 或 doPost() 函式中使用，則大部分的指令碼執行作業都會傳回 null。

回攻員

String - 使用者代理程式字串