Class DataSourceSheet

Datenquelle

Auf vorhandenes Datenquellenblatt zugreifen und es ändern Verwenden Sie Spreadsheet.insertDataSourceSheet(spec), um eine neue Datenquelle zu erstellen.

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

Methoden

MethodeRückgabetypKurzbeschreibung
addFilter(columnName, filterCriteria)DataSourceSheetFügt einen Filter hinzu, der auf das Tabellenblatt der Datenquelle angewendet wird.
asSheet()SheetGibt das Datenquellentabellenblatt 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.
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 für das Datenquellentabellenblatt für den angegebenen Spaltennamen zurück.
getSheetValues(columnName, startRow, numRows)Object[]Gibt alle Werte für das Datenquellentabellenblatt für den angegebenen Spaltennamen von der angegebenen Startzeile (base-1) bis zur angegebenen numRows zurück.
getSortSpecs()SortSpec[]Ruft alle Sortierspezifikationen im Datenquellentabellenblatt ab.
getStatus()DataExecutionStatusRuft den Datenausführungsstatus des Objekts ab.
refreshData()DataSourceSheetAktualisiert die Daten des Objekts.
removeFilters(columnName)DataSourceSheetEntfernt alle Filter, die auf die Spalte des Datenquellentabellenblatts angewendet wurden.
removeSortSpec(columnName)DataSourceSheetEntfernt die Spezifikationsspezifikationen für eine Spalte im Tabellenblatt der Datenquelle.
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 Spezifikation der Spalte in der Datenquelle fest.
setSortSpec(columnName, sortOrder)DataSourceSheetLegt die Spezifikation der Spalte in der Datenquelle fest.
waitForCompletion(timeoutInSeconds)DataExecutionStatusWartet, bis die aktuelle Ausführung abgeschlossen ist. Das Zeitlimit wird nach der angegebenen Anzahl von Sekunden überschritten.

Detaillierte Dokumentation

addFilter(columnName, filterCriteria)

Fügt einen Filter hinzu, der auf das Tabellenblatt der Datenquelle angewendet wird.

Parameter

NameTypBeschreibung
columnNameStringDer Name der Spalte, auf die dieser Filter angewendet werden soll.
filterCriteriaFilterCriteriaDie anzuwendenden Filterkriterien.

Zurücksenden

DataSourceSheet: Das Datenquellentabellenblatt zum Verketten von Methoden.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

asSheet()

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

Zurücksenden

Sheet: Das reguläre Tabellenblatt.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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 Spaltenname.

Zurücksenden

DataSourceSheet: Dieses Datenquellenblatt zum Verketten.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

Zurücksenden

DataSourceSheet: Dieses Datenquellenblatt zum Verketten.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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 findest du unter refreshData().

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Verwenden Sie SpreadsheetApp#enable...Execution()-Methoden, um die Datenausführung für einen bestimmten Datenquellentyp zu aktivieren.

Zurücksenden

DataSourceSheet: Das Datenobjekt.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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 Spaltenname.

Zurücksenden

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

Zurücksenden

DataSource: Die Datenquelle.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

Zurücksenden

DataSourceSheetFilter[]: Ein Array aller Filter, die auf das Datenquellentabellenblatt angewendet wurden.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSheetValues(columnName)

Gibt alle Werte für das Datenquellentabellenblatt für den angegebenen Spaltennamen zurück.

Parameter

NameTypBeschreibung
columnNameStringDer Name der Datenquellenspalte, für die Werte abgerufen werden sollen.

Zurücksenden

Object[]: Ein eindimensionales Array von Werten.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSheetValues(columnName, startRow, numRows)

Gibt alle Werte für das Datenquellentabellenblatt für den angegebenen Spaltennamen von der angegebenen Startzeile (base-1) bis zur 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.

Zurücksenden

Object[]: Ein eindimensionales Array von Werten.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSortSpecs()

Ruft alle Sortierspezifikationen im Datenquellentabellenblatt ab.

Zurücksenden

SortSpec[]: Eine Liste von Sortierspezifikationen.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getStatus()

Ruft den Datenausführungsstatus des Objekts ab.

Zurücksenden

DataExecutionStatus: Der Status der Datenausführung.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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 wird gegenüber forceRefreshData() bevorzugt, um unerwartete Änderungen an der Datenquelle zu verhindern.

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Verwenden Sie SpreadsheetApp#enable...Execution()-Methoden, um die Datenausführung für einen bestimmten Datenquellentyp zu aktivieren.

Zurücksenden

DataSourceSheet: Das Datenobjekt.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeFilters(columnName)

Entfernt alle Filter, die auf die Spalte des Datenquellentabellenblatts angewendet wurden.

Parameter

NameTypBeschreibung
columnNameStringDer Name der Spalte, aus der Filter entfernt werden sollen.

Zurücksenden

DataSourceSheet: Das Datenquellentabellenblatt zum Verketten von Methoden.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeSortSpec(columnName)

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

Parameter

NameTypBeschreibung
columnNameStringDer Name der Spalte.

Zurücksenden

DataSourceSheet: Das Datenquellentabellenblatt zum Verketten.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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 Spaltenname.
widthIntegerDie neue Breite der Spalte.

Zurücksenden

DataSourceSheet: Dieses Datenquellenblatt zum Verketten.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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 Breite der Spalten.

Zurücksenden

DataSourceSheet: Dieses Datenquellenblatt zum Verketten.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setSortSpec(columnName, ascending)

Legt die Spezifikation der Spalte in der Datenquelle fest.

Parameter

NameTypBeschreibung
columnNameStringDer Name der zu sortierenden Spalte.
ascendingBooleanBei true sortieren Sie die Spalte in aufsteigender Reihenfolge, bei false die Spalte in absteigender Reihenfolge.

Zurücksenden

DataSourceSheet: Das Datenquellentabellenblatt zum Verketten.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setSortSpec(columnName, sortOrder)

Legt die Spezifikation der Spalte in der Datenquelle fest.

Parameter

NameTypBeschreibung
columnNameStringDer Name der zu sortierenden Spalte.
sortOrderSortOrderDie Sortierreihenfolge.

Zurücksenden

DataSourceSheet: Das Datenquellentabellenblatt zum Verketten.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

waitForCompletion(timeoutInSeconds)

Wartet, bis die aktuelle Ausführung abgeschlossen ist. Das Zeitlimit wird nach der angegebenen Anzahl von Sekunden überschritten. Löst eine Ausnahme aus, wenn die Ausführung bei der Zeitüberschreitung nicht abgeschlossen ist, die Datenausführung jedoch nicht abgebrochen wird.

Parameter

NameTypBeschreibung
timeoutInSecondsIntegerDie Wartezeit in Sekunden auf die Datenausführung. Der Höchstwert beträgt 300 Sekunden.

Zurücksenden

DataExecutionStatus: Der Status der Datenausführung.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets