網路應用程式

如果您為指令碼建構使用者介面,可以將指令碼發布為網頁應用程式。例如,讓使用者向支援團隊成員預約預約的指令碼最好以網頁應用程式形式呈現,方便使用者直接透過瀏覽器存取。

獨立指令碼繫結至 Google Workspace 應用程式的指令碼都可以轉換為網頁應用程式,前提是須符合下列規定。

網頁應用程式規定

指令碼必須符合以下需求條件,才能以網頁應用程式形式發布:

要求參數

當使用者造訪應用程式或程式傳送 HTTP GET 要求時,Apps Script 就會執行 doGet(e) 函式。當程式傳送 HTTP POST 要求給應用程式時,Apps Script 會改為執行 doPost(e)。在這兩種情況下,e 引數都代表一個事件參數,可包含任何要求參數的相關資訊。事件物件的結構如下表所示:

欄位
e.queryString

網址查詢字串部分的值,如果未指定查詢字串,則為 null

name=alice&n=1&n=2
e.parameter

與要求參數對應的鍵/值組合物件。 如果參數有多個值,系統只會傳回第一個值。

{"name": "alice", "n": "1"}
e.parameters

e.parameter 類似的物件,但每個鍵都有一組值陣列

{"name": ["alice"], "n": ["1", "2"]}
e.pathInfo

/exec/dev 之後的網址路徑。舉例來說,如果網址路徑的結尾為 /exec/hello,則路徑資訊為 hello

e.contextPath 不使用,一律為空白字串。
e.contentLength

POST 要求的要求主體長度,GET 要求長度則為 -1

332
e.postData.length

與「e.contentLength」相同

332
e.postData.type

POST 內文的 MIME 類型

text/csv
e.postData.contents

POST 內文的內容文字

Alice,21
e.postData.name

值一律為「postData」

postData

舉例來說,您可以將 usernameage 等參數傳遞至網址,如下所示:

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
}

將指令碼部署為網頁應用程式

如要將指令碼部署為網頁應用程式,請按照下列步驟操作:

  1. 在指令碼專案右上方,依序點選「部署」 >「新增部署作業」
  2. 在「選取類型」旁邊,依序點選「啟用部署類型」圖示 >「網頁應用程式」
  3. 在「部署作業設定」下方的欄位輸入網頁應用程式的相關資訊。
  4. 點選「Deploy」

將網頁應用程式網址分享給您要使用應用程式的對象,前提是您已將其存取權授予應用程式。

測試網頁應用程式部署作業

如要以網頁應用程式形式測試指令碼,請按照下列步驟操作:

  1. 在指令碼專案右上方,依序點選「部署」>「測試部署」
  2. 在「選取類型」旁邊,依序點選「啟用部署類型」圖示 >「網頁應用程式」
  3. 按一下網頁應用程式網址下方的「複製」
  4. 將網址貼到瀏覽器中,並測試網頁應用程式。

    這個網址結尾是 /dev,只有具備指令碼編輯權限的使用者才能存取。此應用程式執行個體一律會執行最近儲存的程式碼,且僅適用於開發期間的測試。

權限

網頁應用程式的權限取決於您選擇執行應用程式的方式:

  • 以我的身分執行應用程式:在此情況下,無論存取網頁應用程式的人員為何,指令碼一律會以您 (指令碼擁有者) 的身分執行。
  • 以存取網頁應用程式的身分執行應用程式:在此情況下,指令碼會以使用網頁應用程式的活躍使用者身分執行。這項權限會在使用者授權時,讓網頁應用程式顯示指令碼擁有者的電子郵件地址。

在 Google 協作平台中嵌入網頁應用程式

您必須先部署這個應用程式,才能在 Google 協作平台中嵌入網頁應用程式。此外,您還需要 Deploy 對話方塊中的「Deployed URL」(部署的網址)

如要將網頁應用程式嵌入協作平台頁面,請按照下列步驟操作:

  1. 開啟要新增網頁應用程式的協作平台頁面。
  2. 依序選取「插入」>「嵌入網址」
  3. 貼上網頁應用程式網址,然後按一下「新增」

網頁應用程式會顯示在頁面預覽畫面的頁框中。當您發布頁面時,網站檢視者可能需要先授權網頁應用程式,才能正常執行。未經授權的網頁應用程式會向使用者顯示授權提示。

網頁應用程式和瀏覽器記錄

建議您讓 Apps Script 網頁應用程式模擬多頁面應用程式,或透過網址參數控制動態 UI。為了達成目標,您可以定義代表應用程式 UI 或頁面的狀態物件,並在使用者瀏覽應用程式時將狀態推送到瀏覽器記錄中。您也可以監聽記錄事件,如此一來,當使用者透過瀏覽器按鈕來回瀏覽時,網頁應用程式就會顯示正確的 UI。藉由查詢載入時的網址參數,您可以讓應用程式根據這些參數動態建構 UI,讓使用者以特定狀態啟動應用程式。

Apps Script 提供兩個非同步用戶端 JavaScript API,協助您建立連結至瀏覽器歷史記錄的網頁應用程式:

  • google.script.history 提供可允許對瀏覽器記錄變更進行動態回應的方法。這包括:將狀態 (可定義的簡單物件) 推送到瀏覽器記錄上、取代記錄堆疊中的最高狀態,以及設定事件監聽器回呼函式以回應記錄變更。

  • google.script.url 可讓您擷取目前網頁的網址參數和網址片段 (如有)。

這些記錄 API 僅適用於網頁應用程式。側欄、對話方塊或外掛程式不支援這些模組。此外,也不建議用於 Google 協作平台內嵌的網頁應用程式中。