Dostęp do istniejącej tabeli źródeł danych i jej modyfikowanie. Aby utworzyć nową tabelę źródła danych w nowym arkuszu, użyj funkcji Spreadsheet.insertSheetWithDataSourceTable(spec)
.
Używaj tej klasy tylko w przypadku danych połączonych z bazą danych.
Z tego przykładu dowiesz się, jak utworzyć nową tabelę źródeł danych.
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());
Z tego przykładu dowiesz się, jak edytować źródło danych.
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());
Metody
Metoda | Typ zwracanej wartości | Krótki opis |
---|---|---|
addColumns(columnNames) | DataSourceTable | Dodaje kolumny do tabeli źródła danych. |
addFilter(columnName, filterCriteria) | DataSourceTable | Dodaje filtr zastosowany do tabeli źródła danych. |
addSortSpec(columnName, ascending) | DataSourceTable | Dodaje specyfikację sortowania w kolumnie w tabeli źródła danych. |
addSortSpec(columnName, sortOrder) | DataSourceTable | Dodaje specyfikację sortowania w kolumnie w tabeli źródła danych. |
cancelDataRefresh() | DataSourceTable | Anuluje odświeżanie danych powiązane z tym obiektem, jeśli jest aktualnie uruchomiony. |
forceRefreshData() | DataSourceTable | Odświeża dane tego obiektu niezależnie od bieżącego stanu. |
getColumns() | DataSourceTableColumn[] | Pobiera wszystkie kolumny źródła danych dodane do tabeli źródła danych. |
getDataSource() | DataSource | Pobiera źródło danych, z którym jest połączony obiekt. |
getFilters() | DataSourceTableFilter[] | Zwraca wszystkie filtry zastosowane do tabeli źródła danych. |
getRange() | Range | Pobiera element Range , który obejmuje ta tabela źródła danych. |
getRowLimit() | Integer | Zwraca limit wierszy w tabeli źródeł danych. |
getSortSpecs() | SortSpec[] | Pobiera wszystkie specyfikacje sortowania z tabeli źródeł danych. |
getStatus() | DataExecutionStatus | Pobiera stan wykonania danych obiektu. |
isSyncingAllColumns() | Boolean | Zwraca, czy tabela źródła danych synchronizuje wszystkie kolumny w powiązanym źródle danych. |
refreshData() | DataSourceTable | Odświeża dane obiektu. |
removeAllColumns() | DataSourceTable | Usuwa wszystkie kolumny w tabeli źródła danych. |
removeAllSortSpecs() | DataSourceTable | Usuwa wszystkie specyfikacje sortowania z tabeli źródeł danych. |
setRowLimit(rowLimit) | DataSourceTable | Aktualizuje limit wierszy w tabeli źródeł danych. |
syncAllColumns() | DataSourceTable | Zsynchronizuj wszystkie obecne i przyszłe kolumny w powiązanym źródle danych z tabelą źródła danych. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Czeka na zakończenie bieżącego wykonania, a limit czasu oczekiwania po określonej liczbie sekund zostanie przekroczony. |
Szczegółowa dokumentacja
addColumns(columnNames)
Dodaje kolumny do tabeli źródła danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnNames | String[] | Lista nazw kolumn do dodania. |
Powroty
DataSourceTable
– tabela źródła danych na potrzeby łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addFilter(columnName, filterCriteria)
Dodaje filtr zastosowany do tabeli źródła danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny, do której chcesz zastosować ten filtr. |
filterCriteria | FilterCriteria | Kryteria filtrowania, które mają zostać zastosowane. |
Powroty
DataSourceTable
– tabela źródła danych na potrzeby łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addSortSpec(columnName, ascending)
Dodaje specyfikację sortowania w kolumnie w tabeli źródła danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny do sortowania. |
ascending | Boolean | Jeśli ustawiona jest wartość true , posortuj kolumnę w kolejności rosnącej. Jeśli ustawiona jest wartość false , posortuj kolumnę w kolejności malejącej. |
Powroty
DataSourceTable
– arkusz źródła danych na potrzeby łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addSortSpec(columnName, sortOrder)
Dodaje specyfikację sortowania w kolumnie w tabeli źródła danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny do sortowania. |
sortOrder | SortOrder | kolejność sortowania. |
Powroty
DataSourceTable
– arkusz źródła danych na potrzeby łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
cancelDataRefresh()
Anuluje odświeżanie danych powiązane z tym obiektem, jeśli jest aktualnie uruchomiony.
Ten przykład pokazuje, jak anulować odświeżenie formuły.
const spreadsheet = SpreadsheetApp.getActive(); const formula = spreadsheet.getDataSourceFormulas()[0]; // Cancel the ongoing refresh on the formula. formula.cancelDataRefresh();
Jeśli typ źródła danych nie jest włączony, zgłasza wyjątek. Użyj metod
SpreadsheetApp#enable...Execution()
, aby włączyć wykonywanie danych w przypadku określonego typu źródła danych.
Powroty
DataSourceTable
– obiekt danych;
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
forceRefreshData()
Odświeża dane tego obiektu niezależnie od bieżącego stanu. Aby dowiedzieć się więcej, wejdź na refreshData()
. Jeśli chcesz anulować uruchomione odświeżanie tego obiektu, zobacz cancelDataRefresh()
.
Jeśli typ źródła danych nie jest włączony, zgłasza wyjątek. Użyj metod SpreadsheetApp#enable...Execution()
, aby włączyć wykonywanie danych w przypadku określonego typu źródła danych.
Powroty
DataSourceTable
– obiekt danych;
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumns()
Pobiera wszystkie kolumny źródła danych dodane do tabeli źródła danych.
Powroty
DataSourceTableColumn[]
– lista kolumn tabeli źródeł danych.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSource()
Pobiera źródło danych, z którym jest połączony obiekt.
Powroty
DataSource
– źródło danych.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFilters()
Zwraca wszystkie filtry zastosowane do tabeli źródła danych.
Powroty
DataSourceTableFilter[]
– tablica wszystkich filtrów zastosowanych do tabeli źródeł danych.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRange()
getRowLimit()
Zwraca limit wierszy w tabeli źródeł danych.
Powroty
Integer
– limit wierszy w tabeli źródeł danych lub null
, jeśli nie ustawiono limitu, a tabela używa domyślnego limitu maksymalnego dostępnego w interfejsie Arkuszy Google.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSortSpecs()
Pobiera wszystkie specyfikacje sortowania z tabeli źródeł danych.
Powroty
SortSpec[]
– lista specyfikacji sortowania.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getStatus()
Pobiera stan wykonania danych obiektu.
Powroty
DataExecutionStatus
– stan wykonania danych.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
isSyncingAllColumns()
Zwraca, czy tabela źródła danych synchronizuje wszystkie kolumny w powiązanym źródle danych.
Powroty
Boolean
– True
, jeśli tabela źródła danych synchronizuje wszystkie kolumny w powiązanym źródle danych, lub false
w innym przypadku.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
refreshData()
Odświeża dane obiektu.
Zgłasza wyjątek, jeśli użytkownik jest w stanie error
. Użyj narzędzia DataSource#updateSpec()
, aby zaktualizować specyfikację. Ta metoda jest preferowana zamiast metody forceRefreshData()
, aby zapobiegać nieoczekiwanym zmianom w źródle danych.
Jeśli typ źródła danych nie jest włączony, zgłasza wyjątek. Użyj metod SpreadsheetApp#enable...Execution()
, aby włączyć wykonywanie danych w przypadku określonego typu źródła danych.
Powroty
DataSourceTable
– obiekt danych;
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeAllColumns()
Usuwa wszystkie kolumny w tabeli źródła danych.
Powroty
DataSourceTable
– tabela źródła danych na potrzeby łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeAllSortSpecs()
Usuwa wszystkie specyfikacje sortowania z tabeli źródeł danych.
Powroty
DataSourceTable
– arkusz źródła danych na potrzeby łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setRowLimit(rowLimit)
Aktualizuje limit wierszy w tabeli źródeł danych. Jeśli podany limit wierszy to null
, zaktualizuje tabelę źródła danych, aby wykorzystywała domyślny limit liczby wierszy obowiązujący w interfejsie Arkuszy Google.
Parametry
Nazwa | Typ | Opis |
---|---|---|
rowLimit | Integer | Nowy limit wierszy w tabeli danych. Jeśli null , zaktualizuje tabelę, aby używała domyślnego limitu wierszy. |
Powroty
DataSourceTable
– tabela źródła danych na potrzeby łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
syncAllColumns()
Zsynchronizuj wszystkie obecne i przyszłe kolumny w powiązanym źródle danych z tabelą źródła danych.
Powroty
DataSourceTable
– tabela źródła danych na potrzeby łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
waitForCompletion(timeoutInSeconds)
Czeka na zakończenie bieżącego wykonania, a limit czasu oczekiwania po określonej liczbie sekund zostanie przekroczony. Zgłasza wyjątek, jeśli wykonanie nie zostało ukończone w momencie przekroczenia limitu czasu, ale nie anuluje wykonania danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
timeoutInSeconds | Integer | Czas oczekiwania na wykonanie danych (w sekundach). Maksymalna długość to 300 sekund. |
Powroty
DataExecutionStatus
– stan wykonania danych.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets