Class DataSourceSheet

Tabelle mitDatenquelle

Auf ein vorhandenes Datenquellentabellenblatt zugreifen und es ändern Verwenden Sie Spreadsheet.insertDataSourceSheet(spec), um ein neues Tabellenblatt für die Datenquelle zu erstellen.

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

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
addFilter(columnName, filterCriteria)	DataSourceSheet	Hiermit wird ein Filter hinzugefügt, der auf das Tabellenblatt der Datenquelle angewendet wird.
asSheet()	Sheet	Gibt das Datenquellentabellenblatt als normales Tabellenobjekt 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 Datenaktualisierung für dieses Objekt ab, falls sie gerade ausgeführt wird.
forceRefreshData()	DataSourceSheet	Die Daten dieses Objekts werden unabhängig vom aktuellen Status aktualisiert.
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 für das Tabellenblatt der Datenquelle für den angegebenen Spaltennamen zurück.
getSheetValues(columnName, startRow, numRows)	Object[]	Gibt alle Werte für das Tabellenblatt der Datenquelle für den angegebenen Spaltennamen ab der angegebenen Startzeile (basierend auf -1) bis zur angegebenen numRows zurück.
getSortSpecs()	SortSpec[]	Hier werden alle Sortiervorgaben im Tabellenblatt der Datenquelle abgerufen.
getStatus()	DataExecutionStatus	Ruft den Status der Datenausführung des Objekts ab.
refreshData()	DataSourceSheet	Aktualisiert die Daten des Objekts.
removeFilters(columnName)	DataSourceSheet	Hiermit werden alle Filter entfernt, die auf die Arbeitsblattspalte der Datenquelle angewendet wurden.
removeSortSpec(columnName)	DataSourceSheet	Entfernt die Sortiervorgabe für eine Spalte im Tabellenblatt „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	Hiermit wird die Sortiervorgabe für eine Spalte im Tabellenblatt der Datenquelle festgelegt.
setSortSpec(columnName, sortOrder)	DataSourceSheet	Hiermit wird die Sortiervorgabe für eine Spalte im Tabellenblatt der Datenquelle festgelegt.
waitForCompletion(timeoutInSeconds)	DataExecutionStatus	Es wird gewartet, bis die aktuelle Ausführung abgeschlossen ist. Nach der angegebenen Anzahl von Sekunden kommt es zu einer Zeitüberschreitung.

Detaillierte Dokumentation

addFilter(columnName, filterCriteria)

Hiermit 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 anzuwendenden Filterkriterien.

Rückflug

DataSourceSheet: Tabelle mit der Datenquelle für die Methodenverkettung.

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

---

asSheet()

Gibt das Datenquellentabellenblatt als normales Tabellenobjekt zurück.

Rückflug

Sheet – Die normale Tabelle.

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

---

autoResizeColumn(columnName)

Die Breite der angegebenen Spalte wird automatisch angepasst.

Parameter

Name	Typ	Beschreibung
columnName	String	Der Name der Spalte,

Rückflug

DataSourceSheet: Dieses Datenquellenblatt zur Verkettung.

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

---

autoResizeColumns(columnNames)

Die Breite der angegebenen Spalten wird automatisch angepasst.

Parameter

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

Rückflug

DataSourceSheet: Dieses Datenquellenblatt zur Verkettung.

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

---

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 können Sie die Datenausführung für einen bestimmten Datenquellentyp aktivieren.

Rückflug

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

Die Daten dieses Objekts werden unabhängig vom aktuellen Status aktualisiert. Weitere Informationen finden Sie unter refreshData(). 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 können Sie die Datenausführung für einen bestimmten Datenquellentyp aktivieren.

Rückflug

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

---

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 Spalte die Standardbreite verwendet.

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

---

getDataSource()

Ruft die Datenquelle ab, mit der das Objekt verknüpft ist.

Rückflug

DataSource: Datenquelle

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

---

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 werden.

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

---

getSheetValues(columnName)

Gibt alle Werte für das Tabellenblatt der Datenquelle 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

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

---

getSheetValues(columnName, startRow, numRows)

Gibt alle Werte für das Tabellenblatt der Datenquelle für den angegebenen Spaltennamen ab der angegebenen Startzeile (basierend auf -1) bis zur 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 Zeilen, die abgerufen werden sollen.

Rückflug

Object[]: Ein eindimensionales Array von Werten.

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

---

getSortSpecs()

Hier werden alle Sortiervorgaben im Tabellenblatt der Datenquelle abgerufen.

Rückflug

SortSpec[]: Liste der Sortiervorgaben.

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

---

getStatus()

Ruft den Status der Datenausführung des Objekts ab.

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

---

refreshData()

Aktualisiert die Daten des Objekts.

Eine Ausnahme wird geworfen, wenn der aktuelle Status error ist. 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 können Sie die Datenausführung für einen bestimmten Datenquellentyp aktivieren.

Rückflug

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

---

removeFilters(columnName)

Hiermit werden alle Filter entfernt, die auf die Arbeitsblattspalte der Datenquelle angewendet wurden.

Parameter

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

Rückflug

DataSourceSheet: Tabelle mit der Datenquelle für die Methodenverkettung.

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

---

removeSortSpec(columnName)

Entfernt die Sortiervorgabe für eine Spalte im Tabellenblatt „Datenquelle“.

Parameter

Name	Typ	Beschreibung
columnName	String	Der Name der Spalte.

Rückflug

DataSourceSheet: Tabelle mit der Datenquelle, die verkettet werden soll.

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

---

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: Dieses Datenquellenblatt zur Verkettung.

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

---

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: Dieses Datenquellenblatt zur Verkettung.

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

---

setSortSpec(columnName, ascending)

Hiermit wird die Sortiervorgabe für eine Spalte im Tabellenblatt der Datenquelle festgelegt.

Parameter

Name	Typ	Beschreibung
columnName	String	Der Name der Spalte, nach der sortiert werden soll.
ascending	Boolean	Wenn true ausgewählt ist, wird die Spalte in aufsteigender Reihenfolge sortiert. Bei false wird sie in absteigender Reihenfolge sortiert.

Rückflug

DataSourceSheet: Tabelle mit der Datenquelle, die verkettet werden soll.

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

---

setSortSpec(columnName, sortOrder)

Hiermit wird die Sortiervorgabe für eine Spalte im Tabellenblatt der Datenquelle festgelegt.

Parameter

Name	Typ	Beschreibung
columnName	String	Der Name der Spalte, nach der sortiert werden soll.
sortOrder	SortOrder	Die Sortierreihenfolge.

Rückflug

DataSourceSheet: Tabelle mit der Datenquelle, die verkettet werden soll.

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

---

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, bricht die Datenausführung aber nicht ab.

Parameter

Name	Typ	Beschreibung
timeoutInSeconds	Integer	Die Zeit in Sekunden, die auf die Ausführung der Daten gewartet werden soll. Das Maximum beträgt 300 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