Finestre di dialogo e barre laterali nei documenti di Google Workspace

Gli script associati a Documenti, Fogli o Moduli Google possono visualizzare diversi tipi di elementi dell'interfaccia utente: avvisi e prompt predefiniti, oltre a finestre di dialogo e barre laterali che contengono pagine di servizio HTML personalizzate. In genere, questi elementi si aprono dalle voci di menu. (Tieni presente che in Moduli Google, gli elementi dell'interfaccia utente sono visibili solo a un editor che apre il modulo per modificarlo, non a un utente che apre il modulo per rispondere.)

Finestre di avviso

Un avviso è una finestra di dialogo predefinita che si apre all'interno di un editor di Documenti, Fogli, Presentazioni o Moduli Google. Include un messaggio e un pulsante "OK". Il titolo e i pulsanti alternativi sono facoltativi. È simile alla chiamata a window.alert() in JavaScript lato client all'interno di un browser web.

Gli avvisi sospendino lo script lato server mentre la finestra di dialogo è aperta. Lo script viene ripristinato dopo che l'utente chiude la finestra di dialogo, ma le connessioni JDBC non vengono mantenute durante la sospensione.

Come mostrato nell'esempio riportato di seguito, Documenti, Moduli, Presentazioni e Fogli Google utilizzano tutti il metodo Ui.alert(), disponibile in tre varianti. Per eseguire l'override del pulsante "OK" predefinito, trasmetti un valore dall'enum Ui.ButtonSet come argomento buttons. Per valutare il pulsante su cui l'utente ha fatto clic, confronta il valore restituito per alert() con l'enum di 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.');
  }
}

Finestre di dialogo dei prompt

Un prompt è una finestra di dialogo predefinita che si apre all'interno di un editor di Documenti, Fogli, Presentazioni o Moduli Google. Include un messaggio, un campo di immissione di testo e un pulsante "OK". Il titolo e i pulsanti alternativi sono facoltativi. È simile alla chiamata a window.prompt() in JavaScript lato client all'interno di un browser web.

I prompt sospenderanno lo script lato server mentre la finestra di dialogo è aperta. Lo script viene ripristinato dopo che l'utente chiude la finestra di dialogo, ma le connessioni JDBC non vengono mantenute durante la sospensione.

Come mostrato nell'esempio seguente, Documenti Google, Moduli, Presentazioni e Fogli utilizzano tutti il metodo Ui.prompt(), disponibile in tre varianti. Per eseguire l'override del pulsante "OK" predefinito, trasmetti un valore dall'enum Ui.ButtonSet come argomento buttons. Per valutare la risposta dell'utente, acquisisci il valore restituito per prompt(), quindi chiama PromptResponse.getResponseText() per recuperare l'input dell'utente e confronta il valore restituito per PromptResponse.getSelectedButton() con l'enumerazione 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.');
  }
}

Finestre di dialogo personalizzate

Una finestra di dialogo personalizzata può visualizzare l'interfaccia utente di un servizio HTML all'interno di un editor di Documenti, Fogli, Presentazioni o Moduli Google.

Le finestre di dialogo personalizzate non sospendino lo script lato server mentre sono aperte. Il componente lato client può effettuare chiamate asincrone allo script lato server utilizzando l'API google.script per le interfacce di servizio HTML.

La finestra di dialogo può chiudersi chiamando google.script.host.close() sul lato client di un'interfaccia di servizio HTML. La finestra di dialogo non può essere chiusa da altre interfacce, ma solo dall'utente o da se stessa.

Come mostrato nell'esempio riportato di seguito, Documenti, Moduli, Presentazioni e Fogli Google utilizzano tutti il metodo Ui.showModalDialog() per aprire la finestra di dialogo.

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()" />

Barre laterali personalizzate

Una barra laterale può visualizzare l'interfaccia utente di un servizio HTML all'interno di un editor di Documenti, Moduli, Presentazioni e Fogli Google.

Le barre laterali non sospendino lo script lato server mentre la finestra di dialogo è aperta. Il componente lato client può effettuare chiamate asincrone allo script lato server utilizzando l'API google.script per le interfacce di servizio HTML.

La barra laterale può chiudersi chiamando google.script.host.close() sul lato client di un'interfaccia di servizio HTML. La barra laterale non può essere chiusa da altre interfacce, ma solo dall'utente o da se stessa.

Come mostrato nell'esempio seguente, Documenti, Moduli, Presentazioni e Fogli Google utilizzano tutti il metodo Ui.showSidebar() per aprire la barra laterale.

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()" />

Finestre di dialogo aperte

Selettore Google è una finestra di dialogo "apri file" per le informazioni archiviate nei server di Google, tra cui Google Drive, Google Immagini, Google Video e altri ancora.

Come mostrato nell'esempio riportato di seguito, l'API JavaScript lato client del selettore può essere utilizzata in servizio HTML per creare una finestra di dialogo personalizzata che consente agli utenti di selezionare file esistenti o caricarne di nuovi, quindi di ritrasmettere la selezione nello script per un ulteriore utilizzo.

Per abilitare il selettore e ottenere una chiave API, segui queste istruzioni:

  1. Verifica che il progetto di script utilizzi un progetto GCP standard.
  2. Abilita l'"API Google Picker" nel progetto Google Cloud.
  3. Mentre il progetto Google Cloud è ancora aperto, seleziona API e servizi, quindi fai clic su Credenziali.
  4. Fai clic su Crea credenziali > Chiave API. Questa azione crea la chiave, ma devi modificarla per aggiungere sia restrizioni delle applicazioni sia una restrizione dell'API alla chiave.
  5. Nella finestra di dialogo della chiave API, fai clic su Chiudi.
  6. Accanto alla chiave API che hai creato, fai clic su Altro Icona Altro> Modifica chiave API.

  7. In Restrizioni delle applicazioni, completa i seguenti passaggi:

    1. Seleziona Referrer HTTP (siti web).
    2. Nella sezione Limitazioni relative ai siti web, fai clic su Aggiungi un elemento.
    3. Fai clic su Referrer e inserisci *.google.com.
    4. Aggiungi un altro elemento e inserisci *.googleusercontent.com come referrer.
    5. Fai clic su Fine.

  8. In Limitazioni delle API, completa i seguenti passaggi:

    1. Seleziona Limita chiave.

    2. Nella sezione Seleziona API, seleziona API Google Picker e fai clic su OK.

      Nota: l'API Google Picker non viene visualizzata se non l'hai abilitata perché l'elenco mostra solo le API che sono state abilitate per il progetto Cloud.

  9. In Chiave API, fai clic su Copia negli appunti Icona Copia negli appunti.

  10. Fai clic su Salva in fondo alla pagina.

code.gs

picker/code.gs
/**
 * 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
    console.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
    console.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
    console.log('Failed with error: %s', e.error);
  }
}

dialog.html

picker/dialog.html
<!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>