Diálogos y barras laterales en documentos de Google Workspace

Las secuencias de comandos que están vinculadas a Documentos, Hojas de cálculo o Formularios de Google pueden mostrar varios tipos de elementos de la interfaz de usuario, como alertas y mensajes precompilados, además de diálogos y barras laterales que contienen páginas personalizadas del servicio HTML. Por lo general, estos elementos se abren desde elementos de menú. (Ten en cuenta que en Formularios de Google, los elementos de la interfaz de usuario solo son visibles para un editor que abre el formulario a fin de modificarlo, no para un usuario que abre el formulario para responder).

Diálogos de alerta

Una alerta es un cuadro de diálogo compilado previamente que se abre en un editor de Formularios, Presentaciones, Documentos o Hojas de cálculo de Google. Muestra un mensaje y un botón "OK" (aceptar); un título y botones alternativos son opcionales. Es similar a llamar a window.alert() en JavaScript del lado del cliente dentro de un navegador web.

Las alertas suspenden la secuencia de comandos del servidor mientras el diálogo está abierto. La secuencia de comandos se reanuda después de que el usuario cierra el diálogo, pero las conexiones JDBC no persisten durante la suspensión.

Como se muestra en el siguiente ejemplo, todos los archivos de Documentos, Formularios, Hojas de cálculo y Presentaciones de Google usan el método Ui.alert(), que está disponible en tres variantes. Para anular el botón predeterminado “Aceptar”, pasa un valor de la enumeración Ui.ButtonSet como argumento buttons. Para evaluar en qué botón hizo clic el usuario, compara el valor que muestra alert() con la enumeración 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.');
  }
}

Diálogos de solicitud

Un mensaje es un cuadro de diálogo compilado previamente que se abre en un editor de Formularios, Presentaciones, Documentos o Hojas de cálculo de Google. Muestra un mensaje, un campo de entrada de texto y un botón "Aceptar"; un título y botones alternativos son opcionales. Es similar a llamar a window.prompt() en JavaScript del lado del cliente dentro de un navegador web.

Los mensajes suspenderán la secuencia de comandos del lado del servidor mientras el diálogo esté abierto. La secuencia de comandos se reanuda después de que el usuario cierra el diálogo, pero las conexiones JDBC no persisten durante la suspensión.

Como se muestra en el siguiente ejemplo, Formularios, Presentaciones y Hojas de cálculo de Documentos de Google usan el método Ui.prompt(), que está disponible en tres variantes. Para anular el botón predeterminado “Aceptar”, pasa un valor de la enumeración Ui.ButtonSet como argumento buttons. Para evaluar la respuesta del usuario, captura el valor de retorno de prompt(), luego llama a PromptResponse.getResponseText() a fin de recuperar la entrada del usuario y compara el valor de retorno de PromptResponse.getSelectedButton() con la enumeración 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.');
  }
}

Diálogos personalizados

Un diálogo personalizado puede mostrar una interfaz de usuario del servicio HTML dentro de un editor de Formularios, Hojas de cálculo, Documentos o Hojas de cálculo de Google.

Los diálogos personalizados no suspenden la secuencia de comandos del lado del servidor mientras el diálogo está abierto. El componente del cliente puede realizar llamadas asíncronas a la secuencia de comandos del lado del servidor mediante la API de google.script para las interfaces de servicio HTML.

El diálogo puede cerrarse solo llamando a google.script.host.close() en el lado del cliente de una interfaz de servicio HTML. El diálogo no puede ser cerrado por otras interfaces, solo por el usuario o en sí mismo.

Como se muestra en el siguiente ejemplo, todos los archivos de Documentos, Formularios, Hojas de cálculo y Presentaciones de Google usan el método Ui.showModalDialog() para abrir el diálogo.

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');
}

Página.html

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

Barras laterales personalizadas

Una barra lateral puede mostrar una interfaz de usuario del servicio de HTML dentro de un editor de Hojas de cálculo, Presentaciones, Documentos o Formularios de Google.

Las barras laterales no suspenden la secuencia de comandos del lado del servidor mientras el diálogo está abierto. El componente del cliente puede realizar llamadas asíncronas a la secuencia de comandos del lado del servidor mediante la API de google.script para las interfaces de servicio HTML.

La barra lateral se puede cerrar sola llamando a google.script.host.close() en el lado del cliente de una interfaz de servicio HTML. Otras interfaces no pueden cerrar la barra lateral, solo el usuario o la misma.

Como se muestra en el siguiente ejemplo, Documentos, Formularios, Presentaciones y Hojas de cálculo de Google usan el método Ui.showSidebar() para abrir la barra lateral.

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);
}

Página.html

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

Abrir diálogos de archivos

El Selector de Google es un diálogo "file-open" para la información almacenada en los servidores de Google, que incluye Google Drive, Búsqueda de imágenes de Google, Búsqueda de videos de Google y más.

Como se muestra en el siguiente ejemplo, la API de JavaScript del lado del cliente del selector se puede usar en el servicio HTML para crear un diálogo personalizado que permita a los usuarios seleccionar archivos existentes o subir nuevos y, luego, pasar esa selección a tu secuencia de comandos para su uso posterior.

Nota: Para usar el selector de Google, tu proyecto de secuencia de comandos debe usar un proyecto estándar de Cloud Platform (GCP).

