如果您為指令碼建構使用者介面,可以將指令碼發布為網路應用程式。舉例來說,如果指令碼可讓使用者與支援團隊成員預約時間,最好將指令碼發布為網路應用程式,方便使用者直接透過瀏覽器存取。
只要符合下列規定,獨立指令碼和繫結至應用程式的指令碼 Google Workspace 都能轉換為網頁應用程式。
網頁應用程式規定
如要將指令碼發布為網頁應用程式,必須符合下列條件:
- 包含
doGet(e)
或doPost(e)
函式。 - 此函式會傳回 HTML 服務
HtmlOutput
物件或 Content 服務TextOutput
物件。
要求參數
當使用者造訪應用程式,或程式傳送 HTTP GET
要求給應用程式時,Apps Script 會執行 doGet(e)
函式。當程式傳送 HTTP POST
要求給應用程式時,Apps Script 會改為執行 doPost(e)
。在這兩種情況下,e
引數代表事件參數,可包含任何要求參數的相關資訊。下表顯示事件物件的結構:
欄位 | |
---|---|
e.queryString |
網址查詢字串部分的值,或 name=alice&n=1&n=2 |
e.parameter |
與要求參數對應的鍵/值組合物件。 如果參數有多個值,系統只會傳回第一個值。 {"name": "alice", "n": "1"} |
e.parameters |
與 {"name": ["alice"], "n": ["1", "2"]} |
e.pathInfo |
|
e.contextPath |
未使用,一律為空字串。 |
e.contentLength |
POST 要求的請求主體長度,或 GET 要求的 332 |
e.postData.length |
與「 332 |
e.postData.type |
POST 主體的 MIME 類型 text/csv |
e.postData.contents |
POST 主體的內容文字 Alice,21 |
e.postData.name |
一律為「postData」值 postData |
舉例來說,您可以將 username
和 age
等參數傳遞至網址,如下所示:
https://script.google.com/.../exec?username=jsmith&age=21
接著,您可以顯示參數,如下所示:
function doGet(e) {
var params = JSON.stringify(e);
return ContentService.createTextOutput(params).setMimeType(ContentService.MimeType.JSON);
}
在上述範例中,doGet(e)
會傳回下列輸出內容:
{
"queryString": "username=jsmith&age=21",
"parameter": {
"username": "jsmith",
"age": "21"
},
"contextPath": "",
"parameters": {
"username": [
"jsmith"
],
"age": [
"21"
]
},
"contentLength": -1
}
將指令碼部署為網頁應用程式
如要將指令碼部署為網路應用程式,請按照下列步驟操作:
- 依序按一下指令碼專案右上方的「部署」 >「新增部署」。
- 按一下「選取類型」旁邊的「啟用部署類型」 >「網頁應用程式」。
- 在「部署設定」下方的欄位中,輸入網頁應用程式的相關資訊。
- 按一下 [Deploy] (部署)。
只要您已授予存取權,就能與想使用應用程式的人分享網頁應用程式網址。
測試網頁應用程式部署作業
如要將指令碼測試為網頁應用程式,請按照下列步驟操作:
- 在指令碼專案的右上角,依序點選「部署」>「測試部署」。
- 按一下「選取類型」旁邊的「啟用部署類型」 「網頁應用程式」。
- 按一下網頁應用程式網址下方的「複製」。
在瀏覽器中貼上網址,然後測試網路應用程式。
這個網址結尾為
/dev
,只有具備指令碼編輯權限的使用者才能存取。這個應用程式執行個體一律會執行最近儲存的程式碼,且僅供開發期間測試。
權限
網頁應用程式的權限取決於您選擇執行應用程式的方式:
- 以我的身分執行應用程式:無論誰存取網路應用程式,指令碼一律會以指令碼擁有者 (也就是您) 的身分執行。
- 將應用程式做為網路應用程式執行:在這種情況下,指令碼會以使用網路應用程式的有效使用者身分執行。如果採用這種權限方法,使用者授權存取時,網路應用程式會顯示指令碼擁有者的電子郵件地址。
在 Google 協作平台中嵌入網頁應用程式
如要在 Google 協作平台中嵌入網頁應用程式,必須先部署該應用程式。您也需要 Deploy
對話方塊中的「Deployed URL」(部署網址)。
如要在 Sites 頁面中嵌入網頁應用程式,請按照下列步驟操作:
- 開啟要新增網頁應用程式的 Google 協作平台頁面。
- 依序選取「插入」>「嵌入網址」。
- 貼上網頁應用程式網址,然後按一下「新增」。
網頁應用程式會顯示在頁面預覽的框架中。發布網頁後,網站訪客可能需要授權網路應用程式,才能正常執行。未經授權的網頁應用程式會向使用者顯示授權提示。
網頁應用程式和瀏覽器歷史記錄
您可能希望 Apps Script 網頁應用程式模擬多頁面應用程式,或透過網址參數控制動態 UI。如要妥善執行這項操作,您可以定義狀態物件來代表應用程式的 UI 或網頁,並在使用者瀏覽應用程式時,將狀態推送至瀏覽器記錄。您也可以監聽記錄事件,以便在使用者透過瀏覽器按鈕來回瀏覽時,網頁應用程式顯示正確的 UI。在載入時查詢網址參數,即可讓應用程式根據這些參數動態建構 UI,讓使用者以特定狀態啟動應用程式。
Apps Script 提供兩個非同步用戶端 JavaScript API,協助您建立連結至瀏覽器記錄的網頁應用程式:
google.script.history
提供的方法可動態回應瀏覽器記錄變更。包括:將狀態 (可定義的簡單物件) 推送到瀏覽器記錄、取代記錄堆疊中的頂端狀態,以及設定接聽程式回呼函式,以便對記錄變更做出回應。google.script.url
提供方法,可擷取目前網頁的網址參數和網址片段 (如有)。
這些記錄 API 僅適用於網頁應用程式。不支援側欄、對話方塊或外掛程式。此外,嵌入 Google 協作平台的網頁應用程式也不建議使用這項功能。