Dialogfelder und Seitenleisten in Google Workspace-Dokumenten

Mit Skripts, die an Google Docs, Google Tabellen oder Google Formulare gebunden sind, können verschiedene Arten von Elementen der Benutzeroberfläche angezeigt werden: vordefinierte Benachrichtigungen und Aufforderungen sowie Dialogfelder und Seitenleisten, die benutzerdefinierte Seiten für HTML-Dienste enthalten. In der Regel werden diese Elemente über Menüpunkte geöffnet. Hinweis: In Google Formulare sind Benutzeroberflächenelemente nur für Bearbeiter sichtbar, die das Formular öffnen, um es zu ändern, und nicht für Nutzer, die das Formular zum Antworten öffnen.

Dialogfelder für Benachrichtigungen

Eine Benachrichtigung ist ein vordefiniertes Dialogfeld, das in einem Google Docs-, Google Tabellen-, Google Präsentationen- oder Formulareditor geöffnet wird. Es zeigt eine Nachricht und eine Schaltfläche "OK" an. Ein Titel und alternative Schaltflächen sind optional. Dieser Vorgang ist mit dem Aufruf von window.alert() in clientseitigem JavaScript in einem Webbrowser vergleichbar.

Durch Benachrichtigungen wird das serverseitige Script angehalten, während das Dialogfeld geöffnet ist. Das Skript wird fortgesetzt, nachdem der Nutzer das Dialogfeld geschlossen hat, aber JDBC-Verbindungen bleiben während der Sperrung nicht erhalten.

Wie im folgenden Beispiel gezeigt, verwenden Google-Dokumente, -Formulare, -Präsentationen und -Tabellen alle die Methode Ui.alert(), die in drei Varianten verfügbar ist. Wenn Sie die Standardschaltfläche „OK“ überschreiben möchten, übergeben Sie einen Wert aus der Enum Ui.ButtonSet als buttons-Argument. Wenn Sie herausfinden möchten, auf welche Schaltfläche der Nutzer geklickt hat, vergleichen Sie den Rückgabewert für alert() mit dem 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.');
  }
}

Aufforderungsdialoge

Eine Aufforderung ist ein vordefiniertes Dialogfeld, das in einem Google Docs-, Google Tabellen-, Google Präsentationen- oder Formulareditor geöffnet wird. Es werden eine Nachricht, ein Texteingabefeld und eine Schaltfläche "OK" angezeigt. Ein Titel und alternative Schaltflächen sind optional. Dieser Vorgang ist mit dem Aufruf von window.prompt() in clientseitigem JavaScript in einem Webbrowser vergleichbar.

Mit Aufforderungen wird das serverseitige Script angehalten, während das Dialogfeld geöffnet ist. Das Skript wird fortgesetzt, nachdem der Nutzer das Dialogfeld geschlossen hat, aber JDBC-Verbindungen bleiben während der Sperrung nicht erhalten.

Wie im folgenden Beispiel gezeigt, verwenden alle Google-Dokumente, Formulare, Präsentationen und Tabellen die Methode Ui.prompt(), die in drei Varianten verfügbar ist. Wenn Sie die Standardschaltfläche „OK“ überschreiben möchten, übergeben Sie einen Wert aus der Aufzählung Ui.ButtonSet als buttons-Argument. Zum Auswerten der Nutzerantwort erfassen Sie den Rückgabewert für prompt(), rufen dann PromptResponse.getResponseText() auf, um die Eingabe des Nutzers abzurufen, und vergleichen den Rückgabewert für PromptResponse.getSelectedButton() mit dem 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.');
  }
}

Benutzerdefinierte Dialogfelder

Ein benutzerdefiniertes Dialogfeld kann die Benutzeroberfläche eines HTML-Dienstes in einem Google Docs-, Google Tabellen-, Google Präsentationen- oder Google Formulare-Editor anzeigen.

Durch benutzerdefinierte Dialogfelder wird das serverseitige Script nicht angehalten, während das Dialogfeld geöffnet ist. Die clientseitige Komponente kann mithilfe der google.script API für HTML-Dienstschnittstellen asynchrone Aufrufe an das serverseitige Skript senden.

