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 reguler.
autoResizeColumn(columnName)DataSourceSheetMengubah ukuran otomatis lebar kolom yang ditentukan.
autoResizeColumns(columnNames)DataSourceSheetMengubah ukuran otomatis lebar kolom yang ditentukan.
forceRefreshData()DataSourceSheetMemuat ulang data objek ini terlepas dari status saat ini.
getColumnWidth(columnName)IntegerMenampilkan lebar kolom yang ditentukan.
getDataSource()DataSourceMendapatkan sumber data yang ditautkan ke objek tersebut.
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 yang diberikan (berbasis 1) dan hingga numRows yang diberikan.
getSortSpecs()SortSpec[]Mendapatkan semua spesifikasi pengurutan di sheet sumber data.
getStatus()DataExecutionStatusMendapatkan status eksekusi data objek.
refreshData()DataSourceSheetMemuat ulang 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 habis setelah jumlah detik yang diberikan.

Dokumentasi mendetail

addFilter(columnName, filterCriteria)

Menambahkan filter yang diterapkan ke sheet sumber data.

Parameter

NameJenisDeskripsi
columnNameStringNama kolom tempat filter ini diterapkan.
filterCriteriaFilterCriteriaKriteria filter yang akan diterapkan.

Return

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

asSheet()

Menampilkan sheet sumber data sebagai objek sheet reguler.

Return

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 otomatis lebar kolom yang ditentukan.

Parameter

NameJenisDeskripsi
columnNameStringNama kolom.

Return

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

autoResizeColumns(columnNames)

Mengubah ukuran otomatis lebar kolom yang ditentukan.

Parameter

NameJenisDeskripsi
columnNamesString[]Daftar nama kolom yang akan diperbarui.

Return

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

forceRefreshData()

Memuat ulang data objek ini terlepas dari status saat ini. Lihat refreshData() untuk mengetahui detail selengkapnya.

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

Return

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

NameJenisDeskripsi
columnNameStringNama kolom.

Return

Integer — 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 tersebut.

Return

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.

Return

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

NameJenisDeskripsi
columnNameStringNama kolom sumber data yang nilainya akan diambil.

Return

Object[] — Larik 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 yang diberikan (berbasis 1) dan hingga numRows yang diberikan.

Parameter

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

Return

Object[] — Larik 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.

Return

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.

Return

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

Memuat ulang data objek.

Menampilkan pengecualian jika saat ini dalam status error. Gunakan DataSource#updateSpec() untuk memperbarui spesifikasi. Metode ini lebih disarankan 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.

Return

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

NameJenisDeskripsi
columnNameStringNama kolom yang filternya akan dihapus.

Return

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

removeSortSpec(columnName)

Menghapus spesifikasi pengurutan pada kolom di sheet sumber data.

Parameter

NameJenisDeskripsi
columnNameStringNama kolom.

Return

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

setColumnWidth(columnName, width)

Menetapkan lebar kolom yang ditentukan.

Parameter

NameJenisDeskripsi
columnNameStringNama kolom.
widthIntegerLebar baru untuk kolom.

Return

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

setColumnWidths(columnNames, width)

Menetapkan lebar kolom yang ditentukan.

Parameter

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

Return

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

setSortSpec(columnName, ascending)

Menetapkan spesifikasi pengurutan pada kolom di sheet sumber data.

Parameter

NameJenisDeskripsi
columnNameStringNama kolom yang akan diurutkan.
ascendingBooleanJika true, urutkan kolom dalam urutan menaik; jika false, urutkan kolom dalam urutan menurun.

Return

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

setSortSpec(columnName, sortOrder)

Menetapkan spesifikasi pengurutan pada kolom di sheet sumber data.

Parameter

NameJenisDeskripsi
columnNameStringNama kolom yang akan diurutkan.
sortOrderSortOrderTata urutan.

Return

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

waitForCompletion(timeoutInSeconds)

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

Parameter

NameJenisDeskripsi
timeoutInSecondsIntegerWaktu untuk menunggu eksekusi data, dalam detik. Maksimumnya adalah 300 detik.

Return

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