Mengakses dan mengubah tabel sumber data yang ada. Untuk membuat tabel sumber data baru pada {i>sheet<i} baru,
gunakan Spreadsheet.insertSheetWithDataSourceTable(spec)
.
Hanya gunakan class ini dengan sumber data BigQuery.
Contoh ini menunjukkan cara membuat tabel sumber data baru.
SpreadsheetApp.enableBigQueryExecution(); var spreadsheet = SpreadsheetApp.getActive(); var spec = SpreadsheetApp.newDataSourceSpec() .asBigQuery() .setProjectId('big_query_project') .setRawQuery('select @FIELD from table limit @LIMIT') .setParameterFromCell('FIELD', 'Sheet1!A1') .setParameterFromCell('LIMIT', 'namedRangeCell') .build(); // Starts data execution asynchronously. var dataSheet = spreadsheet.insertSheetWithDataSourceTable(spec); var dataSourceTable = dataSheet.getDataSourceTables()[0]; // waitForCompletion() blocks script execution until data execution completes. dataSourceTable.waitForCompletion(60); // Check status after execution. Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState());
Contoh ini menunjukkan cara mengedit sumber data.
SpreadsheetApp.enableBigQueryExecution(); var dataSheet = SpreadsheetApp.getActive().getSheetByName("Data Sheet 1"); var dataSourceTable = dataSheet.getDataSourceTables()[0]; var dataSource = dataSourceTable.getDataSource(); var newSpec = dataSource.getSpec() .copy() .asBigQuery() .setRawQuery('select name from table limit 2') .removeAllParameters() .build(); // Updates data source specification and starts data execution asynchronously. dataSource.updateSpec(newSpec); // Check status during execution. Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState()); // waitForCompletion() blocks script execution until data execution completes. dataSourceTable.waitForCompletion(60); // Check status after execution. Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState());
Metode
Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
---|---|---|
addColumns(columnNames) | DataSourceTable | Menambahkan kolom ke tabel sumber data. |
addFilter(columnName, filterCriteria) | DataSourceTable | Menambahkan filter yang diterapkan ke tabel sumber data. |
addSortSpec(columnName, ascending) | DataSourceTable | Menambahkan spesifikasi pengurutan pada kolom di tabel sumber data. |
addSortSpec(columnName, sortOrder) | DataSourceTable | Menambahkan spesifikasi pengurutan pada kolom di tabel sumber data. |
cancelDataRefresh() | DataSourceTable | Membatalkan pemuatan ulang data yang terkait dengan objek ini jika objek sedang berjalan. |
forceRefreshData() | DataSourceTable | Memuat ulang data objek ini terlepas dari status saat ini. |
getColumns() | DataSourceTableColumn[] | Mendapatkan semua kolom sumber data yang ditambahkan ke tabel sumber data. |
getDataSource() | DataSource | Mendapatkan sumber data yang ditautkan ke objek. |
getFilters() | DataSourceTableFilter[] | Menampilkan semua filter yang diterapkan ke tabel sumber data. |
getRange() | Range | Mendapatkan Range yang mencakup tabel sumber data ini. |
getRowLimit() | Integer | Menampilkan batas baris untuk tabel sumber data. |
getSortSpecs() | SortSpec[] | Mendapatkan semua spesifikasi pengurutan di tabel sumber data. |
getStatus() | DataExecutionStatus | Mendapatkan status eksekusi data objek. |
isSyncingAllColumns() | Boolean | Menampilkan apakah tabel sumber data menyinkronkan semua kolom di sumber data terkait. |
refreshData() | DataSourceTable | Memuat ulang data objek. |
removeAllColumns() | DataSourceTable | Menghapus semua kolom di tabel sumber data. |
removeAllSortSpecs() | DataSourceTable | Menghapus semua spesifikasi pengurutan di tabel sumber data. |
setRowLimit(rowLimit) | DataSourceTable | Memperbarui batas baris untuk tabel sumber data. |
syncAllColumns() | DataSourceTable | Sinkronkan semua kolom yang ada dan kolom di masa mendatang di sumber data terkait ke tabel sumber data. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Menunggu hingga eksekusi saat ini selesai, waktu habis setelah jumlah detik yang diberikan. |
Dokumentasi mendetail
addColumns(columnNames)
Menambahkan kolom ke tabel sumber data.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnNames | String[] | Daftar nama kolom yang akan ditambahkan. |
Pulang pergi
DataSourceTable
— Tabel 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
addFilter(columnName, filterCriteria)
Menambahkan filter yang diterapkan ke tabel sumber data.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnName | String | Nama kolom tempat filter ini akan diterapkan. |
filterCriteria | FilterCriteria | Kriteria filter yang akan diterapkan. |
Pulang pergi
DataSourceTable
— Tabel 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
addSortSpec(columnName, ascending)
Menambahkan spesifikasi pengurutan pada kolom di tabel sumber data.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnName | String | Nama kolom yang akan diurutkan. |
ascending | Boolean | Jika true , urutkan kolom dalam urutan menaik; jika false , urutkan
kolom dalam
urutan menurun. |
Pulang pergi
DataSourceTable
— 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
addSortSpec(columnName, sortOrder)
Menambahkan spesifikasi pengurutan pada kolom di tabel sumber data.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
columnName | String | Nama kolom yang akan diurutkan. |
sortOrder | SortOrder | Urutan pengurutan. |
Pulang pergi
DataSourceTable
— 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
cancelDataRefresh()
Membatalkan pemuatan ulang data yang terkait dengan objek ini jika objek 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 SpreadsheetApp#enable...Execution()
untuk mengaktifkan eksekusi data untuk jenis sumber data
tertentu.
Pulang pergi
DataSourceTable
— 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()
Memperbarui data objek ini terlepas dari status saat ini. Lihat refreshData()
untuk
secara lebih mendetail. Jika Anda ingin membatalkan pemuatan ulang objek ini yang sedang berjalan, lihat cancelDataRefresh()
.
Menampilkan pengecualian jika jenis sumber data tidak diaktifkan. Menggunakan metode SpreadsheetApp#enable...Execution()
untuk mengaktifkan eksekusi data bagi sumber data tertentu
.
Pulang pergi
DataSourceTable
— 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
getColumns()
Mendapatkan semua kolom sumber data yang ditambahkan ke tabel sumber data.
Pulang pergi
DataSourceTableColumn[]
— Daftar kolom 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
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 tabel sumber data.
Pulang pergi
DataSourceTableFilter[]
— Array dari semua filter yang diterapkan ke 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
getRange()
getRowLimit()
Menampilkan batas baris untuk tabel sumber data.
Pulang pergi
Integer
— Batas baris untuk tabel sumber data, atau null
jika tidak ada batas yang ditetapkan dan
menggunakan batas maksimum default seperti di UI Google 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
getSortSpecs()
Mendapatkan semua spesifikasi pengurutan di tabel 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
isSyncingAllColumns()
Menampilkan apakah tabel sumber data menyinkronkan semua kolom di sumber data terkait.
Pulang pergi
Boolean
— True
jika tabel sumber data menyinkronkan semua kolom di sumber data terkait, atau 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
refreshData()
Memuat ulang data objek.
Menampilkan pengecualian jika saat ini dalam status error
. Gunakan DataSource#updateSpec()
untuk mengupdate spesifikasi. Metodenya adalah
lebih disukai daripada forceRefreshData()
untuk mencegah pengeditan yang tidak terduga pada sumber data.
Menampilkan pengecualian jika jenis sumber data tidak diaktifkan. Menggunakan metode SpreadsheetApp#enable...Execution()
untuk mengaktifkan eksekusi data bagi sumber data tertentu
.
Pulang pergi
DataSourceTable
— 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
removeAllColumns()
Menghapus semua kolom di tabel sumber data.
Pulang pergi
DataSourceTable
— Tabel 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
removeAllSortSpecs()
Menghapus semua spesifikasi pengurutan di tabel sumber data.
Pulang pergi
DataSourceTable
— 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
setRowLimit(rowLimit)
Memperbarui batas baris untuk tabel sumber data. Jika batas baris yang diberikan adalah null
,
kemudian memperbarui tabel sumber data agar menggunakan batas baris maks default seperti di UI Google Spreadsheet.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
rowLimit | Integer | Batas baris baru untuk tabel data. Jika null , memperbarui tabel untuk menggunakan
batas baris default. |
Pulang pergi
DataSourceTable
— Tabel 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
syncAllColumns()
Sinkronkan semua kolom yang ada dan kolom di masa mendatang di sumber data terkait ke tabel sumber data.
Pulang pergi
DataSourceTable
— Tabel 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, waktu 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 |
---|---|---|
timeoutInSeconds | Integer | Waktu tunggu untuk eksekusi data, dalam detik. Maksimumnya adalah 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