Class DataSourceSheet

Arkuszźródładanych

Dostęp do istniejącego arkusza źródła danych i jego modyfikowanie. Aby utworzyć nowy arkusz źródła danych, użyj Spreadsheet.insertDataSourceSheet(spec).

Używaj tej klasy tylko w przypadku danych połączonych z bazą danych.

Metody

MetodaZwracany typKrótki opis
addFilter(columnName, filterCriteria)DataSourceSheetDodaje filtr zastosowany do arkusza źródła danych.
asSheet()SheetZwraca arkusz źródła danych jako zwykły obiekt arkusza.
autoResizeColumn(columnName)DataSourceSheetAutomatycznie zmienia szerokość określonej kolumny.
autoResizeColumns(columnNames)DataSourceSheetAutomatycznie zmienia szerokość wskazanych kolumn.
cancelDataRefresh()DataSourceSheetAnuluje odświeżanie danych powiązane z tym obiektem, jeśli jest ono obecnie w toku.
forceRefreshData()DataSourceSheetOdświeża dane tego obiektu niezależnie od jego bieżącego stanu.
getColumnWidth(columnName)Integer|nullZwraca szerokość określonej kolumny.
getDataSource()DataSourcePobiera źródło danych, z którym połączony jest obiekt.
getFilters()DataSourceSheetFilter[]Zwraca wszystkie filtry zastosowane do arkusza źródła danych.
getSheetValues(columnName)Object[]Zwraca wszystkie wartości z arkusza źródła danych dla podanej nazwy kolumny.
getSheetValues(columnName, startRow, numRows)Object[]Zwraca wszystkie wartości z arkusza źródła danych dla podanej nazwy kolumny, począwszy od podanego wiersza początkowego (liczonego od 1) aż do podanego wiersza numRows.
getSortSpecs()SortSpec[]Pobiera wszystkie specyfikacje sortowania z arkusza źródła danych.
getStatus()DataExecutionStatusPobiera stan wykonania danych obiektu.
refreshData()DataSourceSheetOdświeża dane obiektu.
removeFilters(columnName)DataSourceSheetUsuwa wszystkie filtry zastosowane do kolumny arkusza źródła danych.
removeSortSpec(columnName)DataSourceSheetUsuwa specyfikację sortowania w kolumnie w arkuszu źródła danych.
setColumnWidth(columnName, width)DataSourceSheetUstawia szerokość określonej kolumny.
setColumnWidths(columnNames, width)DataSourceSheetUstawia szerokość określonych kolumn.
setSortSpec(columnName, ascending)DataSourceSheetUstawia specyfikację sortowania w kolumnie w arkuszu źródła danych.
setSortSpec(columnName, sortOrder)DataSourceSheetUstawia specyfikację sortowania w kolumnie w arkuszu źródła danych.
waitForCompletion(timeoutInSeconds)DataExecutionStatusCzeka na zakończenie bieżącego działania. Po upływie podanej liczby sekund następuje przekroczenie limitu czasu.

Szczegółowa dokumentacja

addFilter(columnName, filterCriteria)

Dodaje filtr zastosowany do arkusza źródła danych.

Parametry

NazwaTypOpis
columnNameStringNazwa kolumny, do której ma zostać zastosowany ten filtr.
filterCriteriaFilterCriteriaKryteria filtra do zastosowania.

Powrót

DataSourceSheet – arkusz źródła danych do łączenia metod.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

asSheet()

Zwraca arkusz źródła danych jako zwykły obiekt arkusza.

Powrót

Sheet – zwykły arkusz.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

autoResizeColumn(columnName)

Automatycznie zmienia szerokość określonej kolumny.

Parametry

NazwaTypOpis
columnNameStringNazwa kolumny.

Powrót

DataSourceSheet – arkusz tego źródła danych do łączenia.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

autoResizeColumns(columnNames)

Automatycznie zmienia szerokość wskazanych kolumn.

Parametry

NazwaTypOpis
columnNamesString[]Lista nazw kolumn do zaktualizowania.

Powrót

DataSourceSheet – arkusz tego źródła danych do łączenia.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 ono obecnie w toku.

Ten przykład pokazuje, jak anulować odświeżanie formuły. 

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

Zgłasza wyjątek, jeśli typ źródła danych nie jest włączony. Użyj metod SpreadsheetApp#enable...Execution(), aby umożliwić wykonywanie zapytań do bazy danych w przypadku określonego typu źródła danych.

