Class Spreadsheet

Spreadsheet

Mengakses dan mengubah file Google Spreadsheet. Operasi yang umum adalah menambahkan sheet baru dan menambahkan kolaborator.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addDeveloperMetadata(key)SpreadsheetMenambahkan metadata developer dengan kunci yang ditentukan ke spreadsheet level teratas.
addDeveloperMetadata(key, visibility)SpreadsheetMenambahkan metadata developer dengan kunci dan visibilitas yang ditentukan ke spreadsheet.
addDeveloperMetadata(key, value)SpreadsheetMenambahkan metadata developer dengan kunci dan nilai yang ditentukan ke spreadsheet.
addDeveloperMetadata(key, value, visibility)SpreadsheetMenambahkan metadata developer dengan kunci, nilai, dan visibilitas yang ditentukan ke spreadsheet.
addEditor(emailAddress)SpreadsheetMenambahkan pengguna tertentu ke daftar editor untuk Spreadsheet.
addEditor(user)SpreadsheetMenambahkan pengguna tertentu ke daftar editor untuk Spreadsheet.
addEditors(emailAddresses)SpreadsheetMenambahkan array pengguna tertentu ke daftar editor untuk Spreadsheet.
addMenu(name, subMenus)voidMembuat menu baru di UI Spreadsheet.
addViewer(emailAddress)SpreadsheetMenambahkan pengguna tertentu ke daftar pelihat untuk Spreadsheet.
addViewer(user)SpreadsheetMenambahkan pengguna tertentu ke daftar pelihat untuk Spreadsheet.
addViewers(emailAddresses)SpreadsheetMenambahkan array pengguna tertentu ke daftar pelihat untuk Spreadsheet.
appendRow(rowContents)SheetMenambahkan baris ke bagian bawah region data saat ini dalam sheet.
autoResizeColumn(columnPosition)SheetMenetapkan lebar kolom tertentu agar sesuai dengan kontennya.
copy(name)SpreadsheetMenyalin spreadsheet dan mengembalikan yang baru.
createDeveloperMetadataFinder()DeveloperMetadataFinderMenampilkan DeveloperMetadataFinder untuk menemukan metadata developer dalam cakupan spreadsheet ini.
createTextFinder(findText)TextFinderMembuat pencari teks untuk spreadsheet, yang dapat digunakan untuk menemukan dan mengganti teks dalam spreadsheet.
deleteActiveSheet()SheetMenghapus sheet yang sedang aktif.
deleteColumn(columnPosition)SheetMenghapus kolom di posisi kolom tertentu.
deleteColumns(columnPosition, howMany)voidMenghapus sejumlah kolom yang dimulai pada posisi kolom tertentu.
deleteRow(rowPosition)SheetMenghapus baris di posisi baris tertentu.
deleteRows(rowPosition, howMany)voidMenghapus sejumlah baris yang dimulai pada posisi baris yang ditentukan.
deleteSheet(sheet)voidMenghapus sheet yang ditentukan.
duplicateActiveSheet()SheetMenduplikasi sheet aktif dan menjadikannya sheet aktif.
getActiveCell()RangeMenampilkan sel aktif dalam sheet ini.
getActiveRange()RangeMenampilkan rentang yang dipilih di sheet aktif, atau null jika tidak ada rentang aktif.
getActiveRangeList()RangeListMenampilkan daftar rentang aktif dalam sheet aktif atau null jika tidak ada rentang aktif.
getActiveSheet()SheetMendapatkan sheet aktif dalam spreadsheet.
getAs(contentType)BlobMenampilkan data di dalam objek ini sebagai blob yang dikonversi ke jenis konten yang ditentukan.
getBandings()Banding[]Menampilkan semua garis berwarna dalam spreadsheet ini.
getBlob()BlobMenampilkan data di dalam objek ini sebagai blob.
getColumnWidth(columnPosition)IntegerMendapatkan lebar kolom yang ditentukan dalam piksel.
getCurrentCell()RangeMenampilkan sel saat ini dalam sheet aktif atau null jika tidak ada sel saat ini.
getDataRange()RangeMenampilkan Range yang sesuai dengan dimensi yang berisi data.
getDataSourceFormulas()DataSourceFormula[]Mendapatkan semua formula sumber data.
getDataSourcePivotTables()DataSourcePivotTable[]Mendapatkan semua tabel pivot sumber data.
getDataSourceRefreshSchedules()DataSourceRefreshSchedule[]Mendapatkan jadwal refresh spreadsheet ini.
getDataSourceSheets()DataSourceSheet[]Menampilkan semua sheet sumber data di spreadsheet.
getDataSourceTables()DataSourceTable[]Mendapatkan semua tabel sumber data.
getDataSources()DataSource[]Menampilkan semua sumber data di spreadsheet.
getDeveloperMetadata()DeveloperMetadata[]Mendapatkan metadata developer yang terkait dengan spreadsheet tingkat atas.
getEditors()User[]Mendapatkan daftar editor untuk Spreadsheet ini.
getFormUrl()StringMenampilkan URL untuk formulir yang mengirimkan responsnya ke spreadsheet ini, atau null jika spreadsheet ini tidak memiliki formulir terkait.
getFrozenColumns()IntegerMenampilkan jumlah kolom yang dibekukan.
getFrozenRows()IntegerMenampilkan jumlah baris yang dibekukan.
getId()StringMendapatkan ID unik untuk spreadsheet ini.
getImages()OverGridImage[]Menampilkan semua gambar di petak pada sheet.
getIterativeCalculationConvergenceThreshold()NumberMenampilkan nilai minimum yang digunakan selama penghitungan berulang.
getLastColumn()IntegerMenampilkan posisi kolom terakhir yang memiliki konten.
getLastRow()IntegerMenampilkan posisi baris terakhir yang memiliki konten.
getMaxIterativeCalculationCycles()IntegerMenampilkan jumlah maksimum iterasi yang akan digunakan selama penghitungan berulang.
getName()StringMendapatkan nama dokumen.
getNamedRanges()NamedRange[]Mendapatkan semua rentang bernama dalam spreadsheet ini.
getNumSheets()IntegerMenampilkan jumlah sheet dalam spreadsheet ini.
getOwner()UserMenampilkan pemilik dokumen, atau null untuk dokumen di drive bersama.
getPredefinedSpreadsheetThemes()SpreadsheetTheme[]Menampilkan daftar tema yang telah ditentukan.
getProtections(type)Protection[]Mendapatkan array objek yang mewakili semua rentang atau sheet yang dilindungi dalam spreadsheet.
getRange(a1Notation)RangeMenampilkan rentang seperti yang ditentukan dalam notasi A1 atau notasi R1C1.
getRangeByName(name)RangeMenampilkan rentang bernama, atau null jika tidak ditemukan rentang dengan nama yang diberikan.
getRangeList(a1Notations)RangeListMenampilkan koleksi RangeList yang merepresentasikan rentang dalam sheet yang sama yang ditentukan oleh daftar notasi A1 atau notasi R1C1 yang tidak kosong.
getRecalculationInterval()RecalculationIntervalMenampilkan interval penghitungan untuk spreadsheet ini.
getRowHeight(rowPosition)IntegerMendapatkan tinggi baris yang ditentukan dalam piksel.
getSelection()SelectionMenampilkan Selection saat ini di spreadsheet.
getSheetByName(name)SheetMenampilkan sheet dengan nama yang diberikan.
getSheetId()IntegerMenampilkan ID sheet yang direpresentasikan oleh objek ini.
getSheetName()StringMenampilkan nama sheet.
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]Menampilkan nilai kisi persegi panjang untuk rentang ini mulai dari koordinat yang diberikan.
getSheets()Sheet[]Mendapatkan semua sheet di spreadsheet ini.
getSpreadsheetLocale()StringMendapatkan lokalitas spreadsheet.
getSpreadsheetTheme()SpreadsheetThemeMenampilkan tema spreadsheet saat ini, atau null jika tidak ada tema yang diterapkan.
getSpreadsheetTimeZone()StringMendapatkan zona waktu untuk spreadsheet.
getUrl()StringMenampilkan URL untuk spreadsheet yang ditentukan.
getViewers()User[]Mendapatkan daftar pelihat dan pengomentar untuk Spreadsheet ini.
hideColumn(column)voidMenyembunyikan satu atau beberapa kolom dalam rentang yang diberikan.
hideRow(row)voidMenyembunyikan baris dalam rentang yang diberikan.
insertColumnAfter(afterPosition)SheetMenyisipkan kolom setelah posisi kolom yang ditentukan.
insertColumnBefore(beforePosition)SheetMenyisipkan kolom sebelum posisi kolom yang ditentukan.
insertColumnsAfter(afterPosition, howMany)SheetMenyisipkan jumlah kolom tertentu setelah posisi kolom yang ditentukan.
insertColumnsBefore(beforePosition, howMany)SheetMenyisipkan jumlah kolom sebelum posisi kolom tertentu.
insertDataSourceSheet(spec)DataSourceSheetMenyisipkan DataSourceSheet baru ke spreadsheet dan memulai eksekusi data.
insertImage(blobSource, column, row)OverGridImageMenyisipkan Spreadsheet sebagai gambar dalam dokumen pada baris dan kolom tertentu.
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageMenyisipkan Spreadsheet sebagai gambar dalam dokumen pada baris dan kolom tertentu, dengan offset piksel.
insertImage(url, column, row)OverGridImageMenyisipkan gambar dalam dokumen pada baris dan kolom tertentu.
insertImage(url, column, row, offsetX, offsetY)OverGridImageMenyisipkan gambar dalam dokumen pada baris dan kolom tertentu, dengan offset piksel.
insertRowAfter(afterPosition)SheetMenyisipkan baris setelah posisi baris yang ditentukan.
insertRowBefore(beforePosition)SheetMenyisipkan baris sebelum posisi baris yang ditentukan.
insertRowsAfter(afterPosition, howMany)SheetMenyisipkan jumlah baris setelah posisi baris yang ditentukan.
insertRowsBefore(beforePosition, howMany)SheetMenyisipkan jumlah baris sebelum posisi baris yang ditentukan.
insertSheet()SheetMenyisipkan sheet baru ke dalam spreadsheet, menggunakan nama sheet default.
insertSheet(sheetIndex)SheetMenyisipkan sheet baru ke spreadsheet pada indeks yang diberikan.
insertSheet(sheetIndex, options)SheetMenyisipkan sheet baru ke spreadsheet pada indeks yang diberikan dan menggunakan argumen lanjutan opsional.
insertSheet(options)SheetMenyisipkan sheet baru ke spreadsheet, menggunakan nama sheet default dan argumen lanjutan opsional.
insertSheet(sheetName)SheetMenyisipkan sheet baru ke dalam spreadsheet dengan nama yang diberikan.
insertSheet(sheetName, sheetIndex)SheetMenyisipkan sheet baru ke dalam spreadsheet dengan nama yang diberikan di indeks yang diberikan.
insertSheet(sheetName, sheetIndex, options)SheetMenyisipkan sheet baru ke dalam spreadsheet dengan nama yang diberikan pada indeks yang diberikan dan menggunakan argumen lanjutan opsional.
insertSheet(sheetName, options)SheetMenyisipkan sheet baru ke spreadsheet dengan nama yang diberikan dan menggunakan argumen lanjutan opsional.
insertSheetWithDataSourceTable(spec)SheetMenyisipkan sheet baru ke dalam spreadsheet, membuat DataSourceTable yang mencakup seluruh sheet dengan spesifikasi sumber data yang ditentukan, dan memulai eksekusi data.
isColumnHiddenByUser(columnPosition)BooleanMenampilkan apakah kolom tertentu disembunyikan oleh pengguna.
isIterativeCalculationEnabled()BooleanMenampilkan apakah perhitungan berulang diaktifkan dalam spreadsheet ini.
isRowHiddenByFilter(rowPosition)BooleanMenampilkan apakah baris tertentu disembunyikan oleh filter (bukan tampilan filter).
isRowHiddenByUser(rowPosition)BooleanMenampilkan apakah baris tertentu disembunyikan oleh pengguna.
moveActiveSheet(pos)voidMemindahkan sheet aktif ke posisi yang ditentukan dalam daftar sheet.
moveChartToObjectSheet(chart)SheetMembuat sheet SheetType.OBJECT baru dan memindahkan diagram yang disediakan ke sheet tersebut.
refreshAllDataSources()voidMemuat ulang semua sumber data yang didukung dan objek sumber data tertautnya, sehingga melewati objek sumber data yang tidak valid.
removeEditor(emailAddress)SpreadsheetMenghapus pengguna tertentu dari daftar editor untuk Spreadsheet.
removeEditor(user)SpreadsheetMenghapus pengguna tertentu dari daftar editor untuk Spreadsheet.
removeMenu(name)voidMenghapus menu yang ditambahkan oleh addMenu(name, subMenus).
removeNamedRange(name)voidMenghapus rentang bernama dengan nama yang diberikan.
removeViewer(emailAddress)SpreadsheetMenghapus pengguna tertentu dari daftar pelihat dan pengomentar untuk Spreadsheet.
removeViewer(user)SpreadsheetMenghapus pengguna tertentu dari daftar pelihat dan pengomentar untuk Spreadsheet.
rename(newName)voidMengganti nama dokumen.
renameActiveSheet(newName)voidMengganti nama sheet yang aktif saat ini menjadi nama baru yang diberikan.
resetSpreadsheetTheme()SpreadsheetThemeMenghapus tema yang diterapkan dan menetapkan tema default di spreadsheet.
setActiveRange(range)RangeMenetapkan rentang yang ditentukan sebagai active range dalam sheet aktif, dengan sel kiri atas dalam rentang sebagai current cell.
setActiveRangeList(rangeList)RangeListMenetapkan daftar rentang yang ditentukan sebagai active ranges di sheet aktif.
setActiveSelection(range)RangeMenetapkan region pemilihan aktif untuk sheet ini.
setActiveSelection(a1Notation)RangeMenetapkan pemilihan aktif, sebagaimana ditentukan dalam notasi A1 atau notasi R1C1.
setActiveSheet(sheet)SheetMenetapkan sheet yang diberikan sebagai sheet aktif di spreadsheet.
setActiveSheet(sheet, restoreSelection)SheetMenetapkan sheet yang diberikan menjadi sheet aktif di spreadsheet, dengan opsi untuk memulihkan pilihan terbaru dalam sheet tersebut.
setColumnWidth(columnPosition, width)SheetMenetapkan lebar kolom tertentu dalam piksel.
setCurrentCell(cell)RangeMenetapkan sel yang ditentukan sebagai current cell.
setFrozenColumns(columns)voidMembekukan jumlah kolom yang ditentukan.
setFrozenRows(rows)voidMembekukan jumlah baris yang ditentukan.
setIterativeCalculationConvergenceThreshold(minThreshold)SpreadsheetMenetapkan nilai batas minimum untuk penghitungan berulang.
setIterativeCalculationEnabled(isEnabled)SpreadsheetMenetapkan apakah penghitungan berulang diaktifkan dalam spreadsheet ini.
setMaxIterativeCalculationCycles(maxIterations)SpreadsheetMenetapkan jumlah maksimum iterasi penghitungan yang harus dilakukan selama penghitungan iteratif.
setNamedRange(name, range)voidMemberi nama rentang.
setRecalculationInterval(recalculationInterval)SpreadsheetTetapkan seberapa sering spreadsheet ini harus menghitung ulang.
setRowHeight(rowPosition, height)SheetMenetapkan tinggi baris untuk baris tertentu dalam piksel.
setSpreadsheetLocale(locale)voidMenetapkan lokalitas spreadsheet.
setSpreadsheetTheme(theme)SpreadsheetThemeMenetapkan tema pada spreadsheet.
setSpreadsheetTimeZone(timezone)voidMenetapkan zona waktu untuk spreadsheet.
show(userInterface)voidMenampilkan komponen antarmuka pengguna kustom dalam dialog yang dipusatkan di area pandang browser pengguna.
sort(columnPosition)SheetMengurutkan sheet berdasarkan kolom, secara menaik.
sort(columnPosition, ascending)SheetMengurutkan lembar berdasarkan kolom.
toast(msg)voidMenampilkan jendela pop-up di pojok kanan bawah spreadsheet dengan pesan tertentu.
toast(msg, title)voidMenampilkan jendela pop-up di pojok kanan bawah spreadsheet dengan pesan dan judul tertentu.
toast(msg, title, timeoutSeconds)voidMenampilkan jendela pop-up di sudut kanan bawah spreadsheet dengan judul dan pesan tertentu, yang tetap terlihat selama jangka waktu tertentu.
unhideColumn(column)voidMemperlihatkan kolom dalam rentang yang diberikan.
unhideRow(row)voidMemperlihatkan baris dalam rentang yang ditentukan.
updateMenu(name, subMenus)voidMemperbarui menu yang ditambahkan oleh addMenu(name, subMenus).
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidMenunggu hingga semua eksekusi saat ini di spreadsheet selesai, waktu akan habis setelah jumlah detik yang diberikan.

