Hộp thoại và thanh bên trong Tài liệu trên Google Workspace

Các tập lệnh được liên kết với Google Tài liệu, Trang tính hoặc Biểu mẫu có thể hiển thị một số loại phần tử giao diện người dùng — cảnh báo và lời nhắc được tạo sẵn, cùng với hộp thoại và thanh bên chứa tuỳ chỉnh Các trang dịch vụ HTML. Thông thường, những phần tử này được mở qua các mục trong trình đơn. (Lưu ý rằng trong Google Biểu mẫu, các phần tử giao diện người dùng chỉ hiển thị cho người chỉnh sửa mở biểu mẫu để sửa đổi chứ không phải người dùng mở biểu mẫu để trả lời).

Hộp thoại cảnh báo

Cảnh báo là một hộp thoại được tạo sẵn, mở ra bên trong tệp Google Tài liệu, Trang tính, Trang trình bày hoặc trình chỉnh sửa Biểu mẫu. Nó sẽ hiển thị một thông báo và "OK" nút; một tiêu đề và các nút thay thế là tuỳ chọn. Thao tác này cũng tương tự như gọi window.alert() trong JavaScript phía máy khách trong trình duyệt web.

Cảnh báo sẽ tạm ngưng tập lệnh phía máy chủ trong khi hộp thoại đang mở. Tập lệnh sẽ tiếp tục sau khi người dùng đóng hộp thoại, nhưng các kết nối JDBC sẽ không tồn tại trong quá trình tạm ngưng.

Như trong ví dụ bên dưới, Google Tài liệu, Biểu mẫu, Trang trình bày, và Trang tính đều sử dụng phương thức Ui.alert(). Phương thức này có 3 biến thể. Để ghi đè tuỳ chọn "OK" mặc định hãy truyền giá trị từ enum Ui.ButtonSet làm đối số buttons. Để đánh giá xem người dùng đã nhấp vào nút nào, hãy so sánh giá trị trả về cho alert() vào Enum 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.');
  }
}

Hộp thoại lời nhắc

Câu lệnh là một hộp thoại được tạo sẵn, mở ra bên trong tệp Google Tài liệu, Trang tính, Trang trình bày hoặc trình chỉnh sửa Biểu mẫu. Hộp thoại này hiển thị một thông báo, một trường nhập văn bản và một nút "OK"; tiêu đề và các nút thay thế là không bắt buộc. Cách này tương tự như cách gọi window.prompt() trong JavaScript phía máy khách trong trình duyệt web.

Lời nhắc sẽ tạm ngưng tập lệnh phía máy chủ trong khi hộp thoại đang mở. Kịch bản tiếp tục sau khi người dùng đóng hộp thoại, nhưng JDBC không còn kết nối trong quá trình tạm ngưng.

Như trong ví dụ bên dưới, Google Tài liệu, Biểu mẫu, Trang trình bày và Trang tính đều sử dụng phương thức Ui.prompt(), có ba biến thể. Để ghi đè tuỳ chọn "OK" mặc định nút truyền một giá trị từ Ui.ButtonSet enum dưới dạng đối số buttons. Để đánh giá phản hồi của người dùng, hãy ghi lại giá trị trả về cho prompt(), sau đó gọi PromptResponse.getResponseText() để truy xuất dữ liệu đầu vào của người dùng và so sánh giá trị trả về cho PromptResponse.getSelectedButton() với enum 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.');
  }
}

Hộp thoại tuỳ chỉnh

Hộp thoại tuỳ chỉnh có thể hiển thị người dùng dịch vụ HTML bên trong một trình chỉnh sửa Google Tài liệu, Trang tính, Trang trình bày hoặc Biểu mẫu.

Hộp thoại tuỳ chỉnh không tạm ngưng tập lệnh phía máy chủ trong khi hộp thoại đang mở. Thành phần phía máy khách có thể thực hiện các lệnh gọi không đồng bộ đến tập lệnh phía máy chủ bằng cách sử dụng API google.script cho giao diện dịch vụ HTML.

Hộp thoại có thể tự đóng bằng cách gọi google.script.host.close() ở phía máy khách của giao diện dịch vụ HTML. Không thể đóng hộp thoại trước các giao diện khác, chỉ do người dùng hoặc chính người dùng đó thực hiện.