Das Dialogfeld kann sich durch Aufrufen von google.script.host.close() auf der Clientseite einer HTML-Dienstschnittstelle schließen. Das Dialogfeld kann nicht von anderen Benutzeroberflächen geschlossen werden, nur vom Nutzer oder von sich selbst.

Wie im folgenden Beispiel gezeigt, wird in Google Docs, Google Formulare, Google Präsentationen und Google Tabellen die Methode Ui.showModalDialog() verwendet, um das Dialogfeld zu öffnen.

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

Benutzerdefinierte Seitenleisten

In einer Seitenleiste kann die Benutzeroberfläche eines HTML-Dienstes in einem Google Docs-, Google Formulare-, Google Präsentationen- oder Google Tabellen-Editor angezeigt werden.

Das serverseitige Script wird nicht über die Seitenleisten angehalten, während das Dialogfeld geöffnet ist. Die clientseitige Komponente kann mithilfe der google.script API für HTML-Dienstschnittstellen asynchrone Aufrufe an das serverseitige Skript senden.

Die Seitenleiste kann sich selbst schließen, indem auf der Clientseite einer HTML-Dienstoberfläche google.script.host.close() aufgerufen wird. Die Seitenleiste kann nicht von anderen Benutzeroberflächen geschlossen werden, nur durch den Nutzer oder sich selbst.

Wie im folgenden Beispiel gezeigt, wird in Google Docs, Google Formulare, Google Präsentationen und Google Tabellen die Seitenleiste Ui.showSidebar() verwendet.

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

Dialogfelder zum Öffnen von Dateien

Die Google-Auswahl ist ein Dialogfeld zum Öffnen von Daten, das auf Google-Servern gespeichert ist, z. B. Google Drive, Google Bildersuche oder Google Videosuche.

Wie im folgenden Beispiel gezeigt, kann die clientseitige JavaScript API von Picker im HTML-Dienst verwendet werden, um ein benutzerdefiniertes Dialogfeld zu erstellen, in dem Nutzer vorhandene Dateien auswählen oder neue hochladen können. Diese Auswahl kann dann zur weiteren Verwendung an Ihr Skript zurückgegeben werden.

So aktivieren Sie die Auswahl und rufen einen API-Schlüssel ab:

  1. Überprüfen Sie, ob Ihr Skriptprojekt ein GCP-Standardprojekt verwendet.
  2. Aktivieren Sie die Google Picker API in Ihrem Google Cloud-Projekt.
  3. Wählen Sie bei geöffnetem Google Cloud-Projekt APIs und Dienste aus und klicken Sie dann auf Anmeldedaten.
  4. Klicken Sie auf Anmeldedaten erstellen > API-Schlüssel. Durch diese Aktion wird der Schlüssel erstellt. Sie sollten ihn jedoch bearbeiten und ihm sowohl Anwendungseinschränkungen als auch eine API-Einschränkung hinzufügen.
  5. Klicken Sie im Dialogfeld „API-Schlüssel“ auf Schließen.
  6. Klicken Sie neben dem von Ihnen erstellten API-Schlüssel auf das Dreipunkt-Menü Symbol „Mehr“> API-Schlüssel bearbeiten.

  7. Führen Sie unter Anwendungseinschränkungen die folgenden Schritte aus:

    1. Wählen Sie HTTP-Verweis-URLs (Websites) aus.
    2. Klicken Sie unter Website-Einschränkungen auf Element hinzufügen.
    3. Klicken Sie auf Referrer-URL und geben Sie *.google.com ein.
    4. Fügen Sie ein weiteres Element hinzu und geben Sie *.googleusercontent.com als Verweis-URL ein.
    5. Klicken Sie auf Fertig.

  8. Führen Sie unter API-Einschränkungen die folgenden Schritte aus:

    1. Wählen Sie Schlüssel einschränken aus.

    2. Wählen Sie im Abschnitt APIs auswählen die Option Google Picker API aus und klicken Sie auf OK.

      Hinweis:Die Google Picker API wird nur angezeigt, wenn Sie sie aktiviert haben, da die Liste nur APIs enthält, die für das Cloud-Projekt aktiviert wurden.

  9. Klicken Sie unter API-Schlüssel auf „In Zwischenablage kopieren“ Symbol „In Zwischenablage kopieren“.

  10. Klicken Sie unten auf Speichern.

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>