Vorhandenes Datenquellen-Tabellenblatt aufrufen und ändern Wenn Sie ein neues Datenquellenblatt 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 | Damit wird ein Filter hinzugefügt, der auf das Tabellenblatt der Datenquelle angewendet wird. |
asSheet() | Sheet | Gibt das Datenquellenblatt als reguläres Tabellenblattobjekt zurück |
autoResizeColumn(columnName) | DataSourceSheet | Die Breite der angegebenen Spalte wird automatisch angepasst. |
autoResizeColumns(columnNames) | DataSourceSheet | Die Breite der angegebenen Spalten wird automatisch angepasst. |
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 des Datenquellenblatts für den angegebenen Spaltennamen zurück. |
getSheetValues(columnName, startRow, numRows) | Object[] | Gibt alle Werte für das Datenquellenblatt für den angegebenen Spaltennamen von der angegebenen Startzeile (based-1) bis zum angegebenen numRows zurück. |
getSortSpecs() | SortSpec[] | Ruft alle Sortierspezifikationen im Datenquellenblatt ab. |
getStatus() | DataExecutionStatus | Ruft den Datenausführungsstatus des Objekts ab. |
refreshData() | DataSourceSheet | Aktualisiert die Daten des Objekts. |
removeFilters(columnName) | DataSourceSheet | Entfernt alle Filter, die auf die Spalte der Datenquellentabelle angewendet wurden. |
removeSortSpec(columnName) | DataSourceSheet | Entfernt die Sortierspezifikation für eine Spalte im Datenquellenblatt. |
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 Datenquellenblatt fest. |
setSortSpec(columnName, sortOrder) | DataSourceSheet | Legt die Sortierspezifikation für eine Spalte im Datenquellenblatt fest. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Wartet, bis die aktuelle Ausführung abgeschlossen ist. Nach der angegebenen Anzahl von Sekunden wird das Zeitlimit überschritten. |
Detaillierte Dokumentation
addFilter(columnName, filterCriteria)
Damit wird ein Filter hinzugefügt, der auf das Tabellenblatt der Datenquelle angewendet wird.
Parameter
Name | Typ | Beschreibung |
---|---|---|
columnName | String | Der Name der Spalte, auf die dieser Filter angewendet werden soll. |
filterCriteria | FilterCriteria | Die Filterkriterien, die angewendet werden sollen. |
Return
DataSourceSheet
: Das Datenquellenblatt 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 Datenquellenblatt als reguläres Tabellenblattobjekt zurück
Return
Sheet
: Das reguläre 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, |
Return
DataSourceSheet
: Dieses Tabellenblatt für die Datenquelle zum Verketten.
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)
Die Breite der angegebenen Spalten wird automatisch angepasst.
Parameter
Name | Typ | Beschreibung |
---|---|---|
columnNames | String[] | Die Liste der zu aktualisierenden Spaltennamen. |
Return
DataSourceSheet
: Dieses Tabellenblatt für die Datenquelle zum Verketten.
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();
Gibt eine Ausnahme aus, wenn der Typ der Datenquelle nicht aktiviert ist. Verwenden Sie
SpreadsheetApp#enable...Execution()
-Methoden, um die Datenausführung für einen bestimmten Datenquellentyp zu aktivieren.
Return
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. Weitere Informationen finden Sie unter refreshData()
. Informationen zum Abbrechen einer aktuellen Aktualisierung dieses Objekts finden Sie unter cancelDataRefresh()
.
Gibt eine Ausnahme aus, wenn der Typ der Datenquelle nicht aktiviert ist. Verwenden Sie SpreadsheetApp#enable...Execution()
-Methoden, um die Datenausführung für einen bestimmten Datenquellentyp zu aktivieren.
Return
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, |
Return
Integer
: Die Breite der Spalte oder null
, wenn die Spalte die Standardbreite verwendet.
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.
Return
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.
Return
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 des Datenquellenblatts für den angegebenen Spaltennamen zurück.
Parameter
Name | Typ | Beschreibung |
---|---|---|
columnName | String | Der Name der Datenquellenspalte, für die Werte abgerufen werden sollen. |
Return
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 für das Datenquellenblatt für den angegebenen Spaltennamen von der angegebenen Startzeile (based-1) bis zum angegebenen numRows
zurück.
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. |
Return
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 Datenquellenblatt ab.
Return
SortSpec[]
: Eine Liste von 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.
Return
DataExecutionStatus
: 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 sich derzeit der 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.
Gibt eine Ausnahme aus, wenn der Typ der Datenquelle nicht aktiviert ist. Verwenden Sie SpreadsheetApp#enable...Execution()
-Methoden, um die Datenausführung für einen bestimmten Datenquellentyp zu aktivieren.
Return
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)
Entfernt alle Filter, die auf die Spalte der Datenquellentabelle angewendet wurden.
Parameter
Name | Typ | Beschreibung |
---|---|---|
columnName | String | Der Name der Spalte, aus der Filter entfernt werden sollen. |
Return
DataSourceSheet
: Das Datenquellenblatt 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 Datenquellenblatt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
columnName | String | Der Name der Spalte. |
Return
DataSourceSheet
: Das Datenquellenblatt für Verkettungen.
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. |
Return
DataSourceSheet
: Dieses Tabellenblatt für die Datenquelle zum Verketten.
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 Spaltenbreite. |
Return
DataSourceSheet
: Dieses Tabellenblatt für die Datenquelle zum Verketten.
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 Datenquellenblatt fest.
Parameter
Name | Typ | Beschreibung |
---|---|---|
columnName | String | Der Name der Spalte, die sortiert werden soll. |
ascending | Boolean | Bei true wird die Spalte in aufsteigender Reihenfolge sortiert. Bei false wird die Spalte in absteigender Reihenfolge sortiert. |
Return
DataSourceSheet
: Das Datenquellenblatt für Verkettungen.
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 Datenquellenblatt fest.
Parameter
Name | Typ | Beschreibung |
---|---|---|
columnName | String | Der Name der Spalte, die sortiert werden soll. |
sortOrder | SortOrder | Die Sortierreihenfolge. |
Return
DataSourceSheet
: Das Datenquellenblatt für Verkettungen.
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. Nach der angegebenen Anzahl von Sekunden wird das Zeitlimit überschritten. Löst eine Ausnahme aus, wenn die Ausführung bei Ablauf des Zeitlimits nicht abgeschlossen ist, bricht jedoch die Datenausführung nicht ab.
Parameter
Name | Typ | Beschreibung |
---|---|---|
timeoutInSeconds | Integer | Die Zeit in Sekunden, die auf die Ausführung der Daten gewartet werden soll. Maximal sind 300 Sekunden zulässig. |
Return
DataExecutionStatus
: 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