Powrót

DataSourceSheet – obiekt danych.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 jego bieżącego stanu. Więcej informacji znajdziesz w sekcji refreshData(). Jeśli chcesz anulować aktualnie trwające odświeżanie tego obiektu, zapoznaj się z sekcją cancelDataRefresh().

Zgłasza wyjątek, jeśli typ źródła danych nie jest włączony. Użyj metod SpreadsheetApp#enable...Execution(), aby umożliwić wykonywanie zapytań do bazy danych w przypadku określonego typu źródła danych.

Powrót

DataSourceSheet – obiekt danych.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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

NazwaTypOpis
columnNameStringNazwa kolumny.

Powrót

Integer|null – szerokość kolumny lub null, jeśli kolumna używa szerokości domyślnej.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 połączony jest obiekt.

Powrót

DataSource – źródło danych.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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.

Powrót

DataSourceSheetFilter[] – tablica wszystkich filtrów zastosowanych w arkuszu źródła danych.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSheetValues(columnName)

Zwraca wszystkie wartości z arkusza źródła danych dla podanej nazwy kolumny.

Parametry

NazwaTypOpis
columnNameStringNazwa kolumny źródła danych, z której mają być pobierane wartości.

Powrót

Object[] – jednowymiarowa tablica wartości.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 z arkusza źródła danych dla podanej nazwy kolumny, począwszy od podanego wiersza początkowego (liczonego od 1) aż do podanego wiersza numRows.

Parametry

NazwaTypOpis
columnNameStringNazwa kolumny źródła danych, z której mają być pobierane wartości.
startRowIntegerPozycja wiersza, od której mają być pobierane wartości.
numRowsIntegerLiczba wierszy do pobrania.

Powrót

Object[] – jednowymiarowa tablica wartości.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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.

Powrót

SortSpec[] – lista specyfikacji sortowania.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getStatus()

Pobiera stan wykonania danych obiektu.

Powrót

DataExecutionStatus – stan wykonywania zapytań do bazy danych.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 jest w stanie error. Użyj DataSource#updateSpec(), aby zaktualizować specyfikację. Ta metoda jest preferowana w stosunku do forceRefreshData(), ponieważ 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 umożliwić wykonywanie zapytań do bazy danych w przypadku określonego typu źródła danych.

Powrót

DataSourceSheet – obiekt danych.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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

NazwaTypOpis
columnNameStringNazwa kolumny, z której chcesz usunąć filtry.

Powrót

DataSourceSheet – arkusz źródła danych do łączenia metod.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeSortSpec(columnName)

Usuwa specyfikację sortowania w kolumnie w arkuszu źródła danych.

Parametry

NazwaTypOpis
columnNameStringNazwa kolumny.

Powrót

DataSourceSheet – arkusz źródła danych do łączenia.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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

NazwaTypOpis
columnNameStringNazwa kolumny.
widthIntegerNowa szerokość kolumny.

Powrót

DataSourceSheet – arkusz tego źródła danych do łączenia.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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

NazwaTypOpis
columnNamesString[]Lista nazw kolumn do zaktualizowania.
widthIntegerNowa szerokość kolumn.

Powrót

DataSourceSheet – arkusz tego źródła danych do łączenia.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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

NazwaTypOpis
columnNameStringNazwa kolumny, według której ma być wykonane sortowanie.
ascendingBooleanJeśli true, posortuj kolumnę w kolejności rosnącej; jeśli false, posortuj kolumnę w kolejności malejącej.

Powrót

DataSourceSheet – arkusz źródła danych do łączenia.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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

NazwaTypOpis
columnNameStringNazwa kolumny, według której ma być wykonane sortowanie.
sortOrderSortOrderKolejność sortowania.

Powrót

DataSourceSheet – arkusz źródła danych do łączenia.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 działania. Po upływie podanej liczby sekund następuje przekroczenie limitu czasu. Zwraca wyjątek, jeśli wykonanie nie zostanie ukończone przed upływem limitu czasu, ale nie anuluje wykonania danych.

Parametry

NazwaTypOpis
timeoutInSecondsIntegerCzas oczekiwania na wykonanie zapytania do bazy danych w sekundach. Maksymalny czas to 300 sekund.

Powrót

DataExecutionStatus – stan wykonywania zapytań do bazy danych.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets