Действия редактора

Используйте объекты Action для создания интерактивного поведения в надстройках Google Workspace.

Объекты действий определяют, что происходит, когда пользователь взаимодействует с виджетом (например, кнопкой) в пользовательском интерфейсе дополнения.

Добавить действие к виджету

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

Пример: Отобразить новую карточку при нажатии кнопки.

Если вы хотите добавить в свой аддон кнопку, которая при нажатии создает и отображает новую карточку, выполните следующие действия:

  1. Создайте виджет кнопки.
  2. Чтобы задать действие для создания карточки, добавьте функцию обработчика виджета кнопки setOnClickAction .
  3. Создайте функцию обратного вызова Apps Script для выполнения и укажите её в качестве action внутри функции обработчика виджета. В данном случае функция обратного вызова должна создать нужную карточку и вернуть объект ActionResponse . Объект Response указывает дополнению отобразить карточку, созданную функцией обратного вызова.

В следующем примере показано создание виджета кнопки. Действие запрашивает область видимости drive.file для текущего файла от имени дополнения.

/**
 * Adds a section to the Card Builder that displays a "REQUEST PERMISSION"
 * button. When it's clicked, the callback triggers file scope permission flow.
 * This is used in the add-on when the home-page displays basic data.
 */
function addRequestFileScopeButtonToBuilder(cardBuilder) {
    var buttonSection = CardService.newCardSection();
    // If the add-on does not have access permission, add a button that
    // lets the user provide that permission on a per-file basis.
    var buttonAction = CardService.newAction()
      .setFunctionName("onRequestFileScopeButtonClickedInEditor");

    var button = CardService.newTextButton()
      .setText("Request permission")
      .setBackgroundColor("#4285f4")
      .setTextButtonStyle(CardService.TextButtonStyle.FILLED)
      .setOnClickAction(buttonAction);

    buttonSection.addWidget(button);
    cardBuilder.addSection(buttonSection);
}

/**
 * Callback function for a button action. Instructs Docs to display a
 * permissions dialog to the user, requesting `drive.file` scope for the 
 * current file on behalf of this add-on.
 *
 * @param {Object} e The parameters object that contains the document's ID
 * @return {editorFileScopeActionResponse}
 */
function onRequestFileScopeButtonClickedInEditor(e) {
  return CardService.newEditorFileScopeActionResponseBuilder()
      .requestFileScopeForActiveDocument().build();
}

Взаимодействие с файлами через REST API

Дополнения Google Workspace, расширяющие возможности редакторов и использующие REST API, могут включать дополнительное действие виджета для запроса доступа к файлу. Для этого действия требуется, чтобы связанная функция обратного вызова возвращала специализированный объект ответа:

Предпринятые действия Функция обратного вызова должна возвращать
Запросить доступ к файлу EditorFileScopeActionResponse

Для использования объекта действия и ответа этого виджета необходимо выполнение всех следующих условий:

  • Дополнение использует REST API.
  • Дополнение отображает диалоговое окно запроса области действия файла с помощью метода CardService.newEditorFileScopeActionResponseBuilder().requestFileScopeForActiveDocument().build();
  • В манифест дополнения включены область действия редактора https://www.googleapis.com/auth/drive.file и триггер onFileScopeGranted .

Запросить доступ к файлу текущего документа.

Чтобы запросить доступ к текущему документу, выполните следующие действия:

  1. Создайте карточку на главной странице, которая проверяет, имеет ли дополнение область действия drive.file .
  2. В тех случаях, когда надстройке не предоставлена ​​область действия drive.file , необходимо предусмотреть способ запроса у пользователей предоставления области действия drive.file для текущего документа.

Пример: Получение доступа к текущему документу в Документах.

В следующем примере создан интерфейс для Docs, отображающий размер текущего документа. Если у дополнения нет авторизации drive.file , отображается кнопка для запуска авторизации в области действия файла.

/**
 * Build a card that checks selected items' quota usage. Checking
 * quota usage requires user-permissions, so this add-on provides a button
 * to request `drive.file` scope for items the add-on doesn't yet have
 * permission to access.
 *
 * @param e The event object passed containing information about the
 *   current document.
 * @return {Card}
 */
function onDocsHomepage(e) {
  return createAddOnView(e);
}

function onFileScopeGranted(e) {
  return createAddOnView(e);
}

/**
 * For the current document, display either its quota information or
 * a button that lets the user provide permission to access that
 * file to retrieve its quota details.
 *
 * @param e The event containing information about the current document
 * @return {Card}
 */
function createAddOnView(e) {
  var docsEventObject = e['docs'];
  var builder =  CardService.newCardBuilder();

  var cardSection = CardService.newCardSection();
  if (docsEventObject['addonHasFileScopePermission']) {
    cardSection.setHeader(docsEventObject['title']);
    // This add-on uses the recommended, limited-permission `drive.file`
    // scope to get granular per-file access permissions.
    // See: https://developers.google.com/drive/api/v2/about-auth
    // If the add-on has access permission, read and display its quota.
    cardSection.addWidget(
      CardService.newTextParagraph().setText(
          "This file takes up: " +
          getQuotaBytesUsed(docsEventObject['id'])));
  } else {
    // If the add-on does not have access permission, add a button that
    // lets the user provide that permission on a per-file basis.
    cardSection.addWidget(
      CardService.newTextParagraph().setText(
          "The add-on needs permission to access this file's quota."));

    var buttonAction = CardService.newAction()
      .setFunctionName("onRequestFileScopeButtonClicked");

    var button = CardService.newTextButton()
      .setText("Request permission")
      .setOnClickAction(buttonAction);

    cardSection.addWidget(button);
  }
  return builder.addSection(cardSection).build();
}

/**
 * Callback function for a button action. Instructs Docs to
 * display a permissions dialog to the user, requesting `drive.file` scope for
 * the current file on behalf of this add-on.
 *
 * @param {Object} e The parameters object that contains the document's ID
 * @return {editorFileScopeActionResponse}
 */
function onRequestFileScopeButtonClicked(e) {
  return CardService.newEditorFileScopeActionResponseBuilder()
      .requestFileScopeForActiveDocument().build();
}