Class DataSourceSheet

DataSourceSheet

Auf das Tabellenblatt „Datenquelle“ zugreifen und es bearbeiten. Wenn Sie eine neue Datenquellentabelle 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)DataSourceSheetHiermit wird ein Filter hinzugefügt, 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.
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 für das Tabellenblatt der Datenquelle für den angegebenen Spaltennamen zurück.
getSheetValues(columnName, startRow, numRows)Object[]Gibt alle Werte der Datenquelle für den angegebenen Spaltennamen aus dem bereitgestellten Startzeile (based-1) und bis zur angegebenen numRows.
getSortSpecs()SortSpec[]Ruft alle Sortierspezifikationen im Tabellenblatt der Datenquelle ab.
getStatus()DataExecutionStatusRuft den Status der Datenausführung des Objekts ab.
refreshData()DataSourceSheetAktualisiert die Daten des Objekts
removeFilters(columnName)DataSourceSheetHiermit werden alle Filter entfernt, 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 Tabellenblatt der Datenquelle fest.
setSortSpec(columnName, sortOrder)DataSourceSheetLegt die Sortierspezifikation für eine Spalte im Tabellenblatt der Datenquelle fest.
waitForCompletion(timeoutInSeconds)DataExecutionStatusWartet, bis die aktuelle Ausführung abgeschlossen ist, wobei nach der angegebenen Anzahl von Sekunden eine Zeitüberschreitung auftritt.

Detaillierte Dokumentation

addFilter(columnName, filterCriteria)

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

Rückflug

DataSourceSheet: Tabelle mit der Datenquelle, 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 Datenquellentabellenblatt als normales Tabellenobjekt zurück.

Rückflug

Sheet: Das normale Tabellenblatt.

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

NameTypBeschreibung
columnNameStringDer Name der Spalte,

Rückflug

DataSourceSheet: Diese Datenquellentabelle zur Verkettung.

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)

Passt die Breite der angegebenen Spalten automatisch an.

Parameter

NameTypBeschreibung
columnNamesString[]Die Liste der zu aktualisierenden Spaltennamen.

Rückflug

DataSourceSheet: Diese Datenquellentabelle zur Verkettung.

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();

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Mit SpreadsheetApp#enable...Execution()-Methoden die Datenausführung für eine bestimmte Datenquelle aktivieren Typ.

Rückflug

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. refreshData() ansehen für erhalten Sie weitere Informationen. 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 die Datenausführung für eine bestimmte Datenquelle aktivieren Typ.

Rückflug

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,

Rückflug

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

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.

Rückflug

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.

Rückflug

DataSourceSheetFilter[]: ein Array aller Filter, die auf das Tabellenblatt der Datenquelle angewendet wurden.

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 in der Datenquellentabelle 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

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 Tabellenblatt der Datenquelle für den angegebenen Spaltennamen ab der angegebenen Startzeile (basierend auf -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.

Rückflug

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

Hier werden alle Sortiervorgaben im Tabellenblatt der Datenquelle abgerufen.

Rückflug

SortSpec[]: Eine Liste der 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.

Rückflug

DataExecutionStatus: Der 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 sie sich derzeit im Status error befindet. Verwenden Sie DataSource#updateSpec(), um die Spezifikation zu aktualisieren. Die Methode ist gegenüber forceRefreshData() bevorzugt, um unerwartete Änderungen an der Datenquelle zu vermeiden.

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Mit SpreadsheetApp#enable...Execution()-Methoden die Datenausführung für eine bestimmte Datenquelle aktivieren Typ.

Rückflug

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 im Tabellenblatt der Datenquelle angewendet wurden.

Parameter

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

Rückflug

DataSourceSheet: Die Datenquellentabelle 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 Tabellenblatt der Datenquelle.

Parameter

NameTypBeschreibung
columnNameStringDer Name der Spalte.

Rückflug

DataSourceSheet: Das Tabellenblatt der Datenquelle für die Verkettung.

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.

Rückflug

DataSourceSheet: Diese Datenquellentabelle zur Verkettung.

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

Rückflug

DataSourceSheet: Diese Datenquellentabelle zur Verkettung.

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 Tabellenblatt der Datenquelle fest.

Parameter

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

Rückflug

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

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 Tabellenblatt der Datenquelle fest.

Parameter

NameTypBeschreibung
columnNameStringDer Name der Spalte, nach der sortiert werden soll.
sortOrderSortOrderDie Sortierreihenfolge.

Rückflug

DataSourceSheet: Das Tabellenblatt der Datenquelle für die Verkettung.

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, wobei nach der angegebenen Anzahl von Sekunden eine Zeitüberschreitung auftritt. Löst eine Ausnahme aus, wenn die Ausführung bei einer Zeitüberschreitung nicht abgeschlossen ist, aber bricht den Datenausführung.

Parameter

NameTypBeschreibung
timeoutInSecondsIntegerDie Zeit in Sekunden, die auf die Datenausführung gewartet werden soll. Maximal sind 300 zulässig Sekunden.

Rückflug

DataExecutionStatus: Der 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