Class DataSourceSheet

DataSourceSheet

Mengakses dan mengubah sheet sumber data yang ada. Untuk membuat sheet sumber data baru, gunakan Spreadsheet.insertDataSourceSheet(spec).

Hanya gunakan class ini dengan data yang terhubung ke database.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addFilter(columnName, filterCriteria)DataSourceSheetMenambahkan filter yang diterapkan ke sheet sumber data.
asSheet()SheetMenampilkan sheet sumber data sebagai objek sheet biasa.
autoResizeColumn(columnName)DataSourceSheetMengubah ukuran lebar kolom yang ditentukan secara otomatis.
autoResizeColumns(columnNames)DataSourceSheetMengubah ukuran lebar kolom yang ditentukan secara otomatis.
cancelDataRefresh()DataSourceSheetMembatalkan refresh data yang terkait dengan objek ini jika saat ini sedang berjalan.
forceRefreshData()DataSourceSheetMemuat ulang data objek ini, terlepas dari status saat ini.
getColumnWidth(columnName)Integer|nullMenampilkan lebar kolom yang ditentukan.
getDataSource()DataSourceMendapatkan sumber data yang ditautkan ke objek.
getFilters()DataSourceSheetFilter[]Menampilkan semua filter yang diterapkan ke sheet sumber data.
getSheetValues(columnName)Object[]Menampilkan semua nilai untuk sheet sumber data untuk nama kolom yang diberikan.
getSheetValues(columnName, startRow, numRows)Object[]Menampilkan semua nilai untuk sheet sumber data untuk nama kolom yang diberikan dari baris awal (berbasis 1) yang diberikan dan hingga numRows yang diberikan.
getSortSpecs()SortSpec[]Mendapatkan semua spesifikasi pengurutan di sheet sumber data.
getStatus()DataExecutionStatusMendapatkan status eksekusi data objek.
refreshData()DataSourceSheetMemperbarui data objek.
removeFilters(columnName)DataSourceSheetMenghapus semua filter yang diterapkan ke kolom sheet sumber data.
removeSortSpec(columnName)DataSourceSheetMenghapus spesifikasi pengurutan pada kolom di sheet sumber data.
setColumnWidth(columnName, width)DataSourceSheetMenetapkan lebar kolom yang ditentukan.
setColumnWidths(columnNames, width)DataSourceSheetMenetapkan lebar kolom yang ditentukan.
setSortSpec(columnName, ascending)DataSourceSheetMenetapkan spesifikasi pengurutan pada kolom di sheet sumber data.
setSortSpec(columnName, sortOrder)DataSourceSheetMenetapkan spesifikasi pengurutan pada kolom di sheet sumber data.
waitForCompletion(timeoutInSeconds)DataExecutionStatusMenunggu hingga eksekusi saat ini selesai, dengan waktu tunggu habis setelah jumlah detik yang diberikan.

Dokumentasi mendetail

addFilter(columnName, filterCriteria)

Menambahkan filter yang diterapkan ke sheet sumber data.

Parameter

NamaJenisDeskripsi
columnNameStringNama kolom yang akan menerapkan filter ini.
filterCriteriaFilterCriteriaKriteria filter yang akan diterapkan.

Pulang pergi

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

asSheet()

Menampilkan sheet sumber data sebagai objek sheet biasa.

Pulang pergi

Sheet — Sheet reguler.

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(columnName)

Mengubah ukuran lebar kolom yang ditentukan secara otomatis.

Parameter

NamaJenisDeskripsi
columnNameStringNama kolom.

Pulang pergi

DataSourceSheet — Lembar sumber data ini, untuk penggabungan.

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

autoResizeColumns(columnNames)

Mengubah ukuran lebar kolom yang ditentukan secara otomatis.

Parameter

NamaJenisDeskripsi
columnNamesString[]Daftar nama kolom yang akan diperbarui.

Pulang pergi

DataSourceSheet — Lembar sumber data ini, untuk penggabungan.

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

cancelDataRefresh()

Membatalkan refresh data yang terkait dengan objek ini jika saat ini sedang berjalan.

Contoh ini menunjukkan cara membatalkan refresh formula. 

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

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

Pulang pergi

DataSourceSheet — Objek 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

forceRefreshData()

Memuat ulang data objek ini, terlepas dari status saat ini. Lihat refreshData() untuk detail selengkapnya. Jika Anda ingin membatalkan penyegaran objek ini yang sedang berjalan, lihat cancelDataRefresh().

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

