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

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 services HTML personnalisées. En règle générale, ces éléments sont ouverts à partir des éléments de 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 celui qui ouvre le formulaire 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 l'éditeur Google Docs, Sheets, Slides ou Forms. Elle affiche un message et un bouton "OK". Un titre et d'autres boutons sont facultatifs. Cette méthode s'apparente à l'appel de window.alert() dans le code 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 une fois que l'utilisateur a fermé la boîte de dialogue, mais les connexions JDBC ne persistent pas pendant la suspension.

Comme le montre l'exemple ci-dessous, Google Docs, Forms, Slides et Sheets utilisent tous la méthode Ui.alert(), qui est disponible en trois variantes. Pour ignorer le bouton "OK" par défaut, transmettez une valeur de l'énumération Ui.ButtonSet en tant qu'argument buttons. Pour évaluer le bouton sur lequel 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 d'invite

Une invite est une boîte de dialogue prédéfinie qui s'ouvre dans l'éditeur Google Docs, Sheets, Slides ou Forms. Elle affiche un message, un champ de saisie de texte et un bouton "OK". Un titre et d'autres boutons sont facultatifs. Cette méthode s'apparente à l'appel de window.prompt() dans le code 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 une fois 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 ci-dessous, Google Docs Forms, Slides et Sheets utilisent la méthode Ui.prompt(), qui est disponible en trois variantes. Pour ignorer 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 l'entrée 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 que la boîte de dialogue est ouverte. Le composant côté client peut effectuer des appels asynchrones vers le 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, uniquement par l'utilisateur ou par lui-même.

Comme le montre l'exemple ci-dessous, 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 et 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 vers le 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, que par l'utilisateur ou par lui-même.

Comme le montre l'exemple ci-dessous, 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

L'outil de sélection Google est une boîte de dialogue qui s'ouvre sur des informations stockées sur les serveurs Google, y compris Google Drive, Google Recherche d'Images et Google Recherche de vidéos.

Comme indiqué dans l'exemple ci-dessous, l'API JavaScript côté client de "Picker" peut être utilisée dans un service HTML pour créer une boîte de dialogue personnalisée qui permet 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.

Remarque :Pour utiliser Google Picker, votre projet de script doit utiliser un projet Google Cloud standard.

Pour activer le sélecteur et obtenir une clé API, procédez comme suit:

1. Vérifiez que votre projet de script utilise un projet GCP standard.
2. Activez l'API Google Picker dans votre projet Google Cloud.
3. Pendant que votre projet Google Cloud est toujours ouvert, sélectionnez API et services, puis cliquez sur Identifiants.
4. Cliquez sur Créer des identifiants > Clé API. Cette action crée la clé, mais vous devez la modifier pour ajouter à la clé des restrictions d'application et une restriction d'API.
5. Dans la boîte de dialogue de la clé API, cliquez sur Fermer.
6. À côté de la clé API que vous avez créée, cliquez sur Plus > Modifier la clé API.

7. Sous Restrictions liées aux applications, 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 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.

8. Sous API restrictions (Restrictions liées à l'API), procédez comme suit:

   1. Sélectionnez Restreindre la clé.

   2. Dans la section Sélectionner des API, sélectionnez API Google Picker, puis cliquez sur OK.

      Remarque:L'API Google Picker ne s'affiche que si vous l'avez activée, car la liste n'affiche que les API activées pour le projet Cloud.

9. Sous API key (Clé API), cliquez sur Copier dans le presse-papiers .

10. Au bas de la page, cliquez sur Enregistrer.

L'exemple suivant appelle ScriptApp.getOAuthToken() afin de pouvoir transmettre le jeton d'accès OAuth 2.0 de l'utilisateur à "Picker". Cette technique évite que Picker n'ait besoin d'afficher sa propre boîte de dialogue d'autorisation, mais ce n'est possible que si le champ d'application OAuth nécessaire au sélecteur est disponible dans Apps Script. Sinon, votre code Picker devra déclarer ses propres champs d'application OAuth, comme indiqué dans cet exemple "Hello World".

Vous devez appeler setOrigin(google.script.host.origin) lorsque vous créez le PickerBuilder.

code.gs

sélecteur/code.gs

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

dialogue.html

sélecteur/boîte de dialogue.html

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