Auf vorhandene Datenquellentabelle zugreifen und sie bearbeiten. Um eine neue Datenquellentabelle
auf einem neuen Tabellenblatt zu erstellen,
Spreadsheet.insertSheetWithDataSourceTable(spec)
verwenden.
Verwenden Sie diese Klasse nur mit BigQuery-Datenquellen.
In diesem Beispiel wird gezeigt, wie Sie eine neue Datenquellentabelle erstellen.
SpreadsheetApp.enableBigQueryExecution(); var spreadsheet = SpreadsheetApp.getActive(); var spec = SpreadsheetApp.newDataSourceSpec() .asBigQuery() .setProjectId('big_query_project') .setRawQuery('select @FIELD from table limit @LIMIT') .setParameterFromCell('FIELD', 'Sheet1!A1') .setParameterFromCell('LIMIT', 'namedRangeCell') .build(); // Starts data execution asynchronously. var dataSheet = spreadsheet.insertSheetWithDataSourceTable(spec); var dataSourceTable = dataSheet.getDataSourceTables()[0]; // waitForCompletion() blocks script execution until data execution completes. dataSourceTable.waitForCompletion(60); // Check status after execution. Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState());
In diesem Beispiel wird gezeigt, wie Sie eine Datenquelle bearbeiten.
SpreadsheetApp.enableBigQueryExecution(); var dataSheet = SpreadsheetApp.getActive().getSheetByName("Data Sheet 1"); var dataSourceTable = dataSheet.getDataSourceTables()[0]; var dataSource = dataSourceTable.getDataSource(); var newSpec = dataSource.getSpec() .copy() .asBigQuery() .setRawQuery('select name from table limit 2') .removeAllParameters() .build(); // Updates data source specification and starts data execution asynchronously. dataSource.updateSpec(newSpec); // Check status during execution. Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState()); // waitForCompletion() blocks script execution until data execution completes. dataSourceTable.waitForCompletion(60); // Check status after execution. Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState());
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addColumns(columnNames) | DataSourceTable | Fügen Sie der Datenquellentabelle Spalten hinzu. |
addFilter(columnName, filterCriteria) | DataSourceTable | Hiermit wird ein Filter hinzugefügt, der auf die Datenquellentabelle angewendet wird. |
addSortSpec(columnName, ascending) | DataSourceTable | Hiermit wird einer Spalte in der Datenquellentabelle eine Sortierspezifikation hinzugefügt. |
addSortSpec(columnName, sortOrder) | DataSourceTable | Fügt eine Sortierspezifikation für eine Spalte in der Datenquellentabelle hinzu. |
cancelDataRefresh() | DataSourceTable | Bricht die mit diesem Objekt verknüpfte Datenaktualisierung ab, wenn es gerade ausgeführt wird. |
forceRefreshData() | DataSourceTable | Die Daten dieses Objekts werden unabhängig vom aktuellen Status aktualisiert. |
getColumns() | DataSourceTableColumn[] | Ruft alle Datenquellenspalten ab, die der Datenquellentabelle hinzugefügt wurden. |
getDataSource() | DataSource | Ruft die Datenquelle ab, mit der das Objekt verknüpft ist. |
getFilters() | DataSourceTableFilter[] | Gibt alle Filter zurück, die auf die Datenquellentabelle angewendet wurden. |
getRange() | Range | Ruft den Range ab, den diese Datenquellentabelle umfasst. |
getRowLimit() | Integer | Gibt das Zeilenlimit für die Datenquellentabelle zurück. |
getSortSpecs() | SortSpec[] | Ruft alle Sortierspezifikationen in der Datenquellentabelle ab. |
getStatus() | DataExecutionStatus | Ruft den Status der Datenausführung des Objekts ab. |
isSyncingAllColumns() | Boolean | Gibt zurück, ob mit der Datenquellentabelle alle Spalten in der verknüpften Datenquelle synchronisiert werden. |
refreshData() | DataSourceTable | Aktualisiert die Daten des Objekts |
removeAllColumns() | DataSourceTable | Entfernt alle Spalten in der Datenquellentabelle. |
removeAllSortSpecs() | DataSourceTable | Entfernt alle Sortierspezifikationen in der Datenquellentabelle. |
setRowLimit(rowLimit) | DataSourceTable | Aktualisiert das Zeilenlimit für die Datenquellentabelle. |
syncAllColumns() | DataSourceTable | Alle aktuellen und zukünftigen Spalten in der zugehörigen Datenquelle mit der Datenquellentabelle synchronisieren. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Wartet, bis die aktuelle Ausführung abgeschlossen ist, wobei nach der angegebenen Anzahl von Sekunden eine Zeitüberschreitung auftritt. |
Detaillierte Dokumentation
addColumns(columnNames)
Fügt der Datenquellentabelle Spalten hinzu.
Parameter
Name | Typ | Beschreibung |
---|---|---|
columnNames | String[] | Die Liste der Namen der hinzuzufügenden Spalten. |
Rückflug
DataSourceTable
: Die Datenquellentabelle zur Verkettung.
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
addFilter(columnName, filterCriteria)
Fügt einen Filter hinzu, der auf die Datenquellentabelle angewendet wird.
Parameter
Name | Typ | Beschreibung |
---|---|---|
columnName | String | Der Name der Spalte, auf die dieser Filter angewendet werden soll. |
filterCriteria | FilterCriteria | Die anzuwendenden Filterkriterien. |
Rückflug
DataSourceTable
: Die Datenquellentabelle für die Verknüpfung.
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
addSortSpec(columnName, ascending)
Fügt eine Sortierspezifikation für eine Spalte in der Datenquellentabelle hinzu.
Parameter
Name | Typ | Beschreibung |
---|---|---|
columnName | String | Der Name der zu sortierenden Spalte. |
ascending | Boolean | Wenn true , sortieren Sie die Spalte in aufsteigender Reihenfolge. wenn false , sortieren
Spalte in absteigender Reihenfolge. |
Rückflug
DataSourceTable
: Tabelle mit der Datenquelle, die verkettet werden soll.
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
addSortSpec(columnName, sortOrder)
Hiermit wird einer Spalte in der Datenquellentabelle eine Sortierspezifikation hinzugefügt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
columnName | String | Der Name der zu sortierenden Spalte. |
sortOrder | SortOrder | Die Sortierreihenfolge. |
Rückflug
DataSourceTable
: Das Tabellenblatt der Datenquelle für die Verkettung.
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
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 die Datenausführung für eine bestimmte Datenquelle aktivieren
Typ.
Rückflug
DataSourceTable
: 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()
Aktualisiert die Daten dieses Objekts unabhängig vom aktuellen Status. refreshData()
ansehen für
erhalten Sie weitere Informationen. 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 die Datenausführung für eine bestimmte Datenquelle aktivieren
Typ.
Rückflug
DataSourceTable
: Das Datenobjekt.
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()
Hier werden alle Datenquellenspalten abgerufen, die der Datenquellentabelle hinzugefügt wurden.
Rückflug
DataSourceTableColumn[]
: Liste der Tabellenspalten 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
getDataSource()
Ruft die Datenquelle ab, mit der das Objekt verknüpft ist.
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
getFilters()
Gibt alle Filter zurück, die auf die Datenquellentabelle angewendet wurden.
Rückflug
DataSourceTableFilter[]
: Ein Array aller Filter, die auf die Datenquellentabelle angewendet wurden.
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
getRange()
Gibt den Range
zurück, den diese Datenquellentabelle umfasst.
Rückflug
Range
: Der Bereich.
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
getRowLimit()
Gibt das Zeilenlimit für die Datenquellentabelle zurück.
Rückflug
Integer
: das Zeilenlimit für die Datenquellentabelle oder null
, wenn kein Limit festgelegt ist und der
verwendet das standardmäßige maximale Limit, wie in der Benutzeroberfläche von Google Tabellen.
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
getSortSpecs()
Ruft alle Sortierspezifikationen in der Datenquellentabelle ab.
Rückflug
SortSpec[]
: Liste der Sortiervorgaben.
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
getStatus()
Ruft den Datenausführungsstatus des Objekts ab.
Rückflug
DataExecutionStatus
: Der Status der Datenausführung.
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
isSyncingAllColumns()
Gibt zurück, ob mit der Datenquellentabelle alle Spalten in der verknüpften Datenquelle synchronisiert werden.
Rückflug
Boolean
–True
, wenn in der Datenquellentabelle alle Spalten in der zugehörigen Datenquelle synchronisiert werden, andernfalls false
.
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
refreshData()
Aktualisiert die Daten des Objekts
Löst eine Ausnahme aus, wenn sie sich derzeit im Status error
befindet. 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 die Datenausführung für eine bestimmte Datenquelle aktivieren
Typ.
Rückflug
DataSourceTable
: Das Datenobjekt.
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
removeAllColumns()
Alle Spalten in der Datenquellentabelle werden entfernt.
Rückflug
DataSourceTable
: Die Datenquellentabelle zur Verkettung.
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
removeAllSortSpecs()
Entfernt alle Sortierspezifikationen in der Datenquellentabelle.
Rückflug
DataSourceTable
: Das Tabellenblatt der Datenquelle für die Verkettung.
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
setRowLimit(rowLimit)
Aktualisiert das Zeilenlimit für die Datenquellentabelle. Wenn das angegebene Zeilenlimit null
ist, wird die Datenquellentabelle so aktualisiert, dass das standardmäßige maximale Zeilenlimit wie in der Google Tabellen-Benutzeroberfläche verwendet wird.
Parameter
Name | Typ | Beschreibung |
---|---|---|
rowLimit | Integer | Das neue Zeilenlimit für die Datentabelle. Bei null wird die zu verwendende Tabelle aktualisiert
das Standard-Zeilenlimit. |
Rückflug
DataSourceTable
: Die Datenquellentabelle zur Verkettung.
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
syncAllColumns()
Alle aktuellen und zukünftigen Spalten in der zugehörigen Datenquelle mit der Datenquellentabelle synchronisieren.
Rückflug
DataSourceTable
: Die Datenquellentabelle für die Verknüpfung.
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
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, aber bricht den Datenausführung.
Parameter
Name | Typ | Beschreibung |
---|---|---|
timeoutInSeconds | Integer | Die Zeit in Sekunden, die auf die Datenausführung gewartet werden soll. Maximal sind 300 zulässig 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