Class DataSourceSheet

Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Arkusz źródłowy

Otwierać i modyfikować istniejące arkusze źródeł danych. Aby utworzyć nowy arkusz źródła danych, użyj Spreadsheet.insertDataSourceSheet(spec).

tej klasy używaj tylko z danymi połączonymi z bazą danych.

Metody

MetodaZwracany typKrótki opis
addFilter(columnName, filterCriteria)DataSourceSheetDodaje filtr zastosowany do arkusza źródeł danych.
asSheet()SheetZwraca arkusz źródła danych jako obiekt zwykłego arkusza.
autoResizeColumn(columnName)DataSourceSheetAutomatycznie zmienia szerokość określonej kolumny.
autoResizeColumns(columnNames)DataSourceSheetAutomatycznie zmienia szerokość określonych kolumn.
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 obiekt jest połączony.
getFilters()DataSourceSheetFilter[]Zwraca wszystkie filtry zastosowane do arkusza źródła danych.
getSheetValues(columnName)Object[]Zwraca wszystkie wartości dla arkusza źródła danych dla podanej nazwy kolumny.
getSheetValues(columnName, startRow, numRows)Object[]Zwraca wszystkie wartości dla arkusza źródła danych dla podanej nazwy kolumny z podanego wiersza początkowego (na podstawie 1) i dla podanego numRows.
getSortSpecs()SortSpec[]Pobiera wszystkie specyfikacje sortowania w arkuszu ź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 kolumnę 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)DataExecutionStatusPowoduje, że bieżące wykonanie zostanie zakończone po upływie określonej liczby sekund.

Szczegółowa dokumentacja

addFilter(columnName, filterCriteria)

Dodaje filtr zastosowany do arkusza źródeł danych.

Parametry

NazwaTypOpis
columnNameStringNazwa kolumny, do której chcesz zastosować ten filtr.
filterCriteriaFilterCriteriaKryteria filtrowania, które mają zostać zastosowane.

Zwróć

DataSourceSheet – arkusz źródeł danych używany w łańcuchach metod.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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 obiekt zwykłego arkusza.

Zwróć

Sheet – arkusz zwykły.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

Zwróć

DataSourceSheet – ten arkusz źródeł danych na potrzeby łańcucha.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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ść określonych kolumn.

Parametry

NazwaTypOpis
columnNamesString[]Lista nazw kolumn do zaktualizowania.

Zwróć

DataSourceSheet – ten arkusz źródeł danych na potrzeby łańcucha.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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 bieżącego stanu. Więcej informacji: refreshData().

Zwraca wyjątek, jeśli typ źródła danych nie jest włączony. Użyj metod SpreadsheetApp#enable...Execution(), aby włączyć wykonywanie danych dla określonego typu źródła danych.

Zwróć

DataSourceSheet – obiekt danych;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

Zwróć

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

Autoryzacja

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

Zwróć

DataSource – źródło danych,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

Zwróć

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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 dla arkusza źródła danych dla podanej nazwy kolumny.

Parametry

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

Zwróć

Object[] – jednowymiarowy tablica wartości.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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 dla arkusza źródła danych dla podanej nazwy kolumny z podanego wiersza początkowego (na podstawie 1) i dla podanego numRows.

Parametry

NazwaTypOpis
columnNameStringNazwa kolumny źródła danych, z której wartości mają zostać pobrane.
startRowIntegerPozycja wiersza, z którego chcesz zacząć pobierać wartości.
numRowsIntegerLiczba wierszy do pobrania.

Zwróć

Object[] – jednowymiarowy tablica wartości.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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 w arkuszu źródła danych.

Zwróć

SortSpec[] – lista specyfikacji sortowania.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

Zwróć

DataExecutionStatus – stan wykonania danych.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

Zwraca wyjątek, jeśli obecnie jest w stanie error. Użyj DataSource#updateSpec(), aby zaktualizować specyfikację. Ta metoda jest preferowana zamiast forceRefreshData(), aby zapobiec nieoczekiwanym zmianom w źródle danych.

Zwraca wyjątek, jeśli typ źródła danych nie jest włączony. Użyj metod SpreadsheetApp#enable...Execution(), aby włączyć wykonywanie danych dla określonego typu źródła danych.

Zwróć

DataSourceSheet – obiekt danych;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

Zwróć

DataSourceSheet – arkusz źródeł danych używany w łańcuchach metod.

Autoryzacja

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

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

removeSortSpec(columnName)

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

Parametry

NazwaTypOpis
columnNameStringNazwa kolumny.

Zwróć

DataSourceSheet – arkusz źródeł danych na potrzeby łańcucha.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

Zwróć

DataSourceSheet – ten arkusz źródeł danych na potrzeby łańcucha.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

Zwróć

DataSourceSheet – ten arkusz źródeł danych na potrzeby łańcucha.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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, którą chcesz posortować.
ascendingBooleanJeśli true, sortuj kolumnę w kolejności malejącej. Jeśli false ma być posortowana w kolejności malejącej.

Zwróć

DataSourceSheet – arkusz źródeł danych na potrzeby łańcucha.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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, którą chcesz posortować.
sortOrderSortOrderKolejność sortowania.

Zwróć

DataSourceSheet – arkusz źródeł danych na potrzeby łańcucha.

Autoryzacja

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

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

waitForCompletion(timeoutInSeconds)

Powoduje, że bieżące wykonanie zostanie zakończone po upływie określonej liczby sekund. Zwraca wyjątek, jeśli wykonanie zadania nie zostanie zakończone, ale nie anuluje jego wykonania.

Parametry

NazwaTypOpis
timeoutInSecondsIntegerCzas oczekiwania na wykonanie danych (w sekundach). Maksymalna długość to 300 sekund.

Zwróć

DataExecutionStatus – stan wykonania danych.

Autoryzacja

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

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