Диалоги и боковые панели в документах Google Workspace

Проекты Google Apps Script, привязанные к Google Docs, Google Sheets или Google Forms, могут отображать элементы пользовательского интерфейса, такие как предварительно созданные оповещения, подсказки, всплывающие уведомления, диалоги и боковые панели. Эти элементы обычно содержат пользовательский HTML- контент и часто открываются из пунктов меню . В Forms элементы пользовательского интерфейса видны только редактору, который открывает форму для ее изменения, а не пользователю, отвечающему на вопросы.

Диалоги оповещений

«Alert» — это предварительно созданное диалоговое окно, которое открывается в редакторе документов, таблиц, презентаций или форм. Оно отображает сообщение и кнопку «ОК» ; заголовок и альтернативные кнопки являются необязательными. Это похоже на вызов метода window.alert в клиентском JavaScript в веб-браузере.

Уведомления приостанавливают выполнение серверного скрипта на время открытия диалогового окна. Скрипт возобновляет работу после закрытия пользователем диалогового окна, но JDBC- соединения не сохраняются после приостановки.

Как показано в следующем примере, в документах (Docs), формах (Forms), слайдах (Slides) и таблицах (Sheets) используется метод Ui.alert , который доступен в трех вариантах. Чтобы переопределить кнопку «ОК» по умолчанию, передайте значение из перечисления 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() {
  const ui = SpreadsheetApp.getUi(); // Same variations.

  const 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.");
  }
}

Диалоги подсказок

Диалоговое окно «Подсказка» — это предварительно созданное диалоговое окно, которое открывается в редакторе документов, таблиц, презентаций или форм. Оно отображает сообщение, текстовое поле ввода и кнопку «ОК» ; заголовок и дополнительные кнопки являются необязательными. Это похоже на вызов метода window.prompt в клиентском JavaScript в веб-браузере.

При появлении подсказок выполнение серверного скрипта приостанавливается на время работы диалогового окна. Скрипт возобновляется после закрытия пользователем диалогового окна, но JDBC- соединения не сохраняются после приостановки.

Как показано в следующем примере, в документах (Docs), формах (Forms), слайдах (Slides) и таблицах (Sheets) используется метод Ui.prompt , который доступен в трех вариантах. Чтобы переопределить кнопку «ОК» по умолчанию, передайте значение из перечисления 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() {
  const ui = SpreadsheetApp.getUi(); // Same variations.

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

  // Process the user's response.
  const button = result.getSelectedButton();
  const 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.");
  }
}

Подсказки в виде электронных таблиц

«Всплывающее сообщение» — это небольшое диалоговое окно в правом нижнем углу редактора таблиц, которое отображает сообщение, но не приостанавливает выполнение скрипта. Это хороший способ показать сообщения о состоянии или обновления, не требующие взаимодействия с пользователем.

Как показано в следующем примере, в Sheets используется метод Spreadsheet.toast . Всплывающие уведомления (toast) доступны только в Sheets.

function showToast() {
  SpreadsheetApp.getActiveSpreadsheet().toast("Task completed successfully.");
}

Пользовательские диалоги

Пользовательское диалоговое окно может отображать HTML-интерфейс службы внутри редактора документов, таблиц, презентаций или форм.

Пользовательские диалоги не приостанавливают выполнение серверного скрипта во время открытия диалога. Поскольку они асинхронны, серверная функция, открывающая диалог, завершается немедленно. Для передачи данных из пользовательского диалога обратно на сервер используйте API google.script в клиентском коде.

Диалоговое окно может закрыться само собой, вызвав метод google.script.host.close на стороне клиента в интерфейсе HTML-сервиса. Диалоговое окно не может быть закрыто другими интерфейсами, только пользователем или самим собой.

Как показано в следующем примере, для открытия диалогового окна в окнах Docs, Forms, Slides и Sheets используется метод Ui.showModalDialog .

Code.gs 

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

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

Страница.html 

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

Настраиваемые боковые панели

Боковая панель может отображать пользовательский интерфейс HTML-сервиса внутри редакторов документов, форм, презентаций и таблиц.

Боковые панели не приостанавливают выполнение серверного скрипта, пока диалоговое окно открыто. Клиентский компонент может выполнять асинхронные вызовы к серверному скрипту, используя API google.script для интерфейсов HTML-сервисов.

Боковая панель может закрыться сама собой, вызвав метод google.script.host.close на стороне клиента в интерфейсе HTML-сервиса. Боковая панель не может быть закрыта другими интерфейсами, только пользователем или самой собой.

Как показано в следующем примере, в документах, формах, слайдах и таблицах для открытия боковой панели используется метод Ui.showSidebar .

Code.gs 

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

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

Страница.html 

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

Диалоги открытия файлов

Google Picker — это JavaScript API, позволяющий пользователям выбирать или загружать файлы из Google Диска. Используйте библиотеку Google Picker в HTML-сервисе для создания пользовательского диалогового окна, позволяющего пользователям выбирать существующие файлы или загружать новые, а затем передавать выбранные файлы обратно в ваш скрипт.

Требования

Использование Google Picker с Google Apps Script требует соблюдения ряда условий:

  • Настройте среду для работы с Google Picker.

  • В вашем проекте скрипта должен использоваться стандартный проект Google Cloud .

    Если используется область drive.file , передайте тот же номер проекта Cloud в метод PickerBuilder.setAppId .

  • В манифесте проекта Apps Script необходимо указать области авторизации, требуемые API Google Picker, чтобы ScriptApp.getOAuthToken возвращал правильный токен для PickerBuilder.setOauthtoken .

  • Ограничьте использование ключа API, заданного в PickerBuilder.setDeveloperKey , только для Apps Script. В разделе «Ограничения приложения» выполните следующие действия:

    1. Выберите HTTP-источники переходов (веб-сайты) .
    2. В разделе «Ограничения веб-сайта» нажмите «Добавить элемент» .
    3. Нажмите «Реферер» и введите *.google.com .
    4. Добавьте еще один элемент и укажите *.googleusercontent.com в качестве источника перехода.
    5. Нажмите «Готово» .

  • Вызовите метод PickerBuilder.setOrigin .

Пример

В следующем примере показан инструмент Google Picker в Apps Script.

код.gs

picker/code.gs
/**
 * 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");
}
// Ensure the Drive API is enabled.
if (!Drive) {
  throw new Error("Please enable the Drive advanced service.");
}

/**
 * Checks that the file can be accessed.
 * @param {string} fileId The ID of the file.
 * @return {Object} The file resource.
 */
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();
}

диалог.html

picker/dialog.html
<!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.");
        }
      }

      /**
       * @typedef {Object} PickerResponse
       * @property {string} action
       * @property {PickerDocument[]} docs
       */

      /**
       * @typedef {Object} PickerDocument
       * @property {string} id
       * @property {string} name
       * @property {string} mimeType
       * @property {string} url
       * @property {string} lastEditedUtc
       */

      /**
       * 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 {PickerResponse} 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 {PickerResponse} 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
{
  "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"
      }
    ]
  }
}