Dialogfelder und Seitenleisten in Google Workspace-Dokumenten

Skripts, die an Google Docs gebunden sind, In Google Tabellen und Google Formulare können verschiedene Arten von Benutzeroberflächenelementen angezeigt werden: vordefinierte Benachrichtigungen und Eingabeaufforderungen sowie Dialogfelder und Seitenleisten mit benutzerdefinierten Seiten des HTML-Dienstes. In der Regel umfassen diese Elemente werden über die Menüpunkte geöffnet. Hinweis: In Google Formulare Elemente der Benutzeroberfläche sind nur für Mitbearbeiter sichtbar, die das Formular öffnen. und nicht an Nutzer, die das Formular öffnen, um zu antworten.)

Dialogfelder für Benachrichtigungen

Eine Benachrichtigung ist ein vordefiniertes Dialogfeld, das in einem Präsentationen oder Formulare-Editoren. Es wird eine Meldung und ein „OK“ angezeigt. Schaltfläche; Titel und sind optional. Das entspricht dem Aufruf von window.alert() in clientseitigem JavaScript in einem Webbrowser.

Bei 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 über die Dauer der Sperrung hinweg nicht bestehen.

Wie im Beispiel unten gezeigt, und Google Tabellen verwenden die Methode Ui.alert(), gibt es in drei Varianten. Wenn Sie die Standardschaltfläche „OK“ überschreiben möchten, übergeben Sie als buttons-Argument einen Wert aus der Ui.ButtonSet-Enumeration. Um zu ermitteln, auf welche Schaltfläche die Nutzenden geklickt haben, den Rückgabewert für alert() an den Ui.Button enum.

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

Aufforderungsdialogfelder

Ein Prompt ist ein vordefiniertes Dialogfeld, das in einem Editor von Google Docs, Google Sheets, Google Präsentationen oder Google Formulare geöffnet wird. Es enthält eine Nachricht, ein Texteingabefeld und eine Schaltfläche „OK“. Ein Titel und alternative Schaltflächen sind optional. Das entspricht dem Aufruf von window.prompt() in clientseitigem JavaScript in einem Webbrowser.

Bei Eingabeaufforderungen wird das serverseitige Skript angehalten, während das Dialogfeld geöffnet ist. Das Skript wird fortgesetzt, nachdem der Nutzer das Dialogfeld geschlossen hat, aber JDBC Verbindungen bleiben über die Dauer der Sperrung hinweg nicht bestehen.

Wie im Beispiel unten gezeigt, wird in Google Docs – Formulare, Präsentationen und Tabellen die Methode Ui.prompt(), das in drei Varianten erhältlich ist. Wenn Sie die Standardschaltfläche „OK“ überschreiben möchten, übergeben Sie als Argument für buttons einen Wert aus dem Ui.ButtonSet-Enum. Um die Antwort des Nutzers zu bewerten, erfassen Sie die Rückgabewert für prompt(), dann Aufruf PromptResponse.getResponseText() um die Eingabe des Nutzers abzurufen und den Rückgabewert für PromptResponse.getSelectedButton() zur Ui.Button-Enum hinzu.

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

In einem benutzerdefinierten Dialogfeld kann ein Nutzer des HTML-Dienstes angezeigt werden Google Docs-, Google Tabellen-, Google Präsentationen- oder Google Formulare-Editoren verwenden.

Bei benutzerdefinierten Dialogfeldern wird das serverseitige Script nicht angehalten, wenn es geöffnet ist. Die clientseitige Komponente kann asynchrone Aufrufe an das serverseitige Script mithilfe der google.script API für HTML-Dienstoberflächen ausführen.

Das Dialogfeld kann sich selbst schließen, indem google.script.host.close() auf der Clientseite einer HTML-Dienstschnittstelle aufgerufen wird. Das Dialogfeld kann nicht geschlossen werden durch Benutzeroberflächen oder andere Benutzeroberflächen.

Wie im Beispiel unten gezeigt, wird in Google Docs, Google Formulare, Google Präsentationen und Google Tabellen die Methode Ui.showModalDialog() zum Öffnen des Dialogfelds verwendet.

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');
}

Seite.html

Hello, world! <input type="button" value="Close" onclick="google.script.host.close()" />

Benutzerdefinierte Seitenleisten

In einer Seitenleiste kann der Nutzer eines HTML-Dienstes angezeigt werden. in Google Docs, Google Formulare, Google Präsentationen oder Google Tabellen

Das serverseitige Script wird über Seitenleisten nicht angehalten, wenn das Dialogfeld geöffnet ist. Die kann die clientseitige Komponente asynchrone Aufrufe an das serverseitige Skript senden. mit der google.script API für HTML-Dienst-Schnittstellen.

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

Wie im Beispiel unten gezeigt, wird die Seitenleiste in Google Docs, Google Formulare, Google Präsentationen und Google Tabellen mit der Methode Ui.showSidebar() geöffnet.

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

Google Picker ist ein „file-open“- Dialogfeld für Informationen gespeichert in Google-Server, einschließlich Google Drive, Google Bildersuche, Google Video Suche und mehr.

Wie im Beispiel unten gezeigt, kann die clientseitige JavaScript API von Picker verwendet werden. im HTML-Dienst, um ein benutzerdefiniertes Dialogfeld zu erstellen, mit dem Nutzer wählen vorhandene Dateien aus oder laden neue hoch und geben diese Auswahl an das Skript zur weiteren Verwendung.

Hinweis :Damit Sie die Google-Auswahl verwenden können, muss Ihr Skriptprojekt ein Google Cloud-Standardprojekt

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

1. Prü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, während Ihr Google Cloud-Projekt noch geöffnet ist, APIs und Dienste, dann Klicken Sie auf Anmeldedaten.
4. Klicken Sie auf Anmeldedaten erstellen > API-Schlüssel. Dadurch wird der Schlüssel erstellt. Sie sollten ihn jedoch bearbeiten, um ihm sowohl Anwendungseinschränkungen als auch eine API-Einschränkung hinzuzufügen.
5. Klicken Sie im Dialogfeld „API-Schlüssel“ auf Schließen.
6. Klicken Sie neben dem erstellten API-Schlüssel auf das Dreipunkt-Menü > 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 Referrer-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 Bereich 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. In der Liste werden nur APIs angezeigt, die für das Cloud-Projekt aktiviert wurden.

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

10. Klicken Sie unten auf Speichern.

Im folgenden Beispiel wird ScriptApp.getOAuthToken() aufgerufen, damit es Das OAuth 2.0-Zugriffstoken des Nutzers an Picker übergeben. Mit dieser Technik bleibt die muss kein eigenes Dialogfeld für die Autorisierung angezeigt werden. Dies ist jedoch nur möglich, Der von Picker benötigte OAuth-Bereich ist in Apps Script verfügbar. Andernfalls müssen in Ihrem Auswahlcode die OAuth-Bereiche, wie in diesem "Hello World"-Beispiel Beispiel

Du musst anrufen setOrigin(google.script.host.origin) beim Erstellen des PickerBuilder

code.gs

Picker/code.gs

Auf GitHub ansehen

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

Auf GitHub ansehen

<!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>