Diese Seite wurde von der Cloud Translation API übersetzt.

Class DataSourceSheet

Auf das Tabellenblatt „Datenquelle“ zugreifen und es bearbeiten. Wenn Sie eine neue Datenquellentabelle erstellen möchten, verwenden Sie Spreadsheet.insertDataSourceSheet(spec).

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

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
`addFilter(columnName, filterCriteria)`	`DataSourceSheet`	Fügt einen Filter hinzu, der auf das Tabellenblatt mit der Datenquelle angewendet wird.
`asSheet()`	`Sheet`	Gibt das Datenquellentabellenblatt als reguläres Tabellenblattobjekt zurück.
`autoResizeColumn(columnName)`	`DataSourceSheet`	Die Breite der angegebenen Spalte wird automatisch angepasst.
`autoResizeColumns(columnNames)`	`DataSourceSheet`	Passt die Breite der angegebenen Spalten automatisch an.
`cancelDataRefresh()`	`DataSourceSheet`	Bricht die mit diesem Objekt verknüpfte Datenaktualisierung ab, wenn es gerade ausgeführt wird.
`forceRefreshData()`	`DataSourceSheet`	Aktualisiert die Daten dieses Objekts unabhängig vom aktuellen Status.
`getColumnWidth(columnName)`	`Integer`	Gibt die Breite der angegebenen Spalte zurück.
`getDataSource()`	`DataSource`	Ruft die Datenquelle ab, mit der das Objekt verknüpft ist.
`getFilters()`	`DataSourceSheetFilter[]`	Gibt alle Filter zurück, die auf das Tabellenblatt der Datenquelle angewendet wurden.
`getSheetValues(columnName)`	`Object[]`	Gibt alle Werte in der Datenquellentabelle für den angegebenen Spaltennamen zurück.
`getSheetValues(columnName, startRow, numRows)`	`Object[]`	Gibt alle Werte der Datenquelle für den angegebenen Spaltennamen aus dem bereitgestellten Startzeile (based-1) und bis zur angegebenen `numRows`.
`getSortSpecs()`	`SortSpec[]`	Ruft alle Sortierspezifikationen im Tabellenblatt der Datenquelle ab.
`getStatus()`	`DataExecutionStatus`	Ruft den Datenausführungsstatus des Objekts ab.
`refreshData()`	`DataSourceSheet`	Aktualisiert die Daten des Objekts
`removeFilters(columnName)`	`DataSourceSheet`	Dadurch werden alle Filter entfernt, die auf die Spalte im Tabellenblatt der Datenquelle angewendet wurden.
`removeSortSpec(columnName)`	`DataSourceSheet`	Entfernt die Sortierspezifikation für eine Spalte im Tabellenblatt der Datenquelle.
`setColumnWidth(columnName, width)`	`DataSourceSheet`	Legt die Breite der angegebenen Spalte fest.
`setColumnWidths(columnNames, width)`	`DataSourceSheet`	Legt die Breite der angegebenen Spalten fest.
`setSortSpec(columnName, ascending)`	`DataSourceSheet`	Legt die Sortierspezifikation für eine Spalte im Tabellenblatt der Datenquelle fest.
`setSortSpec(columnName, sortOrder)`	`DataSourceSheet`	Legt die Sortierspezifikation für eine Spalte im Tabellenblatt der Datenquelle fest.
`waitForCompletion(timeoutInSeconds)`	`DataExecutionStatus`	Wartet, bis die aktuelle Ausführung abgeschlossen ist, wobei nach der angegebenen Anzahl von Sekunden eine Zeitüberschreitung auftritt.

Detaillierte Dokumentation

`addFilter(columnName, filterCriteria)`

Fügt einen Filter hinzu, der auf das Tabellenblatt mit der Datenquelle 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

DataSourceSheet: Die Datenquellentabelle für die Methodenverkettung.

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

`asSheet()`

Gibt das Datenquellentabellenblatt als reguläres Tabellenblattobjekt zurück.

Rückflug

Sheet: Das normale Tabellenblatt.

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

`autoResizeColumn(columnName)`

Die Breite der angegebenen Spalte wird automatisch angepasst.

Parameter

Name	Typ	Beschreibung
`columnName`	`String`	Der Name der Spalte,

Rückflug

DataSourceSheet: Diese 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

`autoResizeColumns(columnNames)`

Passt die Breite der angegebenen Spalten automatisch an.

Parameter

Name	Typ	Beschreibung
`columnNames`	`String[]`	Die Liste der zu aktualisierenden Spaltennamen.

Rückflug

DataSourceSheet: Diese 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

