Эта страница переведена с помощью Cloud Translation API.

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

Скрипты, привязанные к Google Docs, Sheets или Forms, могут отображать несколько типов элементов пользовательского интерфейса — готовые оповещения и подсказки, а также диалоговые окна и боковые панели с пользовательскими HTML- страницами. Обычно эти элементы открываются из пунктов меню . (Обратите внимание, что в Google Forms элементы пользовательского интерфейса видны только редактору, открывающему форму для редактирования, но не пользователю, открывающему форму для ответа.)

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

Оповещение — это готовое диалоговое окно, которое открывается в редакторе Google Docs, Sheets, Slides или Forms. Оно отображает сообщение и кнопку «ОК»; заголовок и альтернативные кнопки необязательны. Оно аналогично вызову window.alert() в клиентском JavaScript-коде в веб-браузере.

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

Как показано в следующем примере, Google 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() {
  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 Docs, Sheets, Slides или Forms. Оно отображает сообщение, поле ввода текста и кнопку «ОК»; заголовок и альтернативные кнопки необязательны. Это аналогично вызову window.prompt() в клиентском JavaScript-коде в веб-браузере.

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

Как показано в следующем примере, формы, слайды и таблицы Google Docs¸ используют метод 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() {
  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.");
  }
}

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

Пользовательский диалог может отображать пользовательский интерфейс службы HTML внутри редактора Google Docs, Sheets, Slides или Forms.

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

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

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

Код.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');
}

Страница.html

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

Пользовательские боковые панели

Боковая панель может отображать пользовательский интерфейс службы HTML внутри редактора Google Docs, Forms, Slides и Sheets.

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

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

Как показано в следующем примере, Google Docs, Forms, Slides и Sheets используют метод Ui.showSidebar() для открытия боковой панели.

Код.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);
}

Страница.html

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

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

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

Требования

Для использования Google Picker с Apps Script существует несколько требований.

Настройте свою среду для Google Picker.
Ваш проект сценария должен использовать стандартный проект Google Cloud .
Примечание: тот же номер облачного проекта следует передать в PickerBuilder.setAppId() , если используется область действия drive.file .
В манифесте проекта Apps Script должны быть указаны области авторизации, требуемые API Google Picker, чтобы ScriptApp.getOAuthToken() возвращал правильный токен для PickerBuilder.setOauthtoken() .
Ключ API, заданный в PickerBuilder.setDeveloperKey() можно ограничить скриптом приложений. В разделе «Ограничения приложений» выполните следующие действия:
1. Выберите HTTP-рефереры (веб-сайты) .
2. В разделе «Ограничения веб-сайта» нажмите «Добавить элемент» .
3. Нажмите «Referrer» и введите *.google.com .
4. Добавьте еще один элемент и введите *.googleusercontent.com в качестве реферера.
5. Нажмите Готово .
Необходимо вызвать PickerBuilder.setOrigin(google.script.host.origin) .

Пример

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

код.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();
}

диалог.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 Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

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

Подсказки диалогов

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

Код.gs

Страница.html

Пользовательские боковые панели

Код.gs

Страница.html

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

Требования

Пример

код.gs

диалог.html

appsscript.json

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