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, przeczytaj sekcję DataSourceTable.

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

Metody

MetodaTyp zwracanej wartościKrótki opis
cancelAllLinkedDataSourceObjectRefreshes()voidAnuluje wszystkie aktualnie uruchomione odświeżenia 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 z tego ź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)DataSourceColumnZwraca obliczoną kolumnę w źródle danych odpowiadającą 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ó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 o nową specyfikację.
updateSpec(spec, refreshAllLinkedObjects)DataSourceAktualizuje specyfikację źródła danych i odświeża link data source sheets o nową specyfikację.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidCzeka na zakończenie wszystkich bieżących wykonań połączonych obiektów źródła danych. Limit czasu jest przekroczony po podanej liczbie sekund.

Szczegółowa dokumentacja

cancelAllLinkedDataSourceObjectRefreshes()

Anuluje wszystkie aktualnie uruchomione odświeżenia 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();

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 na podstawie określonego typu ź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

createCalculatedColumn(name, formula)

Tworzy obliczoną kolumnę.

Parametry

NazwaTypOpis
nameStringNazwa obliczonej kolumny.
formulaStringFormuła obliczonej kolumny.

Powroty

DataSourceColumn – nowo utworzona obliczona kolumna.

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

createDataSourcePivotTableOnNewSheet()

Tworzy tabelę przestawną źródła danych z tego źródła danych w pierwszej komórce nowego arkusza. Efektem ubocznym jest ustawienie nowego arkusza w aktywny.

Powroty

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

createDataSourceTableOnNewSheet()

Tworzy tabelę źródła danych z tego źródła danych w pierwszej komórce nowego arkusza. Efektem ubocznym jest ustawienie nowego arkusza w aktywny.

Powroty

DataSourceTable – nowo utworzona tabela źródeł 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

getCalculatedColumnByName(columnName)

Zwraca obliczoną kolumnę w źródle danych odpowiadającą nazwie kolumny.

Parametry

NazwaTypOpis
columnNameStringNazwa obliczonej kolumny do uzyskania.

Powroty

DataSourceColumn – obliczona kolumna zgodna z nazwą kolumny lub null, jeśli nie ma takiej obliczonej kolumny.

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

getCalculatedColumns()

Zwraca wszystkie obliczone kolumny w źródle danych.

Powroty

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

getColumns()

Zwraca wszystkie kolumny w źródle danych.

Powroty

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

getDataSourceSheets()

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

Powroty

DataSourceSheet[] – tablica arkuszy źródeł 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

getSpec()

Pobiera specyfikację źródła danych.

Powroty

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

refreshAllLinkedDataSourceObjects()

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

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 o nową specyfikację.

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 na podstawie określonego typu źródła danych.

Parametry

NazwaTypOpis
specDataSourceSpecSpecyfikacja źródła danych, którą należy zaktualizować.

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

updateSpec(spec, refreshAllLinkedObjects)

Aktualizuje specyfikację źródła danych i odświeża link data source sheets o nową specyfikację.

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 na podstawie określonego typu źródła danych.

Parametry

NazwaTypOpis
specDataSourceSpecSpecyfikacja źródła danych, którą należy zaktualizować.
refreshAllLinkedObjectsBooleanJeśli true, odświeża też wszystkie obiekty źródła danych połączone z tym źródłem danych.

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Czeka na zakończenie wszystkich bieżących wykonań połączonych obiektów źródła danych. Limit czasu jest przekroczony po podanej liczbie sekund. Zgłasza wyjątek, jeśli wykonania nie zostaną ukończone w momencie przekroczenia limitu czasu, ale nie anuluje wykonania danych.

Parametry

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

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