`cancelDataRefresh()`

Bricht die mit diesem Objekt verknüpfte Datenaktualisierung ab, wenn es gerade ausgeführt wird.

In diesem Beispiel wird gezeigt, wie Sie eine Formelaktualisierung 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

DataSourceSheet: 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

`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

DataSourceSheet: 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

`getColumnWidth(columnName)`

Gibt die Breite der angegebenen Spalte zurück.

Parameter

Name	Typ	Beschreibung
`columnName`	`String`	Der Name der Spalte,

Rückflug

Integer: Die Breite der Spalte oder null, wenn die Standardbreite verwendet wird.

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 das Tabellenblatt der Datenquelle angewendet wurden.

Rückflug

DataSourceSheetFilter[]: ein Array aller Filter, die auf das Tabellenblatt der Datenquelle 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

`getSheetValues(columnName)`

Gibt alle Werte in der Datenquellentabelle für den angegebenen Spaltennamen zurück.

Parameter

Name	Typ	Beschreibung
`columnName`	`String`	Der Name der Datenquellenspalte, für die Werte abgerufen werden sollen.

Rückflug

Object[]: Ein eindimensionales Array von Werten.

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

`getSheetValues(columnName, startRow, numRows)`

Gibt alle Werte der Datenquelle für den angegebenen Spaltennamen aus dem bereitgestellten Startzeile (based-1) und bis zum angegebenen numRows.

Parameter

Name	Typ	Beschreibung
`columnName`	`String`	Der Name der Datenquellenspalte, für die Werte abgerufen werden sollen.
`startRow`	`Integer`	Die Zeilenposition, ab der Werte abgerufen werden sollen.
`numRows`	`Integer`	Die Anzahl der abzurufenden Zeilen.

Rückflug

Object[]: Ein eindimensionales Array von Werten.

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 im Tabellenblatt der Datenquelle ab.

Rückflug

SortSpec[]: Eine Liste der Sortierspezifikationen.

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

`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. Die Methode ist gegenüber forceRefreshData() bevorzugt, um unerwartete Änderungen an der Datenquelle zu vermeiden.

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

DataSourceSheet: 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

`removeFilters(columnName)`

Dadurch werden alle Filter entfernt, die auf die Spalte im Tabellenblatt der Datenquelle angewendet wurden.

Parameter

Name	Typ	Beschreibung
`columnName`	`String`	Der Name der Spalte, aus der Filter entfernt werden sollen.

Rückflug

DataSourceSheet: Die Datenquellentabelle für die Methodenverkettung.

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

`removeSortSpec(columnName)`

Entfernt die Sortierspezifikation für eine Spalte im Tabellenblatt der Datenquelle.

Parameter

Name	Typ	Beschreibung
`columnName`	`String`	Der Name der Spalte.

Rückflug

DataSourceSheet: 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

`setColumnWidth(columnName, width)`

Legt die Breite der angegebenen Spalte fest.

Parameter

Name	Typ	Beschreibung
`columnName`	`String`	Der Name der Spalte,
`width`	`Integer`	Die neue Breite der Spalte.

Rückflug

DataSourceSheet: Diese 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

`setColumnWidths(columnNames, width)`

Legt die Breite der angegebenen Spalten fest.

Parameter

Name	Typ	Beschreibung
`columnNames`	`String[]`	Die Liste der zu aktualisierenden Spaltennamen.
`width`	`Integer`	Die neue Breite der Spalten.

Rückflug

DataSourceSheet: Diese 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

`setSortSpec(columnName, ascending)`

Legt die Sortierspezifikation für eine Spalte im Tabellenblatt der Datenquelle fest.

Parameter

Name	Typ	Beschreibung
`columnName`	`String`	Der Name der zu sortierenden Spalte.
`ascending`	`Boolean`	Bei `true` sortieren Sie die Spalte in aufsteigender Reihenfolge. wenn `false`, sortieren Spalte in absteigender Reihenfolge.

Rückflug

DataSourceSheet: 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

`setSortSpec(columnName, sortOrder)`

Legt die Sortierspezifikation für eine Spalte im Tabellenblatt der Datenquelle fest.

Parameter

Name	Typ	Beschreibung
`columnName`	`String`	Der Name der zu sortierenden Spalte.
`sortOrder`	`SortOrder`	Die Sortierreihenfolge.

Rückflug

DataSourceSheet: 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

`waitForCompletion(timeoutInSeconds)`

Wartet, bis die aktuelle Ausführung abgeschlossen ist, wobei nach der angegebenen Anzahl von Sekunden eine Zeitüberschreitung auftritt. 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

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