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

Google Workspace 文件中的對話方塊和側欄

繫結至 Google 文件、試算表或表單的腳本可以顯示多種使用者介面元素，包括內建的快訊和提示，以及包含自訂 HTML 服務頁面的對話方塊和側欄。通常，這些元素會透過選單項目開啟。(請注意，在 Google 表單中，只有開啟表單進行修改的編輯者才能看到使用者介面元素，而非開啟表單進行回覆的使用者)。

快訊對話方塊

警示是預先建構的對話方塊，會在 Google 文件、試算表、簡報或表單編輯器中開啟。這類對話方塊會顯示訊息和「確定」按鈕；標題和其他按鈕則為選用項目。這類似於在網頁瀏覽器中，在用戶端 JavaScript 中呼叫 window.alert()。

在對話方塊開啟時，警示會暫停伺服器端指令碼。使用者關閉對話方塊後，指令碼會繼續執行，但 JDBC 連線不會在暫停期間持續存在。

如以下範例所示，Google 文件、表單、簡報和試算表都使用 Ui.alert() 方法，且有三種變化版本。如要覆寫預設的「OK」按鈕，請將 Ui.ButtonSet 列舉的值做為 buttons 引數傳遞。如要評估使用者按下哪個按鈕，請將 alert() 的傳回值與 Ui.Button 列舉進行比較。

function onOpen() {
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
    .createMenu("Custom Menu")
    .addItem("Show alert", "showAlert")
    .addToUi();
}

function showAlert() {
  var ui = SpreadsheetApp.getUi(); // Same variations.

  var result = ui.alert(
    "Please confirm",
    "Are you sure you want to continue?",
    ui.ButtonSet.YES_NO,
  );

  // Process the user's response.
  if (result == ui.Button.YES) {
    // User clicked "Yes".
    ui.alert("Confirmation received.");
  } else {
    // User clicked "No" or X in the title bar.
    ui.alert("Permission denied.");
  }
}

提示對話方塊

提示是預先建構的對話方塊，會在 Google 文件、試算表、簡報或表單編輯器中開啟。這類對話方塊會顯示訊息、文字輸入欄位和「確定」按鈕；標題和其他按鈕則為選用項目。這類似於在網頁瀏覽器中，在用戶端 JavaScript 中呼叫 window.prompt()。

提示在對話方塊開啟時暫停伺服器端指令碼。使用者關閉對話方塊後，指令碼會繼續執行，但 JDBC 連線不會在暫停期間持續存在。

如以下範例所示，Google 文件、表單、簡報和試算表都使用 Ui.prompt() 方法，且有三種變化版本。如要覆寫預設的「OK」按鈕，請將 Ui.ButtonSet 列舉的值做為 buttons 引數傳遞。如要評估使用者的回應，請擷取 prompt() 的傳回值，然後呼叫 PromptResponse.getResponseText() 來擷取使用者的輸入內容，並將 PromptResponse.getSelectedButton() 的傳回值與 Ui.Button 列舉進行比較。

function onOpen() {
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
    .createMenu("Custom Menu")
    .addItem("Show prompt", "showPrompt")
    .addToUi();
}

function showPrompt() {
  var ui = SpreadsheetApp.getUi(); // Same variations.

  var result = ui.prompt(
    "Let's get to know each other!",
    "Please enter your name:",
    ui.ButtonSet.OK_CANCEL,
  );

  // Process the user's response.
  var button = result.getSelectedButton();
  var text = result.getResponseText();
  if (button == ui.Button.OK) {
    // User clicked "OK".
    ui.alert("Your name is " + text + ".");
  } else if (button == ui.Button.CANCEL) {
    // User clicked "Cancel".
    ui.alert("I didn't get your name.");
  } else if (button == ui.Button.CLOSE) {
    // User clicked X in the title bar.
    ui.alert("You closed the dialog.");
  }
}

自訂對話方塊

自訂對話方塊可在 Google 文件、試算表、簡報或表單編輯器中顯示 HTML 服務使用者介面。

自訂對話方塊在開啟時「不會」暫停伺服器端指令碼。用戶端元件可使用 google.script API 針對 HTML 服務介面，對伺服器端指令碼發出非同步呼叫。

對話方塊可在 HTML 服務介面的用戶端端點中呼叫 google.script.host.close()，藉此關閉自身。對話方塊只能由使用者或對話方塊本身關閉，其他介面無法關閉。

如以下範例所示，Google 文件、表單、簡報和試算表都會使用 Ui.showModalDialog() 方法開啟對話方塊。

Code.gs

function onOpen() {
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
      .createMenu('Custom Menu')
      .addItem('Show dialog', 'showDialog')
      .addToUi();
}

function showDialog() {
  var html = HtmlService.createHtmlOutputFromFile('Page')
      .setWidth(400)
      .setHeight(300);
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
      .showModalDialog(html, 'My custom dialog');
}

Page.html

Hello, world! <input type="button" value="Close" onclick="google.script.host.close()" />

自訂側欄

側欄可在 Google 文件、表單、簡報和試算表編輯器中顯示 HTML 服務使用者介面。

對話方塊在開啟時不會暫停伺服器端指令碼。在 HTML 服務介面中，用戶端元件可使用 google.script API 對伺服器端指令碼發出非同步呼叫。

側欄可以透過在 HTML 服務介面的用戶端端呼叫 google.script.host.close()，自行關閉。其他介面無法關閉側邊欄，只有使用者或側邊欄本身可以關閉。

如以下範例所示，Google 文件、表單、簡報和試算表都使用 Ui.showSidebar() 方法開啟側欄。

Code.gs

function onOpen() {
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
      .createMenu('Custom Menu')
      .addItem('Show sidebar', 'showSidebar')
      .addToUi();
}

function showSidebar() {
  var html = HtmlService.createHtmlOutputFromFile('Page')
      .setTitle('My custom sidebar');
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
      .showSidebar(html);
}

Page.html

Hello, world! <input type="button" value="Close" onclick="google.script.host.close()" />

檔案開啟對話方塊

Google Picker 是一種 JavaScript API，可讓使用者選取或上傳 Google 雲端硬碟檔案。Google Picker 程式庫可用於 HTML 服務，用於建立自訂對話方塊，讓使用者選取現有檔案或上傳新檔案，然後將該選取項目傳回至指令碼，以供日後使用。

需求條件

如要搭配 Apps Script 使用 Google Picker，必須符合幾項規定。

設定 Google Picker 環境。
指令碼專案必須使用標準 Google Cloud 專案。

注意： 如果使用 drive.file 範圍，應將相同的 Cloud 專案編號傳遞至 PickerBuilder.setAppId()。
Apps Script 專案資訊清單必須指定 Google Picker API 所需的授權範圍，以便 ScriptApp.getOAuthToken() 傳回 PickerBuilder.setOauthtoken() 的正確權杖。
在 PickerBuilder.setDeveloperKey() 中設定的 API 金鑰可限制為 Apps Script。在「應用程式限制」下方，完成下列步驟：
1. 選取「HTTP 參照網址 (網站)」。
2. 在「網站限制」下方，點選「新增項目」。
3. 按一下「參照網址」，然後輸入 *.google.com。
4. 新增另一個項目，並輸入 *.googleusercontent.com 做為參照來源。
5. 按一下 [完成]。
您必須呼叫 PickerBuilder.setOrigin(google.script.host.origin)。

範例

以下範例說明 Apps Script 中的 Google Picker。

code.gs

picker/code.gs

前往 GitHub 查看

/**
 * Creates a custom menu in Google Sheets when the spreadsheet opens.
 */
function onOpen() {
  SpreadsheetApp.getUi()
    .createMenu("Picker")
    .addItem("Start", "showPicker")
    .addToUi();
}

/**
 * Displays an HTML-service dialog in Google Sheets that contains client-side
 * JavaScript code for the Google Picker API.
 */
function showPicker() {
  const html = HtmlService.createHtmlOutputFromFile("dialog.html")
    .setWidth(800)
    .setHeight(600)
    .setSandboxMode(HtmlService.SandboxMode.IFRAME);
  SpreadsheetApp.getUi().showModalDialog(html, "Select a file");
}
/**
 * Checks that the file can be accessed.
 */
function getFile(fileId) {
  return Drive.Files.get(fileId, { fields: "*" });
}

/**
 * Gets the user's OAuth 2.0 access token so that it can be passed to Picker.
 * This technique keeps Picker from needing to show its own authorization
 * dialog, but is only possible if the OAuth scope that Picker needs is
 * available in Apps Script. In this case, the function includes an unused call
 * to a DriveApp method to ensure that Apps Script requests access to all files
 * in the user's Drive.
 *
 * @return {string} The user's OAuth 2.0 access token.
 */
function getOAuthToken() {
  return ScriptApp.getOAuthToken();
}

dialog.html

picker/dialog.html

前往 GitHub 查看

