Class DataSourceFormula

DatenQuelleFormel

Auf vorhandene Datenquellenformeln zugreifen und diese ändern Verwenden Sie Range.setFormula(formula), um eine neue Datenquellenformel zu erstellen.

Verwenden Sie diese Klasse nur mit Daten, die mit einer BigQuery-Datenbank verbunden sind.

Methoden

MethodeRückgabetypKurzbeschreibung
cancelDataRefresh()DataSourceFormulaBricht die Datenaktualisierung für dieses Objekt ab, falls sie gerade ausgeführt wird.
forceRefreshData()DataSourceFormulaDie Daten dieses Objekts werden unabhängig vom aktuellen Status aktualisiert.
getAnchorCell()RangeGibt die Range zurück, die die Zelle darstellt, an die diese Datenquellenformel angedockt ist.
getDataSource()DataSourceRuft die Datenquelle ab, mit der das Objekt verknüpft ist.
getDisplayValue()StringGibt den Anzeigewert der Datenquellenformel zurück.
getFormula()StringGibt die Formel für diese Datenquellenformel zurück.
getStatus()DataExecutionStatusRuft den Status der Datenausführung des Objekts ab.
refreshData()DataSourceFormulaAktualisiert die Daten des Objekts.
setFormula(formula)DataSourceFormulaDie Formel wird aktualisiert.
waitForCompletion(timeoutInSeconds)DataExecutionStatusEs wird gewartet, bis die aktuelle Ausführung abgeschlossen ist. Nach der angegebenen Anzahl von Sekunden kommt es zu einer Zeitüberschreitung.

Detaillierte Dokumentation

cancelDataRefresh()

Bricht die Datenaktualisierung für dieses Objekt ab, falls sie gerade ausgeführt wird.

In diesem Beispiel wird gezeigt, wie Sie die Aktualisierung einer Formel abbrechen. 

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

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Mit SpreadsheetApp#enable...Execution()-Methoden können Sie die Datenausführung für einen bestimmten Datenquellentyp aktivieren.

Rückflug

DataSourceFormula: Das Datenobjekt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

forceRefreshData()

Die Daten dieses Objekts werden unabhängig vom aktuellen Status aktualisiert. Weitere Informationen finden Sie unter refreshData(). Informationen zum Abbrechen einer aktuell laufenden Aktualisierung dieses Objekts finden Sie unter cancelDataRefresh().

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Mit SpreadsheetApp#enable...Execution()-Methoden können Sie die Datenausführung für einen bestimmten Datenquellentyp aktivieren.

Rückflug

DataSourceFormula: Das Datenobjekt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getAnchorCell()

Gibt die Range zurück, die die Zelle darstellt, an die diese Datenquellenformel angedockt ist.

Rückflug

Range: Die Ankerzelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getDataSource()

Ruft die Datenquelle ab, mit der das Objekt verknüpft ist.

Rückflug

DataSource: Datenquelle

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getDisplayValue()

Gibt den Anzeigewert der Datenquellenformel zurück.

Rückflug

String: Der angezeigte Wert.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getFormula()

Gibt die Formel für diese Datenquellenformel zurück.

Rückflug

String – Die Formel.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getStatus()

Ruft den Status der Datenausführung des Objekts ab.

Rückflug

DataExecutionStatus: Der Status der Datenausführung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

refreshData()

Aktualisiert die Daten des Objekts.

Eine Ausnahme wird geworfen, wenn der aktuelle Status error ist. Verwenden Sie DataSource#updateSpec(), um die Spezifikation zu aktualisieren. Diese Methode wird gegenüber forceRefreshData() bevorzugt, um unerwartete Änderungen an der Datenquelle zu verhindern.

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Mit SpreadsheetApp#enable...Execution()-Methoden können Sie die Datenausführung für einen bestimmten Datenquellentyp aktivieren.

Rückflug

DataSourceFormula: Das Datenobjekt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setFormula(formula)

Die Formel wird aktualisiert.

Parameter

NameTypBeschreibung
formulaStringDie neue Formel.

Rückflug

DataSourceFormula: Datenquellenformel für die Verknüpfung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

waitForCompletion(timeoutInSeconds)

Es wird gewartet, bis die aktuelle Ausführung abgeschlossen ist. Nach der angegebenen Anzahl von Sekunden kommt es zu einer Zeitüberschreitung. Löst eine Ausnahme aus, wenn die Ausführung bei einer Zeitüberschreitung nicht abgeschlossen ist, bricht die Datenausführung aber nicht ab.

Parameter

NameTypBeschreibung
timeoutInSecondsIntegerDie Zeit in Sekunden, die auf die Ausführung der Daten gewartet werden soll. Das Maximum beträgt 300 Sekunden.

Rückflug

DataExecutionStatus: Der Status der Datenausführung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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