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 alerty, a także okna i paski boczne zawierające niestandardowe strony usług HTML. Elementy te otwierają zwykle menu. Pamiętaj, że elementy interfejsu Google są widoczne tylko dla edytującego, który otwiera formularz w celu jego zmodyfikowania, a nie dla użytkownika, który chce go otworzyć.

Okna alertów

Alert to gotowe okno dialogowe, które otwiera się w edytorze Dokumentów, Arkuszy, Prezentacji lub Formularzy Google. Wyświetla się komunikat i przycisk „OK”. Tytuł i alternatywne przyciski są opcjonalne. Działa ono podobnie jak wywołanie window.alert() w JavaScript po stronie klienta w przeglądarce.

Alerty zawieszają skrypt po stronie serwera po otwarciu okna dialogowego. Skrypt jest wznawiany po zamknięciu okna, ale połączenia JDBC nie są zachowywane po zawieszeniu.

Jak pokazano 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ż jako wartość buttons wartość z wyliczenia Ui.ButtonSet. Aby ocenić, który przycisk kliknął użytkownik, porównaj wartość zwracaną przez funkcję 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 monitujące

Monit to gotowe okno dialogowe, które otwiera się w edytorze Dokumentów, Arkuszy, Prezentacji lub Formularzy Google. Wyświetla ona wiadomość, pole do wprowadzania tekstu i przycisk „OK”; przyciski tytułu i alternatywnego elementu są opcjonalne. Działa ono podobnie jak wywołanie 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, ale połączenia JDBC nie są zachowywane po zawieszeniu.

Jak pokazano w przykładzie poniżej, w Dokumentach, Formularzach, Prezentacjach i Arkuszach Google wykorzystano metodę Ui.prompt(), która jest dostępna w 3 wersjach. Aby zastąpić domyślny przycisk „OK”, podaj wartość z wywołania Ui.ButtonSet jako argument buttons. Aby ocenić odpowiedź użytkownika, przechwytuj wartość zwracaną przez funkcję prompt(), wywołaj metodę PromptResponse.getResponseText(), aby pobrać dane wejściowe użytkownika, a następnie porównaj wartość zwracaną dla 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 ono otwarte. Komponent po stronie klienta może wykonywać asynchroniczne wywołania po stronie serwera za pomocą interfejsu API google.script w interfejsach usług HTML.

To okno może zostać zamknięte przez wywołanie interfejsu google.script.host.close() po stronie klienta w interfejsie usługi HTML. Inny interfejs może zamknąć tylko użytkownik lub sam interfejs.

Jak pokazano na poniższym przykładzie, do otwarcia tego okna stosowane są metody Dokumentów, Formularzy, Prezentacji i Arkuszy Google Ui.showModalDialog().

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

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 i Arkuszy Google.

Paski boczne nie zawieszają skryptu po stronie serwera po otwarciu okna dialogowego. Komponent po stronie klienta może wykonywać asynchroniczne wywołania po stronie serwera za pomocą interfejsu API google.script w przypadku interfejsów usługi HTML.

Pasek boczny może zamykać się, wywołując google.script.host.close() po stronie klienta w interfejsie usługi HTML. Tylko użytkownik lub sam interfejs nie mogą zamknąć paska bocznego.

Jak widać na przykładzie poniżej, pasek boczny Dokumentów, Formularzy, Prezentacji i Arkuszy Google korzysta z metody Ui.showSidebar().

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

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

Okna otwierania plików

Selektor Google to okno „otwarte pliki” z informacjami przechowywanymi na serwerach Google, w tym z Dysku Google, wyszukiwarki grafiki Google, wyszukiwarki filmów Google i nie tylko.

Jak pokazano 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 dotychczasowych plików lub przesyłanie nowych, a następnie przekazanie tego wyboru z powrotem do skryptu do późniejszego wykorzystania.

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 Google Cloud
3. Gdy projekt Google Cloud pozostanie 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ć, dodając 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 stron kliknij Dodaj element.
   3. Kliknij Witryna 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 pojawi się, dopóki go nie włączysz, ponieważ na liście są widoczne tylko te interfejsy API, które zostały włączone w projekcie Cloud.

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

10. U dołu strony kliknij Zapisz.

/**
 * 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);
  }
}

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