HTML 服務:與伺服器函式通訊

google.script.run 是用於非同步用戶端 JavaScript API,可讓 HTML 服務網頁呼叫伺服器端 Apps Script 函式。以下範例說明 google.script.run 最基本的功能,也就是從用戶端 JavaScript 呼叫伺服器上的函式

Code.gs

function doGet() {
  return HtmlService.createHtmlOutputFromFile('Index');
}

function doSomething() {
  Logger.log('I was called!');
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
    <script>
      google.script.run.doSomething();
    </script>
  </head>
</html>

如果您將這個指令碼部署為網頁應用程式,並造訪其網址,您將不會看到任何內容,但如果您查看記錄,就會看到系統呼叫了伺服器函式 doSomething()

用戶端對伺服器端函式的呼叫為非同步:在瀏覽器要求伺服器執行函式 doSomething() 後,瀏覽器會立即繼續執行下一行程式碼,而不會等待回應。這表示伺服器函式呼叫可能不會依照預期順序執行。如果您同時發出兩個函式呼叫,就無法得知哪個函式會先執行;每次載入網頁時,結果可能會有所不同。在這種情況下,成功處理常式失敗處理常式可協助控制程式碼的流程。

google.script.run API 允許同時呼叫 10 個伺服器函式。如果您在 10 個呼叫仍在執行時發出第 11 次呼叫,伺服器函式會延遲,直到 10 個位置中的其中一個釋出為止。實際上,您不太需要考慮這項限制,尤其是因為大多數瀏覽器已將對同一伺服器的並行要求數量限制在 10 以下。舉例來說,Firefox 的限制為 6 個。大多數瀏覽器也會延遲多餘的伺服器要求,直到其中一個現有要求完成為止。

參數和傳回值

您可以從用戶端呼叫含有參數的伺服器函式。同樣地,伺服器函式可以將值傳回給用戶端,做為傳遞至成功處理常式的參數。

合法的參數和傳回值是 JavaScript 原始值,例如 NumberBooleanStringnull,以及由原始值、物件和陣列組成的 JavaScript 物件和陣列。頁面中的 form 元素也可以做為參數,但必須是函式的唯一參數,且不得做為傳回值。如果您嘗試傳遞 DateFunction、DOM 元素 (除了 form) 或其他禁止類型 (包括物件或陣列中的禁止類型),要求就會失敗。建立循環參照的物件也會失敗,而陣列中的未定義欄位會變成 null

請注意,傳遞至伺服器的物件會成為原始物件的副本。如果伺服器函式接收物件並變更其屬性,用戶端上的屬性不會受到影響。

成功處理常式

由於用戶端程式碼會繼續執行下一行,而不會等待伺服器呼叫完成,因此 withSuccessHandler(function) 可讓您指定用戶端回呼函式,以便在伺服器回應時執行。如果伺服器函式傳回值,API 會將該值做為參數傳遞至新函式。

以下範例會在伺服器回應時顯示瀏覽器快訊。請注意,由於伺服器端函式會存取您的 Gmail 帳戶,因此這個程式碼範例需要授權。授權指令碼最簡單的方法,就是在載入網頁前,先從指令碼編輯器手動執行 getUnreadEmails() 函式一次。或者,您也可以在部署網路應用程式時,選擇以「使用者存取網路應用程式」的身份執行應用程式,這樣一來,您在載入應用程式時,系統就會提示您授權。

Code.gs

function doGet() {
  return HtmlService.createHtmlOutputFromFile('Index');
}

function getUnreadEmails() {
  return GmailApp.getInboxUnreadCount();
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
    <script>
      function onSuccess(numUnread) {
        var div = document.getElementById('output');
        div.innerHTML = 'You have ' + numUnread
            + ' unread messages in your Gmail inbox.';
      }

      google.script.run.withSuccessHandler(onSuccess)
          .getUnreadEmails();
    </script>
  </head>
  <body>
    <div id="output"></div>
  </body>
</html>

失敗處理常式

如果伺服器無法回應或擲回錯誤,您可以使用 withFailureHandler(function) 指定失敗處理常式,而非成功處理常式,並將 Error 物件 (如有) 傳遞為引數。

根據預設,如果您未指定失敗處理常式,系統會將失敗記錄記錄到 JavaScript 主控台。如要覆寫此值,請呼叫 withFailureHandler(null) 或提供不執行任何操作的失敗處理常式。

失敗處理常式的語法幾乎與成功處理常式相同,如本範例所示。

Code.gs

function doGet() {
  return HtmlService.createHtmlOutputFromFile('Index');
}

function getUnreadEmails() {
  // 'got' instead of 'get' will throw an error.
  return GmailApp.gotInboxUnreadCount();
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
    <script>
      function onFailure(error) {
        var div = document.getElementById('output');
        div.innerHTML = "ERROR: " + error.message;
      }

      google.script.run.withFailureHandler(onFailure)
          .getUnreadEmails();
    </script>
  </head>
  <body>
    <div id="output"></div>
  </body>
</html>

使用者物件

您可以呼叫 withUserObject(object),指定要以第二個參數傳遞至處理常式的物件,藉此為多個伺服器呼叫重複使用相同的成功或失敗處理常式。這個「使用者物件」(請勿與 User 類別混淆) 可讓您回應用戶端與伺服器聯絡的情況。由於使用者物件不會傳送至伺服器,因此幾乎可以是任何物件,包括函式、DOM 元素等,且不會受到伺服器呼叫的參數和傳回值限制。不過,使用者物件不能是使用 new 運算子建構的物件。

在這個範例中,點選兩個按鈕中的任一按鈕,系統會使用伺服器的值更新該按鈕,而另一個按鈕則保持不變,即使兩者共用一個成功處理常式。在 onclick 處理常式中,關鍵字 this 是指 button 本身。

Code.gs

function doGet() {
  return HtmlService.createHtmlOutputFromFile('Index');
}

function getEmail() {
  return Session.getActiveUser().getEmail();
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
    <script>
      function updateButton(email, button) {
        button.value = 'Clicked by ' + email;
      }
    </script>
  </head>
  <body>
    <input type="button" value="Not Clicked"
      onclick="google.script.run
          .withSuccessHandler(updateButton)
          .withUserObject(this)
          .getEmail()" />
    <input type="button" value="Not Clicked"
      onclick="google.script.run
          .withSuccessHandler(updateButton)
          .withUserObject(this)
          .getEmail()" />
  </body>
</html>

表單

如果您使用 form 元素做為參數來呼叫伺服器函式,表單就會變成單一物件,其中欄位名稱做為鍵,欄位值做為值。所有值都會轉換為字串,但檔案輸入欄位的內容會變成 Blob 物件。

這個範例會處理表單 (包括檔案輸入欄位),但不會重新載入網頁;它會將檔案上傳至 Google 雲端硬碟,然後在用戶端網頁中列印檔案的網址。在 onsubmit 處理常式中,關鍵字 this 會參照表單本身。請注意,在載入頁面中的所有表單時,preventFormSubmit 會停用預設的提交動作。這樣一來,如果發生例外狀況,頁面就不會重新導向至不正確的網址。

Code.gs

function doGet() {
  return HtmlService.createHtmlOutputFromFile('Index');
}

function processForm(formObject) {
  var formBlob = formObject.myFile;
  var driveFile = DriveApp.createFile(formBlob);
  return driveFile.getUrl();
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
    <script>
      // Prevent forms from submitting.
      function preventFormSubmit() {
        var forms = document.querySelectorAll('form');
        for (var i = 0; i < forms.length; i++) {
          forms[i].addEventListener('submit', function(event) {
            event.preventDefault();
          });
        }
      }
      window.addEventListener('load', preventFormSubmit);

      function handleFormSubmit(formObject) {
        google.script.run.withSuccessHandler(updateUrl).processForm(formObject);
      }
      function updateUrl(url) {
        var div = document.getElementById('output');
        div.innerHTML = '<a href="' + url + '">Got it!</a>';
      }
    </script>
  </head>
  <body>
    <form id="myForm" onsubmit="handleFormSubmit(this)">
      <input name="myFile" type="file" />
      <input type="submit" value="Submit" />
    </form>
    <div id="output"></div>
 </body>
</html>

指令碼執行工具

您可以將 google.script.run 視為「指令碼執行程式」的建構工具。如果您將成功處理常式、失敗處理常式或使用者物件新增至指令碼執行程式,就不會變更現有的執行程式,而是會取得具有新行為的新指令碼執行程式。

您可以使用 withSuccessHandler()withFailureHandler()withUserObject() 的任何組合和順序。您也可以在已設定值的指令碼執行程式上呼叫任何修改函式。新的值會直接覆寫先前的值。

這個範例會為所有三個伺服器呼叫設定通用失敗處理常式,但有兩個不同的成功處理常式:

var myRunner = google.script.run.withFailureHandler(onFailure);
var myRunner1 = myRunner.withSuccessHandler(onSuccess);
var myRunner2 = myRunner.withSuccessHandler(onDifferentSuccess);

myRunner1.doSomething();
myRunner1.doSomethingElse();
myRunner2.doSomething();

私人功能

名稱結尾為底線的伺服器函式會視為私有函式。這些函式無法由 google.script 呼叫,而且其名稱絕不會傳送至用戶端。因此,您可以使用這些元素隱藏在伺服器上需要保密的實作詳細資料。google.script 也無法查看程式庫中的函式,以及未在指令碼頂層宣告的函式。

在這個範例中,函式 getBankBalance() 可在用戶端程式碼中使用;即使您沒有呼叫該函式,檢查原始碼的使用者仍可發現其名稱。不過,deepSecret_()obj.objectMethod() 函式對用戶端完全不可見。

Code.gs

function doGet() {
  return HtmlService.createHtmlOutputFromFile('Index');
}

function getBankBalance() {
  var email = Session.getActiveUser().getEmail()
  return deepSecret_(email);
}

function deepSecret_(email) {
 // Do some secret calculations
 return email + ' has $1,000,000 in the bank.';
}

var obj = {
  objectMethod: function() {
    // More secret calculations
  }
};

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
    <script>
      function onSuccess(balance) {
        var div = document.getElementById('output');
        div.innerHTML = balance;
      }

      google.script.run.withSuccessHandler(onSuccess)
          .getBankBalance();
    </script>
  </head>
  <body>
    <div id="output">No result yet...</div>
  </body>
</html>

調整 Google Workspace 應用程式中的對話方塊大小

如要調整 Google 文件、試算表或表單中的自訂對話方塊大小,請在用戶端程式碼中呼叫 google.script.host 方法 setWidth(width)setHeight(height)。(如要設定對話方塊的初始大小,請使用 HtmlOutput 方法 setWidth(width)setHeight(height))。請注意,對話方塊在調整大小後不會在父視窗中重新置中,且無法調整側欄的大小。

關閉 Google Workspace中的對話方塊和側欄

如果您使用 HTML 服務在 Google 文件、試算表或表單中顯示對話方塊或側欄,就無法透過呼叫 window.close() 關閉介面。而是必須呼叫 google.script.host.close()。如需範例說明,請參閱「將 HTML 做為 Google Workspace 使用者介面提供」一節。

在 Google Workspace中移動瀏覽器焦點

如要將使用者瀏覽器中的焦點從對話方塊或側邊列切換回 Google 文件、試算表或表單編輯器,只要呼叫 google.script.host.editor.focus() 方法即可。此方法搭配文件服務方法 Document.setCursor(position)Document.setSelection(range) 時特別實用。