Questa pagina è stata tradotta dall'API Cloud Translation.

Finestre di dialogo e barre laterali nei documenti di Google Workspace

Gli script associati a Documenti, Fogli o Moduli Google possono mostrare diversi tipi di elementi dell'interfaccia utente, avvisi e prompt predefiniti, nonché finestre di dialogo e barre laterali contenenti pagine di servizio HTML personalizzate. In genere, questi elementi vengono aperti dalle voci di menu. Tieni presente che in Google Moduli gli elementi dell'interfaccia utente sono visibili solo a un editor che apre il modulo per modificarlo, non a un utente che lo apre per rispondere.

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 Google. Viene visualizzato un messaggio e un pulsante "Ok". Un titolo e pulsanti alternativi sono facoltativi. È simile alla chiamata di window.alert() in JavaScript lato client in un browser web.

Gli avvisi sospendono lo script lato server mentre la finestra di dialogo è aperta. Lo script riprende 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, Moduli, Presentazioni e Fogli Google utilizzano tutti il metodo Ui.alert(), disponibile in tre varianti. Per sostituire il pulsante "Ok" predefinito, passa un valore dell'enum Ui.ButtonSet come argomento buttons. Per valutare su quale pulsante ha fatto clic l'utente, confronta il valore restituito per alert() con l'enum 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.");
  }
}

Prompt di dialogo

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

Chiede di sospendere lo script lato server mentre la finestra di dialogo è aperta. Lo script riprende 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, Moduli, Presentazioni e Fogli Google utilizzano tutti il metodo Ui.prompt(), disponibile in tre varianti. Per sostituire il pulsante "OK" predefinito, passa un valore dell'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'enum 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.");
  }
}

Dialoghi personalizzati

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

Le finestre di dialogo personalizzate non sospendono 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 del servizio HTML.

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

Come mostrato nell'esempio seguente, 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ò mostrare un'interfaccia utente di un servizio HTML all'interno di un editor di Documenti, Moduli, Presentazioni e Fogli Google.

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 di servizio HTML.

La barra laterale può chiudersi chiamando google.script.host.close() nel lato client di un'interfaccia di servizio HTML. La barra laterale non può essere chiusa da altre interfacce, 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 di apertura dei file

Google Picker è un'API JavaScript che consente agli utenti di selezionare o caricare file di Google Drive. La libreria Google Picker può essere utilizzata in HTML service per creare una finestra di dialogo personalizzata che consenta agli utenti di selezionare file esistenti o caricarne di nuovi, per poi ritrasferire la selezione allo script per un ulteriore utilizzo.

Requisiti

Esistono diversi requisiti per l'utilizzo di Google Picker con Apps Script.

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

Nota: lo stesso numero di progetto Cloud deve essere passato a PickerBuilder.setAppId() se utilizzi l'ambito drive.file.
Il manifesto del progetto di 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().
La chiave API impostata in PickerBuilder.setDeveloperKey() può essere limitata ad Apps Script. Nella sezione Limitazioni dell'applicazione, 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.
Devi chiamare PickerBuilder.setOrigin(google.script.host.origin).

Esempio

L'esempio seguente mostra il selettore Google 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");
}
/**
 * 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();
}

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

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

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