Dokumentasi mendetail

addDeveloperMetadata(key)

Menambahkan metadata developer dengan kunci yang ditentukan ke spreadsheet level teratas.

// 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');

// Adds the key 'NAME' in the developer metadata for the spreadsheet.
ss.addDeveloperMetadata('NAME')

// Gets the first developer metadata object and logs its key.
const developerMetaData = ss.getDeveloperMetadata()[0]
console.log(developerMetaData.getKey())

Parameter

NamaJenisDeskripsi
keyStringKunci untuk metadata developer baru.

Return

Spreadsheet — Spreadsheet ini, untuk membuat rantai.

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

addDeveloperMetadata(key, visibility)

Menambahkan metadata developer dengan kunci dan visibilitas yang ditentukan ke spreadsheet.

// 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');

// Adds the key 'NAME' in the developer metadata for the spreadsheet and sets the visibility
// to the developer project that created the metadata.
ss.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

// Gets the first developer metadata object and logs its key and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()},
.             Visibility: ${developerMetaData.getVisibility()}`);

Parameter

NamaJenisDeskripsi
keyStringKunci untuk metadata developer baru.
visibilityDeveloperMetadataVisibilityVisibilitas metadata developer baru.

Return

Spreadsheet — Spreadsheet ini, untuk membuat rantai.

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

addDeveloperMetadata(key, value)

Menambahkan metadata developer dengan kunci dan nilai yang ditentukan ke spreadsheet.

// 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');

// Adds the key 'NAME' and sets the value to 'GOOGLE' in the developer metadata for the
// spreadsheet.
ss.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the first developer metadata object and logs its key and value.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()}, Value: ${developerMetaData.getValue()}`);

Parameter

NamaJenisDeskripsi
keyStringKunci untuk metadata developer baru.
valueStringNilai untuk metadata developer baru.

Return

Spreadsheet — Spreadsheet ini, untuk membuat rantai.

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

addDeveloperMetadata(key, value, visibility)

Menambahkan metadata developer dengan kunci, nilai, dan visibilitas yang ditentukan ke spreadsheet.

