Class HtmlService

HtmlService

用於從指令碼傳回 HTML 和其他文字內容的服務。

基於安全考量,指令碼無法直接將內容傳回至瀏覽器。相反地,他們必須清除 HTML,以免執行惡意動作。請參閱 HtmlOutput 的說明,瞭解這項限制對可傳回內容的影響。

屬性

屬性類型說明
SandboxModeSandboxMode代表可用於用戶端 HtmlService 指令碼的沙箱模式的列舉。
XFrameOptionsModeXFrameOptionsMode代表可用於用戶端 HtmlService 指令碼的 X-Frame-Options 模式的列舉。

方法

方法傳回類型簡短說明
createHtmlOutput()HtmlOutput建立可從指令碼傳回的新 HtmlOutput 物件。
createHtmlOutput(blob)HtmlOutputBlobSource 資源建立新的 HtmlOutput 物件。
createHtmlOutput(html)HtmlOutput建立可從指令碼傳回的新 HtmlOutput 物件。
createHtmlOutputFromFile(filename)HtmlOutput從程式碼編輯器中的檔案建立新的 HtmlOutput 物件。
createTemplate(blob)HtmlTemplateBlobSource 資源建立新的 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;
}

參數

名稱類型說明
blobBlobSource要取得 HTML 的物件

回攻員

HtmlOutput:新的 HtmlOutput 物件

擲回

Error:如果 Blob 不含 HTML 或 HTML 格式錯誤


createHtmlOutput(html)

建立可從指令碼傳回的新 HtmlOutput 物件。

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

參數

名稱類型說明
htmlString要放送的內容

回攻員

HtmlOutput:新的 HtmlOutput 物件

擲回

Error:如果 HTML 格式錯誤


createHtmlOutputFromFile(filename)

在程式碼編輯器中,從檔案建立新的 HtmlOutput 物件。

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

參數

名稱類型說明
filenameString要使用的檔案名稱

回攻員

HtmlOutput:新的 HtmlOutput 物件

擲回

Error:如果找不到檔案或檔案中的 HTML 格式不正確


createTemplate(blob)

BlobSource 資源建立新的 HtmlTemplate 物件。

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

參數

名稱類型說明
blobBlobSource要取得 HTML 的物件。

回攻員

HtmlTemplate:新的 HtmlTemplate 物件

擲回

Error - 如果 Blob 不含 HTML


createTemplate(html)

建立可從指令碼傳回的新 HtmlTemplate 物件。

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

參數

名稱類型說明
htmlString範本內容

回攻員

HtmlTemplate:新的 HtmlTemplate 物件


createTemplateFromFile(filename)

在程式碼編輯器中,從檔案建立新的 HtmlTemplate 物件。

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

參數

名稱類型說明
filenameString要使用的檔案名稱

回攻員

HtmlTemplate:新的 HtmlTemplate 物件

擲回

Error:如果找不到檔案


getUserAgent()

取得目前瀏覽器的使用者代理程式字串。如果未在網路應用程式的 doGet()doPost() 函式中使用,則會針對多數指令碼執行作業傳回 null

回攻員

String - 使用者代理程式字串