Dialog dan Sidebar di Dokumen Google Workspace

Skrip yang terikat dengan Google Dokumen, Spreadsheet, atau Formulir dapat menampilkan beberapa jenis elemen antarmuka pengguna, yaitu pemberitahuan dan perintah bawaan, serta dialog dan sidebar yang berisi halaman layanan HTML kustom. Biasanya, elemen ini dibuka dari item menu. (Perhatikan bahwa dalam Google Formulir, elemen antarmuka pengguna hanya terlihat oleh editor yang membuka formulir untuk mengubahnya, bukan oleh pengguna yang membuka formulir untuk merespons.)

Dialog notifikasi

Pemberitahuan adalah kotak dialog bawaan yang terbuka di dalam editor Google Dokumen, Spreadsheet, Slide, atau Formulir. Dialog ini menampilkan pesan dan tombol "OK"; judul dan tombol alternatif bersifat opsional. Ini mirip dengan memanggil window.alert() di JavaScript sisi klien dalam browser web.

Notifikasi menangguhkan skrip sisi server saat dialog terbuka. Skrip ini dilanjutkan setelah pengguna menutup dialog, tetapi koneksi JDBC tidak akan bertahan selama penangguhan.

Seperti ditunjukkan dalam contoh di bawah, Google Dokumen, Formulir, Slide, dan Spreadsheet semuanya menggunakan metode Ui.alert(), yang tersedia dalam tiga varian. Untuk mengganti tombol "OK" default, teruskan nilai dari enum Ui.ButtonSet sebagai argumen buttons. Untuk mengevaluasi tombol mana yang diklik pengguna, bandingkan nilai yang ditampilkan untuk alert() dengan 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.');
  }
}

Dialog perintah

Perintah adalah kotak dialog bawaan yang terbuka di dalam editor Google Dokumen, Spreadsheet, Slide, atau Formulir. Dialog ini menampilkan pesan, kolom input teks, dan tombol "Oke"; judul dan tombol alternatif bersifat opsional. Ini mirip dengan memanggil window.prompt() di JavaScript sisi klien dalam browser web.

Perintah akan menangguhkan skrip sisi server saat dialog terbuka. Skrip ini dilanjutkan setelah pengguna menutup dialog, tetapi koneksi JDBC tidak akan bertahan selama penangguhan.

Seperti yang ditunjukkan pada contoh di bawah, Google Dokumen 'Formulir, Slide, dan Spreadsheet menggunakan metode Ui.prompt(), yang tersedia dalam tiga varian. Untuk mengganti tombol "OK" default, teruskan nilai dari enum Ui.ButtonSet sebagai argumen buttons. Untuk mengevaluasi respons pengguna, ambil nilai yang ditampilkan untuk prompt(), lalu panggil PromptResponse.getResponseText() untuk mengambil input pengguna, dan bandingkan nilai yang ditampilkan untuk PromptResponse.getSelectedButton() dengan 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.');
  }
}

Dialog kustom

Dialog kustom dapat menampilkan antarmuka pengguna layanan HTML di dalam editor Google Dokumen, Spreadsheet, Slide, atau Formulir.

Dialog kustom tidak menangguhkan skrip sisi server saat dialog terbuka. Komponen sisi klien dapat melakukan panggilan asinkron ke skrip sisi server menggunakan google.script API untuk antarmuka layanan HTML.

Dialog dapat menutup sendiri dengan memanggil google.script.host.close() di sisi klien antarmuka layanan HTML. Dialog tidak dapat ditutup oleh antarmuka lain, hanya oleh pengguna atau dirinya sendiri.

Seperti yang ditunjukkan pada contoh di bawah, Google Dokumen, Formulir, Slide, dan Spreadsheet semuanya menggunakan metode Ui.showModalDialog() untuk membuka dialog.

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

Sidebar kustom

Sidebar dapat menampilkan antarmuka pengguna layanan HTML di dalam editor Google Dokumen, Formulir, Slide, dan Spreadsheet.

Sidebar tidak menangguhkan skrip sisi server saat dialog terbuka. Komponen sisi klien dapat melakukan panggilan asinkron ke skrip sisi server menggunakan google.script API untuk antarmuka layanan HTML.

Sidebar dapat menutup sendiri dengan memanggil google.script.host.close() di sisi klien antarmuka layanan HTML. Sidebar tidak dapat ditutup oleh antarmuka lain, hanya oleh pengguna atau dirinya sendiri.

Seperti yang ditunjukkan pada contoh di bawah, Google Dokumen, Formulir, Slide, dan Spreadsheet semuanya menggunakan metode Ui.showSidebar() untuk membuka sidebar.

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

Dialog membuka file

Alat Pilih Google adalah dialog "membuka file" untuk informasi yang disimpan di server Google, termasuk Google Drive, Penelusuran Google Gambar, Penelusuran Video Google, dan lainnya.

Seperti yang ditunjukkan dalam contoh di bawah, JavaScript API sisi klien Picker dapat digunakan di layanan HTML untuk membuat dialog kustom yang memungkinkan pengguna memilih file yang ada atau mengupload file baru, lalu meneruskan pilihan tersebut kembali ke skrip Anda untuk digunakan lebih lanjut.

Untuk mengaktifkan Pemilih dan mendapatkan kunci API, ikuti petunjuk berikut:

1. Pastikan bahwa project skrip Anda menggunakan project GCP standar.
2. Aktifkan "Google Picker API" di project Google Cloud Anda.
3. Saat project Google Cloud Anda masih terbuka, pilih APIs & Services, lalu klik Credentials.
4. Klik Create credentials > API key. Tindakan ini akan membuat kunci, tetapi Anda harus mengedit kunci untuk menambahkan pembatasan aplikasi dan pembatasan API ke kunci tersebut.
5. Pada dialog kunci API, klik Close.
6. Di samping kunci API yang dibuat, klik Lainnya > Edit kunci API.

7. Di bagian Application restrictions, selesaikan langkah-langkah berikut:

   1. Pilih Perujuk HTTP (situs).
   2. Di bagian Pembatasan situs, klik Tambahkan item.
   3. Klik Perujuk dan masukkan *.google.com.
   4. Tambahkan item lain dan masukkan *.googleusercontent.com sebagai perujuk.
   5. Klik Selesai.

8. Di bagian API restrictions, selesaikan langkah-langkah berikut:

   1. Pilih Restrict key.

   2. Di bagian Select APIs, pilih Google Picker API, lalu klik Oke.

      Catatan: Google Picker API tidak akan muncul kecuali Anda telah mengaktifkannya karena daftar hanya menampilkan API yang telah diaktifkan untuk project Cloud.

9. Di bagian API key, klik Salin ke papan klip .

10. Di bagian bawah, klik Simpan.

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