Finestre di dialogo e barre laterali nei documenti di Google Workspace

I progetti Google Apps Script associati a Documenti, Fogli o Moduli Google possono visualizzare elementi dell'interfaccia utente, come avvisi, prompt, toast, finestre di dialogo e barre laterali predefiniti. Questi elementi in genere contengono contenuti del servizio HTML personalizzati e vengono spesso aperti dalle voci di menu. In Moduli, gli elementi dell'interfaccia utente sono visibili solo a un editor che apre il modulo per modificarlo, non a un rispondente.

Finestre di dialogo di avviso

Un avviso è una finestra di dialogo predefinita che si apre all'interno di un editor di Documenti, Fogli, Presentazioni o Moduli. Visualizza un messaggio e un pulsante Ok ; un titolo e pulsanti alternativi sono facoltativi. È simile alla chiamata window.alert in JavaScript lato client all'interno di un browser web.

Gli avvisi sospendono lo script lato server mentre la finestra di dialogo è aperta. Lo script riprende dopo che l'utente ha chiuso la finestra di dialogo, ma le connessioni JDBC non vengono mantenute durante la sospensione.

Come mostrato nell'esempio seguente, Documenti, Moduli, Presentazioni e Fogli utilizzano tutti il metodo Ui.alert, disponibile in tre varianti. Per sostituire il pulsante Ok predefinito, passa un valore dall' Ui.ButtonSet enumerazione come argomento buttons. Per valutare il pulsante su cui l'utente ha fatto clic, confronta il valore restituito per alert con l'enumerazione 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.");
  }
}

Finestre di dialogo di prompt

Un prompt è una finestra di dialogo predefinita che si apre all'interno di un editor di Documenti, Fogli, Presentazioni o Moduli. Visualizza un messaggio, un campo di input di testo e un pulsante Ok ; un titolo e pulsanti alternativi sono facoltativi. È simile alla chiamata window.prompt in JavaScript lato client all'interno di un browser web.

I prompt sospendono lo script lato server mentre la finestra di dialogo è aperta. Lo script riprende dopo che l'utente ha chiuso la finestra di dialogo, ma le connessioni JDBC non vengono mantenute durante la sospensione.

Come mostrato nell'esempio seguente, Documenti, Moduli, Presentazioni e Fogli utilizzano tutti il metodo Ui.prompt, che è disponibile in tre varianti. Per sostituire il pulsante Ok predefinito, passa un valore dall'enumerazione 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() {
  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.");
  }
}

Toast del foglio di lavoro

Un "toast" è una piccola finestra di dialogo nell'angolo in basso a destra di un editor di Fogli che visualizza un messaggio, ma non sospende lo script. È un buon modo per mostrare messaggi di stato o aggiornamenti che non richiedono l'interazione dell'utente.

Come mostrato nell'esempio seguente, Fogli utilizza il metodo Spreadsheet.toast. I toast sono disponibili solo in Fogli.

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

Finestre di dialogo personalizzate

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

Le finestre di dialogo personalizzate non sospendono lo script lato server mentre la finestra di dialogo è aperta. Poiché sono asincrone, la funzione lato server che apre la finestra di dialogo termina immediatamente. Per passare i dati dalla finestra di dialogo personalizzata al server, utilizza l'API google.script nel codice lato client.

La finestra di dialogo può chiudersi chiamando google.script.host.close sul lato client di un'interfaccia del 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 seguente, Documenti, Moduli, Presentazioni e Fogli 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() {
  const 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 un'interfaccia utente del servizio HTML all'interno di un editor di Documenti, Moduli, Presentazioni e Fogli.

Le barre laterali non sospendono 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 del servizio HTML.

La barra laterale può chiudersi chiamando google.script.host.close sul lato client di un'interfaccia del 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 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() {
  const 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 di apertura file

Google Picker è un'API JavaScript che consente agli utenti di selezionare o caricare file di Google Drive. Utilizza la libreria Google Picker nel servizio HTML per creare una finestra di dialogo personalizzata che consenta agli utenti di selezionare file esistenti o caricarne di nuovi, quindi passa la selezione a tuo script.

Requisiti

L'utilizzo di Google Picker con Google Apps Script presenta diversi requisiti:

Configura l'ambiente per Google Picker.
Il progetto di script deve utilizzare un standard progetto Google Cloud.

Passa lo stesso numero di progetto Cloud a PickerBuilder.setAppId se utilizzi l'ambito drive.file.
Il manifest del progetto Apps Script deve specificare gli ambiti di autorizzazione richiesti dall'API Google Picker in modo che ScriptApp.getOAuthToken restituisca il token corretto per PickerBuilder.setOauthtoken.
Limita la chiave API impostata in PickerBuilder.setDeveloperKey ad Apps Script. In Restrizioni delle applicazioni, segui questi 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.
Chiama PickerBuilder.setOrigin.

Esempio

L'esempio seguente mostra Google Picker in Apps Script.

code.gs

picker/code.gs

Visualizza su 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");
}
// 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();
}

dialog.html

picker/dialog.html

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

      /**
       * @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

Visualizza su 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"
      }
    ]
  }
}

Finestre di dialogo e barre laterali nei documenti di Google Workspace Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Finestre di dialogo di avviso

Finestre di dialogo di prompt

Toast del foglio di lavoro

Finestre di dialogo personalizzate

Code.gs

Page.html

Barre laterali personalizzate

Code.gs

Page.html

Finestre di dialogo di apertura file

Requisiti

Esempio

code.gs

dialog.html

appsscript.json

Finestre di dialogo e barre laterali nei documenti di Google Workspace