Class SpreadsheetApp

Membuat spreadsheet baru dengan nama tertentu.

// The code below creates a new spreadsheet "Finances" and logs the URL for it
var ssNew = SpreadsheetApp.create("Finances");
Logger.log(ssNew.getUrl());

Parameter

Return

Spreadsheet — spreadsheet baru

Otorisasi

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

• https://www.googleapis.com/auth/spreadsheets

Membuat spreadsheet baru dengan nama yang diberikan serta jumlah baris dan kolom yang ditentukan.

// The code below creates a new spreadsheet "Finances" with 50 rows and 5 columns and logs the
// URL for it
var ssNew = SpreadsheetApp.create("Finances", 50, 5);
Logger.log(ssNew.getUrl());

Parameter

Return

Spreadsheet — spreadsheet baru

Otorisasi

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

• https://www.googleapis.com/auth/spreadsheets

Mengaktifkan eksekusi data untuk semua jenis sumber data.

Eksekusi data menampilkan pengecualian jika jenis sumber data tidak diaktifkan. Gunakan metode ini untuk mengaktifkan eksekusi data bagi semua jenis sumber data.

// Turns data execution on for all types of data sources.
SpreadsheetApp.enableAllDataSourcesExecution();

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets the first data source sheet in the spreadsheet and refreshes the data.
ss.getDataSourceSheets()[0].refreshData();

Otorisasi

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

• https://www.googleapis.com/auth/bigquery.readonly

Mengaktifkan eksekusi data untuk sumber data BigQuery.

Eksekusi data untuk sumber data BigQuery akan menampilkan pengecualian jika tidak diaktifkan.

// Turns data execution on for BigQuery data sources.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets the first data source sheet in the spreadsheet and refreshes the BigQuery data.
ss.getDataSourceSheets()[0].refreshData();

Otorisasi

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

• https://www.googleapis.com/auth/bigquery.readonly

Menerapkan semua perubahan Spreadsheet yang tertunda.

Operasi spreadsheet terkadang dipaketkan bersama untuk meningkatkan performa, seperti saat melakukan beberapa panggilan ke Range.getValue(). Namun, terkadang Anda mungkin ingin memastikan bahwa semua perubahan yang tertunda segera dibuat, misalnya untuk menampilkan data pengguna saat skrip dieksekusi.

// The code below changes the background color of cells A1 and B1 twenty times. You should be
// able to see the updates live in the spreadsheet. If flush() is not called, the updates may
// be applied live or may all be applied at once when the script completes.
function colors() {
  var sheet = SpreadsheetApp.getActiveSheet();
  for (var i = 0; i < 20; i++) {
    if ((i % 2) == 0) {
      sheet.getRange('A1').setBackground('green');
      sheet.getRange('B1').setBackground('red');
    } else {
      sheet.getRange('A1').setBackground('red');
      sheet.getRange('B1').setBackground('green');
    }
    SpreadsheetApp.flush();
  }
}

Menampilkan spreadsheet yang sedang aktif, atau null jika tidak ada.

Fungsi yang dijalankan dalam konteks spreadsheet bisa mendapatkan referensi ke objek Spreadsheet yang sesuai dengan memanggil fungsi ini.

// The code below logs the URL for the active spreadsheet.
Logger.log(SpreadsheetApp.getActive().getUrl());

Return

Spreadsheet — objek Spreadsheet aktif

Otorisasi

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

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Menampilkan rentang yang dipilih di sheet aktif, atau null jika tidak ada rentang aktif. Jika beberapa rentang dipilih, metode ini hanya menampilkan rentang terakhir yang dipilih.

Secara umum, rentang ini berarti rentang yang telah dipilih pengguna di sheet aktif. Namun, dalam fungsi kustom, rentang ini mengacu pada sel yang secara aktif dihitung ulang.

// The code below logs the background color for the active range.
var colorObject = SpreadsheetApp.getActiveRange().getBackgroundObject();
// Assume the color has ColorType.RGB.
Logger.log(colorObject.asRgbColor().asHexString());

Return

Range — Rentang aktif.

Otorisasi

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

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Menampilkan daftar rentang aktif di sheet aktif atau null jika tidak ada rentang yang dipilih. Rentang aktif yang berisi sel yang saat ini disorot akan ditempatkan terakhir dalam daftar.

Jika ada satu rentang yang dipilih, ini akan berperilaku sebagai panggilan getActiveRange().

// Returns the list of active ranges.
var rangeList = SpreadsheetApp.getActiveRangeList();

Return

RangeList — daftar rentang aktif

Otorisasi

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

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Mendapatkan sheet aktif dalam spreadsheet.

Sheet aktif dalam spreadsheet adalah sheet yang ditampilkan di UI spreadsheet.

// The code below logs the name of the active sheet.
Logger.log(SpreadsheetApp.getActiveSheet().getName());

Return

Sheet — objek Sheet aktif

Otorisasi

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

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Menampilkan spreadsheet yang sedang aktif, atau null jika tidak ada.

Fungsi yang dijalankan dalam konteks spreadsheet bisa mendapatkan referensi ke objek Spreadsheet yang sesuai dengan memanggil fungsi ini.

// The code below logs the URL for the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getUrl());

Return

Spreadsheet — objek Spreadsheet aktif

Otorisasi

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

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Menampilkan sel saat ini (ditandai) yang dipilih di salah satu rentang aktif di sheet aktif atau null jika tidak ada sel saat ini.

// Returns the current highlighted cell in the one of the active ranges.
var currentCell = SpreadsheetApp.getCurrentCell();

Return

Range — sel saat ini

Otorisasi

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

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Menampilkan Selection saat ini di spreadsheet.

var selection = SpreadsheetApp.getSelection();
var currentCell = selection.getCurrentCell();

Return

Selection — pilihan saat ini

Otorisasi

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

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Menampilkan instance lingkungan antarmuka pengguna spreadsheet yang memungkinkan skrip untuk menambahkan fitur seperti menu, dialog, dan sidebar. Skrip hanya dapat berinteraksi dengan UI untuk instance spreadsheet terbuka saat ini, dan hanya jika skrip terikat ke spreadsheet. Untuk mengetahui informasi selengkapnya, lihat panduan untuk menu serta dialog dan sidebar.

// Add a custom menu to the active spreadsheet, 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();
}

Return

Ui — instance lingkungan antarmuka pengguna spreadsheet ini

Membuat builder untuk CellImage.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A1 on Sheet1.
const range = sheet.getRange('A1');

// Builds an image using a source URL.
const cellImage = SpreadsheetApp.newCellImage()
  .setSourceUrl('https://www.gstatic.com/images/branding/productlogos/apps_script/v10/web-64dp/logo_apps_script_color_1x_web_64dp.png')
  .build();

// Sets the image in cell A1.
range.setValue(cellImage);

Return

CellImageBuilder — Builder baru.

Membuat builder untuk Color.

var rgbColor = SpreadsheetApp.newColor().setRgbColor("#FF0000").build();

Return

ColorBuilder — Builder baru.

Membuat builder untuk aturan format bersyarat.

