Cette page a été traduite par l'API Cloud Translation.

Boîtes de dialogue et barres latérales dans les documents Google Workspace

Les scripts liés à Google Docs, Sheets ou Forms peuvent afficher plusieurs types d'éléments d'interface utilisateur : des alertes et des invites prédéfinies, ainsi que des boîtes de dialogue et des barres latérales contenant des pages de service HTML personnalisées. En règle générale, ces éléments sont ouverts à partir des éléments du menu. (Notez que dans Google Forms, les éléments de l'interface utilisateur ne sont visibles que par un éditeur qui ouvre le formulaire pour le modifier, et non par un utilisateur qui l'ouvre pour y répondre.)

Boîtes de dialogue d'alerte

Une alerte est une boîte de dialogue prédéfinie qui s'ouvre dans un éditeur Google Docs, Sheets, Slides ou Forms. Il affiche un message et un bouton "OK". Un titre et des boutons alternatifs sont facultatifs. Cela équivaut à appeler window.alert() en JavaScript côté client dans un navigateur Web.

Les alertes suspendent le script côté serveur lorsque la boîte de dialogue est ouverte. Le script reprend après que l'utilisateur a fermé la boîte de dialogue, mais les connexions JDBC ne persistent pas pendant la suspension.

Comme illustré dans l'exemple suivant, Google Docs, Forms, Slides et Sheets utilisent tous la méthode Ui.alert(), qui est disponible en trois variantes. Pour remplacer le bouton "OK" par défaut, transmettez une valeur de l'énumération Ui.ButtonSet en tant qu'argument buttons. Pour évaluer sur quel bouton l'utilisateur a cliqué, comparez la valeur renvoyée pour alert() à l'énumération 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.");
  }
}

Boîtes de dialogue de requête

Une invite est une boîte de dialogue prédéfinie qui s'ouvre dans un éditeur Google Docs, Sheets, Slides ou Forms. Il affiche un message, un champ de saisie de texte et un bouton "OK". Un titre et des boutons alternatifs sont facultatifs. Cela ressemble à l'appel de window.prompt() en JavaScript côté client dans un navigateur Web.

Les invites suspendent le script côté serveur lorsque la boîte de dialogue est ouverte. Le script reprend lorsque l'utilisateur ferme la boîte de dialogue, mais les connexions JDBC ne persistent pas pendant la suspension.

Comme indiqué dans l'exemple suivant, Google Docs, Forms, Slides et Sheets utilisent tous la méthode Ui.prompt(), qui est disponible en trois variantes. Pour remplacer le bouton "OK" par défaut, transmettez une valeur de l'énumération Ui.ButtonSet en tant qu'argument buttons. Pour évaluer la réponse de l'utilisateur, capturez la valeur renvoyée pour prompt(), puis appelez PromptResponse.getResponseText() pour récupérer la saisie de l'utilisateur et comparez la valeur renvoyée pour PromptResponse.getSelectedButton() à l'énumération 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.");
  }
}

Boîtes de dialogue personnalisées

Une boîte de dialogue personnalisée peut afficher une interface utilisateur de service HTML dans un éditeur Google Docs, Sheets, Slides ou Forms.

Les boîtes de dialogue personnalisées ne suspendent pas le script côté serveur tant qu'elles sont ouvertes. Le composant côté client peut effectuer des appels asynchrones au script côté serveur à l'aide de l'API google.script pour les interfaces de service HTML.

La boîte de dialogue peut se fermer en appelant google.script.host.close() côté client d'une interface de service HTML. La boîte de dialogue ne peut pas être fermée par d'autres interfaces, mais uniquement par l'utilisateur ou par elle-même.

Comme illustré dans l'exemple suivant, Google Docs, Forms, Slides et Sheets utilisent tous la méthode Ui.showModalDialog() pour ouvrir la boîte de dialogue.

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

Barres latérales personnalisées

Une barre latérale peut afficher une interface utilisateur de service HTML dans un éditeur Google Docs, Forms, Slides ou Sheets.

Les barres latérales ne suspendent pas le script côté serveur lorsque la boîte de dialogue est ouverte. Le composant côté client peut effectuer des appels asynchrones au script côté serveur à l'aide de l'API google.script pour les interfaces de service HTML.

La barre latérale peut se fermer en appelant google.script.host.close() côté client d'une interface de service HTML. La barre latérale ne peut pas être fermée par d'autres interfaces, mais uniquement par l'utilisateur ou par elle-même.

Comme illustré dans l'exemple suivant, Google Docs, Forms, Slides et Sheets utilisent tous la méthode Ui.showSidebar() pour ouvrir la barre latérale.

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

Boîtes de dialogue d'ouverture de fichier

Google Picker est une API JavaScript qui permet aux utilisateurs de sélectionner ou d'importer des fichiers Google Drive. La bibliothèque Google Picker peut être utilisée dans le service HTML pour créer une boîte de dialogue personnalisée permettant aux utilisateurs de sélectionner des fichiers existants ou d'en importer de nouveaux, puis de transmettre cette sélection à votre script pour une utilisation ultérieure.

Conditions requises

Pour utiliser l'outil de sélection Google avec Apps Script, vous devez respecter plusieurs conditions.

Configurez votre environnement pour Google Picker.
Votre projet de script doit utiliser un projet Google Cloud standard.

Remarque :Le même numéro de projet Cloud doit être transmis à PickerBuilder.setAppId() si vous utilisez le champ d'application drive.file.
Le fichier manifeste du projet Apps Script doit spécifier les champs d'autorisation requis par l'API Google Picker afin que ScriptApp.getOAuthToken() renvoie le jeton approprié pour PickerBuilder.setOauthtoken().
La clé API définie dans PickerBuilder.setDeveloperKey() peut être limitée à Apps Script. Sous Restrictions d'application, procédez comme suit:
1. Sélectionnez URL de provenance HTTP (sites Web).
2. Sous Restrictions liées aux sites Web, cliquez sur Ajouter un élément.
3. Cliquez sur Referrer (URL de provenance), puis saisissez *.google.com.
4. Ajoutez un autre élément et saisissez *.googleusercontent.com comme URL de provenance.
5. Cliquez sur OK.
Vous devez appeler PickerBuilder.setOrigin(google.script.host.origin).

Exemple

L'exemple suivant montre le sélecteur Google dans Apps Script.

code.gs

sélecteur/code.gs

Afficher sur 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

Afficher sur 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

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