Class DataSource

DataSource

uzyskiwać dostęp do istniejącego źródła danych i je modyfikować; Aby utworzyć tabelę źródła danych z nowym źródłem danych, zapoznaj się z artykułem DataSourceTable.

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

Metody

MetodaZwracany typKrótki opis
cancelAllLinkedDataSourceObjectRefreshes()voidAnuluje wszystkie trwające obecnie odświeżanie 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 na podstawie tego źródła danych w pierwszej komórce nowego arkusza.
createDataSourceTableOnNewSheet()DataSourceTableTworzy tabelę źródła danych na podstawie tego źródła danych w pierwszej komórce nowego arkusza.
getCalculatedColumnByName(columnName)DataSourceColumnZwraca obliczoną kolumnę w źródle danych, która odpowiada nazwie kolumny.
getCalculatedColumns()DataSourceColumn[]Zwraca wszystkie obliczone kolumny w źródle danych.
getColumns()DataSourceColumn[]Zwraca wszystkie kolumny w źródle danych.
getDataSourceSheets()DataSourceSheet[]Zwraca arkusze źródeł 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 połączone z nią obiekty źródła danych zgodnie z nową specyfikacją.
updateSpec(spec, refreshAllLinkedObjects)DataSourceAktualizuje specyfikację źródła danych i odświeża połączone data source sheets zgodnie z nową specyfikacją.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidCzeka na zakończenie wszystkich bieżących działań obiektów połączonych źródeł danych. Po upływie podanej liczby sekund następuje przekroczenie limitu czasu.

Szczegółowa dokumentacja

cancelAllLinkedDataSourceObjectRefreshes()

Anuluje wszystkie trwające obecnie odświeżanie obiektów źródła danych połączonych z tym źródłem danych.

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

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

Wyjątek jest zgłaszany, jeśli typ źródła danych nie jest włączony. Użyj metod SpreadsheetApp#enable...Execution(), aby włączyć wykonywanie związanych z danymi danych typu źródła.

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

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 co najmniej jednym 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 na podstawie tego źródła danych w pierwszej komórce nowego arkusza. Jako efekt uboczny sprawia, że nowy arkusz staje się aktywnym arkuszem.

Powrót

DataSourcePivotTable – nowo utworzona tabela przestawna źródła danych.

Autoryzacja

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

createDataSourceTableOnNewSheet()

Tworzy tabelę źródła danych na podstawie tego źródła danych w pierwszej komórce nowego arkusza. Jako strona sprawia, że nowy arkusz staje się arkuszem aktywnym.

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

Powrót

DataSourceTable – nowo utworzona tabela źródeł danych.

Autoryzacja

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

getCalculatedColumnByName(columnName)

Zwraca obliczoną kolumnę w źródle danych, która odpowiada nazwie kolumny.

Parametry

NazwaTypOpis
columnNameStringNazwa obliczonej kolumny, która ma zostać pobrana.

Powrót

DataSourceColumn – obliczona kolumna pasująca do nazwy kolumny lub null, jeśli jej nie ma obliczonej kolumny.

Autoryzacja

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

getCalculatedColumns()

Zwraca wszystkie kolumny obliczeniowe w źródle danych.

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

Powrót

DataSourceColumn[] – tablica wszystkich obliczonych kolumn w źródle danych.

Autoryzacja

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

getColumns()

Zwraca wszystkie kolumny ze źródła danych.

Powrót

DataSourceColumn[] – tablica wszystkich elementów DataSourceColumn w źródle danych.

Autoryzacja

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

getDataSourceSheets()

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

Powrót

DataSourceSheet[] – tablice źródła danych.

Autoryzacja

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

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 co najmniej jednym 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 włączyć wykonywanie związanych z danymi danych typu źródła.

Autoryzacja

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

updateSpec(spec)

Aktualizuje specyfikację źródła danych i odświeża połączone z nią obiekty źródła danych zgodnie z nową specyfikacją.

Zgłasza wyjątek, jeśli typ źródła danych nie jest włączony. Użyj metod SpreadsheetApp#enable...Execution(), aby włączyć wykonywanie związanych z danymi danych typu źródła.

Wyjątek jest zgłaszany, 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, która ma zostać zaktualizowana.

Powrót

DataSource – źródło danych.

Autoryzacja

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

updateSpec(spec, refreshAllLinkedObjects)

Aktualizuje specyfikację źródła danych i odświeża połączone data source sheets zgodnie z nową specyfikacją.

Zgłasza wyjątek, 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().

Wyjątek jest zgłaszany, 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, która ma zostać zaktualizowana.
refreshAllLinkedObjectsBooleanJeśli ustawiona jest wartość true, powoduje też odświeżenie wszystkich obiektów ź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 co najmniej jednym z tych zakresów:

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Oczekiwanie na zakończenie wszystkich bieżących wykonań połączonych obiektów źródła danych, przekroczenie limitu czasu po podanej liczbie sekund. Zgłasza wyjątek, jeśli wykonania nie zostaną ukończone gdy limit czasu zostanie przekroczony, ale nie anuluje uruchomień związanych z danymi.

Parametry

NazwaTypOpis
timeoutInSecondsIntegerCzas oczekiwania na uruchomienia danych (w sekundach). Maksymalna liczba to 300 sek.

Autoryzacja

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