Class DataSource

DataSource

Auf vorhandene Datenquellen zugreifen und sie ändern. Informationen zum Erstellen einer Datenquellentabelle mit einer neuen Datenquelle finden Sie unter DataSourceTable.

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

Methoden

MethodeRückgabetypKurzbeschreibung
cancelAllLinkedDataSourceObjectRefreshes()voidBricht alle aktuell ausgeführten Aktualisierungen von Datenquellenobjekten ab, die mit dieser Datenquelle verknüpft sind.
createCalculatedColumn(name, formula)DataSourceColumnErstellt eine berechnete Spalte.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableErstellt eine Pivot-Tabelle für die Datenquelle aus dieser Datenquelle in der ersten Zelle eines neuen Tabellenblatts.
createDataSourceTableOnNewSheet()DataSourceTableErstellt eine Datenquellentabelle aus dieser Datenquelle in der ersten Zelle eines neuen Tabellenblatts.
getCalculatedColumnByName(columnName)DataSourceColumnGibt die berechnete Spalte in der Datenquelle zurück, die mit dem Spaltennamen übereinstimmt.
getCalculatedColumns()DataSourceColumn[]Gibt alle berechneten Spalten in der Datenquelle zurück.
getColumns()DataSourceColumn[]Gibt alle Spalten in der Datenquelle zurück.
getDataSourceSheets()DataSourceSheet[]Gibt die Datenquellentabellenblätter zurück, die mit dieser Datenquelle verknüpft sind.
getSpec()DataSourceSpecRuft die Datenquellenspezifikation ab.
refreshAllLinkedDataSourceObjects()voidAktualisiert alle Datenquellenobjekte, die mit der Datenquelle verknüpft sind.
updateSpec(spec)DataSourceAktualisiert die Datenquellenspezifikation und aktualisiert die damit verknüpften Datenquellenobjekte Datenquelle mit der neuen Spezifikation.
updateSpec(spec, refreshAllLinkedObjects)DataSourceAktualisiert die Datenquellenspezifikation und aktualisiert die verknüpfte data source sheets mit der neuen Spezifikation.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidWartet, bis alle aktuellen Ausführungen der verknüpften Datenquellenobjekte abgeschlossen sind (Zeitüberschreitung) nach der angegebenen Anzahl von Sekunden.

Detaillierte Dokumentation

cancelAllLinkedDataSourceObjectRefreshes()

Bricht alle aktuell ausgeführten Aktualisierungen von Datenquellenobjekten ab, die mit dieser Datenquelle verknüpft sind.

In diesem Beispiel wird gezeigt, wie Sie alle Aktualisierungen einer Datenquelle abbrechen. 

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

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. SpreadsheetApp#enable...Execution()-Methoden verwenden, um die Datenausführung für die spezifischen Daten zu aktivieren Quelltyp.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

createCalculatedColumn(name, formula)

Erstellt eine berechnete Spalte. Diese Methode ist nur für BigQuery-Datenquellen verfügbar.

Parameter

NameTypBeschreibung
nameStringDer Name der berechneten Spalte.
formulaStringDie Formel für berechnete Spalten.

Rückflug

DataSourceColumn: Die neu erstellte berechnete Spalte.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

createDataSourcePivotTableOnNewSheet()

Hiermit wird in der ersten Zelle eines neuen Tabellenblatts eine Pivot-Tabelle für die Datenquelle erstellt. Als wird das neue Tabellenblatt zum aktiven Blatt.

Rückflug

DataSourcePivotTable: Die neu erstellte Pivot-Tabelle der Datenquelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

createDataSourceTableOnNewSheet()

Erstellt eine Datenquellentabelle aus dieser Datenquelle in der ersten Zelle eines neuen Tabellenblatts. Als Nebeneffekt wird die neue Tabelle zur aktiven Tabelle.

Diese Methode ist nur für BigQuery-Datenquellen verfügbar.

Rückflug

DataSourceTable: Die neu erstellte Datenquellentabelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getCalculatedColumnByName(columnName)

Gibt die berechnete Spalte in der Datenquelle zurück, die mit dem Spaltennamen übereinstimmt.

Parameter

NameTypBeschreibung
columnNameStringDer Name der berechneten Spalte, die abgerufen werden soll.

Rückflug

DataSourceColumn: die berechnete Spalte, die mit dem Spaltennamen übereinstimmt, oder null, wenn kein solcher Spaltenname vorhanden ist berechnet.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getCalculatedColumns()

Gibt alle berechneten Spalten in der Datenquelle zurück.

Bei den Datenquellenspezifikationen vom Typ DataSourceType.LOOKER wird ein leeres Array zurückgegeben.

Rückflug

DataSourceColumn[]: Ein Array aller berechneten Spalten in der Datenquelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getColumns()

Gibt alle Spalten in der Datenquelle zurück.

Rückflug

DataSourceColumn[]: Ein Array aller DataSourceColumn in der Datenquelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getDataSourceSheets()

Gibt die Datenquellentabellenblätter zurück, die mit dieser Datenquelle verknüpft sind.

Rückflug

DataSourceSheet[]: Ein Array von Datenquellentabellen.

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

getSpec()

Ruft die Datenquellenspezifikation ab.

Rückflug

DataSourceSpec: Datenquellenspezifikation.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

refreshAllLinkedDataSourceObjects()

Aktualisiert alle Datenquellenobjekte, die mit der Datenquelle verknüpft sind.

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. SpreadsheetApp#enable...Execution()-Methoden verwenden, um die Datenausführung für die spezifischen Daten zu aktivieren Quelltyp.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

updateSpec(spec)

Aktualisiert die Datenquellenspezifikation und aktualisiert die damit verknüpften Datenquellenobjekte Datenquelle mit der neuen Spezifikation.

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. SpreadsheetApp#enable...Execution()-Methoden verwenden, um die Datenausführung für die spezifischen Daten zu aktivieren Quelltyp.

Löst eine Ausnahme aus, wenn der Typ der Datenquellenspezifikation nicht vom Typ aktuellen Datenquellentyp.

Parameter

NameTypBeschreibung
specDataSourceSpecDie Datenquellenspezifikation, mit der aktualisiert werden soll.

Rückflug

DataSource: Die Datenquelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

updateSpec(spec, refreshAllLinkedObjects)

Aktualisiert die Datenquellenspezifikation und aktualisiert die verknüpfte data source sheets mit der neuen Spezifikation.

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. SpreadsheetApp#enable...Execution()-Methoden verwenden, um die Datenausführung für die spezifischen Daten zu aktivieren Quelltyp.

Löst eine Ausnahme aus, wenn der Typ der Datenquellenspezifikation nicht vom Typ aktuellen Datenquellentyp.

Parameter

NameTypBeschreibung
specDataSourceSpecDie Datenquellenspezifikation, mit der die Daten aktualisiert werden sollen.
refreshAllLinkedObjectsBooleanBei true werden auch alle Datenquellenobjekte aktualisiert. die mit dieser Datenquelle verknüpft sind.

Rückflug

DataSource: Die Datenquelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Wartet, bis alle aktuellen Ausführungen der verknüpften Datenquellenobjekte abgeschlossen sind (Zeitüberschreitung) nach der angegebenen Anzahl von Sekunden. Löst eine Ausnahme aus, wenn die Ausführungen nicht abgeschlossen sind wenn das Zeitlimit überschritten wird. Die Datenausführungen werden jedoch nicht abgebrochen.

Parameter

NameTypBeschreibung
timeoutInSecondsIntegerDie Zeit, die auf Datenausführungen gewartet werden soll, in Sekunden. Maximal sind 300 zulässig Sekunden.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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