Class DataSourceSheet

DataSourceSheet

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

MethodeRückgabetypKurzbeschreibung
addFilter(columnName, filterCriteria)DataSourceSheetDamit wird ein Filter hinzugefügt, der auf das Tabellenblatt der Datenquelle angewendet wird.
asSheet()SheetGibt das Datenquellenblatt als reguläres Tabellenblattobjekt zurück
autoResizeColumn(columnName)DataSourceSheetDie Breite der angegebenen Spalte wird automatisch angepasst.
autoResizeColumns(columnNames)DataSourceSheetDie Breite der angegebenen Spalten wird automatisch angepasst.
cancelDataRefresh()DataSourceSheetBricht die mit diesem Objekt verknüpfte Datenaktualisierung ab, wenn es gerade ausgeführt wird.
forceRefreshData()DataSourceSheetAktualisiert die Daten dieses Objekts unabhängig vom aktuellen Status.
getColumnWidth(columnName)IntegerGibt die Breite der angegebenen Spalte zurück.
getDataSource()DataSourceRuft 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()DataExecutionStatusRuft den Datenausführungsstatus des Objekts ab.
refreshData()DataSourceSheetAktualisiert die Daten des Objekts.
removeFilters(columnName)DataSourceSheetEntfernt alle Filter, die auf die Spalte der Datenquellentabelle angewendet wurden.
removeSortSpec(columnName)DataSourceSheetEntfernt die Sortierspezifikation für eine Spalte im Datenquellenblatt.
setColumnWidth(columnName, width)DataSourceSheetLegt die Breite der angegebenen Spalte fest.
setColumnWidths(columnNames, width)DataSourceSheetLegt die Breite der angegebenen Spalten fest.
setSortSpec(columnName, ascending)DataSourceSheetLegt die Sortierspezifikation für eine Spalte im Datenquellenblatt fest.
setSortSpec(columnName, sortOrder)DataSourceSheetLegt die Sortierspezifikation für eine Spalte im Datenquellenblatt fest.
waitForCompletion(timeoutInSeconds)DataExecutionStatusWartet, 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

NameTypBeschreibung
columnNameStringDer Name der Spalte, auf die dieser Filter angewendet werden soll.
filterCriteriaFilterCriteriaDie 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

NameTypBeschreibung
columnNameStringDer 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

NameTypBeschreibung
columnNamesString[]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

NameTypBeschreibung
columnNameStringDer 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

NameTypBeschreibung
columnNameStringDer 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

NameTypBeschreibung
columnNameStringDer Name der Datenquellenspalte, für die Werte abgerufen werden sollen.
startRowIntegerDie Zeilenposition, ab der Werte abgerufen werden sollen.
numRowsIntegerDie 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

NameTypBeschreibung
columnNameStringDer 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

NameTypBeschreibung
columnNameStringDer 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

NameTypBeschreibung
columnNameStringDer Name der Spalte,
widthIntegerDie 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

NameTypBeschreibung
columnNamesString[]Die Liste der zu aktualisierenden Spaltennamen.
widthIntegerDie 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

NameTypBeschreibung
columnNameStringDer Name der Spalte, die sortiert werden soll.
ascendingBooleanBei 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

NameTypBeschreibung
columnNameStringDer Name der Spalte, die sortiert werden soll.
sortOrderSortOrderDie 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

NameTypBeschreibung
timeoutInSecondsIntegerDie 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