Class DataSourceSheet

DataSourceSheet

uzyskiwać dostęp do istniejącego arkusza źródła danych i je modyfikować; Aby utworzyć nowy arkusz źródła danych, użyj funkcji Spreadsheet.insertDataSourceSheet(spec).

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

Metody

MetodaTyp zwracanej wartościKró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ść określonych kolumn.
cancelDataRefresh()DataSourceSheetAnuluje odświeżanie danych powiązane z tym obiektem, jeśli jest aktualnie uruchomiony.
forceRefreshData()DataSourceSheetOdświeża dane tego obiektu niezależnie od bieżącego stanu.
getColumnWidth(columnName)IntegerZwraca szerokość określonej kolumny.
getDataSource()DataSourcePobiera ź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 z podanego wiersza początkowego (-1) do podanej wartości 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 z kolumny 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 dla kolumny w arkuszu źródła danych.
setSortSpec(columnName, sortOrder)DataSourceSheetUstawia specyfikację sortowania dla kolumny w arkuszu źródła danych.
waitForCompletion(timeoutInSeconds)DataExecutionStatusCzeka na zakończenie bieżącego wykonania, a limit czasu oczekiwania po określonej liczbie sekund zostanie przekroczony.

Szczegółowa dokumentacja

addFilter(columnName, filterCriteria)

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

Parametry

NazwaTypOpis
columnNameStringNazwa kolumny, do której chcesz zastosować ten filtr.
filterCriteriaFilterCriteriaKryteria 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()

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

Powroty

Sheet – zwykły arkusz.

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

autoResizeColumn(columnName)

Automatycznie zmienia szerokość określonej kolumny.

Parametry

NazwaTypOpis
columnNameStringNazwa kolumny.

Powroty

DataSourceSheet – ten 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

NazwaTypOpis
columnNamesString[]Lista nazw kolumn do zaktualizowania.

Powroty

DataSourceSheet – ten 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

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

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

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

NazwaTypOpis
columnNameStringNazwa kolumny.

Powroty

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

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 do arkusza ź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

NazwaTypOpis
columnNameStringNazwa kolumny źródła danych, dla 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 z podanego wiersza początkowego (-1) do podanej wartości numRows.

Parametry

NazwaTypOpis
columnNameStringNazwa kolumny źródła danych, dla której mają zostać pobrane wartości.
startRowIntegerPozycja wiersza, od której należy rozpocząć pobieranie wartości.
numRowsIntegerLiczba 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 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

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

NazwaTypOpis
columnNameStringNazwa kolumny, z której chcesz usunąć 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

NazwaTypOpis
columnNameStringNazwa 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

NazwaTypOpis
columnNameStringNazwa kolumny.
widthIntegerNowa szerokość kolumny.

Powroty

DataSourceSheet – ten 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

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

Powroty

DataSourceSheet – ten 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 dla kolumny w arkuszu źródła danych.

Parametry

NazwaTypOpis
columnNameStringNazwa kolumny do sortowania.
ascendingBooleanJeś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 dla kolumny w arkuszu źródła danych.

Parametry

NazwaTypOpis
columnNameStringNazwa kolumny do sortowania.
sortOrderSortOrderkolejność 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, 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

NazwaTypOpis
timeoutInSecondsIntegerCzas 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