Okna i paski boczne w Dokumentach Google Workspace

skrypty powiązane z Dokumentami Google, Arkusze i Formularze mogą wyświetlać kilka typów elementów interfejsu użytkownika: gotowe alerty i prompty, a także okna i paski boczne, strony usługi HTML. Zwykle te elementy są otwierane z pozycji menu. (Pamiętaj, że w Formularzach Google elementy interfejsu użytkownika są widoczne tylko dla edytującego, który otwiera formularz jego modyfikowanie, a nie użytkownikowi, który otwiera formularz, aby na nie odpowiedzieć).

Okna alertów

Alert to gotowe okno dialogowe, które można otworzyć w Dokumentach, Arkuszach Google Prezentacje lub Edytor Formularzy. Wyświetla się komunikat i komunikat „OK”. (przycisk) tytuł, (przyciski alternatywne są opcjonalne). Działa to podobnie do dzwonienia window.alert() w JavaScripcie po stronie klienta w przeglądarce.

Alerty zawieszają skrypt po stronie serwera na czas otwierania okna. Skrypt zostanie wznowione, gdy użytkownik zamknie okno, ale JDBC i nie utrzymują się przez cały czas jego zawieszenia.

Jak widać na przykładzie poniżej, Dokumenty, Formularze, Prezentacje Google a Arkusze używają metody Ui.alert(), która jest dostępny w trzech wersjach. Aby zastąpić domyślne „OK” , prześlij wartość z wyliczenia Ui.ButtonSet jako argumentu buttons. Aby ocenić, który przycisk został kliknięty przez użytkownika, porównaj wartość zwrócona dla funkcji alert() do funkcji Wyliczenie 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 ono komunikat, pole do wpisywania tekstu i przycisk „OK”. Tytuł i przyciski alternatywne są opcjonalne. Działa to podobnie do dzwonienia window.prompt() w JavaScripcie po stronie klienta w przeglądarce.

Pojawią się prośby o zawieszenie skryptu po stronie serwera na czas otwarcia okna. Skrypt zostanie wznowione, gdy użytkownik zamknie okno, ale JDBC i nie utrzymują się przez cały czas jego zawieszenia.

Jak widać na przykładzie poniżej, w Dokumentach Google jako w Formularzach, Prezentacjach i Arkuszach używana jest metoda Ui.prompt(), który jest dostępny w 3 wersjach. Aby zastąpić domyślny przycisk „OK”, jako argument buttons podaj wartość z enumeracji Ui.ButtonSet. Aby ocenić odpowiedź użytkownika, uchwyć wartość zwracaną przez funkcję prompt(), a następnie wywołaj funkcję PromptResponse.getResponseText(), aby pobrać dane wejściowe użytkownika, i porównaj wartość zwracaną przez funkcję PromptResponse.getSelectedButton() z enumeracją 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 usługi HTML w Dokumentach, Arkuszach, Prezentacjach lub edytorze Formularzy Google.

Okna niestandardowe 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 dla interfejsów usługi HTML.

Okno może się zamknąć, wywołując google.script.host.close() po stronie klienta w interfejsie usługi HTML. Okno nie może zostać zamknięte przez za pomocą innych metod.

Jak widać na przykładzie poniżej, 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()" />

Paski boczne niestandardowe

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

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

Pasek boczny może się zamknąć, gdy wywołaszgoogle.script.host.close()po stronie klienta interfejsu usługi HTML. Nie można zamknąć paska bocznego za pomocą innych interfejsów, tylko przez użytkownika lub przez niego.

Jak widać na przykładzie poniżej, Dokumenty, Formularze, Prezentacje i Arkusze Google otwierają pasek boczny za pomocą metody Ui.showSidebar().

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 dialogowe otwierania pliku

Selektor Google ma typ „file-open” okna z informacjami przechowywanymi Serwery Google, w tym Dysk Google, wyszukiwarka grafiki Google i Google Video Wyszukiwanie i inne funkcje.

Jak widać w przykładzie poniżej, można użyć interfejsu JavaScript API selektora po stronie klienta w usłudze HTML, by utworzyć niestandardowe okno, użytkownicy wybierają istniejące pliki lub przesyłają nowe, a następnie przekazują ten wybór z powrotem do skrypt do dalszego wykorzystania.

Uwaga: aby można było używać selektora Google, projekt skryptu musi korzystać z tagu standardowym projekcie Google Cloud.

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

1. Sprawdź, czy Twój projekt skryptu korzysta ze standardowego projektu GCP.
2. Włącz interfejs „Google Picker API” w projekcie Google Cloud.
3. Jeśli Twój projekt Google Cloud jest nadal otwarty, wybierz Interfejsy API Usługi, a następnie kliknij Dane logowania.
4. Kliknij Utwórz dane logowania > Klucz interfejsu API. To działanie powoduje utworzenie klucza, ale należy zmodyfikować klucz, aby dodać do klucza zarówno ograniczenia aplikacji, jak i ograniczenie 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 Referrer i wpisz *.google.com.
   4. Dodaj kolejny element i jako witrynę odsyłającą wpisz *.googleusercontent.com.
   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 nie jest widoczny, jeśli nie włączysz go, ponieważ na liście znajdują się tylko interfejsy API, które zostały włączone dla Cloud w projektach AI.

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

10. U dołu strony kliknij Zapisz.

W tym przykładzie wywołujemy funkcję ScriptApp.getOAuthToken(), aby przekazać token dostępu OAuth 2.0 użytkownika do selektora. Dzięki tej metodzie selektor wyświetlania własnego okna autoryzacji, ale jest to możliwe tylko wtedy, gdy Zakres protokołu OAuth wymagany przez selektor to dostępne w Apps Script. W przeciwnym razie kod selektora będzie musiał zadeklarować własnych zakresów protokołu OAuth, pokazanych w tym artykule „hello world” przykład.

Musisz wywołać metodę setOrigin(google.script.host.origin) podczas tworzenia obiektu PickerBuilder.

code.gs

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

selektor/okno.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>