本頁面由 Cloud Translation API 翻譯而成。

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 個。大多數瀏覽器同樣也會將額外的伺服器要求延遲，直到其中一個現有要求完成為止。

參數和傳回值

您可以使用用戶端的參數呼叫伺服器函式。同樣地，伺服器函式可用參數的形式將值傳回用戶端，並傳遞至成功處理常式。

法律參數和傳回值是如 Number、Boolean、String 或 null 等 JavaScript 基元，以及由基元、物件和陣列組成的 JavaScript 物件和陣列。網頁內的 form 元素同樣可做為參數，但這必須是函式的唯一參數，且不合法傳回傳回值。如果您嘗試傳遞 Date、Function、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>

User 物件

您可以呼叫 withUserObject(object)，指定要傳遞至處理常式的物件做為第二個參數，藉此在多次呼叫伺服器時重複使用相同的成功或失敗處理常式。這個「使用者物件」不需要與 User 類別混淆，可讓您針對用戶端與伺服器連線的情境做出回應。由於使用者物件不會傳送至伺服器，因此幾乎是任何內容，包括函式、DOM 元素等，沒有參數限制，也不會對伺服器呼叫傳回值。但 User 物件不能為使用 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();

Private 函式

名稱結尾為底線的伺服器函式會視為不公開。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()。如需範例，請參閱「以 Google Workspace 使用者介面提供 HTML」一節。

正在將瀏覽器焦點移至「 Google Workspace」

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