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 prompty, a także okna i paski boczne zawierające niestandardowe strony usług HTML. Zwykle elementy te są otwierane z poziomu elementów menu. (pamiętaj, że w Formularzach Google elementy interfejsu użytkownika są widoczne tylko dla osób edytujących formularz, które go otwierają, a nie dla użytkowników, którzy otwierają formularz w celu jego wypełnienia).

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”. Tytuł i przyciski alternatywne są opcjonalne. Funkcja ta jest podobna do wywoływania window.alert() w JavaScripcie po stronie klienta w przeglądarce.

Alerty zawieszają skrypt po stronie serwera na czas otwarcia okna dialogowego. Skrypt wznawia się po zamknięciu okna przez użytkownika, ale połączenia z JDBC nie są utrzymywane w okresie zawieszenia.

Jak pokazano w poniższym przykładzie, Dokumenty, Formularze, Prezentacje i Arkusze Google korzystają z metody Ui.alert(), która jest dostępna w 3 wariantach. Aby zastąpić domyślny przycisk „OK”, przekaż wartość z wyliczenia Ui.ButtonSet jako argument buttons. Aby sprawdzić, który przycisk został kliknięty, 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 z promptami

Prompt to gotowe okno dialogowe, które otwiera się w edytorze Dokumentów, Arkuszy, Prezentacji lub Formularzy Google. Wyświetla on komunikat, pole do wprowadzania tekstu i przycisk „OK”. Tytuł i przyciski alternatywne są opcjonalne. Funkcja ta jest podobna do wywoływania window.prompt() w JavaScripcie po stronie klienta w przeglądarce.

Prośby powodują zawieszenie skryptu po stronie serwera w czasie, gdy okno jest otwarte. Skrypt wznawia się po zamknięciu okna przez użytkownika, ale połączenia z JDBC nie są utrzymywane w okresie zawieszenia.

Jak widać na przykładzie poniżej, Formularze, Prezentacje i Arkusze w Dokumentach Google używają metody Ui.prompt(), która jest dostępna w 3 wariantach. Aby zastąpić domyślny przycisk „OK”, przekaż wartość z wyliczenia Ui.ButtonSet jako argument buttons. Aby ocenić odpowiedź użytkownika, przechwyć wartość zwracaną przez funkcję prompt(), wywołaj metodę PromptResponse.getResponseText() w celu pobrania informacji wejściowych użytkownika i porównaj wartość zwracaną przez zdarzenie 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.

Niestandardowe okna nie zawieszają skryptu po stronie serwera, gdy jest ono otwarte. Komponent po stronie klienta może wykonywać asynchroniczne wywołania skryptu po stronie serwera za pomocą interfejsu API google.script przeznaczonego do interfejsów usługi HTML.

Okno może się zamknąć, wywołując google.script.host.close() po stronie klienta interfejsu usługi HTML. Okno nie może zostać zamknięte przez inne interfejsy – tylko użytkownik ani sam użytkownik.

Jak pokazano w poniższym przykładzie, Dokumenty, Formularze, Prezentacje i Arkusze Google używają metody Ui.showModalDialog() do otwierania okna.

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

Niestandardowe paski boczne

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

Paski boczne nie zawieszają skryptu po stronie serwera, gdy okno jest otwarte. Komponent po stronie klienta może wykonywać asynchroniczne wywołania skryptu po stronie serwera za pomocą interfejsu API google.script przeznaczonego do interfejsów usługi HTML.

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

Jak pokazano w poniższym przykładzie, Dokumenty, Formularze, Prezentacje i Arkusze Google używają metody Ui.showSidebar() do otwierania paska bocznego.

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

Okna podczas otwierania pliku

Selektor Google to okno do otwierania pliku. Zawiera ono informacje przechowywane na serwerach Google, w tym na Dysku Google, w wyszukiwarce grafiki Google i w wyszukiwarce wideo Google.

Jak pokazano w przykładzie poniżej, można użyć interfejsu API JavaScript po stronie klienta selektora w usłudze HTML do utworzenia niestandardowego okna, które pozwala użytkownikom wybrać istniejące pliki lub przesłać nowe, a następnie przekazać ten wybór z powrotem do skryptu do dalszego wykorzystania.

Uwaga: aby można było korzystać z selektora Google, projekt skryptu musi korzystać ze standardowego projektu Google Cloud.

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

1. Sprawdź, czy projekt skryptu używa standardowego projektu GCP.
2. Włącz w projekcie Google Cloud interfejs „Google Picker API”.
3. Gdy projekt Google Cloud 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 musisz zmodyfikować klucz, aby dodać do niego ograniczenia aplikacji i 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 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 interfejsów API wykonaj te czynności:

   1. Wybierz Ogranicz klucz.

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

      Uwaga: interfejs Google Picker API jest widoczny tylko wtedy, gdy go włączysz, ponieważ na liście znajdują się 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.

W poniższym przykładzie wywołujemy ScriptApp.getOAuthToken(), by przekazać token dostępu użytkownika OAuth 2.0 do selektora. Dzięki tej metodzie selektor nie musi wyświetlać własnego okna autoryzacji, ale jest to możliwe tylko wtedy, gdy zakres protokołu OAuth, którego potrzebuje selektor, jest dostępny w Apps Script. W przeciwnym razie kod selektora będzie musiał zadeklarować własne zakresy OAuth, tak jak w tym przykładzie „hello world”.

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

code.gs

picker/code.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

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