Class DataSourceFormula

ŹródłodanychFormuła

uzyskiwać dostęp do istniejących formuł źródeł danych i je modyfikować; Aby utworzyć nową formułę źródła danych, użyj funkcji Range.setFormula(formula).

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

Metody

MetodaZwracany typKrótki opis
cancelDataRefresh()DataSourceFormulaanuluje odświeżanie danych powiązane z tym obiektem, jeśli jest obecnie uruchomione.
forceRefreshData()DataSourceFormulaOdświeża dane tego obiektu niezależnie od jego bieżącego stanu.
getAnchorCell()RangeZwraca wartość Range, która odpowiada komórce, w której jest zakotwiczona formuła źródła danych.
getDataSource()DataSourcePobiera źródło danych, z którym jest powiązany obiekt.
getDisplayValue()StringZwraca wartość wyświetlania formuły źródła danych.
getFormula()StringZwraca formułę tego źródła danych.
getStatus()DataExecutionStatusPobiera stan wykonania danych obiektu.
refreshData()DataSourceFormulaOdświeża dane obiektu.
setFormula(formula)DataSourceFormulaZaktualizuje formułę.
waitForCompletion(timeoutInSeconds)DataExecutionStatusCzeka na zakończenie bieżącego wykonania, po czym po upływie podanej liczby sekund kończy działanie.

Szczegółowa dokumentacja

cancelDataRefresh()

anuluje odświeżanie danych powiązane z tym obiektem, jeśli jest obecnie uruchomione.

Ten przykład pokazuje, jak anulować odświeżanie formuły.

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

Wyjątek jest zgłaszany, 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().

Powrót

DataSourceFormula – obiekt danych.

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

forceRefreshData()

Odświeża dane tego obiektu niezależnie od jego bieżącego stanu. Więcej informacji znajdziesz w artykule refreshData(). Jeśli chcesz anulować aktualnie wykonywane odświeżanie tego obiektu, zapoznaj się z artykułem cancelDataRefresh().

Wyjątek jest zgłaszany, 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().

Powrót

DataSourceFormula – obiekt danych.

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

getAnchorCell()

Zwraca wartość Range, która odpowiada komórce, w której jest zakotwiczona formuła źródła danych.

Powrót

Range – komórka kotwiczy.

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

getDataSource()

Pobiera źródło danych, z którym jest powiązany obiekt.

Powrót

DataSource – źródło danych.

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

getDisplayValue()

Zwraca wartość wyświetlania formuły źródła danych.

Powrót

String – wyświetlana wartość.

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

getFormula()

Zwraca formułę tego źródła danych.

Powrót

String – formuł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

getStatus()

Pobiera stan wykonania danych obiektu.

Powrót

DataExecutionStatus – stan wykonania danych.

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

refreshData()

Odświeża dane obiektu.

Wyjątek jest rzucany, jeśli aktualny stan to error. Aby zaktualizować specyfikację, użyj DataSource#updateSpec(). Ta metoda jest preferowana w stosunku do forceRefreshData(), ponieważ zapobiega nieoczekiwanym zmianom w źródle danych.

Wyjątek jest zgłaszany, 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().

Powrót

DataSourceFormula – obiekt danych.

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

setFormula(formula)

Zaktualizuje formułę.

Parametry

NazwaTypOpis
formulaStringNowa formuła.

Powrót

DataSourceFormula – formuła źródła danych, która służy do łańcuchowania.

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

waitForCompletion(timeoutInSeconds)

Czeka na zakończenie bieżącego wykonania, po czym po upływie podanej liczby sekund kończy działanie. Wyjątek jest zwracany, jeśli wykonanie nie zostało ukończone, gdy upłynął limit czasu, ale nie anuluje wykonania danych.

Parametry

NazwaTypOpis
timeoutInSecondsIntegerCzas oczekiwania na wykonanie danych (w sekundach). Maksymalny czas trwania to 300 sekund.

Powrót

DataExecutionStatus – stan wykonania danych.

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