Class DataSource

Źródłodanych

Dostęp do istniejącego źródła danych i jego modyfikowanie. Aby utworzyć tabelę źródła danych z nowym źródłem danych, zapoznaj się z tym artykułem:DataSourceTable

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

Metody

MetodaZwracany typKrótki opis
cancelAllLinkedDataSourceObjectRefreshes()voidAnuluje wszystkie aktualnie działające odświeżania obiektów źródła danych połączonych z tym źródłem danych.
createCalculatedColumn(name, formula)DataSourceColumnTworzy obliczoną kolumnę.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableTworzy tabelę przestawną źródła danych w pierwszej komórce nowego arkusza.
createDataSourceTableOnNewSheet()DataSourceTableTworzy tabelę źródła danych z tego źródła danych w pierwszej komórce nowego arkusza.
getCalculatedColumnByName(columnName)DataSourceColumn|nullZwraca obliczoną kolumnę w źródle danych, która pasuje do nazwy kolumny.
getCalculatedColumns()DataSourceColumn[]Zwraca wszystkie kolumny obliczone w źródle danych.
getColumns()DataSourceColumn[]Zwraca wszystkie kolumny w źródle danych.
getDataSourceSheets()DataSourceSheet[]Zwraca arkusze źródła danych powiązane z tym źródłem danych.
getSpec()DataSourceSpecPobiera specyfikację źródła danych.
refreshAllLinkedDataSourceObjects()voidOdświeża wszystkie obiekty źródła danych połączone ze źródłem danych.
updateSpec(spec)DataSourceAktualizuje specyfikację źródła danych i odświeża obiekty źródła danych połączone z tym źródłem danych za pomocą nowej specyfikacji.
updateSpec(spec, refreshAllLinkedObjects)DataSourceAktualizuje specyfikację źródła danych i odświeża połączony z nią plik data source sheets, używając nowej specyfikacji.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidCzeka, aż wszystkie bieżące wykonania obiektów połączonego źródła danych zostaną ukończone. Po upływie podanej liczby sekund następuje przekroczenie limitu czasu.

Szczegółowa dokumentacja

cancelAllLinkedDataSourceObjectRefreshes()

Anuluje wszystkie aktualnie działające odświeżania obiektów źródła danych połączonych z tym źródłem danych.

Ten przykład pokazuje, jak anulować wszystkie odświeżania źródła danych. 

SpreadsheetApp.enableBigQueryExecution();
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const dataSource = spreadsheet.getDataSources()[0];
dataSource.cancelAllLinkedDataSourceObjectRefreshes();

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.

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

createCalculatedColumn(name, formula)

Tworzy obliczoną kolumnę. Ta metoda jest dostępna tylko w przypadku źródeł danych BigQuery.

Parametry

NazwaTypOpis
nameStringNazwa obliczonej kolumny.
formulaStringFormuła obliczonej kolumny.

Powrót

DataSourceColumn – nowo utworzona obliczona kolumna.

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

createDataSourcePivotTableOnNewSheet()

Tworzy tabelę przestawną źródła danych w pierwszej komórce nowego arkusza. W efekcie nowy arkusz staje się aktywny.

Powrót

DataSourcePivotTable – nowo utworzona tabela przestawna ź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

createDataSourceTableOnNewSheet()

Tworzy tabelę źródła danych z tego źródła danych w pierwszej komórce nowego arkusza. Przy okazji sprawia, że nowy arkusz staje się aktywny.

Ta metoda jest dostępna tylko w przypadku źródeł danych BigQuery.

Powrót

DataSourceTable – nowo utworzona tabela ź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

getCalculatedColumnByName(columnName)

Zwraca obliczoną kolumnę w źródle danych, która pasuje do nazwy kolumny.

Parametry

NazwaTypOpis
columnNameStringNazwa obliczonej kolumny do pobrania.

Powrót

DataSourceColumn|null – obliczona kolumna, która pasuje do nazwy kolumny, lub null, jeśli nie ma takiej obliczonej kolumny.

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

getCalculatedColumns()

Zwraca wszystkie kolumny obliczone w źródle danych.

Specyfikacje źródła danych typu DataSourceType.LOOKER zwracają pustą tablicę.

Powrót

DataSourceColumn[] – tablica wszystkich obliczonych kolumn w źródle 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

getColumns()

Zwraca wszystkie kolumny w źródle danych.

Powrót

DataSourceColumn[] – tablica wszystkich DataSourceColumn w źródle 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

getDataSourceSheets()

Zwraca arkusze źródła danych powiązane z tym źródłem danych.

Powrót

DataSourceSheet[] – tablica arkuszy ź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

getSpec()

Pobiera specyfikację źródła danych.

Powrót

DataSourceSpec – specyfikacja ź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

refreshAllLinkedDataSourceObjects()

Odświeża wszystkie obiekty źródła danych połączone ze źródłem 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.

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

updateSpec(spec)

Aktualizuje specyfikację źródła danych i odświeża obiekty źródła danych połączone z tym źródłem danych za pomocą nowej specyfikacji.

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.

Zgłasza wyjątek, jeśli typ specyfikacji źródła danych jest inny niż typ bieżącego źródła danych.

Parametry

NazwaTypOpis
specDataSourceSpecSpecyfikacja źródła danych do zaktualizowania.

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

updateSpec(spec, refreshAllLinkedObjects)

Aktualizuje specyfikację źródła danych i odświeża połączony z nią plik data source sheets, używając nowej specyfikacji.

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.

Zgłasza wyjątek, jeśli typ specyfikacji źródła danych jest inny niż typ bieżącego źródła danych.

Parametry

NazwaTypOpis
specDataSourceSpecSpecyfikacja źródła danych do zaktualizowania.
refreshAllLinkedObjectsBooleanJeśli true, odświeża też wszystkie obiekty źródła danych połączone z tym źródłem danych.

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Czeka, aż wszystkie bieżące wykonania obiektów połączonego źródła danych zostaną ukończone. Po upływie podanej liczby sekund następuje przekroczenie limitu czasu. Wyrzuca wyjątek, jeśli wykonania nie zostaną 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.

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