Như trong ví dụ bên dưới, Google Tài liệu, Biểu mẫu, Trang trình bày và Trang tính đều sử dụng phương thức Ui.showModalDialog() để mở hộp thoại.

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

Thanh bên tuỳ chỉnh

Thanh bên có thể hiển thị người dùng dịch vụ HTML bên trong trình chỉnh sửa của Google Tài liệu, Biểu mẫu, Trang trình bày và Trang tính.

Thanh bên không tạm ngưng tập lệnh phía máy chủ khi hộp thoại đang mở. Chiến lược phát hành đĩa đơn thành phần phía máy khách có thể thực hiện lệnh gọi không đồng bộ đến tập lệnh phía máy chủ bằng API google.script cho giao diện dịch vụ HTML.

Thanh bên có thể tự đóng bằng cách gọi google.script.host.close() ở phía máy khách của giao diện dịch vụ HTML. Không thể đóng thanh bên bởi các giao diện khác, mà chỉ do người dùng hoặc chính người dùng đó thực hiện.

Như trong ví dụ bên dưới, Google Tài liệu, Biểu mẫu, Trang trình bày và Trang tính đều sử dụng phương thức Ui.showSidebar() để mở thanh bên.

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

Hộp thoại mở tệp

Google Inspector là một tệp "file-open" hộp thoại để xem thông tin được lưu trữ trong Máy chủ của Google, bao gồm Google Drive, Google Tìm kiếm hình ảnh, Google Video Tìm kiếm và hơn thế nữa.

Như trong ví dụ bên dưới, bạn có thể sử dụng API JavaScript phía máy khách của Bộ chọn trong dịch vụ HTML để tạo hộp thoại tuỳ chỉnh cho phép người dùng chọn các tệp hiện có hoặc tải tệp mới lên, sau đó chuyển lựa chọn đó trở lại để sử dụng trong tương lai.

Để bật Bộ chọn và nhận khoá API, hãy làm theo các hướng dẫn sau:

  1. Xác minh rằng dự án tập lệnh của bạn đang sử dụng dự án GCP chuẩn.
  2. Bật "API Bộ chọn của Google" trong dự án Google Cloud của bạn.
  3. Khi dự án Google Cloud của bạn vẫn còn mở, hãy chọn API và Services, sau đó nhấp vào Thông tin xác thực.
  4. Nhấp vào Tạo thông tin xác thực &gt; Khoá API. Thao tác này sẽ tạo ra khoá, nhưng bạn nên chỉnh sửa khoá để thêm cả các quy tắc hạn chế của ứng dụng và quy định hạn chế về API vào khoá.
  5. Trong hộp thoại khoá API, hãy nhấp vào Đóng.
  6. Bên cạnh khoá API mà bạn đã tạo, hãy nhấp vào biểu tượng Tuỳ chọn khác Biểu tượng Thêm> Chỉnh sửa khoá API.

  7. Trong phần Hạn chế ứng dụng, hãy hoàn tất các bước sau:

    1. Chọn Đường liên kết giới thiệu HTTP (trang web).
    2. Trong phần Hạn chế về trang web, hãy nhấp vào Thêm một mục.
    3. Nhấp vào Đường liên kết giới thiệu rồi nhập *.google.com.
    4. Thêm một mặt hàng khác rồi nhập *.googleusercontent.com làm đường liên kết giới thiệu.
    5. Nhấp vào Xong.

  8. Trong phần Các hạn chế về API, hãy hoàn thành các bước sau:

    1. Chọn Hạn chế khoá.

    2. Trong phần Select APIs (Chọn API), hãy chọn Google phép đặt API rồi nhấp vào OK.

      Lưu ý: API Bộ chọn của Google chỉ xuất hiện khi bạn bật vì danh sách chỉ hiển thị các API được bật cho Đám mây dự án.

  9. Trong phần Khoá API, hãy nhấp vào biểu tượng Sao chép vào bảng nhớ tạm Biểu tượng Sao chép vào bảng nhớ tạm.

  10. Ở dưới cùng, hãy nhấp vào Lưu.

code.gs

bộ chọn/code.gs
/**
 * 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

bộ chọn/hộp thoại.html
<!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>