Class DataSourceSheet

Źródłodanycharkusza

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

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 rozmiar szerokości określonej kolumny.
autoResizeColumns(columnNames)DataSourceSheetAutomatycznie zmienia rozmiar szerokości wskazanych kolumn.
cancelDataRefresh()DataSourceSheetanuluje odświeżanie danych powiązane z tym obiektem, jeśli jest obecnie uruchomione.
forceRefreshData()DataSourceSheetOdświeża dane tego obiektu niezależnie od jego bieżącego stanu.
getColumnWidth(columnName)IntegerZwraca szerokość wskazanej kolumny.
getDataSource()DataSourcePobiera źródło danych, z którym jest powiązany 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 w arkuszu źródła danych dla podanej nazwy kolumny od podanego wiersza startowego (-1) 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ść wskazanych 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 wykonania, po czym po upływie podanej liczby sekund kończy działanie.

Szczegółowa dokumentacja

addFilter(columnName, filterCriteria)

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

Parametry

NazwaTypOpis
columnNameStringNazwa kolumny, do której ma być zastosowany ten filtr.
filterCriteriaFilterCriteriaKryteria filtrowania, które mają być stosowane.

Powrót

DataSourceSheet – arkusz źródła danych, który służy do łańcuchowania metod.

Autoryzacja

Skrypty, które korzystają 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()

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

Powrót

Sheet – zwykły arkusz.

Autoryzacja

Skrypty, które korzystają 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

autoResizeColumn(columnName)

Automatycznie zmienia rozmiar szerokości określonej kolumny.

Parametry

NazwaTypOpis
columnNameStringNazwa kolumny.

Powrót

DataSourceSheet – arkusz źródła danych, który służy do łańcuchowania.

Autoryzacja

Skrypty, które korzystają 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 rozmiar szerokości wskazanych kolumn.

Parametry

NazwaTypOpis
columnNamesString[]Lista nazw kolumn do zaktualizowania.

Powrót

DataSourceSheet – arkusz źródła danych, który służy do łańcuchowania.

Autoryzacja

Skrypty, które korzystają 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 obecnie uruchomione.

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();

Wyjątek jest zgłaszany, jeśli typ źródła danych nie jest włączony. Aby umożliwić wykonywanie zapytań do bazy danych w przypadku konkretnego typu źródła danych, użyj metody SpreadsheetApp#enable...Execution().

Powrót

DataSourceSheet – obiekt danych.

Autoryzacja

Skrypty, które korzystają 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 jego bieżącego stanu. Więcej informacji znajdziesz w artykule refreshData(). Jeśli chcesz anulować aktualnie wykonywane odświeżanie tego obiektu, zapoznaj się z artykułem cancelDataRefresh().

Wyjątek jest zgłaszany, jeśli typ źródła danych nie jest włączony. Aby umożliwić wykonywanie zapytań do bazy danych w przypadku konkretnego typu źródła danych, użyj metody SpreadsheetApp#enable...Execution().

Powrót

DataSourceSheet – obiekt danych.

Autoryzacja

Skrypty, które korzystają 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ść wskazanej kolumny.

Parametry

NazwaTypOpis
columnNameStringNazwa kolumny.

Powrót

Integer – szerokość kolumny lub null, jeśli kolumna ma szerokość domyślną.

Autoryzacja

Skrypty, które korzystają 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 powiązany obiekt.

Powrót

DataSource – źródło danych.

Autoryzacja

Skrypty, które korzystają 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.

Powrót

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

Autoryzacja

Skrypty, które korzystają 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 z arkusza źródła danych dla podanej nazwy kolumny.

Parametry

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

Powrót

Object[] – jednowymiarowy tablica wartości.

Autoryzacja

Skrypty, które korzystają 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 startowego (-1) do podanego wiersza numRows.

Parametry

NazwaTypOpis
columnNameStringNazwa kolumny w źródle danych, z której mają być pobierane wartości.
startRowIntegerPozycja wiersza, od której ma się rozpoczynać pobieranie wartości.
numRowsIntegerLiczba wierszy do pobrania.

Powrót

Object[] – jednowymiarowy tablica wartości.

Autoryzacja

Skrypty, które korzystają 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.

Powrót

SortSpec[] – lista specyfikacji sortowania.

Autoryzacja

Skrypty, które korzystają 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.

Powrót

DataExecutionStatus – stan wykonania danych.

Autoryzacja

Skrypty, które korzystają 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.

Wyjątek jest rzucany, jeśli aktualny stan to error. Aby zaktualizować specyfikację, użyj DataSource#updateSpec(). Ta metoda jest preferowana w stosunku do forceRefreshData(), ponieważ zapobiega nieoczekiwanym zmianom w źródle danych.

Wyjątek jest zgłaszany, jeśli typ źródła danych nie jest włączony. Aby umożliwić wykonywanie zapytań do bazy danych w przypadku konkretnego typu źródła danych, użyj metody SpreadsheetApp#enable...Execution().

Powrót

DataSourceSheet – obiekt danych.

Autoryzacja

Skrypty, które korzystają 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

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

Powrót

DataSourceSheet – arkusz źródła danych, który służy do łańcuchowania metod.

Autoryzacja

Skrypty, które korzystają 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 w kolumnie w arkuszu źródła danych.

Parametry

NazwaTypOpis
columnNameStringNazwa kolumny.

Powrót

DataSourceSheet – arkusz źródła danych, który służy do łańcuchowania.

Autoryzacja

Skrypty, które korzystają 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

NazwaTypOpis
columnNameStringNazwa kolumny.
widthIntegerNowa szerokość kolumny.

Powrót

DataSourceSheet – arkusz źródła danych, który służy do łańcuchowania.

Autoryzacja

Skrypty, które korzystają 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ść wskazanych kolumn.

Parametry

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

Powrót

DataSourceSheet – arkusz źródła danych, który służy do łańcuchowania.

Autoryzacja

Skrypty, które korzystają 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

NazwaTypOpis
columnNameStringNazwa kolumny, którą chcesz posortować.
ascendingBooleanJeśli true, posortuj kolumnę w kolejności rosnącej, a jeśli false – w kolejności malejącej.

Powrót

DataSourceSheet – arkusz źródła danych, który służy do łańcuchowania.

Autoryzacja

Skrypty, które korzystają 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

NazwaTypOpis
columnNameStringNazwa kolumny, którą chcesz posortować.
sortOrderSortOrderKolejność sortowania.

Powrót

DataSourceSheet – arkusz źródła danych, który służy do łańcuchowania.

Autoryzacja

Skrypty, które korzystają 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, po czym po upływie podanej liczby sekund kończy działanie. Wyjątek jest zwracany, jeśli wykonanie nie zostało ukończone, gdy upłynął limit czasu, ale nie anuluje wykonania danych.

Parametry

NazwaTypOpis
timeoutInSecondsIntegerCzas oczekiwania na wykonanie danych (w sekundach). Maksymalny czas trwania to 300 sekund.

Powrót

DataExecutionStatus – stan wykonania danych.

Autoryzacja

Skrypty, które korzystają 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