Class DataSourceSheet

DataSourceSheet

Auf vorhandene Datenquellenblätter zugreifen und diese bearbeiten Verwenden Sie Spreadsheet.insertDataSourceSheet(spec), um ein neues Datenquellenblatt 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 Datenquellenblatt angewendet wird.
asSheet()SheetGibt das Datenquellentabellenblatt als reguläres Tabellenblattobjekt zurück.
autoResizeColumn(columnName)DataSourceSheetPasst die Breite der angegebenen Spalte automatisch an.
autoResizeColumns(columnNames)DataSourceSheetPasst die Breite der angegebenen Spalten automatisch an.
cancelDataRefresh()DataSourceSheetBricht die Datenaktualisierung ab, die mit diesem Objekt verknüpft ist, falls sie gerade ausgeführt wird.
forceRefreshData()DataSourceSheetAktualisiert die Daten dieses Objekts unabhängig vom aktuellen Status.
getColumnWidth(columnName)Integer|nullGibt 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 Datenquellenblatt angewendet wurden.
getSheetValues(columnName)Object[]Gibt alle Werte für das Datenquellenblatt für den angegebenen Spaltennamen zurück.
getSheetValues(columnName, startRow, numRows)Object[]Gibt alle Werte für das Datenquellenblatt für den angegebenen Spaltennamen ab der angegebenen Startzeile (1-basiert) bis zum angegebenen numRows zurück.
getSortSpecs()SortSpec[]Ruft alle Sortierspezifikationen im Datenquellenblatt ab.
getStatus()DataExecutionStatusRuft den Status der Datenausführung des Objekts ab.
refreshData()DataSourceSheetAktualisiert die Daten des Objekts.
removeFilters(columnName)DataSourceSheetEntfernt alle Filter, die auf die Spalte des Datenquellen-Arbeitsblatts angewendet wurden.
removeSortSpec(columnName)DataSourceSheetEntfernt die Sortierspezifikation 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 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. Es kommt nach der angegebenen Anzahl von Sekunden zu einer Zeitüberschreitung.

Detaillierte Dokumentation

addFilter(columnName, filterCriteria)

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

Parameter

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

Rückflug

DataSourceSheet: Das Datenquellenblatt für die Verkettung von Methoden.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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 reguläre Tabellenblatt.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

autoResizeColumn(columnName)

Passt die Breite der angegebenen Spalte automatisch an.

Parameter

NameTypBeschreibung
columnNameStringDer Name der Spalte,

Rückflug

DataSourceSheet: Dieses Datenquellen-Arbeitsblatt für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

autoResizeColumns(columnNames)

Passt die Breite der angegebenen Spalten automatisch an.

Parameter

NameTypBeschreibung
columnNamesString[]Die Liste der zu aktualisierenden Spaltennamen.

Rückflug

DataSourceSheet: Dieses Datenquellen-Arbeitsblatt für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

cancelDataRefresh()

Bricht die Datenaktualisierung ab, die mit diesem Objekt verknüpft ist, falls sie gerade ausgeführt wird.

In diesem Beispiel wird gezeigt, wie Sie das Aktualisieren 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 Datenabfrage für einen bestimmten Datenquelltyp aktivieren.

Rückflug

DataSourceSheet: Das Datenobjekt.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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(). Wenn Sie eine aktuell laufende Aktualisierung dieses Objekts abbrechen möchten, lesen Sie cancelDataRefresh().

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Mit SpreadsheetApp#enable...Execution()-Methoden können Sie die Datenabfrage für einen bestimmten Datenquelltyp aktivieren.

Rückflug

DataSourceSheet: Das Datenobjekt.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getFilters()

Gibt alle Filter zurück, die auf das Datenquellenblatt angewendet wurden.

Rückflug

DataSourceSheetFilter[]: Ein Array aller Filter, die auf das Datenquellenblatt angewendet werden.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getSheetValues(columnName)

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

Parameter

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

Rückflug

Object[]: Ein eindimensionales Array von Werten.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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 ab der angegebenen Startzeile (1-basiert) 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.

Rückflug

Object[]: Ein eindimensionales Array von Werten.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getSortSpecs()

Ruft alle Sortierspezifikationen im Datenquellenblatt ab.

Rückflug

SortSpec[]: Eine Liste mit Sortierspezifikationen.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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 die Instanz 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. Mit SpreadsheetApp#enable...Execution()-Methoden können Sie die Datenabfrage für einen bestimmten Datenquelltyp aktivieren.

Rückflug

DataSourceSheet: Das Datenobjekt.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

removeFilters(columnName)

Entfernt alle Filter, die auf die Spalte des Datenquellen-Arbeitsblatts angewendet wurden.

Parameter

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

Rückflug

DataSourceSheet: Das Datenquellenblatt für die Verkettung von Methoden.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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

NameTypBeschreibung
columnNameStringDer Name der Spalte.

Rückflug

DataSourceSheet: Das Datenquellenblatt für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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 für die Spalte.

Rückflug

DataSourceSheet: Dieses Datenquellen-Arbeitsblatt für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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 für die Spalten.

Rückflug

DataSourceSheet: Dieses Datenquellen-Arbeitsblatt für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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, nach der sortiert werden soll.
ascendingBooleanWenn true, sortieren Sie die Spalte in aufsteigender Reihenfolge. Wenn false, sortieren Sie die Spalte in absteigender Reihenfolge.

Rückflug

DataSourceSheet: Das Datenquellenblatt für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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, nach der sortiert werden soll.
sortOrderSortOrderDie Sortierreihenfolge.

Rückflug

DataSourceSheet: Das Datenquellenblatt für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

waitForCompletion(timeoutInSeconds)

Wartet, bis die aktuelle Ausführung abgeschlossen ist. Es kommt nach der angegebenen Anzahl von Sekunden zu einer Zeitüberschreitung. Löst eine Ausnahme aus, wenn die Ausführung bei Zeitüberschreitung nicht abgeschlossen ist, bricht die Datenausführung jedoch nicht ab.

Parameter

NameTypBeschreibung
timeoutInSecondsIntegerDie Zeit in Sekunden, die auf die Ausführung von Daten gewartet werden soll. Das Maximum beträgt 300 Sekunden.

Rückflug

DataExecutionStatus: Der Status der Datenausführung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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