// Adds a conditional format rule to a sheet that causes all cells in range A1:B3 to turn red
// if they contain a number between 1 and 10.
var sheet = SpreadsheetApp.getActive().getActiveSheet();
var range = sheet.getRange('A1:B3');
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberBetween(1, 10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build()
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Return

ConditionalFormatRuleBuilder — builder baru.

Membuat builder untuk DataSourceSpec.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Enables BigQuery.
SpreadsheetApp.enableBigQueryExecution();

// Builds a data source specification.
// TODO (developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
  .asBigQuery()
  .setProjectId('project-id-1')
  .setTableProjectId('bigquery-public-data')
  .setDatasetId('ncaa_basketball')
  .setTableId('mbb_historical_teams_games')
  .build();

// Adds the data source and its data to the spreadsheet.
ss.insertDataSourceSheet(dataSourceSpec);

Return

DataSourceSpecBuilder — Builder baru.

Membuat builder untuk aturan validasi data.

var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation()
    .requireNumberBetween(1, 100)
    .setAllowInvalid(false)
    .setHelpText('Number must be between 1 and 100.')
    .build();
cell.setDataValidation(rule);

Return

DataValidationBuilder — Builder baru.

Membuat builder untuk FilterCriteria.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Sets the range to A1:D20.
const range = sheet.getRange('A1:D20');

// Creates a filter and applies it to the specified range.
range.createFilter();

// Gets the current filter for the range and creates filter criteria that only shows cells
// that aren't empty.
const filter = range.getFilter();
const criteria = SpreadsheetApp.newFilterCriteria().whenCellNotEmpty().build();

// Sets the criteria to  column C.
filter.setColumnFilterCriteria(3, criteria);

Return

FilterCriteriaBuilder — builder baru

Membuat builder untuk nilai Rich Text.

// Sets cell A1 to have the text "Hello world", with "Hello" bolded.
var cell = SpreadsheetApp.getActive().getRange('A1');
var bold = SpreadsheetApp.newTextStyle().setBold(true).build();
var value = SpreadsheetApp.newRichTextValue()
    .setText("Hello world")
    .setTextStyle(0, 5, bold)
    .build();
cell.setRichTextValue(value);

Return

RichTextValueBuilder — Builder baru.

Membuat builder untuk gaya teks.

// Sets range A1:B3 to have red, size 22, bolded, underlined text.
var range = SpreadsheetApp.getActive().getRange('A1:B3');
var style = SpreadsheetApp.newTextStyle()
    .setForegroundColor("red")
    .setFontSize(22)
    .setBold(true)
    .setUnderline(true)
    .build();
range.setTextStyle(style);

Return

TextStyleBuilder — Builder baru.

Membuka spreadsheet yang sesuai dengan objek File yang diberikan.

// Get any starred spreadsheets from Google Drive, then open the spreadsheets and log the name
// of the first sheet within each spreadsheet.
var files = DriveApp.searchFiles(
    'starred = true and mimeType = "' + MimeType.GOOGLE_SHEETS + '"');
while (files.hasNext()) {
  var spreadsheet = SpreadsheetApp.open(files.next());
  var sheet = spreadsheet.getSheets()[0];
  Logger.log(sheet.getName());
}

Parameter

Return

Spreadsheet — spreadsheet

Otorisasi

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

• https://www.googleapis.com/auth/spreadsheets

Membuka spreadsheet dengan ID yang diberikan. ID spreadsheet dapat diekstrak dari URL-nya. Misalnya, ID spreadsheet di URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 adalah "abc1234567".

// The code below opens a spreadsheet using its ID and logs the name for it.
// Note that the spreadsheet is NOT physically opened on the client side.
// It is opened on the server only (for modification by the script).
var ss = SpreadsheetApp.openById("abc1234567");
Logger.log(ss.getName());

Parameter

Return

Spreadsheet — Objek Spreadsheet dengan ID yang diberikan

Otorisasi

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

• https://www.googleapis.com/auth/spreadsheets

Membuka spreadsheet dengan URL yang ditentukan. Menampilkan pengecualian pembuatan skrip jika URL tidak ada atau pengguna tidak memiliki izin untuk mengaksesnya.

// Opens a spreadsheet by its URL and logs its name.
// Note that the spreadsheet doesn't physically open on the client side.
// It opens on the server only (for modification by the script).
var ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc1234567/edit');
console.log(ss.getName());

Parameter

Return

Spreadsheet — Objek spreadsheet dengan URL yang diberikan.

Otorisasi

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

• https://www.googleapis.com/auth/spreadsheets

Menetapkan rentang yang ditentukan sebagai active range, dengan sel kiri atas dalam rentang sebagai current cell.

UI spreadsheet menampilkan sheet yang berisi rentang yang dipilih dan memilih sel yang ditentukan dalam rentang yang dipilih.

// The code below sets range C1:D4 in the first sheet as the active range.
var range = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('C1:D4');
SpreadsheetApp.setActiveRange(range);

var selection = SpreadsheetApp.getSelection();
// Current cell: C1
var currentCell = selection.getCurrentCell();
// Active Range: C1:D4
var activeRange = selection.getActiveRange();

Parameter

Return

Range — Rentang aktif baru

Menetapkan daftar rentang yang ditentukan sebagai active ranges. Rentang terakhir dalam daftar ditetapkan sebagai active range.

// The code below sets ranges [D4, B2:C4] in the active sheet as the active ranges.
var rangeList = SpreadsheetApp.getActiveSheet().getRanges(['D4', 'B2:C4']);
SpreadsheetApp.setActiveRangeList(rangeList);

var selection = SpreadsheetApp.getSelection();
// Current cell: B2
var currentCell = selection.getCurrentCell();
// Active range: B2:C4
var activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
var activeRangeList = selection.getActiveRangeList();

Parameter

Return

RangeList — daftar rentang yang baru dipilih

Otorisasi

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

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Menetapkan sheet aktif di spreadsheet. UI Google Spreadsheet menampilkan sheet yang dipilih kecuali jika sheet tersebut milik spreadsheet lain.

// The code below makes the 2nd sheet active in the active spreadsheet.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
SpreadsheetApp.setActiveSheet(spreadsheet.getSheets()[1]);

Parameter

Return

Sheet — sheet yang telah dijadikan sheet aktif baru

Menetapkan sheet aktif dalam spreadsheet, dengan opsi untuk memulihkan pilihan terbaru dalam sheet tersebut. UI Google Spreadsheet menampilkan sheet yang dipilih kecuali jika sheet tersebut milik spreadsheet berbeda.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var firstSheet = spreadsheet.getSheets()[0];
var secondSheet = spreadsheet.getSheets()[1];
// Set the first sheet as the active sheet and select the range D4:F4.
spreadsheet.setActiveSheet(firstSheet).getRange('D4:F4').activate();

// Switch to the second sheet to do some work.
spreadsheet.setActiveSheet(secondSheet);
// Switch back to first sheet, and restore its selection.
spreadsheet.setActiveSheet(firstSheet, true);

// The selection of first sheet is restored, and it logs D4:F4
var range = spreadsheet.getActiveSheet().getSelection().getActiveRange();
Logger.log(range.getA1Notation());

Parameter

Return

Sheet — sheet aktif baru

Otorisasi

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

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Menetapkan spreadsheet aktif.

// The code below makes the spreadsheet with key "1234567890" the active spreadsheet
var ss = SpreadsheetApp.openById("1234567890");
SpreadsheetApp.setActiveSpreadsheet(ss);

Parameter

Menetapkan sel yang ditentukan sebagai current cell.

Jika sel yang ditentukan ada dalam rentang yang sudah dipilih, rentang tersebut akan menjadi rentang aktif dengan sel sebagai sel saat ini.

Jika sel yang ditentukan tidak ada dalam rentang yang dipilih, pilihan yang ada akan dihapus dan sel tersebut akan menjadi sel saat ini dan rentang yang aktif.

Catatan:Range yang ditentukan harus terdiri dari satu sel. Jika tidak, metode ini akan menampilkan pengecualian.

// The code below sets the cell B5 in the first sheet as the current cell.
var cell = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('B5');
SpreadsheetApp.setCurrentCell(cell);

var selection = SpreadsheetApp.getSelection();
// Current cell: B5
var currentCell = selection.getCurrentCell();

Parameter

Return

Range — sel saat ini yang baru ditetapkan

Otorisasi

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

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets