Otwieranie i modyfikowanie istniejącego arkusza źródła danych. Aby utworzyć nowy arkusz źródła danych, użyj Spreadsheet.insertDataSourceSheet(spec)
.
Używaj tej klasy tylko z danymi połączonymi z bazą danych.
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addFilter(columnName, filterCriteria) | DataSourceSheet | Dodaje filtr zastosowany do arkusza źródła danych. |
asSheet() | Sheet | Zwraca arkusz źródła danych jako zwykły obiekt arkusza. |
autoResizeColumn(columnName) | DataSourceSheet | Automatycznie zmienia szerokość określonej kolumny. |
autoResizeColumns(columnNames) | DataSourceSheet | Automatycznie zmienia szerokość określonych kolumn. |
forceRefreshData() | DataSourceSheet | Odświeża dane tego obiektu niezależnie od bieżącego stanu. |
getColumnWidth(columnName) | Integer | Zwraca szerokość określonej kolumny. |
getDataSource() | DataSource | Pobiera źródło danych, z którym jest połączony obiekt. |
getFilters() | DataSourceSheetFilter[] | Zwraca wszystkie filtry zastosowane do arkusza źródła danych. |
getSheetValues(columnName) | Object[] | Zwraca wszystkie wartości w arkuszu źródła danych dla podanej nazwy kolumny. |
getSheetValues(columnName, startRow, numRows) | Object[] | Zwraca wszystkie wartości w arkuszu źródła danych dla podanej nazwy kolumny od podanego wiersza początkowego (-1) do podanej nazwy numRows . |
getSortSpecs() | SortSpec[] | Pobiera wszystkie specyfikacje sortowania z arkusza źródła danych. |
getStatus() | DataExecutionStatus | Pobiera stan wykonania danych obiektu. |
refreshData() | DataSourceSheet | Odświeża dane obiektu. |
removeFilters(columnName) | DataSourceSheet | Usuwa wszystkie filtry zastosowane do kolumny arkusza źródła danych. |
removeSortSpec(columnName) | DataSourceSheet | Usuwa specyfikację sortowania z kolumny w arkuszu źródła danych. |
setColumnWidth(columnName, width) | DataSourceSheet | Ustawia szerokość określonej kolumny. |
setColumnWidths(columnNames, width) | DataSourceSheet | Ustawia szerokość określonych kolumn. |
setSortSpec(columnName, ascending) | DataSourceSheet | Ustawia specyfikację sortowania w kolumnie w arkuszu źródła danych. |
setSortSpec(columnName, sortOrder) | DataSourceSheet | Ustawia specyfikację sortowania w kolumnie w arkuszu źródła danych. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Czeka na zakończenie bieżącego wykonania. Limit czasu zostaje przekroczony po podanej liczbie sekund. |
Szczegółowa dokumentacja
addFilter(columnName, filterCriteria)
Dodaje filtr zastosowany do arkusza źródła danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny, w której chcesz zastosować ten filtr. |
filterCriteria | FilterCriteria | Kryteria filtrowania, które mają zostać zastosowane. |
Powroty
DataSourceSheet
– arkusz źródła danych na potrzeby łańcuchów metod.
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
asSheet()
autoResizeColumn(columnName)
Automatycznie zmienia szerokość określonej kolumny.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny. |
Powroty
DataSourceSheet
– 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
autoResizeColumns(columnNames)
Automatycznie zmienia szerokość określonych kolumn.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnNames | String[] | Lista nazw kolumn do zaktualizowania. |
Powroty
DataSourceSheet
– 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
forceRefreshData()
Odświeża dane tego obiektu niezależnie od bieżącego stanu. Aby dowiedzieć się więcej, wejdź na refreshData()
.
Zgłasza wyjątek, jeśli typ źródła danych nie jest włączony. Użyj metod SpreadsheetApp#enable...Execution()
, aby włączyć wykonywanie danych w przypadku określonego typu źródła danych.
Powroty
DataSourceSheet
– 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
getColumnWidth(columnName)
Zwraca szerokość określonej kolumny.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny. |
Powroty
Integer
– szerokość kolumny lub null
, jeśli kolumna ma domyślną szerokość.
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 arkusza źródła danych.
Powroty
DataSourceSheetFilter[]
– tablica wszystkich filtrów zastosowanych w arkuszu źródła 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
getSheetValues(columnName)
Zwraca wszystkie wartości w arkuszu źródła danych dla podanej nazwy kolumny.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny źródła danych, z której mają zostać pobrane wartości. |
Powroty
Object[]
– jednowymiarowa tablica wartości.
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
getSheetValues(columnName, startRow, numRows)
Zwraca wszystkie wartości w arkuszu źródła danych dla podanej nazwy kolumny od podanego wiersza początkowego (-1) do podanej nazwy numRows
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny źródła danych, z której mają zostać pobrane wartości. |
startRow | Integer | Pozycja wiersza, od której należy rozpocząć pobieranie wartości. |
numRows | Integer | Liczba wierszy do pobrania. |
Powroty
Object[]
– jednowymiarowa tablica wartości.
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 arkusza źródła 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
refreshData()
Odświeża dane obiektu.
Zgłasza wyjątek, jeśli obecnie znajduje się w stanie error
. Użyj DataSource#updateSpec()
, aby zaktualizować specyfikację. Ta metoda jest preferowana zamiast metody forceRefreshData()
, aby zapobiegać nieoczekiwanym zmianom w źródle danych.
Zgłasza wyjątek, jeśli typ źródła danych nie jest włączony. Użyj metod SpreadsheetApp#enable...Execution()
, aby włączyć wykonywanie danych w przypadku określonego typu źródła danych.
Powroty
DataSourceSheet
– 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
removeFilters(columnName)
Usuwa wszystkie filtry zastosowane do kolumny arkusza źródła danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny, z której mają być usuwane filtry. |
Powroty
DataSourceSheet
– arkusz źródła danych na potrzeby łańcuchów metod.
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
removeSortSpec(columnName)
Usuwa specyfikację sortowania z kolumny w arkuszu źródła danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny. |
Powroty
DataSourceSheet
– 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
setColumnWidth(columnName, width)
Ustawia szerokość określonej kolumny.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny. |
width | Integer | Nowa szerokość kolumny. |
Powroty
DataSourceSheet
– 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
setColumnWidths(columnNames, width)
Ustawia szerokość określonych kolumn.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnNames | String[] | Lista nazw kolumn do zaktualizowania. |
width | Integer | Nowa szerokość kolumn. |
Powroty
DataSourceSheet
– 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
setSortSpec(columnName, ascending)
Ustawia specyfikację sortowania w kolumnie w arkuszu ź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
DataSourceSheet
– 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
setSortSpec(columnName, sortOrder)
Ustawia specyfikację sortowania w kolumnie w arkuszu źródła danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny do sortowania. |
sortOrder | SortOrder | Kolejność sortowania. |
Powroty
DataSourceSheet
– 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
waitForCompletion(timeoutInSeconds)
Czeka na zakończenie bieżącego wykonania. Limit czasu zostaje przekroczony po podanej liczbie sekund. Zgłasza wyjątek, jeśli wykonanie nie zostało ukończone po przekroczeniu limitu czasu, ale nie anuluje wykonywania 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