Okna i paski boczne w dokumentach Google Workspace

Skrypty powiązane z Dokumentami, Arkuszami lub Formularzami Google mogą wyświetlać kilka typów elementów interfejsu użytkownika: gotowe alerty i komunikaty, a także okna i paski boczne zawierające niestandardowe strony usług HTML. Zwykle elementy te są dostępne w menu. Pamiętaj, że w Formularzach Google elementy interfejsu są widoczne tylko dla osoby edytującej, która otwiera formularz w celu ich zmodyfikowania, a nie dla użytkownika, który chce otworzyć formularz.

Okna alertów

Alert to gotowe okno dialogowe, które otwiera się w edytorze Dokumentów, Arkuszy, Prezentacji lub Formularzy Google. Wyświetli się komunikat i przycisk „OK”. Przycisk tytułu i alternatywnych przycisków jest opcjonalny. Jest to podobne do wywoływania window.alert() w JavaScript po stronie klienta w przeglądarce.

Alerty zawieszają skrypt po stronie serwera, gdy jest otwarte. Skrypt jest wznawiany po zamknięciu okna przez użytkownika, ale połączenia JDBC nie pozostają aktywne po zawieszeniu.

Tak jak w przykładzie poniżej, Dokumenty, Formularze, Prezentacje i Arkusze Google korzystają z metody Ui.alert(), która jest dostępna w 3 wersjach. Aby zastąpić domyślny przycisk „OK”, przekaż wartość z listy Ui.ButtonSet jako argument buttons. Aby ustalić, który przycisk kliknął użytkownik, porównaj wartość zwrotną alert() z wyliczeniem 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.');
  }
}

Okna poleceń

Monit to gotowe okno dialogowe, które otwiera się w edytorze Dokumentów, Arkuszy, Prezentacji lub Formularzy Google. Wyświetla on wiadomość, pole do wprowadzania tekstu i przycisk „OK”. Przyciski tytułu i alternatywne są opcjonalne. Jest to podobne do wywoływania window.prompt() w JavaScript po stronie klienta w przeglądarce.

Po otwarciu okna dialogowego monity zawieszają skrypt po stronie serwera. Skrypt jest wznawiany po zamknięciu okna przez użytkownika, ale połączenia JDBC nie pozostają aktywne po zawieszeniu.

Tak jak w przykładzie poniżej, Formularze, Prezentacje i Arkusze Google korzystają z metody Ui.prompt(), która jest dostępna w 3 wersjach. Aby zastąpić domyślny przycisk „OK”, przekaż wartość z wywołania Ui.ButtonSet jako argument buttons. Aby ocenić odpowiedź użytkownika, przechwyć wartość zwracaną dla prompt(), wywołaj PromptResponse.getResponseText(), by pobrać dane użytkownika, i porównaj wartość zwrotną PromptResponse.getSelectedButton() z wyliczeniem 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.');
  }
}

Okna niestandardowe

Okno niestandardowe może wyświetlać interfejs użytkownika usługi HTML w edytorze Dokumentów, Arkuszy, Prezentacji lub Formularzy Google.

Okna niestandardowe nie zawieszają skryptu po stronie serwera, gdy jest on otwarty. Komponent po stronie klienta może wykonywać asynchroniczne wywołania po stronie serwera za pomocą interfejsu API google.script dla interfejsów usługi HTML.

Okno może zamknąć się, wywołując google.script.host.close() po stronie klienta interfejsu usługi HTML. Tego okna nie mogą zamknąć inne interfejsy, tylko użytkownik lub sam użytkownik.

Jak widać na tym przykładzie, Dokumenty, Formularze, Prezentacje i Arkusze Google korzystają z metody Ui.showModalDialog() do otwierania okna.

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

Strona.html

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

Niestandardowe paski boczne

Na pasku bocznym może wyświetlać się interfejs usługi HTML w edytorze Dokumentów, Formularzy, Prezentacji lub Arkuszy Google.

paski boczne nie zawieszają skryptu po stronie serwera, gdy jest otwarte okno; Komponent po stronie klienta może wykonywać asynchroniczne wywołania po stronie serwera, używając interfejsu API google.script dla interfejsów usługi HTML.

Pasek boczny może się zamykać, wywołując interfejs google.script.host.close() po stronie klienta interfejsu usługi HTML. Pasek boczny nie może być zamknięty przez inne interfejsy użytkownika ani tylko przez użytkownika.

Jak widać na tym przykładzie, Dokumenty, Formularze, Prezentacje i Arkusze Google używają metody Ui.showSidebar() do otwierania paska bocznego.

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

Strona.html

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

Okna otwierania plików

Selektor Google to okno do otwierania plików, które zawiera informacje przechowywane na serwerach Google, w tym m.in. na Dysku Google, w wyszukiwarce grafiki Google i w wyszukiwarce filmów Google.

Jak widać w przykładzie poniżej, możesz użyć interfejsu API JavaScript po stronie klienta w usłudze HTML, aby utworzyć niestandardowe okno, które umożliwia użytkownikom wybieranie istniejących plików lub przesyłanie nowych, a następnie przekazywanie tych wyborów z powrotem do skryptu do dalszego wykorzystania.

Uwaga: aby można było używać selektora Google, projekt skryptu musi korzystać z standardowego projektu Cloud Platform (GCP).

Aby włączyć selektor i pobrać klucz interfejsu API, wykonaj te czynności:

1. Sprawdź, czy projekt skryptu korzysta ze standardowego projektu GCP.
2. Włącz interfejs „Google Picker API” w projekcie GCP.
3. Gdy projekt GCP jest nadal otwarty, wybierz Interfejsy API i usługi, a następnie kliknij Dane logowania.
4. Kliknij Utwórz dane logowania > Klucz interfejsu API. To działanie spowoduje utworzenie klucza, ale należy go zmodyfikować, aby dodać do niego zarówno ograniczenia aplikacji, jak i ograniczenia interfejsu API.
5. W oknie klucza interfejsu API kliknij Zamknij.
6. Obok utworzonego klucza interfejsu API kliknij Więcej > Edytuj klucz interfejsu API.

7. W sekcji Ograniczenia aplikacji wykonaj te czynności:

   1. Wybierz Strony odsyłające HTTP (witryny internetowe).
   2. W sekcji Ograniczenia dostępu do witryn kliknij Dodaj element.
   3. Kliknij Strona odsyłająca i wpisz *.google.com.
   4. Dodaj kolejny element i wpisz *.googleusercontent.com jako stronę odsyłającą.
   5. Kliknij Gotowe.

8. W sekcji Ograniczenia interfejsu API wykonaj te czynności:

   1. Wybierz Ogranicz klucz.

   2. W sekcji Wybierz interfejsy API wybierz Google Picker API i kliknij OK.

      Uwaga: interfejs Google Picker API nie jest widoczny, dopóki go nie włączysz, ponieważ na liście znajdują się tylko interfejsy API włączone w projekcie Cloud.

9. W sekcji Klucz interfejsu API kliknij Kopiuj do schowka .

10. Kliknij Zapisz u dołu strony.

Poniższy przykład wywołuje ScriptApp.getOAuthToken(), aby mógł przekazać token dostępu OAuth 2.0 do selektora. Ta metoda zapobiega wyświetlaniu przez selektor własnego okna autoryzacji, ale jest to możliwe tylko wtedy, gdy zakres OAuth wymagany przez selektor jest dostępny w Apps Script. W przeciwnym razie kod selektora będzie musiał zadeklarować własne zakresy OAuth, jak pokazano w tym przykładzie „hello world”.

Podczas tworzenia właściwości PickerBuilder musisz wywołać metodę setOrigin(google.script.host.origin).

code.gs

selektor/kod.gs

Wyświetl w GitHubie

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

selektor/dialog.html

Wyświetl w GitHubie

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