Class Ui

Membuka kotak dialog di editor pengguna dengan pesan yang diberikan dan tombol "OK". Metode ini menangguhkan skrip sisi server saat dialog terbuka. Skrip dilanjutkan setelah pengguna menutup dialog, tetapi koneksi Jdbc dan kunci LockService tidak tetap ada selama penangguhan. Untuk informasi selengkapnya, lihat panduan untuk dialog dan sidebar.

// Display "Hello, world" in a dialog box with an "OK" button. The user can also
// close the dialog by clicking the close button in its title bar.
SpreadsheetApp.getUi().alert('Hello, world');

Parameter

Pulang pergi

Button — Tombol yang diklik pengguna.

Membuka kotak dialog di editor pengguna dengan pesan dan kumpulan tombol yang diberikan. Metode ini menangguhkan skrip sisi server saat dialog terbuka. Skrip dilanjutkan setelah pengguna menutup dialog, tetapi koneksi Jdbc dan kunci LockService tidak tetap ada selama penangguhan. Untuk informasi selengkapnya, lihat panduan untuk dialog dan sidebar.

// Display a dialog box with a message and "Yes" and "No" buttons. The user can
// also close the dialog by clicking the close button in its title bar.
const ui = SpreadsheetApp.getUi();
const response = ui.alert(
    'Are you sure you want to continue?',
    ui.ButtonSet.YES_NO,
);

// Process the user's response.
if (response === ui.Button.YES) {
  Logger.log('The user clicked "Yes."');
} else {
  Logger.log(
      'The user clicked "No" or the close button in the dialog\'s title bar.',
  );
}

Parameter

Pulang pergi

Button — Tombol yang diklik pengguna.

Membuka kotak dialog di editor pengguna dengan judul, pesan, dan kumpulan tombol yang diberikan. Metode ini menangguhkan skrip sisi server saat dialog terbuka. Skrip dilanjutkan setelah pengguna menutup dialog, tetapi koneksi Jdbc dan kunci LockService tidak tetap ada selama penangguhan. Untuk informasi selengkapnya, lihat panduan untuk dialog dan sidebar.

// Display a dialog box with a title, message, and "Yes" and "No" buttons. The
// user can also close the dialog by clicking the close button in its title bar.
const ui = SpreadsheetApp.getUi();
const response = ui.alert(
    'Confirm',
    'Are you sure you want to continue?',
    ui.ButtonSet.YES_NO,
);

// Process the user's response.
if (response === ui.Button.YES) {
  Logger.log('The user clicked "Yes."');
} else {
  Logger.log(
      'The user clicked "No" or the close button in the dialog\'s title bar.',
  );
}

Parameter

Pulang pergi

Button — Tombol yang diklik pengguna.

Membuat builder yang dapat digunakan untuk menyisipkan submenu ke menu Ekstensi editor. Menu tidak benar-benar diperbarui hingga Menu.addToUi() dipanggil. Jika skrip berjalan sebagai add-on, nama submenu akan cocok dengan nama add-on di web store; jika skrip terikat langsung ke dokumen, nama submenu akan cocok dengan nama skrip. Untuk informasi selengkapnya, lihat panduan menu.

// Add an item to the Add-on menu, under a sub-menu whose name is set
// automatically.
function onOpen(e) {
  SpreadsheetApp.getUi()
      .createAddonMenu()
      .addItem('Show', 'showSidebar')
      .addToUi();
}

Pulang pergi

Menu — Builder menu baru.

Membuat builder yang dapat digunakan untuk menambahkan menu ke antarmuka pengguna editor. Menu sebenarnya tidak ditambahkan hingga Menu.addToUi() dipanggil. Untuk informasi selengkapnya, lihat panduan menu. Label untuk menu tingkat atas harus menggunakan kapitalisasi judul (semua kata utama menggunakan huruf besar), meskipun label untuk submenu harus menggunakan kapitalisasi kalimat (hanya kata pertama yang menggunakan huruf besar). Jika skrip dipublikasikan sebagai add-on, parameter caption akan diabaikan dan menu ditambahkan sebagai sub-menu dari menu Ekstensi, yang setara dengan createAddonMenu().

// Add a custom menu to the active document, including a separator and a
// sub-menu.
function onOpen(e) {
  SpreadsheetApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(
          SpreadsheetApp.getUi()
              .createMenu('My sub-menu')
              .addItem('One sub-menu item', 'mySecondFunction')
              .addItem('Another sub-menu item', 'myThirdFunction'),
          )
      .addToUi();
}

Parameter

Pulang pergi

Menu — Builder menu baru.

Membuka kotak dialog input di editor pengguna dengan pesan yang diberikan dan tombol "OK". Metode ini menangguhkan skrip sisi server saat dialog terbuka. Skrip dilanjutkan setelah pengguna menutup dialog, tetapi koneksi Jdbc dan kunci LockService tidak tetap ada selama penangguhan. Untuk informasi selengkapnya, lihat panduan untuk dialog dan sidebar.

// Display a dialog box with a message, input field, and an "OK" button. The
// user can also close the dialog by clicking the close button in its title bar.
const ui = SpreadsheetApp.getUi();
const response = ui.prompt('Enter your name:');

// Process the user's response.
if (response.getSelectedButton() === ui.Button.OK) {
  Logger.log('The user\'s name is %s.', response.getResponseText());
} else {
  Logger.log('The user clicked the close button in the dialog\'s title bar.');
}

Parameter

Pulang pergi

PromptResponse — Representasi respons pengguna.

Membuka kotak dialog input di editor pengguna dengan pesan dan kumpulan tombol yang diberikan. Metode ini menangguhkan skrip sisi server saat dialog terbuka. Skrip dilanjutkan setelah pengguna menutup dialog, tetapi koneksi Jdbc dan kunci LockService tidak tetap ada selama penangguhan. Untuk informasi selengkapnya, lihat panduan untuk dialog dan sidebar.

// Display a dialog box with a message, input field, and "Yes" and "No" buttons.
// The user can also close the dialog by clicking the close button in its title
// bar.
const ui = SpreadsheetApp.getUi();
const response = ui.prompt('May I know your name?', ui.ButtonSet.YES_NO);

// Process the user's response.
if (response.getSelectedButton() === ui.Button.YES) {
  Logger.log('The user\'s name is %s.', response.getResponseText());
} else if (response.getSelectedButton() === ui.Button.NO) {
  Logger.log('The user didn\'t want to provide a name.');
} else {
  Logger.log('The user clicked the close button in the dialog\'s title bar.');
}

Parameter

Pulang pergi

PromptResponse — Representasi respons pengguna.

Membuka kotak dialog input di editor pengguna dengan judul, pesan, dan kumpulan tombol yang diberikan. Metode ini menangguhkan skrip sisi server saat dialog terbuka. Skrip akan dilanjutkan setelah pengguna menutup dialog, tetapi koneksi Jdbc dan kunci LockService tidak akan tetap ada selama penangguhan. Untuk informasi selengkapnya, lihat panduan dialog dan sidebar.

// Display a dialog box with a title, message, input field, and "Yes" and "No"
// buttons. The user can also close the dialog by clicking the close button in
// its title bar.
const ui = SpreadsheetApp.getUi();
const response = ui.prompt(
    'Getting to know you',
    'May I know your name?',
    ui.ButtonSet.YES_NO,
);

// Process the user's response.
if (response.getSelectedButton() === ui.Button.YES) {
  Logger.log('The user\'s name is %s.', response.getResponseText());
} else if (response.getSelectedButton() === ui.Button.NO) {
  Logger.log('The user didn\'t want to provide a name.');
} else {
  Logger.log('The user clicked the close button in the dialog\'s title bar.');
}

Parameter

Pulang pergi

PromptResponse — Representasi respons pengguna.

Membuka kotak dialog modal di editor pengguna dengan konten sisi klien kustom. Metode ini tidak menangguhkan skrip sisi server saat dialog terbuka. Untuk berkomunikasi dengan skrip sisi server, komponen sisi klien harus membuat callback asinkron menggunakan google.script API untuk HtmlService. Untuk menutup dialog secara terprogram, panggil google.script.host.close() di sisi klien aplikasi web HtmlService. Untuk informasi selengkapnya, lihat panduan untuk dialog dan sidebar.

Dialog modal mencegah pengguna berinteraksi dengan apa pun selain dialog. Sebaliknya, dialog tanpa mode dan sidebar memungkinkan pengguna berinteraksi dengan editor. Dalam hampir semua kasus, dialog modal atau sidebar adalah pilihan yang lebih baik daripada dialog tanpa mode.

// Display a modal dialog box with custom HtmlService content.
const htmlOutput = HtmlService
                       .createHtmlOutput(
                           '<p>A change of speed, a change of style...</p>',
                           )
                       .setWidth(250)
                       .setHeight(300);
SpreadsheetApp.getUi().showModalDialog(htmlOutput, 'My add-on');

Parameter

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/script.container.ui

Membuka kotak dialog tanpa mode di editor pengguna dengan konten sisi klien kustom. Metode ini tidak menangguhkan skrip sisi server saat dialog terbuka. Untuk berkomunikasi dengan skrip sisi server, komponen sisi klien harus membuat callback asinkron menggunakan google.script API untuk HtmlService. Untuk menutup dialog secara terprogram, panggil google.script.host.close() di sisi klien aplikasi web HtmlService. Untuk informasi selengkapnya, lihat panduan untuk dialog dan sidebar.

Dialog tanpa mode memungkinkan pengguna berinteraksi dengan editor di balik dialog. Sebaliknya, dialog modal tidak. Dalam hampir semua kasus, dialog modal atau sidebar adalah pilihan yang lebih baik daripada dialog tanpa mode.

// Display a modeless dialog box with custom HtmlService content.
const htmlOutput = HtmlService
                       .createHtmlOutput(
                           '<p>A change of speed, a change of style...</p>',
                           )
                       .setWidth(250)
                       .setHeight(300);
SpreadsheetApp.getUi().showModelessDialog(htmlOutput, 'My add-on');

Parameter

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/script.container.ui

Membuka sidebar di editor pengguna dengan konten sisi klien kustom. Metode ini tidak menangguhkan skrip sisi server saat sidebar terbuka. Untuk berkomunikasi dengan skrip sisi server, komponen sisi klien harus membuat callback asinkron menggunakan google.script API untuk HtmlService. Untuk menutup sidebar secara terprogram, panggil google.script.host.close() di sisi klien aplikasi web HtmlService. Untuk informasi selengkapnya, lihat panduan untuk dialog dan sidebar.

Sidebar ditampilkan di sisi kanan editor untuk pengguna yang lingkungannya menggunakan bahasa kiri-kanan dan di sisi kiri editor untuk bahasa kanan-kiri. Semua sidebar yang ditampilkan oleh skrip memiliki lebar 300 piksel.

// Display a sidebar with custom HtmlService content.
const htmlOutput = HtmlService
                       .createHtmlOutput(
                           '<p>A change of speed, a change of style...</p>',
                           )
                       .setTitle('My add-on');
SpreadsheetApp.getUi().showSidebar(htmlOutput);

Parameter

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

• https://www.googleapis.com/auth/script.container.ui