Class DataSourceFormula

DataSourceFormula

Auf vorhandene Datenquellenformeln zugreifen und diese ändern Wenn Sie eine neue Formel für eine Datenquelle erstellen möchten, verwenden Sie Range.setFormula(formula).

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

Methoden

MethodeRückgabetypKurzbeschreibung
cancelDataRefresh()DataSourceFormulaBricht die Datenaktualisierung ab, die mit diesem Objekt verknüpft ist, falls sie gerade ausgeführt wird.
forceRefreshData()DataSourceFormulaAktualisiert die Daten dieses Objekts unabhängig vom aktuellen Status.
getAnchorCell()RangeGibt die Range zurück, die die Zelle darstellt, in der diese Datenquellenformel verankert ist.
getDataSource()DataSourceRuft die Datenquelle ab, mit der das Objekt verknüpft ist.
getDisplayValue()StringGibt den Anzeigenamen 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)DataSourceFormulaAktualisiert die Formel.
waitForCompletion(timeoutInSeconds)DataExecutionStatusWartet, bis die aktuelle Ausführung abgeschlossen ist. Es kommt nach der angegebenen Anzahl von Sekunden zu einer Zeitüberschreitung.

Detaillierte Dokumentation

cancelDataRefresh()

Bricht die Datenaktualisierung ab, die mit diesem Objekt verknüpft ist, falls sie gerade ausgeführt wird.

In diesem Beispiel wird gezeigt, wie Sie das Aktualisieren 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 Datenabfrage für einen bestimmten Datenquelltyp aktivieren.

Rückflug

DataSourceFormula: Das Datenobjekt.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

forceRefreshData()

Aktualisiert die Daten dieses Objekts unabhängig vom aktuellen Status. Weitere Informationen finden Sie unter refreshData(). Wenn Sie eine aktuell laufende Aktualisierung dieses Objekts abbrechen möchten, lesen Sie cancelDataRefresh().

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

Rückflug

DataSourceFormula: Das Datenobjekt.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getAnchorCell()

Gibt die Range zurück, die die Zelle darstellt, in der diese Datenquellenformel verankert ist.

Rückflug

Range – Die Ankerzelle.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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: Die Datenquelle.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getDisplayValue()

Gibt den Anzeigenamen der Datenquellenformel zurück.

Rückflug

String: Der Anzeigewert.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

refreshData()

Aktualisiert die Daten des Objekts.

Löst eine Ausnahme aus, wenn sich die Instanz derzeit im Status error befindet. Verwenden Sie DataSource#updateSpec(), um die Spezifikation zu aktualisieren. Die 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 Datenabfrage für einen bestimmten Datenquelltyp aktivieren.

Rückflug

DataSourceFormula: Das Datenobjekt.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setFormula(formula)

Aktualisiert die Formel.

Parameter

NameTypBeschreibung
formulaStringDie neue Formel.

Rückflug

DataSourceFormula: Die Datenquellenformel für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

waitForCompletion(timeoutInSeconds)

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

Parameter

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

Rückflug

DataExecutionStatus: Der Status der Datenausführung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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