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
Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
---|---|---|
add | Data | Menambahkan filter yang diterapkan ke sheet sumber data. |
as | Sheet | Menampilkan sheet sumber data sebagai objek sheet reguler. |
auto | Data | Mengubah ukuran lebar kolom yang ditentukan secara otomatis. |
auto | Data | Mengubah ukuran lebar kolom yang ditentukan secara otomatis. |
cancel | Data | Membatalkan pembaruan data yang terkait dengan objek ini jika saat ini sedang berjalan. |
force | Data | Memperbarui data objek ini terlepas dari status saat ini. |
get | Integer | Menampilkan lebar kolom yang ditentukan. |
get | Data | Mendapatkan sumber data yang ditautkan ke objek. |
get | Data | Menampilkan semua filter yang diterapkan ke sheet sumber data. |
get | Object[] | Menampilkan semua nilai untuk sheet sumber data untuk nama kolom yang diberikan. |
get | Object[] | Menampilkan semua nilai untuk sheet sumber data untuk nama kolom yang diberikan dari baris awal yang diberikan (berbasis-1) dan hingga num yang diberikan. |
get | Sort | Mendapatkan semua spesifikasi pengurutan di sheet sumber data. |
get | Data | Mendapatkan status eksekusi data objek. |
refresh | Data | Memperbarui data objek. |
remove | Data | Menghapus semua filter yang diterapkan ke kolom sheet sumber data. |
remove | Data | Menghapus spesifikasi pengurutan pada kolom di sheet sumber data. |
set | Data | Menetapkan lebar kolom yang ditentukan. |
set | Data | Menetapkan lebar kolom yang ditentukan. |
set | Data | Menetapkan spesifikasi pengurutan pada kolom di sheet sumber data. |
set | Data | Menetapkan spesifikasi pengurutan pada kolom di sheet sumber data. |
wait | Data | Menunggu hingga eksekusi saat ini selesai, waktu tunggu habis setelah jumlah detik yang diberikan. |
Dokumentasi mendetail
add Filter(columnName, filterCriteria)
Menambahkan filter yang diterapkan ke sheet sumber data.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
column | String | Nama kolom yang akan menerapkan filter ini. |
filter | Filter | Kriteria filter yang akan diterapkan. |
Pulang pergi
Data
— Sheet sumber data, untuk pembuatan rantai 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
as Sheet()
Menampilkan sheet sumber data sebagai objek sheet reguler.
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
auto Resize Column(columnName)
Mengubah ukuran lebar kolom yang ditentukan secara otomatis.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
column | String | Nama kolom. |
Pulang pergi
Data
— Sheet sumber data ini, untuk penyambungan.
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
auto Resize Columns(columnNames)
Mengubah ukuran lebar kolom yang ditentukan secara otomatis.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
column | String[] | Daftar nama kolom yang akan diperbarui. |
Pulang pergi
Data
— Sheet sumber data ini, untuk penyambungan.
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
cancel Data Refresh()
Membatalkan pembaruan data yang terkait dengan objek ini jika saat ini sedang berjalan.
Contoh ini menunjukkan cara membatalkan pembaruan 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 Spreadsheet
untuk mengaktifkan eksekusi data untuk jenis sumber data
tertentu.
Pulang pergi
Data
— 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
force Refresh Data()
Memperbarui data objek ini terlepas dari status saat ini. Lihat refresh
untuk
mengetahui detail selengkapnya. Jika Anda ingin membatalkan pembaruan objek ini yang sedang berjalan, lihat cancel
.
Menampilkan pengecualian jika jenis sumber data tidak diaktifkan. Gunakan metode Spreadsheet
untuk mengaktifkan eksekusi data untuk jenis sumber data
tertentu.
Pulang pergi
Data
— 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
get Column Width(columnName)
Menampilkan lebar kolom yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
column | String | Nama kolom. |
Pulang pergi
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
get Data Source()
Mendapatkan sumber data yang ditautkan ke objek.
Pulang pergi
Data
— 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
get Filters()
Menampilkan semua filter yang diterapkan ke sheet sumber data.
Pulang pergi
Data
— Array dari 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
get Sheet Values(columnName)
Menampilkan semua nilai untuk sheet sumber data untuk nama kolom yang diberikan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
column | String | Nama 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
get Sheet Values(columnName, startRow, numRows)
Menampilkan semua nilai untuk sheet sumber data untuk nama kolom yang diberikan dari baris awal yang diberikan (berbasis-1) dan hingga num
yang diberikan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
column | String | Nama kolom sumber data untuk mengambil nilai. |
start | Integer | Posisi baris untuk mulai mengambil nilai. |
num | Integer | Jumlah 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
get Sort Specs()
Mendapatkan semua spesifikasi pengurutan di sheet sumber data.
Pulang pergi
Sort
— 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
get Status()
Mendapatkan status eksekusi data objek.
Pulang pergi
Data
— 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
refresh Data()
Memperbarui data objek.
Menampilkan pengecualian jika saat ini dalam status error
. Gunakan Data
untuk memperbarui spesifikasi. Metode ini lebih disukai daripada force
untuk mencegah pengeditan yang tidak terduga pada sumber data.
Menampilkan pengecualian jika jenis sumber data tidak diaktifkan. Gunakan metode Spreadsheet
untuk mengaktifkan eksekusi data untuk jenis sumber data
tertentu.
Pulang pergi
Data
— 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
remove Filters(columnName)
Menghapus semua filter yang diterapkan ke kolom sheet sumber data.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
column | String | Nama kolom tempat menghapus filter. |
Pulang pergi
Data
— Sheet sumber data, untuk pembuatan rantai 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
remove Sort Spec(columnName)
Menghapus spesifikasi pengurutan pada kolom di sheet sumber data.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
column | String | Nama kolom. |
Pulang pergi
Data
— Sheet sumber data, untuk penyambungan.
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
set Column Width(columnName, width)
Menetapkan lebar kolom yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
column | String | Nama kolom. |
width | Integer | Lebar baru untuk kolom. |
Pulang pergi
Data
— Sheet sumber data ini, untuk penyambungan.
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
set Column Widths(columnNames, width)
Menetapkan lebar kolom yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
column | String[] | Daftar nama kolom yang akan diperbarui. |
width | Integer | Lebar baru untuk kolom. |
Pulang pergi
Data
— Sheet sumber data ini, untuk penyambungan.
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
set Sort Spec(columnName, ascending)
Menetapkan spesifikasi pengurutan pada kolom di sheet sumber data.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
column | String | Nama kolom yang akan diurutkan. |
ascending | Boolean | Jika true , urutkan kolom dari bawah ke atas; jika false , urutkan kolom dari atas ke bawah. |
Pulang pergi
Data
— Sheet sumber data, untuk penyambungan.
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
set Sort Spec(columnName, sortOrder)
Menetapkan spesifikasi pengurutan pada kolom di sheet sumber data.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
column | String | Nama kolom yang akan diurutkan. |
sort | Sort | Urutan pengurutan. |
Pulang pergi
Data
— Sheet sumber data, untuk penyambungan.
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
wait For Completion(timeoutInSeconds)
Menunggu hingga eksekusi saat ini selesai, waktu tunggu habis setelah jumlah detik yang diberikan. Menampilkan pengecualian jika eksekusi tidak selesai saat waktu tunggu habis, tetapi tidak membatalkan eksekusi data.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
timeout | Integer | Waktu tunggu eksekusi data, dalam detik. Durasi maksimumnya adalah 300 detik. |
Pulang pergi
Data
— 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