Pulang pergi

DataSourceSheet — Objek 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

getColumnWidth(columnName)

Menampilkan lebar kolom yang ditentukan.

Parameter

NamaJenisDeskripsi
columnNameStringNama kolom.

Pulang pergi

Integer|null — Lebar kolom, atau null jika kolom menggunakan lebar 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

getDataSource()

Mendapatkan sumber data yang ditautkan ke objek.

Pulang pergi

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

getFilters()

Menampilkan semua filter yang diterapkan ke sheet sumber data.

Pulang pergi

DataSourceSheetFilter[] — Array semua filter yang diterapkan ke 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

getSheetValues(columnName)

Menampilkan semua nilai untuk sheet sumber data untuk nama kolom yang diberikan.

Parameter

NamaJenisDeskripsi
columnNameStringNama kolom sumber data untuk mengambil nilai.

Pulang pergi

Object[] — Array nilai satu 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

getSheetValues(columnName, startRow, numRows)

Menampilkan semua nilai untuk sheet sumber data untuk nama kolom yang diberikan dari baris awal (berbasis 1) yang diberikan dan hingga numRows yang diberikan.

Parameter

NamaJenisDeskripsi
columnNameStringNama kolom sumber data untuk mengambil nilai.
startRowIntegerPosisi baris untuk mulai mengambil nilai.
numRowsIntegerJumlah baris yang akan diambil.

Pulang pergi

Object[] — Array nilai satu 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

getSortSpecs()

Mendapatkan semua spesifikasi pengurutan di sheet sumber data.

Pulang pergi

SortSpec[] — Daftar spesifikasi pengurutan.

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

getStatus()

Mendapatkan status eksekusi data objek.

Pulang pergi

DataExecutionStatus — Status eksekusi 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

refreshData()

Memperbarui data objek.

Menampilkan pengecualian jika saat ini dalam status error. Gunakan DataSource#updateSpec() untuk memperbarui spesifikasi. Metode ini lebih disukai daripada forceRefreshData() untuk mencegah pengeditan yang tidak terduga pada sumber data.

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

Pulang pergi

DataSourceSheet — Objek 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

removeFilters(columnName)

Menghapus semua filter yang diterapkan ke kolom sheet sumber data.

Parameter

NamaJenisDeskripsi
columnNameStringNama kolom yang filternya akan dihapus.

Pulang pergi

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

removeSortSpec(columnName)

Menghapus spesifikasi pengurutan pada kolom di sheet sumber data.

Parameter

NamaJenisDeskripsi
columnNameStringNama kolom.

Pulang pergi

DataSourceSheet — Sheet sumber data, untuk penggabungan.

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(columnName, width)

Menetapkan lebar kolom yang ditentukan.

Parameter

NamaJenisDeskripsi
columnNameStringNama kolom.
widthIntegerLebar baru untuk kolom.

Pulang pergi

DataSourceSheet — Lembar sumber data ini, untuk penggabungan.

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

setColumnWidths(columnNames, width)

Menetapkan lebar kolom yang ditentukan.

Parameter

NamaJenisDeskripsi
columnNamesString[]Daftar nama kolom yang akan diperbarui.
widthIntegerLebar baru untuk kolom.

Pulang pergi

DataSourceSheet — Lembar sumber data ini, untuk penggabungan.

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

setSortSpec(columnName, ascending)

Menetapkan spesifikasi pengurutan pada kolom di sheet sumber data.

Parameter

NamaJenisDeskripsi
columnNameStringNama kolom yang akan diurutkan.
ascendingBooleanJika true, urutkan kolom dari bawah ke atas; jika false, urutkan kolom dari atas ke bawah.

Pulang pergi

DataSourceSheet — Sheet sumber data, untuk penggabungan.

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

setSortSpec(columnName, sortOrder)

Menetapkan spesifikasi pengurutan pada kolom di sheet sumber data.

Parameter

NamaJenisDeskripsi
columnNameStringNama kolom yang akan diurutkan.
sortOrderSortOrderUrutan penyortiran.

Pulang pergi

DataSourceSheet — Sheet sumber data, untuk penggabungan.

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

waitForCompletion(timeoutInSeconds)

Menunggu hingga eksekusi saat ini selesai, dengan waktu tunggu 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. Maksimum 300 detik.

Pulang pergi

DataExecutionStatus — Status eksekusi 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