HTML 服務可讓您提供可與伺服器端 Apps Script 函式互動的網頁。在 Google 文件、試算表和表單中建構網頁應用程式或新增自訂使用者介面時,特別實用。也可以用來產生電子郵件內文。
建立 HTML 檔案
如要在 Apps Script 專案中加入 HTML 檔案,請按照下列步驟操作:
- 開啟 Apps Script 編輯器。
- 依序按一下左側的「新增檔案」圖示 >「HTML」。
在 HTML 檔案中,您可以編寫大部分的標準 HTML、CSS 和用戶端 JavaScript。這個頁面將以 HTML5 格式放送,但部分 HTML5 進階功能無法使用,詳情請參閱限制一節。
您的檔案也可以包含範本指令碼,範本指令碼會在網頁傳送給使用者之前於伺服器中處理 (類似 PHP),如範本 HTML 一節所述。
以網頁應用程式形式提供 HTML
如要使用 HTML 服務建立網頁應用程式,程式碼必須包含 doGet()
函式,告知指令碼如何提供網頁。該函式必須傳回 HtmlOutput
物件,如以下範例所示。
Code.gs
function doGet() { return HtmlService.createHtmlOutputFromFile('Index'); }
Index.html
<!DOCTYPE html> <html> <head> <base target="_top"> </head> <body> Hello, World! </body> </html>
基本架構設定完畢後,您只需要儲存指令碼版本,然後將指令碼部署為網頁應用程式。
將指令碼部署為網頁應用程式後,您也可以將指令碼嵌入 Google 協作平台。
以 Google 文件、試算表、簡報或表單使用者介面提供 HTML
如果指令碼對檔案容器繫結,HTML 服務就能在 Google 文件、試算表、簡報或表單中顯示對話方塊或側欄。(在 Google 表單中,只有開啟表單進行修改的編輯者才能看到自訂使用者介面,其他開啟表單回覆的使用者看不到。)
與網頁應用程式不同的是,如要為文件、試算表或表單建立使用者介面的指令碼,則不需特別使用 doGet()
函式,您也不必儲存或部署指令碼版本。相反地,開啟使用者介面的函式必須將 HTML 檔案做為 HtmlOutput
物件,傳送至 Ui
物件的 showModalDialog())
或 showSidebar()
方法,以便用於使用中的文件、表單或試算表。
這些範例包含幾項方便操作的額外功能:onOpen()
函式會建立一個可輕鬆開啟介面的自訂選單,而 HTML 檔案中的按鈕會叫用 google.script.host
API 的特殊 close()
方法來關閉介面。
Code.gs
// Use this code for Google Docs, Slides, Forms, or Sheets. function onOpen() { SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp. .createMenu('Dialog') .addItem('Open', 'openDialog') .addToUi(); } function openDialog() { var html = HtmlService.createHtmlOutputFromFile('Index'); SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp. .showModalDialog(html, 'Dialog title'); }
Index.html
<!DOCTYPE html> <html> <head> <base target="_top"> </head> <body> Hello, World! <input type="button" value="Close" onclick="google.script.host.close()" /> </body> </html>
請注意,首次顯示這個使用者介面時,您必須在指令碼編輯器中手動執行 onOpen()
函式,或是重新載入文件、試算表或表單編輯器的視窗 (會關閉指令碼編輯器)。之後,每次開啟檔案時,自訂選單應該會在幾秒內顯示。依序選擇「Dialog」>「Open」查看介面。