Para habilitar el selector y obtener una clave de API, sigue estas instrucciones:

1. Verifica que tu proyecto de secuencia de comandos use un proyecto de GCP estándar.
2. Habilita la "Google Picker API" en tu proyecto de GCP.
3. Mientras tu proyecto de GCP sigue abierto, selecciona API y servicios y, luego, haz clic en Credenciales.
4. Haz clic en Create credentials > key key. Esta acción crea la clave, pero debes editarla para agregar restricciones de aplicaciones y una restricción de API.
5. En el diálogo Clave de API, haz clic en Cerrar.
6. Junto a la clave de API que creaste, haz clic en Más > Editar clave de API.

7. En Restricciones de aplicaciones, completa los siguientes pasos:

   1. Selecciona URL de referencia HTTP (sitios web).
   2. En Restricciones de sitios web, haga clic en Agregar un elemento.
   3. Haga clic en Referrer y, luego, ingrese *.google.com.
   4. Agrega otro elemento y, luego, ingresa *.googleusercontent.com como referente.
   5. Haga clic en Listo.

8. En Restricciones de API, completa los siguientes pasos:

   1. Selecciona Restringir clave.

   2. En la sección Select APIs, selecciona Google Picker API y haz clic en OK.

      Nota: La API de Google Picker no aparece, a menos que la hayas habilitado, porque la lista solo muestra las API que se habilitaron para el proyecto de Cloud.

9. En Clave de API, haz clic en Copiar al portapapeles .

10. En la parte inferior, haz clic en Guardar.

En el siguiente ejemplo, se llama a ScriptApp.getOAuthToken() para que pueda pasar el token de acceso de OAuth 2.0 del usuario al selector. Esta técnica evita que el selector muestre su propio diálogo de autorización, pero solo es posible si el alcance de OAuth que el selector necesita está disponible en Apps Script. De lo contrario, el código del selector deberá declarar sus propios alcances de OAuth, como se muestra en este ejemplo de Hello World.

Debes llamar a setOrigin(google.script.host.origin) cuando construyas el PickerBuilder.

code.gs

selector/código.gs

Ver en GitHub

/**
 * Creates a custom menu in Google Sheets when the spreadsheet opens.
 */
function onOpen() {
  try {
    SpreadsheetApp.getUi().createMenu('Picker')
        .addItem('Start', 'showPicker')
        .addToUi();
  } catch (e) {
    // TODO (Developer) - Handle exception
    Logger.log('Failed with error: %s', e.error);
  }
}

/**
 * Displays an HTML-service dialog in Google Sheets that contains client-side
 * JavaScript code for the Google Picker API.
 */
function showPicker() {
  try {
    const html = HtmlService.createHtmlOutputFromFile('dialog.html')
        .setWidth(600)
        .setHeight(425)
        .setSandboxMode(HtmlService.SandboxMode.IFRAME);
    SpreadsheetApp.getUi().showModalDialog(html, 'Select a file');
  } catch (e) {
    // TODO (Developer) - Handle exception
    Logger.log('Failed with error: %s', e.error);
  }
}

/**
 * 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() {
  try {
    DriveApp.getRootFolder();
    return ScriptApp.getOAuthToken();
  } catch (e) {
    // TODO (Developer) - Handle exception
    Logger.log('Failed with error: %s', e.error);
  }
}

dialog.html

selector/diálogo.html

Ver en GitHub

<!DOCTYPE html>
<html>
<head>
  <link rel="stylesheet" href="https://ssl.gstatic.com/docs/script/css/add-ons.css">
  <script>
    // IMPORTANT: Replace the value for DEVELOPER_KEY with the API key obtained
    // from the Google Developers Console.
    var DEVELOPER_KEY = 'ABC123 ... ';
    var DIALOG_DIMENSIONS = {width: 600, height: 425};
    var pickerApiLoaded = false;

    /**
     * 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(createPicker)
          .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) {
      if (pickerApiLoaded && token) {
        var picker = new google.picker.PickerBuilder()
            // Instruct Picker to display only spreadsheets in Drive. For other
            // views, see https://developers.google.com/picker/docs/#otherviews
            .addView(google.picker.ViewId.SPREADSHEETS)
            // 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)
            .setCallback(pickerCallback)
            .setOrigin(google.script.host.origin)
            // Instruct Picker to fill the dialog, minus 2 pixels for the border.
            .setSize(DIALOG_DIMENSIONS.width - 2,
                DIALOG_DIMENSIONS.height - 2)
            .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/docs/result
     *
     * @param {object} data The response object.
     */
    function pickerCallback(data) {
      var action = data[google.picker.Response.ACTION];
      if (action == google.picker.Action.PICKED) {
        var doc = data[google.picker.Response.DOCUMENTS][0];
        var id = doc[google.picker.Document.ID];
        var url = doc[google.picker.Document.URL];
        var title = doc[google.picker.Document.NAME];
        document.getElementById('result').innerHTML =
            '<b>You chose:</b><br>Name: <a href="' + url + '">' + title +
            '</a><br>ID: ' + id;
      } else if (action == google.picker.Action.CANCEL) {
        document.getElementById('result').innerHTML = 'Picker canceled.';
      }
    }

    /**
     * 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>
    <p id="result"></p>
  </div>
  <script src="https://apis.google.com/js/api.js?onload=onApiLoad"></script>
</body>
</html>