// 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');

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to any developer project with document access.
ss.addDeveloperMetadata('NAME', 'GOOGLE', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

// Gets the first developer metadata object and logs its key, value, and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(`Key: ${developerMetaData.getKey()},
             Value: ${developerMetaData.getValue()},
             Visibility: ${developerMetaData.getVisibility()}`);

Parameter

NamaJenisDeskripsi
keyStringKunci untuk metadata developer baru.
valueStringNilai untuk metadata developer baru.
visibilityDeveloperMetadataVisibilityVisibilitas metadata developer baru.

Return

Spreadsheet — Spreadsheet ini, untuk membuat rantai.

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

addEditor(emailAddress)

Menambahkan pengguna tertentu ke daftar editor untuk Spreadsheet. Jika pengguna sudah ada di daftar audiens, metode ini akan mempromosikan pengguna dari daftar pelihat.

Parameter

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang akan ditambahkan.

Return

SpreadsheetSpreadsheet ini, untuk perantaian.

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

addEditor(user)

Menambahkan pengguna tertentu ke daftar editor untuk Spreadsheet. Jika pengguna sudah ada di daftar audiens, metode ini akan mempromosikan pengguna dari daftar pelihat.

Parameter

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan ditambahkan.

Return

SpreadsheetSpreadsheet ini, untuk perantaian.

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

addEditors(emailAddresses)

Menambahkan array pengguna tertentu ke daftar editor untuk Spreadsheet. Jika salah satu pengguna sudah ada dalam daftar audiens, metode ini akan mempromosikannya dari daftar pelihat.

Parameter

NamaJenisDeskripsi
emailAddressesString[]Array alamat email pengguna yang akan ditambahkan.

Return

SpreadsheetSpreadsheet ini, untuk perantaian.

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

addMenu(name, subMenus)

Membuat menu baru di UI Spreadsheet.

Setiap entri menu menjalankan fungsi yang ditentukan pengguna. Biasanya, Anda ingin memanggilnya dari fungsi onOpen() agar menu otomatis dibuat saat spreadsheet dimuat.

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  var menuEntries = [];
  // When the user clicks on "addMenuExample" then "Menu Entry 1", the function function1 is
  // executed.
  menuEntries.push({name: "Menu Entry 1", functionName: "function1"});
  menuEntries.push(null); // line separator
  menuEntries.push({name: "Menu Entry 2", functionName: "function2"});

  ss.addMenu("addMenuExample", menuEntries);
}

Parameter

NamaJenisDeskripsi
nameStringNama menu yang akan dibuat.
subMenusObject[]Array peta JavaScript dengan parameter name dan functionName . Anda dapat menggunakan fungsi dari library yang disertakan, seperti Library.libFunction1.

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

addViewer(emailAddress)

Menambahkan pengguna tertentu ke daftar pelihat untuk Spreadsheet. Jika pengguna sudah ada di daftar editor, metode ini tidak akan berpengaruh.

Parameter

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang akan ditambahkan.

Return

SpreadsheetSpreadsheet ini, untuk perantaian.

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

addViewer(user)

Menambahkan pengguna tertentu ke daftar pelihat untuk Spreadsheet. Jika pengguna sudah ada di daftar editor, metode ini tidak akan berpengaruh.

Parameter

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan ditambahkan.

Return

SpreadsheetSpreadsheet ini, untuk perantaian.

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

addViewers(emailAddresses)

Menambahkan array pengguna tertentu ke daftar pelihat untuk Spreadsheet. Jika salah satu pengguna sudah ada dalam daftar editor, metode ini tidak akan berpengaruh bagi mereka.

Parameter

NamaJenisDeskripsi
emailAddressesString[]Array alamat email pengguna yang akan ditambahkan.

Return

SpreadsheetSpreadsheet ini, untuk perantaian.

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

appendRow(rowContents)

Menambahkan baris ke bagian bawah region data saat ini dalam sheet. Jika konten sel dimulai dengan =, konten tersebut akan ditafsirkan sebagai formula.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Appends a new row with 3 columns to the bottom of the current
// data region in the sheet containing the values in the array.
sheet.appendRow(["a man", "a plan", "panama"]);

Parameter

NamaJenisDeskripsi
rowContentsObject[]Array nilai yang akan disisipkan setelah baris terakhir dalam sheet.

Return

Sheet — Sheet, berguna untuk perantaian metode.

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

autoResizeColumn(columnPosition)

Menetapkan lebar kolom tertentu agar sesuai dengan kontennya.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.getRange('a1').setValue('Whenever it is a damp, drizzly November in my soul...');

// Sets the first column to a width which fits the text
sheet.autoResizeColumn(1);

Parameter

NamaJenisDeskripsi
columnPositionIntegerPosisi kolom tertentu yang akan diubah ukurannya.

Return

Sheet — sheet, berguna untuk perantaian metode

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

copy(name)

Menyalin spreadsheet dan mengembalikan yang baru.

// This code makes a copy of the current spreadsheet and names it appropriately
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.copy("Copy of " + ss.getName());

Parameter

NamaJenisDeskripsi
nameStringNama salinan.

Return

Spreadsheet — Spreadsheet ini, untuk membuat rantai.

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

createDeveloperMetadataFinder()

Menampilkan DeveloperMetadataFinder untuk menemukan metadata developer dalam cakupan spreadsheet ini. Secara default, opsi ini mempertimbangkan semua metadata yang terkait dengan spreadsheet, sheet, baris, dan kolom.

// 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');

// Adds developer metadata to the spreadsheet.
ss.addDeveloperMetadata('NAME', 'CHARLIE');
ss.addDeveloperMetadata('COMPANY', 'EXAMPLE ORGANIZATION');
ss.addDeveloperMetadata('TECHNOLOGY', 'JAVASCRIPT');

// Creates a developer metadata finder.
const developerMetadataFinder = ss.createDeveloperMetadataFinder();

// Finds the developer metadata objects with 'COMPANY' as the key.
const googleMetadataFromSpreadsheet = developerMetadataFinder.withKey('COMPANY').find();

// Gets the first result of developer metadata that has the key 'COMPANY' and logs its value.
console.log(googleMetadataFromSpreadsheet[0].getValue());

Return

DeveloperMetadataFinder — Pencari metadata developer untuk menelusuri metadata dalam cakupan spreadsheet ini.


createTextFinder(findText)

Membuat pencari teks untuk spreadsheet, yang dapat digunakan untuk menemukan dan mengganti teks dalam spreadsheet. Pencarian dimulai dari lembar pertama {i>spreadsheet<i}.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

// Creates  a text finder.
var textFinder = spreadsheet.createTextFinder('dog');

// Returns the first occurrence of 'dog' in the spreadsheet.
var firstOccurrence = textFinder.findNext();

// Replaces the last found occurrence of 'dog' with 'cat' and returns the number
// of occurrences replaced.
var numOccurrencesReplaced = findOccurrence.replaceWith('cat');

Parameter

NamaJenisDeskripsi
findTextStringTeks yang ditelusuri.

Return

TextFinderTextFinder untuk spreadsheet.


deleteActiveSheet()

Menghapus sheet yang sedang aktif.

// The code below deletes the currently active sheet and stores the new active sheet in a
// variable
var newSheet = SpreadsheetApp.getActiveSpreadsheet().deleteActiveSheet();

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

deleteColumn(columnPosition)

Menghapus kolom di posisi kolom tertentu.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first column
sheet.deleteColumn(1);

Parameter

NamaJenisDeskripsi
columnPositionIntegerPosisi kolom, mulai dari 1 untuk kolom pertama.

Return

Sheet — sheet, berguna untuk perantaian metode

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

deleteColumns(columnPosition, howMany)

Menghapus sejumlah kolom yang dimulai pada posisi kolom tertentu.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first two columns
sheet.deleteColumns(1, 2);

Parameter

NamaJenisDeskripsi
columnPositionIntegerPosisi kolom pertama yang akan dihapus.
howManyIntegerJumlah kolom yang akan dihapus.

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

deleteRow(rowPosition)

Menghapus baris di posisi baris tertentu.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first row
sheet.deleteRow(1);

Parameter

NamaJenisDeskripsi
rowPositionIntegerPosisi baris, mulai dari 1 untuk baris pertama.

Return

Sheet — sheet, berguna untuk perantaian metode

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

deleteRows(rowPosition, howMany)

Menghapus sejumlah baris yang dimulai pada posisi baris yang ditentukan.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first two rows
sheet.deleteRows(1, 2);

Parameter

NamaJenisDeskripsi
rowPositionIntegerPosisi baris pertama yang akan dihapus.
howManyIntegerJumlah baris yang akan dihapus.

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

deleteSheet(sheet)

Menghapus sheet yang ditentukan.

// The code below deletes the specified sheet.
var ss = SpreadsheetApp.getActive();
var sheet = ss.getSheetByName('My Sheet');
ss.deleteSheet(sheet);

Parameter

NamaJenisDeskripsi
sheetSheetSheet yang akan dihapus.

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

duplicateActiveSheet()

Menduplikasi sheet aktif dan menjadikannya sheet aktif.

// The code below makes a duplicate of the active sheet
SpreadsheetApp.getActiveSpreadsheet().duplicateActiveSheet();

Return

Sheet — Sheet 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

getActiveCell()

Menampilkan sel aktif dalam sheet ini.

Catatan: Sebaiknya gunakan getCurrentCell() yang menampilkan sel saat ini yang ditandai.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Returns the active cell
var cell = sheet.getActiveCell();

Return

Range — sel aktif 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

getActiveRange()

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.

Istilah "rentang aktif" mengacu pada rentang yang dipilih pengguna di sheet aktif, tetapi dalam fungsi kustom, istilah tersebut mengacu pada sel yang secara aktif dihitung ulang.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var activeRange = sheet.getActiveRange();

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

Lihat juga


getActiveRangeList()

Menampilkan daftar rentang aktif dalam sheet aktif atau null jika tidak ada rentang aktif.

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

var sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
var activeRangeList = sheet.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

Lihat juga


getActiveSheet()

Mendapatkan sheet aktif dalam spreadsheet.

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();

Return

Sheet — Sheet aktif di spreadsheet.


getAs(contentType)

Menampilkan data di dalam objek ini sebagai blob yang dikonversi ke jenis konten yang ditentukan. Metode ini menambahkan ekstensi yang sesuai ke nama file—misalnya, "myfile.pdf". Namun, dianggap bahwa bagian nama file yang mengikuti titik terakhir (jika ada) adalah ekstensi yang sudah ada dan harus diganti. Akibatnya, "ShoppingList.12.25.2014" menjadi "ShoppingList.12.25.pdf".

Untuk melihat kuota harian konversi, lihat Kuota untuk Layanan Google. Domain Google Workspace yang baru dibuat untuk sementara mungkin dikenai kuota yang lebih ketat.

Parameter

NamaJenisDeskripsi
contentTypeStringJenis MIME yang menjadi tujuan konversi. Untuk sebagian besar blob, 'application/pdf' adalah satu-satunya opsi yang valid. Untuk gambar dalam format BMP, GIF, JPEG, atau PNG, 'image/bmp', 'image/gif', 'image/jpeg', atau 'image/png' juga valid.

Return

Blob — Data sebagai blob.


getBandings()

Menampilkan semua garis berwarna dalam spreadsheet ini.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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 an array of the bandings in the spreadsheet.
const bandings = ss.getBandings();

// Logs the range of the first banding in the spreadsheet to the console.
console.log(bandings[0].getRange().getA1Notation());

Return

Banding[] — Garis berwarna di spreadsheet 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

getBlob()

Menampilkan data di dalam objek ini sebagai blob.

Return

Blob — Data sebagai blob.


getColumnWidth(columnPosition)

Mendapatkan lebar kolom yang ditentukan dalam piksel.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.getColumnWidth(1));

Parameter

NamaJenisDeskripsi
columnPositionIntegerPosisi kolom yang akan diperiksa.

Return

Integer — lebar kolom dalam piksel

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

getCurrentCell()

Menampilkan sel saat ini dalam sheet aktif atau null jika tidak ada sel saat ini. Sel saat ini adalah sel yang memiliki fokus di UI Google Spreadsheet, dan ditandai dengan batas gelap. Jumlah sel saat ini tidak pernah lebih dari satu. Saat pengguna memilih satu atau beberapa rentang sel, salah satu sel yang dipilih adalah sel saat ini.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
// Returns the current highlighted cell in the one of the active ranges.
var currentCell = sheet.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

getDataRange()

Menampilkan Range yang sesuai dengan dimensi yang berisi data.

Secara fungsional, tindakan ini sama dengan membuat Rentang yang dibatasi oleh A1 dan (Sheet.getLastColumn(), Sheet.getLastRow()).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This represents ALL the data
var range = sheet.getDataRange();
var values = range.getValues();

// This logs the spreadsheet in CSV format with a trailing comma
for (var i = 0; i < values.length; i++) {
  var row = "";
  for (var j = 0; j < values[i].length; j++) {
    if (values[i][j]) {
      row = row + values[i][j];
    }
    row = row + ",";
  }
  Logger.log(row);
}

Return

Range — rentang yang terdiri dari semua data dalam spreadsheet

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

getDataSourceFormulas()

Mendapatkan semua formula sumber data.

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

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

// Gets an array of the data source formulas on Sheet1.
// To get an array of data source formulas for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceFormulas = sheet.getDataSourceFormulas();

// Logs the first data source formula in the array.
console.log(dataSourceFormulas[0].getFormula());

Return

DataSourceFormula[] — Daftar formula sumber data.

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

getDataSourcePivotTables()

Mendapatkan semua tabel pivot sumber data.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source pivot tables on Sheet1.
// To get an array of data source pivot tables for the entire
// spreadsheet, replace 'sheet' with 'ss'.
const dataSourcePivotTables = sheet.getDataSourcePivotTables();

// Logs the last time that the first pivot table in the array was refreshed.
console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

Return

DataSourcePivotTable[] — Daftar tabel pivot sumber data.

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

getDataSourceRefreshSchedules()

Mendapatkan jadwal refresh spreadsheet ini.

// 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');

// Activates BigQuery operations for the connected spreadsheet.
SpreadsheetApp.enableBigQueryExecution();

// Gets the frequency type of the first referesh schedule in the array.
const frequencyType = ss.getDataSourceRefreshSchedules()[0]
                        .getFrequency()
                        .getFrequencyType()
                        .toString();

// Logs the frequency type to the console.
console.log(frequencyType);

Return

DataSourceRefreshSchedule[] — Jadwal refresh spreadsheet 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

getDataSourceSheets()

Menampilkan semua sheet sumber data di spreadsheet.

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

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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 the first data source sheet in the spreadsheet.
const dataSource = ss.getDataSourceSheets()[0];

// Gets the name of the data source sheet.
console.log(dataSource.asSheet().getName());

Return

DataSourceSheet[] — Array dari semua sheet sumber data.

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

getDataSourceTables()

Mendapatkan semua tabel sumber data.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of data source tables on Sheet1.
// To get an array of data source tables for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceTables = sheet.getDataSourceTables();

// Logs the last completed data execution time on the first data source table.
console.log(dataSourceTables[0].getStatus().getLastExecutionTime());

Return

DataSourceTable[] — Daftar tabel sumber data.

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

getDataSources()

Menampilkan semua sumber data di spreadsheet.

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

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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 the data sources on the spreadsheet.
const dataSources = ss.getDataSources();

// Logs the name of the first column on the first data source.
console.log(dataSources[0].getColumns()[0].getName());

Return

DataSource[] — Array dari semua sumber data.

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

getDeveloperMetadata()

Mendapatkan metadata developer yang terkait dengan spreadsheet tingkat atas.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Adds 'Google' as a key to the spreadsheet metadata.
ss.addDeveloperMetadata('Google');

// Gets the spreadsheet's metadata.
const ssMetadata = ss.getDeveloperMetadata();

// Gets the first set of the spreadsheet's metadata and logs the key to the console.
console.log(ssMetadata[0].getKey());

Return

DeveloperMetadata[] — Metadata developer yang terkait dengan rentang 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

getEditors()

Mendapatkan daftar editor untuk Spreadsheet ini.

Return

User[] — Array pengguna dengan izin edit.

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

getFormUrl()

Menampilkan URL untuk formulir yang mengirimkan responsnya ke spreadsheet ini, atau null jika spreadsheet ini tidak memiliki formulir terkait. Jika beberapa formulir mengirimkan respons ke spreadsheet ini, URL formulir yang ditampilkan tidak tentu. Sebagai alternatif, pengaitan URL per sheet dapat diambil melalui metode Sheet.getFormUrl().

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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 the form URL from the spreadsheet.
const formUrl = ss.getFormUrl();

// Logs the form URL to the console.
console.log(formUrl);

Return

String — URL untuk formulir yang menempatkan responsnya di spreadsheet ini, atau null jika spreadsheet ini tidak memiliki formulir terkait.

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

getFrozenColumns()

Menampilkan jumlah kolom yang dibekukan.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log("Number of frozen columns: %s", sheet.getFrozenColumns());

Return

Integer — jumlah kolom yang dibekukan

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

getFrozenRows()

Menampilkan jumlah baris yang dibekukan.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log("Number of frozen rows: %s", sheet.getFrozenRows());

Return

Integer — jumlah baris beku

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

getId()

Mendapatkan ID unik untuk spreadsheet ini. 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 logs the ID for the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getId());

Return

String — ID unik (atau kunci) untuk spreadsheet.


getImages()

Menampilkan semua gambar di petak pada sheet.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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 the over-the-grid images from Sheet1.
// To get the over-the-grid images from the entire spreadsheet, use ss.getImages() instead.
const images = sheet.getImages();

// For each image, logs the anchor cell in A1 notation.
for (const image of images) {
 console.log(image.getAnchorCell().getA1Notation());
}

Return

OverGridImage[] — Array gambar yang terhubung ke petak.

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

getIterativeCalculationConvergenceThreshold()

Menampilkan nilai minimum yang digunakan selama penghitungan berulang. Jika hasil penghitungan berturut-turut berbeda kurang dari nilai ini, penghitungan berulang akan berhenti.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Sets the iterative calculation convergence threshold for the spreadsheet.
ss.setIterativeCalculationConvergenceThreshold(2);

// Logs the threshold to the console.
console.log(ss.getIterativeCalculationConvergenceThreshold());

Return

Number — Nilai minimum konvergensi.

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

getLastColumn()

Menampilkan posisi kolom terakhir yang memiliki konten.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

Return

Integer — kolom terakhir pada sheet yang berisi konten

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

getLastRow()

Menampilkan posisi baris terakhir yang memiliki konten.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

Return

Integer — baris terakhir sheet yang berisi konten

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

getMaxIterativeCalculationCycles()

Menampilkan jumlah maksimum iterasi yang akan digunakan selama penghitungan berulang.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.getMaxIterativeCalculationCycles());

Return

Integer — Jumlah maksimum iterasi penghitungan.

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

getName()

Mendapatkan nama dokumen.

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getName());

Return

String — Nama spreadsheet.

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

getNamedRanges()

Mendapatkan semua rentang bernama dalam spreadsheet ini.

// The code below logs the name of the first named range.
var namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();
for (var i = 0; i < namedRanges.length; i++) {
  Logger.log(namedRanges[i].getName());
}

Return

NamedRange[] — Array dari semua rentang bernama di spreadsheet.

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

getNumSheets()

Menampilkan jumlah sheet dalam spreadsheet ini.

// The code below logs the number of sheets in the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getNumSheets());

Return

Integer — Jumlah sheet di spreadsheet.


getOwner()

Menampilkan pemilik dokumen, atau null untuk dokumen di drive bersama.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var owner = ss.getOwner();
Logger.log(owner.getEmail());

Return

User — Pemilik dokumen, atau null jika dokumen berada di drive bersama.

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

getPredefinedSpreadsheetThemes()

Menampilkan daftar tema yang telah ditentukan.

// The code below returns the list of predefined themes.
var predefinedThemesList = SpreadsheetApp.getActiveSpreadsheet()
                               .getPredefinedSpreadsheetThemes();

Return

SpreadsheetTheme[] — Daftar tema yang telah ditentukan.

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

getProtections(type)

Mendapatkan array objek yang mewakili semua rentang atau sheet yang dilindungi dalam spreadsheet.

// Remove all range protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}
// Remove all sheet protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.SHEET);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

Parameter

NamaJenisDeskripsi
typeProtectionTypeJenis kawasan yang dilindungi, SpreadsheetApp.ProtectionType.RANGE atau SpreadsheetApp.ProtectionType.SHEET.

Return

Protection[] — Array objek yang mewakili semua rentang atau sheet yang dilindungi di spreadsheet.

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

getRange(a1Notation)

Menampilkan rentang seperti yang ditentukan dalam notasi A1 atau notasi R1C1.

// Get a range A1:D4 on sheet titled "Invoices"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var range = ss.getRange("Invoices!A1:D4");

// Get cell A1 on the first sheet
var sheet = ss.getSheets()[0];
var cell = sheet.getRange("A1");

Parameter

NamaJenisDeskripsi
a1NotationStringRentang yang akan ditampilkan, seperti yang ditentukan dalam notasi A1 atau notasi R1C1.

Return

Range — rentang di lokasi yang 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

getRangeByName(name)

Menampilkan rentang bernama, atau null jika tidak ditemukan rentang dengan nama yang diberikan. Jika beberapa sheet spreadsheet menggunakan nama rentang yang sama, tentukan nama sheet tanpa tanda kutip tambahan — misalnya, getRangeByName('TaxRates') atau getRangeByName('Sheet Name!TaxRates'), namun bukan getRangeByName('"Sheet Name"!TaxRates').

// Log the number of columns for the range named 'TaxRates' in the active spreadsheet.
var range = SpreadsheetApp.getActiveSpreadsheet().getRangeByName('TaxRates');
if (range != null) {
  Logger.log(range.getNumColumns());
}

Parameter

NamaJenisDeskripsi
nameStringNama rentang yang akan didapatkan.

Return

Range — Rentang sel dengan nama yang diberikan.


getRangeList(a1Notations)

Menampilkan koleksi RangeList yang merepresentasikan rentang dalam sheet yang sama yang ditentukan oleh daftar notasi A1 atau notasi R1C1 yang tidak kosong.

// Get a list of ranges A1:D4, F1:H4.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var rangeList  = sheet.getRangeList(['A1:D4', 'F1:H4']);

Parameter

NamaJenisDeskripsi
a1NotationsString[]Daftar rentang yang akan ditampilkan, seperti yang ditentukan dalam notasi A1 atau notasi R1C1.

Return

RangeList — daftar rentang di lokasi yang 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

getRecalculationInterval()

Menampilkan interval penghitungan untuk spreadsheet ini.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Logs the calculation interval for the spreadsheet to the console.
console.log(ss.getRecalculationInterval().toString());

Return

RecalculationInterval — Interval penghitungan untuk spreadsheet 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

getRowHeight(rowPosition)

Mendapatkan tinggi baris yang ditentukan dalam piksel.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.getRowHeight(1));

Parameter

NamaJenisDeskripsi
rowPositionIntegerPosisi baris yang akan diperiksa.

Return

Integer — tinggi baris dalam piksel

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

getSelection()

Menampilkan Selection saat ini di spreadsheet.

var selection = SpreadsheetApp.getActiveSpreadsheet().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

getSheetByName(name)

Menampilkan sheet dengan nama yang diberikan.

Jika beberapa sheet memiliki nama yang sama, yang paling kiri ditampilkan. Menampilkan null jika tidak ada sheet dengan nama yang diberikan.

// The code below logs the index of a sheet named "Expenses"
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Expenses");
if (sheet != null) {
  Logger.log(sheet.getIndex());
}

Parameter

NamaJenisDeskripsi
nameStringNama sheet yang akan didapatkan.

Return

Sheet — Sheet dengan nama yang diberikan.


getSheetId()

Menampilkan ID sheet yang direpresentasikan oleh objek ini.

Ini adalah ID untuk sheet yang unik untuk {i>spreadsheet<i}. ID adalah bilangan bulat yang meningkat secara monoton yang ditetapkan pada waktu pembuatan sheet yang tidak bergantung pada posisi sheet. Hal ini berguna bersama dengan metode seperti Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) yang menggunakan parameter gridId, bukan instance Sheet.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetId());

Return

Integer — ID untuk sheet unik bagi spreadsheet

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

getSheetName()

Menampilkan nama sheet.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetName());

Return

String — nama sheet

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

getSheetValues(startRow, startColumn, numRows, numColumns)

Menampilkan nilai kisi persegi panjang untuk rentang ini mulai dari koordinat yang diberikan. Nilai -1 yang diberikan sebagai posisi baris atau kolom setara dengan mendapatkan baris atau kolom terakhir yang memiliki data di sheet.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The two samples below produce the same output
var values = sheet.getSheetValues(1, 1, 3, 3);
Logger.log(values);

var range = sheet.getRange(1, 1, 3, 3);
values = range.getValues();
Logger.log(values);

Parameter

NamaJenisDeskripsi
startRowIntegerPosisi baris awal.
startColumnIntegerPosisi kolom awal.
numRowsIntegerJumlah baris yang nilainya akan ditampilkan.
numColumnsIntegerJumlah kolom yang nilainya akan ditampilkan.

Return

Object[][] — array nilai dua dimensi

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

getSheets()

Mendapatkan semua sheet di spreadsheet ini.

// The code below logs the name of the second sheet
var sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
if (sheets.length > 1) {
  Logger.log(sheets[1].getName());
}

Return

Sheet[] — Array dari semua sheet di spreadsheet.


getSpreadsheetLocale()

Mendapatkan lokalitas spreadsheet.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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 the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

Return

String — Lokalitas spreadsheet.

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

getSpreadsheetTheme()

Menampilkan tema spreadsheet saat ini, atau null jika tidak ada tema yang diterapkan.

// The code below returns the current theme of the spreadsheet.
var currentTheme = SpreadsheetApp.getActiveSpreadsheet().getSpreadsheetTheme();

Return

SpreadsheetTheme — Tema yang diterapkan 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

getSpreadsheetTimeZone()

Mendapatkan zona waktu untuk spreadsheet.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

Return

String — Zona waktu, yang ditentukan dalam format "panjang" (misalnya, "America/New_York", seperti yang dicantumkan oleh Joda.org).

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

getUrl()

Menampilkan URL untuk spreadsheet yang ditentukan.

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getUrl());

Return

String — URL untuk spreadsheet yang ditentukan.

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

getViewers()

Mendapatkan daftar pelihat dan pengomentar untuk Spreadsheet ini.

Return

User[] — Array pengguna dengan izin lihat atau komentar.

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

hideColumn(column)

Menyembunyikan satu atau beberapa kolom dalam rentang yang diberikan.

let ss = SpreadsheetApp.getActiveSpreadsheet();
let sheet = ss.getSheets()[0];

// This hides the first column
let range = sheet.getRange("A1");
sheet.hideColumn(range);

// This hides the first 3 columns
let range = sheet.getRange("A:C");
sheet.hideColumn(range);

Parameter

NamaJenisDeskripsi
columnRangeRentang kolom yang akan disembunyikan.

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

hideRow(row)

Menyembunyikan baris dalam rentang yang diberikan.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This hides the first row
var range = sheet.getRange("A1");
sheet.hideRow(range);

Parameter

NamaJenisDeskripsi
rowRangeRentang baris yang akan disembunyikan.

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

insertColumnAfter(afterPosition)

Menyisipkan kolom setelah posisi kolom yang ditentukan.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a column after the first column position
sheet.insertColumnAfter(1);

Parameter

NamaJenisDeskripsi
afterPositionIntegerKolom yang akan ditambahi kolom baru.

Return

Sheet — sheet, berguna untuk perantaian metode

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

insertColumnBefore(beforePosition)

Menyisipkan kolom sebelum posisi kolom yang ditentukan.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a column in the first column position
sheet.insertColumnBefore(1);

Parameter

NamaJenisDeskripsi
beforePositionIntegerKolom yang akan ditambahi kolom baru.

Return

Sheet — sheet, berguna untuk perantaian metode

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

insertColumnsAfter(afterPosition, howMany)

Menyisipkan jumlah kolom tertentu setelah posisi kolom yang ditentukan.

let ss = SpreadsheetApp.getActiveSpreadsheet();
let sheet = ss.getSheets()[0];

// Inserts two columns after the first column on the first sheet of the spreadsheet.
sheet.insertColumnsAfter(1,2);

Parameter

NamaJenisDeskripsi
afterPositionIntegerKolom yang akan ditambahi kolom baru.
howManyIntegerJumlah kolom yang akan disisipkan.

Return

Sheet — sheet, berguna untuk perantaian metode

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

insertColumnsBefore(beforePosition, howMany)

Menyisipkan jumlah kolom sebelum posisi kolom tertentu.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five columns before the first column
sheet.insertColumnsBefore(1, 5);

Parameter

NamaJenisDeskripsi
beforePositionIntegerKolom yang akan ditambahi kolom baru.
howManyIntegerJumlah kolom yang akan disisipkan.

Return

Sheet — sheet, berguna untuk perantaian metode

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

insertDataSourceSheet(spec)

Menyisipkan DataSourceSheet baru ke spreadsheet dan memulai eksekusi data. Sebagai efek samping, tindakan ini juga akan membuat sheet baru menjadi sheet aktif.

Menampilkan pengecualian jika jenis sumber data tidak diaktifkan. Gunakan metode SpreadsheetApp#enable...Execution() untuk mengaktifkan eksekusi data untuk jenis sumber data tertentu.

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// 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');

// 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);

Parameter

NamaJenisDeskripsi
specDataSourceSpecSpesifikasi sumber data yang akan disisipkan.

Return

DataSourceSheet — Sheet sumber data 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

insertImage(blobSource, column, row)

Menyisipkan Spreadsheet sebagai gambar dalam dokumen pada baris dan kolom tertentu. Ukuran gambar diambil dari konten blob. Ukuran blob maksimum yang didukung adalah 2 MB.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

Parameter

NamaJenisDeskripsi
blobSourceBlobSourceBlob yang berisi konten gambar, jenis MIME, dan nama (opsional).
columnIntegerPosisi kolom.
rowIntegerPosisi baris.

Return

OverGridImage — Gambar yang disisipkan.

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

insertImage(blobSource, column, row, offsetX, offsetY)

Menyisipkan Spreadsheet sebagai gambar dalam dokumen pada baris dan kolom tertentu, dengan offset piksel. Ukuran gambar diambil dari konten blob. Ukuran blob maksimum yang didukung adalah 2 MB.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

Parameter

NamaJenisDeskripsi
blobSourceBlobSourceBlob yang berisi konten gambar, jenis MIME, dan nama (opsional).
columnIntegerPosisi kolom.
rowIntegerPosisi baris.
offsetXIntegerOffset horizontal dari sudut sel dalam piksel.
offsetYIntegerOffset vertikal dari sudut sel dalam piksel.

Return

OverGridImage — Gambar yang disisipkan.

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

insertImage(url, column, row)

Menyisipkan gambar dalam dokumen pada baris dan kolom tertentu.

URL yang diberikan harus dapat diakses secara publik.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1);

Parameter

NamaJenisDeskripsi
urlStringURL gambar.
columnIntegerPosisi kolom petak.
rowIntegerPosisi baris petak.

Return

OverGridImage — Gambar yang disisipkan.

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

insertImage(url, column, row, offsetX, offsetY)

Menyisipkan gambar dalam dokumen pada baris dan kolom tertentu, dengan offset piksel.

URL yang diberikan harus dapat diakses secara publik.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1, 10, 10);

Parameter

NamaJenisDeskripsi
urlStringURL untuk gambar.
columnIntegerPosisi kolom.
rowIntegerPosisi baris.
offsetXIntegerOffset horizontal dari sudut sel dalam piksel.
offsetYIntegerOffset vertikal dari sudut sel dalam piksel.

Return

OverGridImage — Gambar yang disisipkan.

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

insertRowAfter(afterPosition)

Menyisipkan baris setelah posisi baris yang ditentukan.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a row after the first row position
sheet.insertRowAfter(1);

Parameter

NamaJenisDeskripsi
afterPositionIntegerBaris yang akan ditambahi baris baru.

Return

Sheet — sheet, berguna untuk perantaian metode

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

insertRowBefore(beforePosition)

Menyisipkan baris sebelum posisi baris yang ditentukan.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a row before the first row position
sheet.insertRowBefore(1);

Parameter

NamaJenisDeskripsi
beforePositionIntegerBaris yang akan ditambahi baris baru.

Return

Sheet — sheet, berguna untuk perantaian metode

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

insertRowsAfter(afterPosition, howMany)

Menyisipkan jumlah baris setelah posisi baris yang ditentukan.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five rows after the first row
sheet.insertRowsAfter(1, 5);

Parameter

NamaJenisDeskripsi
afterPositionIntegerBaris yang akan ditambahi baris baru.
howManyIntegerJumlah baris yang akan disisipkan.

Return

Sheet — sheet, berguna untuk perantaian metode

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

insertRowsBefore(beforePosition, howMany)

Menyisipkan jumlah baris sebelum posisi baris yang ditentukan.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five rows before the first row
sheet.insertRowsBefore(1, 5);

Parameter

NamaJenisDeskripsi
beforePositionIntegerBaris yang akan ditambahi baris baru.
howManyIntegerJumlah baris yang akan disisipkan.

Return

Sheet — sheet, berguna untuk perantaian metode

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

insertSheet()

Menyisipkan sheet baru ke dalam spreadsheet, menggunakan nama sheet default. {i>Sheet<i} baru menjadi {i>sheet<i} aktif.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet();

Return

Sheet — Sheet 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

insertSheet(sheetIndex)

Menyisipkan sheet baru ke spreadsheet pada indeks yang diberikan. Sheet baru akan menjadi sheet aktif.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet(1);

Parameter

NamaJenisDeskripsi
sheetIndexIntegerIndeks sheet yang baru dibuat. Untuk menyisipkan sheet sebagai sheet pertama dalam spreadsheet, tetapkan ke 0.

Return

Sheet — Sheet 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

insertSheet(sheetIndex, options)

Menyisipkan sheet baru ke spreadsheet pada indeks yang diberikan dan menggunakan argumen lanjutan opsional. Sheet baru akan menjadi sheet aktif.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet(1, {template: templateSheet});

Parameter

NamaJenisDeskripsi
sheetIndexIntegerIndeks sheet yang baru dibuat. Untuk menyisipkan sheet sebagai sheet pertama dalam spreadsheet, tetapkan ke 0.
optionsObjectArgumen lanjutan JavaScript opsional.

Parameter lanjutan

NamaJenisDeskripsi
templateSheetSemua data dari objek sheet template disalin ke sheet baru. Template sheet harus berupa salah satu sheet dari objek Spreadsheet.

Return

Sheet — Sheet 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

insertSheet(options)

Menyisipkan sheet baru ke spreadsheet, menggunakan nama sheet default dan argumen lanjutan opsional. Sheet baru akan menjadi sheet aktif.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet({template: templateSheet});

Parameter

NamaJenisDeskripsi
optionsObjectArgumen lanjutan JavaScript opsional, tercantum di bawah.

Parameter lanjutan

NamaJenisDeskripsi
templateSheetSemua data dari objek sheet template disalin ke sheet baru. Template sheet harus berupa salah satu sheet dari objek Spreadsheet ini.

Return

Sheet — Sheet 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

insertSheet(sheetName)

Menyisipkan sheet baru ke dalam spreadsheet dengan nama yang diberikan. Sheet baru akan menjadi sheet aktif.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet');

Parameter

NamaJenisDeskripsi
sheetNameStringNama sheet baru.

Return

Sheet — Sheet 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

insertSheet(sheetName, sheetIndex)

Menyisipkan sheet baru ke dalam spreadsheet dengan nama yang diberikan di indeks yang diberikan. {i>Sheet<i} baru akan menjadi {i>sheet<i} aktif.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet', 1);

Parameter

NamaJenisDeskripsi
sheetNameStringNama sheet baru.
sheetIndexIntegerIndeks sheet yang baru dibuat. Untuk menyisipkan sheet sebagai sheet pertama dalam spreadsheet, tetapkan ke 0.

Return

Sheet — Sheet 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

insertSheet(sheetName, sheetIndex, options)

Menyisipkan sheet baru ke dalam spreadsheet dengan nama yang diberikan pada indeks yang diberikan dan menggunakan argumen lanjutan opsional. Sheet baru akan menjadi sheet aktif.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', 1, {template: templateSheet});

Parameter

NamaJenisDeskripsi
sheetNameStringNama sheet baru.
sheetIndexIntegerIndeks sheet yang baru disisipkan. Untuk menyisipkan sheet sebagai sheet pertama dalam spreadsheet, tetapkan ke 0.
optionsObjectArgumen lanjutan JavaScript opsional.

Parameter lanjutan

NamaJenisDeskripsi
templateSheetSemua data dari objek sheet template disalin ke sheet baru. Template sheet harus berupa salah satu sheet dari objek Spreadsheet.

Return

Sheet — Sheet 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

insertSheet(sheetName, options)

Menyisipkan sheet baru ke spreadsheet dengan nama yang diberikan dan menggunakan argumen lanjutan opsional. Sheet baru akan menjadi sheet aktif.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', {template: templateSheet});

Parameter

NamaJenisDeskripsi
sheetNameStringNama sheet baru.
optionsObjectArgumen lanjutan JavaScript opsional.

Parameter lanjutan

NamaJenisDeskripsi
templateSheetSemua data dari objek sheet template disalin ke sheet baru. Template sheet harus berupa salah satu sheet dari objek Spreadsheet.

Return

Sheet — Sheet 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

insertSheetWithDataSourceTable(spec)

Menyisipkan sheet baru ke dalam spreadsheet, membuat DataSourceTable yang mencakup seluruh sheet dengan spesifikasi sumber data yang ditentukan, dan memulai eksekusi data. Sebagai efek samping, jadikan sheet baru tersebut sebagai sheet aktif.

Menampilkan pengecualian jika jenis sumber data tidak diaktifkan. Gunakan metode SpreadsheetApp#enable...Execution() untuk mengaktifkan eksekusi data untuk jenis sumber data tertentu.

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// 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');

// Adds a sheet and sets cell A1 as the parameter cell.
const parameterCell = ss.insertSheet('parameterSheet').getRange('A1');

// Sets the value of the parameter cell to 'Duke'.
parameterCell.setValue('Duke');

const query = 'select * from `bigquery-public-data`.`ncaa_basketball`.' +
  '`mbb_historical_tournament_games` WHERE win_school_ncaa = @SCHOOL';

// Adds a data source with a query parameter.
// TODO(developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
 .asBigQuery()
 .setProjectId('project-id-1')
 .setRawQuery(query)
 .setParameterFromCell('SCHOOL', 'parameterSheet!A1')
 .build();

// Adds sheets for the data source and data source table to the spreadsheet.
ss.insertSheetWithDataSourceTable(dataSourceSpec);

Parameter

NamaJenisDeskripsi
specDataSourceSpecSpesifikasi sumber data yang akan disisipkan.

Return

Sheet — Sheet 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

isColumnHiddenByUser(columnPosition)

Menampilkan apakah kolom tertentu disembunyikan oleh pengguna.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.isColumnHiddenByUser(1));

Parameter

NamaJenisDeskripsi
columnPositionIntegerPosisi kolom yang akan diperiksa.

Return

Booleantrue jika kolom disembunyikan, false jika tidak.

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

isIterativeCalculationEnabled()

Menampilkan apakah perhitungan berulang diaktifkan dalam spreadsheet ini.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

Return

Booleantrue jika penghitungan berulang diaktifkan, false jika tidak.

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

isRowHiddenByFilter(rowPosition)

Menampilkan apakah baris tertentu disembunyikan oleh filter (bukan tampilan filter).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByFilter(1));

Parameter

NamaJenisDeskripsi
rowPositionIntegerPosisi baris yang akan diperiksa.

Return

Booleantrue jika baris disembunyikan, false jika tidak.

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

isRowHiddenByUser(rowPosition)

Menampilkan apakah baris tertentu disembunyikan oleh pengguna.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByUser(1));

Parameter

NamaJenisDeskripsi
rowPositionIntegerPosisi baris yang akan diperiksa.

Return

Booleantrue jika baris disembunyikan, false jika tidak.

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

moveActiveSheet(pos)

Memindahkan sheet aktif ke posisi yang ditentukan dalam daftar sheet. Menampilkan pengecualian jika posisinya negatif atau lebih besar dari jumlah sheet.

// This example assumes that there are 2 sheets in the current
// active spreadsheet: one named "first" in position 1 and another named "second"
// in position 2.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// Gets the "first" sheet and activates it.
var sheet = spreadsheet.getSheetByName("first").activate();

// Logs 'Current index of sheet: 1'
console.log("Current index of sheet: %s", sheet.getIndex());

spreadsheet.moveActiveSheet(2);

// Logs 'New index of sheet: 2'
console.log("New index of sheet: %s", sheet.getIndex());

Parameter

NamaJenisDeskripsi
posIntegerPosisi 1-indeks untuk memindahkan sheet aktif di daftar sheet.

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

moveChartToObjectSheet(chart)

Membuat sheet SheetType.OBJECT baru dan memindahkan diagram yang disediakan ke sheet tersebut. Jika diagram sudah berada di sheetnya sendiri, sheet tersebut akan ditampilkan tanpa membuat sheet baru.

var sheet = SpreadsheetApp.getActiveSheet();
var chart = sheet.newChart().setPosition(1, 1, 0, 0).build();
sheet.insertChart(chart);
var objectSheet = SpreadsheetApp.getActive().moveChartToObjectSheet(chart);

Parameter

NamaJenisDeskripsi
chartEmbeddedChartDiagram yang akan dipindahkan.

Return

Sheet — Sheet tempat diagram berada.

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

refreshAllDataSources()

Memuat ulang semua sumber data yang didukung dan objek sumber data tertautnya, sehingga melewati objek sumber data yang tidak valid.

Gunakan metode SpreadsheetApp#enable...Execution() untuk mengaktifkan eksekusi data bagi jenis sumber data tertentu.

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// 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 the first data source sheet on the spreadsheet.
const dataSheet = ss.getDataSourceSheets()[0];

// Refreshes all data sources on the spreadsheet.
ss.refreshAllDataSources();

// Logs the last refreshed time of the first data source sheet.
console.log(`Last refresh time: ${dataSheet.getStatus().getLastRefreshedTime()}`);

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

removeEditor(emailAddress)

Menghapus pengguna tertentu dari daftar editor untuk Spreadsheet. Metode ini tidak memblokir pengguna agar tidak mengakses Spreadsheet jika mereka termasuk dalam class pengguna yang memiliki akses umum—misalnya, jika Spreadsheet dibagikan ke seluruh domain pengguna, atau jika Spreadsheet berada di drive bersama yang dapat diakses pengguna.

Untuk file Drive, tindakan ini juga akan menghapus pengguna dari daftar pelihat.

Parameter

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang akan dihapus.

Return

SpreadsheetSpreadsheet ini, untuk perantaian.

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

removeEditor(user)

Menghapus pengguna tertentu dari daftar editor untuk Spreadsheet. Metode ini tidak memblokir pengguna agar tidak mengakses Spreadsheet jika mereka termasuk dalam class pengguna yang memiliki akses umum—misalnya, jika Spreadsheet dibagikan ke seluruh domain pengguna, atau jika Spreadsheet berada di drive bersama yang dapat diakses pengguna.

Untuk file Drive, tindakan ini juga akan menghapus pengguna dari daftar pelihat.

Parameter

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan dihapus.

Return

SpreadsheetSpreadsheet ini, untuk perantaian.

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

removeMenu(name)

Menghapus menu yang ditambahkan oleh addMenu(name, subMenus). Argumen name harus memiliki nilai yang sama dengan panggilan terkait ke addMenu(name, subMenus).

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.addMenu("badMenu", [{name: "remove bad menu", functionName: "removeBadMenu"},
                                       {name: "foo", functionName: "foo"}]);
}
function removeBadMenu() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.removeMenu("badMenu");  // name must match the name used when added the menu
}
function foo(){
// Do nothing
}

Parameter

NamaJenisDeskripsi
nameStringNama menu yang akan dihapus.

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

removeNamedRange(name)

Menghapus rentang bernama dengan nama yang diberikan. Menampilkan pengecualian jika tidak ada rentang dengan nama yang diberikan di spreadsheet.

// The code below creates a new named range "foo", and then remove it.
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("foo", ss.getActiveRange());
ss.removeNamedRange("foo");

Parameter

NamaJenisDeskripsi
nameStringNama rentang.

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

removeViewer(emailAddress)

Menghapus pengguna tertentu dari daftar pelihat dan pengomentar untuk Spreadsheet. Metode ini tidak akan berpengaruh jika pengguna adalah editor, bukan pelihat atau pengomentar. Metode ini juga tidak memblokir pengguna agar tidak mengakses Spreadsheet jika mereka termasuk dalam class pengguna yang memiliki akses umum—misalnya, jika Spreadsheet dibagikan dengan seluruh domain pengguna, atau jika Spreadsheet berada di drive bersama yang dapat diakses pengguna.

Untuk file Drive, tindakan ini juga akan menghapus pengguna dari daftar editor.

Parameter

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang akan dihapus.

Return

SpreadsheetSpreadsheet ini untuk perantaian.

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

removeViewer(user)

Menghapus pengguna tertentu dari daftar pelihat dan pengomentar untuk Spreadsheet. Metode ini tidak akan berpengaruh jika pengguna adalah editor, bukan pelihat. Metode ini juga tidak akan memblokir pengguna agar tidak mengakses Spreadsheet jika mereka termasuk dalam class pengguna yang memiliki akses umum—misalnya, jika Spreadsheet dibagikan ke seluruh domain pengguna, atau jika Spreadsheet berada di drive bersama yang dapat diakses pengguna.

Untuk file Drive, tindakan ini juga akan menghapus pengguna dari daftar editor.

Parameter

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan dihapus.

Return

SpreadsheetSpreadsheet ini untuk perantaian.

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

rename(newName)

Mengganti nama dokumen.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.rename("This is the new name");

Parameter

NamaJenisDeskripsi
newNameStringNama baru untuk dokumen.

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

renameActiveSheet(newName)

Mengganti nama sheet yang aktif saat ini menjadi nama baru yang diberikan.

// The code below renames the active sheet to "Hello world"
SpreadsheetApp.getActiveSpreadsheet().renameActiveSheet("Hello world");

Parameter

NamaJenisDeskripsi
newNameStringNama baru untuk sheet yang aktif 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

resetSpreadsheetTheme()

Menghapus tema yang diterapkan dan menetapkan tema default di spreadsheet.

// The code below applies default theme on the spreadsheet.
SpreadsheetApp.getActiveSpreadsheet().resetSpreadsheetTheme();

Return

SpreadsheetTheme — Tema default.

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

setActiveRange(range)

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var range = sheet.getRange('A1:D4');
sheet.setActiveRange(range);

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

Parameter

NamaJenisDeskripsi
rangeRangeRentang untuk ditetapkan sebagai rentang aktif.

Return

Range — rentang yang baru 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

setActiveRangeList(rangeList)

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

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['D4', 'B2:C4']);
sheet.setActiveRangeList(rangeList);

var selection = sheet.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

NamaJenisDeskripsi
rangeListRangeListDaftar rentang yang dapat dipilih.

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

setActiveSelection(range)

Menetapkan region pemilihan aktif untuk sheet ini.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D4");
sheet.setActiveSelection(range);

Parameter

NamaJenisDeskripsi
rangeRangeRentang untuk ditetapkan sebagai pilihan aktif.

Return

Range — rentang yang baru 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

setActiveSelection(a1Notation)

Menetapkan pemilihan aktif, sebagaimana ditentukan dalam notasi A1 atau notasi R1C1.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.setActiveSelection("A1:D4");

Parameter

NamaJenisDeskripsi
a1NotationStringRentang yang akan ditetapkan sebagai aktif, seperti yang ditentukan dalam notasi A1 atau notasi R1C1.

Return

Range — rentang yang baru 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

setActiveSheet(sheet)

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

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

Parameter

NamaJenisDeskripsi
sheetSheetSheet yang akan ditetapkan sebagai sheet aktif.

Return

Sheet — 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

setActiveSheet(sheet, restoreSelection)

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

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

NamaJenisDeskripsi
sheetSheetSheet aktif baru.
restoreSelectionBooleanJika true, pilihan terbaru dari sheet aktif baru akan dipilih lagi saat sheet baru menjadi aktif; jika false, sheet baru akan aktif tanpa mengubah pilihan saat ini.

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

setColumnWidth(columnPosition, width)

Menetapkan lebar kolom tertentu dalam piksel.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sets the first column to a width of 200 pixels
sheet.setColumnWidth(1, 200);

Parameter

NamaJenisDeskripsi
columnPositionIntegerPosisi kolom tertentu yang akan ditetapkan.
widthIntegerLebar dalam piksel yang ditetapkan.

Return

Sheet — sheet, berguna untuk perantaian metode

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

setCurrentCell(cell)

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, semua pilihan yang ada akan dihapus dan sel tersebut menjadi sel saat ini dan rentang yang aktif.

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var cell = sheet.getRange('B5');
sheet.setCurrentCell(cell);

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

Parameter

NamaJenisDeskripsi
cellRangeSel yang akan ditetapkan sebagai sel saat ini.

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

setFrozenColumns(columns)

Membekukan jumlah kolom yang ditentukan. Jika nol, tidak ada kolom yang dibekukan.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Freezes the first column
sheet.setFrozenColumns(1);

Parameter

NamaJenisDeskripsi
columnsIntegerJumlah kolom yang akan dibekukan.

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

setFrozenRows(rows)

Membekukan jumlah baris yang ditentukan. Jika nol, tidak ada baris yang dibekukan.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Freezes the first row
sheet.setFrozenRows(1);

Parameter

NamaJenisDeskripsi
rowsIntegerJumlah baris yang akan dibekukan.

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

setIterativeCalculationConvergenceThreshold(minThreshold)

Menetapkan nilai batas minimum untuk penghitungan berulang. Jika hasil penghitungan berturut-turut berbeda kurang dari nilai ini, penghitungan berulang akan berhenti. Nilai ini harus tidak negatif, dan defaultnya adalah 0,05.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Sets the iterative calculation convergence threshold for the spreadsheet.
ss.setIterativeCalculationConvergenceThreshold(2);

// Logs the threshold to the console.
console.log(ss.getIterativeCalculationConvergenceThreshold());

Parameter

NamaJenisDeskripsi
minThresholdNumberAmbang batas konvergensi minimum (harus tidak negatif).

Return

Spreadsheet — Spreadsheet ini, untuk membuat rantai.

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

setIterativeCalculationEnabled(isEnabled)

Menetapkan apakah penghitungan berulang diaktifkan dalam spreadsheet ini. Jika jumlah maksimum siklus penghitungan dan nilai minimum konvergensi belum ditetapkan sebelumnya saat penghitungan diaktifkan, jumlah defaultnya adalah 50 dan 0,05. Jika salah satunya telah ditetapkan sebelumnya, keduanya akan mempertahankan nilai sebelumnya.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

Parameter

NamaJenisDeskripsi
isEnabledBooleantrue jika penghitungan berulang harus diaktifkan; false jika tidak.

Return

Spreadsheet — Spreadsheet ini, untuk membuat rantai.

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

setMaxIterativeCalculationCycles(maxIterations)

Menetapkan jumlah maksimum iterasi penghitungan yang harus dilakukan selama penghitungan iteratif. Nilai ini harus antara 1 dan 10.000 (inklusif), dan defaultnya adalah 50.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.getMaxIterativeCalculationCycles());

Parameter

NamaJenisDeskripsi
maxIterationsIntegerJumlah maksimum iterasi penghitungan (antara 1 dan 10.000).

Return

Spreadsheet — Spreadsheet ini, untuk membuat rantai.

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

setNamedRange(name, range)

Memberi nama rentang.

// The code below creates a new named range "TaxRates" in the active spreadsheet
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("TaxRates", SpreadsheetApp.getActiveRange());

Parameter

NamaJenisDeskripsi
nameStringNama untuk memberikan rentang.
rangeRangeSpesifikasi rentang.

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

setRecalculationInterval(recalculationInterval)

Tetapkan seberapa sering spreadsheet ini harus menghitung ulang.

// 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');

// Sets the  calculation interval for the spreadsheet to 'ON_CHANGE'.
const interval = ss.setRecalculationInterval(SpreadsheetApp.RecalculationInterval.ON_CHANGE);

// Logs the calculation interval to the console.
console.log(interval);

Parameter

NamaJenisDeskripsi
recalculationIntervalRecalculationIntervalInterval penghitungan ulang baru.

Return

Spreadsheet — Spreadsheet ini, untuk membuat rantai.

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

setRowHeight(rowPosition, height)

Menetapkan tinggi baris untuk baris tertentu dalam piksel. Secara default, baris membesar agar pas dengan konten sel. Jika Anda ingin memaksa baris ke tinggi yang ditentukan, gunakan Sheet.setRowHeightsForced(startRow, numRows, height).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

Parameter

NamaJenisDeskripsi
rowPositionIntegerPosisi baris yang akan diubah.
heightIntegerTinggi dalam piksel yang disetel.

Return

Sheet — Sheet, berguna untuk perantaian metode.

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

setSpreadsheetLocale(locale)

Menetapkan lokalitas spreadsheet.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Sets the spreadsheet locale.
ss.setSpreadsheetLocale('fr');

// Gets the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

Parameter

NamaJenisDeskripsi
localeStringKode lokal yang akan digunakan (misalnya, 'en', 'fr', atau 'en_US').

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

setSpreadsheetTheme(theme)

Menetapkan tema pada spreadsheet.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// The code below sets the second predefined theme as the current theme of the spreadsheet.
var predefinedThemesList = spreadsheet.getPredefinedSpreadsheetThemes();
spreadsheet.setSpreadsheetTheme(predefinedThemesList[1]);

Parameter

NamaJenisDeskripsi
themeSpreadsheetThemeTema yang akan diterapkan.

Return

SpreadsheetTheme — Tema baru 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

setSpreadsheetTimeZone(timezone)

Menetapkan zona waktu untuk spreadsheet.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

Parameter

NamaJenisDeskripsi
timezoneStringZona waktu, yang ditentukan dalam format "panjang" (misalnya, "America/New_York", seperti yang dicantumkan oleh Joda.org).

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

show(userInterface)

Menampilkan komponen antarmuka pengguna kustom dalam dialog yang dipusatkan di area pandang browser pengguna. Eksekusi skrip sisi server tidak ditangguhkan. Untuk berkomunikasi dengan sisi server, komponen antarmuka pengguna harus membuat callback asinkron ke skrip sisi server.

Jika skrip sisi server sebelumnya menampilkan dialog yang belum ditutup, dialog yang ada akan diganti dengan antarmuka pengguna dialog yang baru diminta.

Cuplikan kode berikut menampilkan aplikasi HtmlService sederhana dalam dialog dengan judul, tinggi, dan lebar yang ditentukan:

var htmlApp = HtmlService
    .createHtmlOutput('<p>A change of speed, a change of style...</p>')
    .setTitle('My HtmlService Application')
    .setWidth(250)
    .setHeight(300);

SpreadsheetApp.getActiveSpreadsheet().show(htmlApp);

// The script resumes execution immediately after showing the dialog.

Parameter

NamaJenisDeskripsi
userInterfaceObjectHtmlOutput.

Otorisasi

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

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

sort(columnPosition)

Mengurutkan sheet berdasarkan kolom, secara menaik.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, ascending
sheet.sort(1);

Parameter

NamaJenisDeskripsi
columnPositionIntegerKolom yang akan diurutkan.

Return

Sheet — sheet, berguna untuk perantaian metode

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

sort(columnPosition, ascending)

Mengurutkan lembar berdasarkan kolom. Dibutuhkan parameter untuk menentukan menaik atau menurun.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

Parameter

NamaJenisDeskripsi
columnPositionIntegerKolom yang akan diurutkan.
ascendingBooleantrue untuk urutan menaik, false untuk menurun.

Return

Sheet — sheet, berguna untuk perantaian metode

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

toast(msg)

Menampilkan jendela pop-up di pojok kanan bawah spreadsheet dengan pesan tertentu.

// Show a popup with the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started');

Parameter

NamaJenisDeskripsi
msgStringPesan yang akan ditampilkan dalam toast.

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

toast(msg, title)

Menampilkan jendela pop-up di pojok kanan bawah spreadsheet dengan pesan dan judul tertentu.

// Show a popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status');

Parameter

NamaJenisDeskripsi
msgStringPesan yang akan ditampilkan dalam toast.
titleStringJudul opsional toast.

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

toast(msg, title, timeoutSeconds)

Menampilkan jendela pop-up di sudut kanan bawah spreadsheet dengan judul dan pesan tertentu, yang tetap terlihat selama jangka waktu tertentu.

// Show a 3-second popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status', 3);

Parameter

NamaJenisDeskripsi
msgStringPesan yang akan ditampilkan dalam toast.
titleStringJudul opsional toast.
timeoutSecondsNumberWaktu tunggu dalam detik; jika null, toast ditetapkan secara default ke 5 detik; jika negatif, toast akan tetap ada sampai ditutup.

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

unhideColumn(column)

Memperlihatkan kolom dalam rentang yang diberikan.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This unhides the first column if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideColumn(range);

Parameter

NamaJenisDeskripsi
columnRangeRentang yang akan diperlihatkan, jika disembunyikan.

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

unhideRow(row)

Memperlihatkan baris dalam rentang yang ditentukan.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This unhides the first row if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideRow(range);

Parameter

NamaJenisDeskripsi
rowRangeRentang yang akan diperlihatkan, jika disembunyikan.

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

updateMenu(name, subMenus)

Memperbarui menu yang ditambahkan oleh addMenu(name, subMenus). Bekerja sama seperti addMenu(name, subMenus).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var menuEntries = [];
menuEntries.push({name: "Lone Menu Entry", functionName: "function1"});
ss.updateMenu("addMenuExample", menuEntries);

Parameter

NamaJenisDeskripsi
nameStringNama menu yang akan diperbarui.
subMenusObject[]Array peta JavaScript dengan parameter name dan functionName . Anda dapat menggunakan fungsi dari library yang disertakan, seperti Library.libFunction1.

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Menunggu hingga semua eksekusi saat ini di spreadsheet selesai, waktu akan habis setelah jumlah detik yang diberikan. Menampilkan pengecualian jika eksekusi tidak selesai saat waktu habis, tetapi tidak membatalkan eksekusi data.

Parameter

NamaJenisDeskripsi
timeoutInSecondsIntegerWaktu untuk menunggu eksekusi data, dalam detik. Durasi maksimumnya adalah 300 detik.

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

Metode yang tidak digunakan lagi