<!DOCTYPE html>
<html>
  <head>
    <link
      rel="stylesheet"
      href="https://ssl.gstatic.com/docs/script/css/add-ons.css"
    />
    <style>
      #result {
        display: flex;
        flex-direction: column;
        gap: 0.25em;
      }

      pre {
        font-size: x-small;
        max-height: 25vh;
        overflow-y: scroll;
        background: #eeeeee;
        padding: 1em;
        border: 1px solid #cccccc;
      }
    </style>
    <script>
      // TODO: Replace the value for DEVELOPER_KEY with the API key obtained
      // from the Google Developers Console.
      const DEVELOPER_KEY = "AIza...";
      // TODO: Replace the value for CLOUD_PROJECT_NUMBER with the project
      // number obtained from the Google Developers Console.
      const CLOUD_PROJECT_NUMBER = "1234567890";

      let pickerApiLoaded = false;
      let oauthToken;

      /**
       * Loads the Google Picker API.
       */
      function onApiLoad() {
        gapi.load("picker", {
          callback: function () {
            pickerApiLoaded = true;
          },
        });
      }

      /**
       * Gets the user's OAuth 2.0 access token from the server-side script so that
       * it can be passed to Picker. This technique keeps Picker from needing to
       * show its own authorization dialog, but is only possible if the OAuth scope
       * that Picker needs is available in Apps Script. Otherwise, your Picker code
       * will need to declare its own OAuth scopes.
       */
      function getOAuthToken() {
        google.script.run
          .withSuccessHandler((token) => {
            oauthToken = token;
            createPicker(token);
          })
          .withFailureHandler(showError)
          .getOAuthToken();
      }

      /**
       * Creates a Picker that can access the user's spreadsheets. This function
       * uses advanced options to hide the Picker's left navigation panel and
       * default title bar.
       *
       * @param {string} token An OAuth 2.0 access token that lets Picker access the
       *     file type specified in the addView call.
       */
      function createPicker(token) {
        document.getElementById("result").innerHTML = "";

        if (pickerApiLoaded && token) {
          const picker = new google.picker.PickerBuilder()
            // Instruct Picker to display only spreadsheets in Drive. For other
            // views, see https://developers.google.com/picker/reference/picker.viewid
            .addView(
              new google.picker.DocsView(
                google.picker.ViewId.SPREADSHEETS
              ).setOwnedByMe(true)
            )
            // Hide the navigation panel so that Picker fills more of the dialog.
            .enableFeature(google.picker.Feature.NAV_HIDDEN)
            // Hide the title bar since an Apps Script dialog already has a title.
            .hideTitleBar()
            .setOAuthToken(token)
            .setDeveloperKey(DEVELOPER_KEY)
            .setAppId(CLOUD_PROJECT_NUMBER)
            .setCallback(pickerCallback)
            .setOrigin(google.script.host.origin)
            .build();
          picker.setVisible(true);
        } else {
          showError("Unable to load the file picker.");
        }
      }

      /**
       * A callback function that extracts the chosen document's metadata from the
       * response object. For details on the response object, see
       * https://developers.google.com/picker/reference/picker.responseobject
       *
       * @param {object} data The response object.
       */
      function pickerCallback(data) {
        const action = data[google.picker.Response.ACTION];
        if (action == google.picker.Action.PICKED) {
          handlePicked(data);
        } else if (action == google.picker.Action.CANCEL) {
          document.getElementById("result").innerHTML = "Picker canceled.";
        }
      }

      /**
       * Handles `"PICKED"` responsed from the Google Picker.
       *
       * @param {object} data The response object.
       */
      function handlePicked(data) {
        const doc = data[google.picker.Response.DOCUMENTS][0];
        const id = doc[google.picker.Document.ID];

        google.script.run
          .withSuccessHandler((driveFilesGetResponse) => {
            // Render the response from Picker and the Drive.Files.Get API.
            const resultElement = document.getElementById("result");
            resultElement.innerHTML = "";

            for (const response of [
              {
                title: "Picker response",
                content: JSON.stringify(data, null, 2),
              },
              {
                title: "Drive.Files.Get response",
                content: JSON.stringify(driveFilesGetResponse, null, 2),
              },
            ]) {
              const titleElement = document.createElement("h3");
              titleElement.appendChild(document.createTextNode(response.title));
              resultElement.appendChild(titleElement);

              const contentElement = document.createElement("pre");
              contentElement.appendChild(
                document.createTextNode(response.content)
              );
              resultElement.appendChild(contentElement);
            }
          })
          .withFailureHandler(showError)
          .getFile(data[google.picker.Response.DOCUMENTS][0].id);
      }

      /**
       * Displays an error message within the #result element.
       *
       * @param {string} message The error message to display.
       */
      function showError(message) {
        document.getElementById("result").innerHTML = "Error: " + message;
      }
    </script>
  </head>

  <body>
    <div>
      <button onclick="getOAuthToken()">Select a file</button>
      <div id="result"></div>
    </div>
    <script src="https://apis.google.com/js/api.js?onload=onApiLoad"></script>
  </body>
</html>

appsscript.json

picker/appsscript.json

前往 GitHub 查看

{
    "timeZone": "America/Los_Angeles",
    "exceptionLogging": "STACKDRIVER",
    "runtimeVersion": "V8",
    "oauthScopes": [
      "https://www.googleapis.com/auth/script.container.ui",
      "https://www.googleapis.com/auth/drive.file"
    ],
    "dependencies": {
      "enabledAdvancedServices": [
        {
          "userSymbol": "Drive",
          "version": "v3",
          "serviceId": "drive"
        }
      ]
    }
  }

Google Workspace 文件中的對話方塊和側欄 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

快訊對話方塊

提示對話方塊

自訂對話方塊

Code.gs

Page.html

自訂側欄

Code.gs

Page.html

檔案開啟對話方塊

需求條件

範例

code.gs

dialog.html

appsscript.json

Google Workspace 文件中的對話方塊和側欄