Class Spreadsheet

Tabelle

Auf Google Tabellen-Dateien zugreifen und sie bearbeiten Gängige Vorgänge sind das Hinzufügen neuer Tabellenblätter und das Hinzufügen von Mitbearbeitern.

Methoden

MethodeRückgabetypKurzbeschreibung
addDeveloperMetadata(key)SpreadsheetFügt der Tabelle auf oberster Ebene Entwicklermetadaten mit dem angegebenen Schlüssel hinzu.
addDeveloperMetadata(key, visibility)SpreadsheetFügt der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel und der Sichtbarkeit hinzu.
addDeveloperMetadata(key, value)SpreadsheetFügt der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel und Wert hinzu.
addDeveloperMetadata(key, value, visibility)SpreadsheetFügt der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel, Wert und der Sichtbarkeit hinzu.
addEditor(emailAddress)SpreadsheetFügt den angegebenen Nutzer der Liste der Bearbeiter für Spreadsheet hinzu.
addEditor(user)SpreadsheetFügt den angegebenen Nutzer der Liste der Bearbeiter für Spreadsheet hinzu.
addEditors(emailAddresses)SpreadsheetFügt das angegebene Array von Nutzern der Liste der Bearbeiter für Spreadsheet hinzu.
addMenu(name, subMenus)voidErstellt ein neues Menü in der Tabellen-UI.
addViewer(emailAddress)SpreadsheetFügt den angegebenen Nutzer der Liste der Betrachter für Spreadsheet hinzu.
addViewer(user)SpreadsheetFügt den angegebenen Nutzer der Liste der Betrachter für Spreadsheet hinzu.
addViewers(emailAddresses)SpreadsheetFügt das angegebene Array von Nutzern der Liste der Betrachter für Spreadsheet hinzu.
appendRow(rowContents)SheetHängt am Ende des aktuellen Datenbereichs im Tabellenblatt eine Zeile an.
autoResizeColumn(columnPosition)SheetLegt die Breite der angegebenen Spalte so fest, dass sie in den Inhalt passt.
copy(name)SpreadsheetKopiert die Tabelle und gibt die neue zurück.
createDeveloperMetadataFinder()DeveloperMetadataFinderGibt ein DeveloperMetadataFinder zurück, um Entwicklermetadaten im Bereich dieser Tabelle zu finden.
createTextFinder(findText)TextFinderErstellt eine Textsuche für die Tabelle, mit der Text in der Tabelle gesucht und ersetzt werden kann.
deleteActiveSheet()SheetLöscht das derzeit aktive Tabellenblatt.
deleteColumn(columnPosition)SheetLöscht die Spalte an der angegebenen Spaltenposition.
deleteColumns(columnPosition, howMany)voidLöscht eine Reihe von Spalten ab der angegebenen Spaltenposition.
deleteRow(rowPosition)SheetLöscht die Zeile an der angegebenen Zeilenposition.
deleteRows(rowPosition, howMany)voidLöscht eine bestimmte Anzahl von Zeilen ab der angegebenen Zeilenposition.
deleteSheet(sheet)voidLöscht das angegebene Tabellenblatt.
duplicateActiveSheet()SheetDupliziert das aktive Tabellenblatt und macht es zum aktiven Tabellenblatt.
getActiveCell()RangeGibt die aktive Zelle in diesem Tabellenblatt zurück.
getActiveRange()RangeGibt den ausgewählten Bereich im aktiven Tabellenblatt zurück oder null, wenn kein aktiver Bereich vorhanden ist
getActiveRangeList()RangeListGibt die Liste der aktiven Bereiche im aktiven Tabellenblatt zurück oder null, wenn keine aktiven Bereiche vorhanden sind.
getActiveSheet()SheetRuft das aktive Tabellenblatt in einer Tabellenkalkulation ab.
getAs(contentType)BlobGibt die Daten in diesem Objekt als Blob zurück, das in den angegebenen Inhaltstyp konvertiert wurde.
getBandings()Banding[]Gibt alle Bandings in dieser Tabellenkalkulation zurück.
getBlob()BlobGibt die Daten in diesem Objekt als Blob zurück.
getColumnWidth(columnPosition)IntegerRuft die Breite der angegebenen Spalte in Pixeln ab.
getCurrentCell()RangeGibt die aktuelle Zelle im aktiven Tabellenblatt zurück oder null, wenn keine Zelle vorhanden ist.
getDataRange()RangeGibt eine Range zurück, die den Dimensionen entspricht, in denen Daten vorhanden sind.
getDataSourceFormulas()DataSourceFormula[]Ruft alle Formeln für Datenquellen ab.
getDataSourcePivotTables()DataSourcePivotTable[]Ruft alle Pivot-Tabellen der Datenquelle ab.
getDataSourceRefreshSchedules()DataSourceRefreshSchedule[]Ruft die Aktualisierungspläne für diese Tabelle ab
getDataSourceSheets()DataSourceSheet[]Gibt alle Datenquellentabellen in der Tabelle zurück.
getDataSourceTables()DataSourceTable[]Ruft alle Datenquellentabellen ab.
getDataSources()DataSource[]Gibt alle Datenquellen in der Tabelle zurück.
getDeveloperMetadata()DeveloperMetadata[]Ruft die mit der Tabelle auf oberster Ebene verknüpften Entwicklermetadaten ab.
getEditors()User[]Ruft die Liste der Bearbeiter für diesen Spreadsheet ab.
getFormUrl()StringGibt die URL für das Formular zurück, das die Antworten an diese Tabelle sendet, oder null, wenn dieser Tabelle kein Formular zugeordnet ist
getFrozenColumns()IntegerGibt die Anzahl der fixierten Spalten zurück
getFrozenRows()IntegerGibt die Anzahl der fixierten Zeilen zurück
getId()StringRuft eine eindeutige ID für diese Tabelle ab.
getImages()OverGridImage[]Gibt alle über das Raster gelegten Bilder im Tabellenblatt zurück.
getIterativeCalculationConvergenceThreshold()NumberGibt den Grenzwert zurück, der während der iterativen Berechnung verwendet wird.
getLastColumn()IntegerGibt die Position der letzten Spalte mit Inhalt zurück.
getLastRow()IntegerGibt die Position der letzten Zeile mit Inhalt zurück.
getMaxIterativeCalculationCycles()IntegerGibt die maximale Anzahl der Iterationen für die iterative Berechnung zurück.
getName()StringRuft den Namen des Dokuments ab.
getNamedRanges()NamedRange[]Ruft alle benannten Bereiche in dieser Tabelle ab.
getNumSheets()IntegerGibt die Anzahl der Tabellenblätter in dieser Tabelle zurück.
getOwner()UserGibt den Eigentümer des Dokuments oder null für ein Dokument in einer geteilten Ablage zurück
getPredefinedSpreadsheetThemes()SpreadsheetTheme[]Gibt die Liste der vordefinierten Themen zurück
getProtections(type)Protection[]Ruft ein Array mit Objekten ab, die alle geschützten Bereiche oder Tabellenblätter in der Tabelle darstellen.
getRange(a1Notation)RangeGibt den Bereich in der A1- oder R1C1-Notation zurück.
getRangeByName(name)RangeGibt einen benannten Bereich oder null zurück, wenn kein Bereich mit dem angegebenen Namen gefunden wird.
getRangeList(a1Notations)RangeListGibt die Sammlung RangeList zurück, die die Bereiche im selben Tabellenblatt darstellt, die durch eine nicht leere Liste von A1- oder R1C1-Notationen angegeben werden.
getRecalculationInterval()RecalculationIntervalGibt das Berechnungsintervall für diese Tabellenkalkulation zurück.
getRowHeight(rowPosition)IntegerRuft die Höhe einer gegebenen Zeile in Pixeln ab.
getSelection()SelectionGibt die aktuelle Selection in der Tabelle zurück.
getSheetByName(name)SheetGibt ein Tabellenblatt mit dem angegebenen Namen zurück.
getSheetId()IntegerGibt die ID des durch dieses Objekt dargestellten Tabellenblatts zurück
getSheetName()StringGibt den Namen des Tabellenblatts zurück
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]Gibt das rechteckige Werteraster für diesen Bereich zurück, beginnend bei den angegebenen Koordinaten.
getSheets()Sheet[]Ruft alle Tabellenblätter in dieser Tabelle ab.
getSpreadsheetLocale()StringRuft das Gebietsschema für die Tabelle ab.
getSpreadsheetTheme()SpreadsheetThemeGibt das aktuelle Design der Tabelle zurück oder null, wenn kein Design angewendet wird.
getSpreadsheetTimeZone()StringZeitzone der Tabelle abrufen.
getUrl()StringGibt die URL für die angegebene Tabelle zurück.
getViewers()User[]Liste der Betrachter und Kommentatoren für diesen Spreadsheet abrufen
hideColumn(column)voidBlendet die Spalte(n) im angegebenen Bereich aus.
hideRow(row)voidBlendet die Zeilen im angegebenen Bereich aus.
insertColumnAfter(afterPosition)SheetFügt eine Spalte nach der angegebenen Spaltenposition ein.
insertColumnBefore(beforePosition)SheetFügt eine Spalte vor der angegebenen Spaltenposition ein.
insertColumnsAfter(afterPosition, howMany)SheetFügt eine bestimmte Anzahl von Spalten nach der angegebenen Spaltenposition ein.
insertColumnsBefore(beforePosition, howMany)SheetFügt eine bestimmte Anzahl von Spalten vor der angegebenen Spaltenposition ein.
insertDataSourceSheet(spec)DataSourceSheetFügt eine neue DataSourceSheet in die Tabelle ein und startet die Datenausführung.
insertImage(blobSource, column, row)OverGridImageFügt ein Spreadsheet als Bild in das Dokument bei einer bestimmten Zeile und Spalte ein.
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageFügt im Dokument an einer bestimmten Zeile und Spalte ein Spreadsheet als Bild mit Pixelversatz ein.
insertImage(url, column, row)OverGridImageFügt in einer bestimmten Zeile und Spalte ein Bild in das Dokument ein.
insertImage(url, column, row, offsetX, offsetY)OverGridImageFügt im Dokument ein Bild mit einem Pixelversatz in einer bestimmten Zeile und Spalte ein.
insertRowAfter(afterPosition)SheetFügt eine Zeile nach der angegebenen Zeilenposition ein.
insertRowBefore(beforePosition)SheetFügt eine Zeile vor der angegebenen Zeilenposition ein.
insertRowsAfter(afterPosition, howMany)SheetFügt eine bestimmte Anzahl von Zeilen nach der angegebenen Zeilenposition ein.
insertRowsBefore(beforePosition, howMany)SheetFügt eine bestimmte Anzahl von Zeilen vor der angegebenen Zeilenposition ein.
insertSheet()SheetFügt ein neues Tabellenblatt unter Verwendung eines Standardtabellennamens in die Tabellenkalkulation ein.
insertSheet(sheetIndex)SheetFügt beim angegebenen Index ein neues Tabellenblatt in die Tabellenkalkulation ein.
insertSheet(sheetIndex, options)SheetFügt am angegebenen Index ein neues Tabellenblatt in die Tabelle ein und verwendet optionale erweiterte Argumente.
insertSheet(options)SheetFügt ein neues Tabellenblatt in die Tabelle ein. Dabei werden ein Standardtabellenname und optionale erweiterte Argumente verwendet.
insertSheet(sheetName)SheetFügt in der Tabelle ein neues Tabellenblatt mit dem angegebenen Namen ein.
insertSheet(sheetName, sheetIndex)SheetFügt ein neues Tabellenblatt mit dem angegebenen Namen am angegebenen Index in die Tabellenkalkulation ein.
insertSheet(sheetName, sheetIndex, options)SheetFügt in die Tabelle ein neues Tabellenblatt mit dem angegebenen Namen am angegebenen Index ein und verwendet optionale erweiterte Argumente.
insertSheet(sheetName, options)SheetFügt in die Tabelle ein neues Tabellenblatt mit dem angegebenen Namen ein und verwendet optionale erweiterte Argumente.
insertSheetWithDataSourceTable(spec)SheetFügt ein neues Tabellenblatt in die Tabelle ein, erstellt eine DataSourceTable, die das gesamte Tabellenblatt mit der angegebenen Datenquellenspezifikation umfasst, und startet die Datenausführung.
isColumnHiddenByUser(columnPosition)BooleanGibt zurück, ob die angegebene Spalte vom Nutzer ausgeblendet wurde.
isIterativeCalculationEnabled()BooleanGibt zurück, ob die iterative Berechnung in dieser Tabellenkalkulation aktiviert ist.
isRowHiddenByFilter(rowPosition)BooleanGibt zurück, ob die angegebene Zeile durch einen Filter (nicht durch eine Filteransicht) ausgeblendet wurde.
isRowHiddenByUser(rowPosition)BooleanGibt zurück, ob die angegebene Zeile vom Nutzer ausgeblendet wurde.
moveActiveSheet(pos)voidVerschiebt das aktive Tabellenblatt an die angegebene Position in der Liste der Tabellenblätter.
moveChartToObjectSheet(chart)SheetErstellt ein neues SheetType.OBJECT-Tabellenblatt und verschiebt das angegebene Diagramm dorthin.
refreshAllDataSources()voidEs werden alle unterstützten Datenquellen und die zugehörigen verknüpften Datenquellenobjekte aktualisiert. Ungültige Datenquellenobjekte werden dabei übersprungen.
removeEditor(emailAddress)SpreadsheetEntfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Spreadsheet.
removeEditor(user)SpreadsheetEntfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Spreadsheet.
removeMenu(name)voidEntfernt eine Speisekarte, die von addMenu(name, subMenus) hinzugefügt wurde.
removeNamedRange(name)voidLöscht einen benannten Bereich mit dem angegebenen Namen.
removeViewer(emailAddress)SpreadsheetEntfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für Spreadsheet.
removeViewer(user)SpreadsheetEntfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für Spreadsheet.
rename(newName)voidBenennt das Dokument um.
renameActiveSheet(newName)voidBenennt das aktuell aktive Tabellenblatt in den angegebenen neuen Namen um.
resetSpreadsheetTheme()SpreadsheetThemeDas angewendete Design wird entfernt und das Standarddesign der Tabelle festgelegt.
setActiveRange(range)RangeLegt den angegebenen Bereich als active range im aktiven Tabellenblatt fest, wobei die linke obere Zelle im Bereich als current cell festgelegt ist.
setActiveRangeList(rangeList)RangeListLegt die angegebene Liste von Bereichen als active ranges im aktiven Tabellenblatt fest.
setActiveSelection(range)RangeLegt den aktiven Auswahlbereich für dieses Tabellenblatt fest.
setActiveSelection(a1Notation)RangeLegt die aktive Auswahl wie in der A1- oder R1C1-Notation angegeben fest.
setActiveSheet(sheet)SheetLegt fest, dass das angegebene Tabellenblatt als aktives Tabellenblatt in der Tabelle festgelegt wird.
setActiveSheet(sheet, restoreSelection)SheetSetzt das angegebene Tabellenblatt als aktives Blatt in der Tabelle und bietet eine Option zum Wiederherstellen der zuletzt ausgewählten Auswahl in diesem Tabellenblatt.
setColumnWidth(columnPosition, width)SheetLegt die Breite der angegebenen Spalte in Pixeln fest.
setCurrentCell(cell)RangeLegt die angegebene Zelle als current cell fest.
setFrozenColumns(columns)voidFixiert die angegebene Anzahl von Spalten.
setFrozenRows(rows)voidFixiert die angegebene Anzahl von Zeilen.
setIterativeCalculationConvergenceThreshold(minThreshold)SpreadsheetLegt den Mindestgrenzwert für die iterative Berechnung fest.
setIterativeCalculationEnabled(isEnabled)SpreadsheetLegt fest, ob die iterative Berechnung in dieser Tabelle aktiviert ist.
setMaxIterativeCalculationCycles(maxIterations)SpreadsheetLegt die maximale Anzahl der Berechnungsiterationen fest, die während der iterativen Berechnung ausgeführt werden sollen.
setNamedRange(name, range)voidBenennt einen Bereich.
setRecalculationInterval(recalculationInterval)SpreadsheetLegt fest, wie oft diese Tabelle neu berechnet werden soll.
setRowHeight(rowPosition, height)SheetLegt die Zeilenhöhe der angegebenen Zeile in Pixeln fest.
setSpreadsheetLocale(locale)voidLegt das Gebietsschema für die Tabelle fest.
setSpreadsheetTheme(theme)SpreadsheetThemeLegt ein Design für die Tabelle fest.
setSpreadsheetTimeZone(timezone)voidLegt die Zeitzone für die Tabelle fest.
show(userInterface)voidZeigt eine benutzerdefinierte UI-Komponente in einem Dialogfeld an, das im Darstellungsbereich des Nutzers zentriert ist.
sort(columnPosition)SheetSortiert ein Tabellenblatt aufsteigend nach Spalte.
sort(columnPosition, ascending)SheetSortiert ein Tabellenblatt nach Spalten.
toast(msg)voidZeigt unten rechts in der Tabelle ein Pop-up-Fenster mit der jeweiligen Nachricht an.
toast(msg, title)voidZeigt unten rechts in der Tabelle ein Pop-up-Fenster mit der angegebenen Nachricht und dem Titel an.
toast(msg, title, timeoutSeconds)voidZeigt in der rechten unteren Ecke der Tabelle ein Pop-up-Fenster mit dem angegebenen Titel und der Nachricht an, das für einen bestimmten Zeitraum sichtbar bleibt.
unhideColumn(column)voidBlendet die Spalte im angegebenen Bereich ein
unhideRow(row)voidBlendet die Zeile im angegebenen Bereich ein
updateMenu(name, subMenus)voidAktualisiert eine Speisekarte, die von addMenu(name, subMenus) hinzugefügt wurde.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidWartet, bis alle aktuellen Ausführungen in der Tabelle abgeschlossen sind, und endet nach der angegebenen Anzahl von Sekunden.

Detaillierte Dokumentation

addDeveloperMetadata(key)

Fügt der Tabelle auf oberster Ebene Entwicklermetadaten mit dem angegebenen Schlüssel hinzu.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds the key 'NAME' in the developer metadata for the spreadsheet.
ss.addDeveloperMetadata('NAME')

// Gets the first developer metadata object and logs its key.
const developerMetaData = ss.getDeveloperMetadata()[0]
console.log(developerMetaData.getKey())

Parameter

NameTypBeschreibung
keyStringDer Schlüssel für die neuen Entwicklermetadaten.

Return

Spreadsheet: Diese Tabelle 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

addDeveloperMetadata(key, visibility)

Fügt der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel und der Sichtbarkeit hinzu.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds the key 'NAME' in the developer metadata for the spreadsheet and sets the visibility
// to the developer project that created the metadata.
ss.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

// Gets the first developer metadata object and logs its key and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()},
.             Visibility: ${developerMetaData.getVisibility()}`);

Parameter

NameTypBeschreibung
keyStringDer Schlüssel für die neuen Entwicklermetadaten.
visibilityDeveloperMetadataVisibilityDie Sichtbarkeit der neuen Entwicklermetadaten.

Return

Spreadsheet: Diese Tabelle 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

addDeveloperMetadata(key, value)

Fügt der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel und Wert hinzu.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds the key 'NAME' and sets the value to 'GOOGLE' in the developer metadata for the
// spreadsheet.
ss.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the first developer metadata object and logs its key and value.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()}, Value: ${developerMetaData.getValue()}`);

Parameter

NameTypBeschreibung
keyStringDer Schlüssel für die neuen Entwicklermetadaten.
valueStringDer Wert für die neuen Entwicklermetadaten.

Return

Spreadsheet: Diese Tabelle 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

addDeveloperMetadata(key, value, visibility)

Fügt der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel, Wert und der Sichtbarkeit hinzu.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to any developer project with document access.
ss.addDeveloperMetadata('NAME', 'GOOGLE', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

// Gets the first developer metadata object and logs its key, value, and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(`Key: ${developerMetaData.getKey()},
             Value: ${developerMetaData.getValue()},
             Visibility: ${developerMetaData.getVisibility()}`);

Parameter

NameTypBeschreibung
keyStringDer Schlüssel für die neuen Entwicklermetadaten.
valueStringDer Wert für die neuen Entwicklermetadaten.
visibilityDeveloperMetadataVisibilityDie Sichtbarkeit der neuen Entwicklermetadaten.

Return

Spreadsheet: Diese Tabelle 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

addEditor(emailAddress)

Fügt den angegebenen Nutzer der Liste der Bearbeiter für Spreadsheet hinzu. Wenn der Nutzer bereits in der Liste der Betrachter enthalten war, wird er mit dieser Methode aus der Liste der Betrachter herausgestuft.

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des Nutzers, der hinzugefügt werden soll.

Return

Spreadsheet: Dieses Spreadsheet 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

addEditor(user)

Fügt den angegebenen Nutzer der Liste der Bearbeiter für Spreadsheet hinzu. Wenn der Nutzer bereits in der Liste der Betrachter enthalten war, wird er mit dieser Methode aus der Liste der Betrachter herausgestuft.

Parameter

NameTypBeschreibung
userUserEine Darstellung des hinzuzufügenden Nutzers.

Return

Spreadsheet: Dieses Spreadsheet 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

addEditors(emailAddresses)

Fügt das angegebene Array von Nutzern der Liste der Bearbeiter für Spreadsheet hinzu. Wenn einer der Nutzer bereits in der Liste der Betrachter enthalten war, wird er mit dieser Methode aus der Liste der Betrachter herausgestuft.

Parameter

NameTypBeschreibung
emailAddressesString[]Ein Array mit E-Mail-Adressen der hinzuzufügenden Nutzer.

Return

Spreadsheet: Dieses Spreadsheet 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

addMenu(name, subMenus)

Erstellt ein neues Menü in der Tabellen-UI.

Jeder Menüeintrag führt eine benutzerdefinierte Funktion aus. Normalerweise wird es über die Funktion onOpen() aufgerufen, damit das Menü beim Laden der Tabelle automatisch erstellt wird.

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  var menuEntries = [];
  // When the user clicks on "addMenuExample" then "Menu Entry 1", the function function1 is
  // executed.
  menuEntries.push({name: "Menu Entry 1", functionName: "function1"});
  menuEntries.push(null); // line separator
  menuEntries.push({name: "Menu Entry 2", functionName: "function2"});

  ss.addMenu("addMenuExample", menuEntries);
}

Parameter

NameTypBeschreibung
nameStringDer Name des zu erstellenden Menüs.
subMenusObject[]Ein Array von JavaScript-Zuordnungen mit den Parametern name und functionName . Sie können Funktionen aus enthaltenen Bibliotheken wie Library.libFunction1 verwenden.

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

addViewer(emailAddress)

Fügt den angegebenen Nutzer der Liste der Betrachter für Spreadsheet hinzu. Wenn sich der Nutzer bereits in der Liste der Bearbeiter befand, hat diese Methode keine Auswirkungen.

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des Nutzers, der hinzugefügt werden soll.

Return

Spreadsheet: Dieses Spreadsheet 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

addViewer(user)

Fügt den angegebenen Nutzer der Liste der Betrachter für Spreadsheet hinzu. Wenn sich der Nutzer bereits in der Liste der Bearbeiter befand, hat diese Methode keine Auswirkungen.

Parameter

NameTypBeschreibung
userUserEine Darstellung des hinzuzufügenden Nutzers.

Return

Spreadsheet: Dieses Spreadsheet 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

addViewers(emailAddresses)

Fügt das angegebene Array von Nutzern der Liste der Betrachter für Spreadsheet hinzu. Wenn sich Nutzer bereits in der Liste der Bearbeiter befanden, hat diese Methode keine Auswirkungen auf sie.

Parameter

NameTypBeschreibung
emailAddressesString[]Ein Array mit E-Mail-Adressen der hinzuzufügenden Nutzer.

Return

Spreadsheet: Dieses Spreadsheet 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

appendRow(rowContents)

Hängt am Ende des aktuellen Datenbereichs im Tabellenblatt eine Zeile an. Wenn der Inhalt einer Zelle mit = beginnt, wird dies als Formel interpretiert.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Appends a new row with 3 columns to the bottom of the current
// data region in the sheet containing the values in the array.
sheet.appendRow(["a man", "a plan", "panama"]);

Parameter

NameTypBeschreibung
rowContentsObject[]Ein Array von Werten, die nach der letzten Zeile im Tabellenblatt eingefügt werden sollen.

Return

Sheet: Das Tabellenblatt, das für die Verkettung von Methoden nützlich ist.

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

Legt die Breite der angegebenen Spalte so fest, dass sie in den Inhalt passt.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.getRange('a1').setValue('Whenever it is a damp, drizzly November in my soul...');

// Sets the first column to a width which fits the text
sheet.autoResizeColumn(1);

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der Spalte, deren Größe geändert werden soll.

Return

Sheet – das Tabellenblatt, das für die Verkettung von Methoden nützlich ist

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

copy(name)

Kopiert die Tabelle und gibt die neue zurück.

// This code makes a copy of the current spreadsheet and names it appropriately
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.copy("Copy of " + ss.getName());

Parameter

NameTypBeschreibung
nameStringDer Name der Kopie.

Return

Spreadsheet: Diese Tabelle 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

createDeveloperMetadataFinder()

Gibt ein DeveloperMetadataFinder zurück, um Entwicklermetadaten im Bereich dieser Tabelle zu finden. Standardmäßig werden dabei alle mit der Tabelle, Tabellen, Zeilen und Spalten verknüpften Metadaten berücksichtigt.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds developer metadata to the spreadsheet.
ss.addDeveloperMetadata('NAME', 'CHARLIE');
ss.addDeveloperMetadata('COMPANY', 'EXAMPLE ORGANIZATION');
ss.addDeveloperMetadata('TECHNOLOGY', 'JAVASCRIPT');

// Creates a developer metadata finder.
const developerMetadataFinder = ss.createDeveloperMetadataFinder();

// Finds the developer metadata objects with 'COMPANY' as the key.
const googleMetadataFromSpreadsheet = developerMetadataFinder.withKey('COMPANY').find();

// Gets the first result of developer metadata that has the key 'COMPANY' and logs its value.
console.log(googleMetadataFromSpreadsheet[0].getValue());

Return

DeveloperMetadataFinder: Ein Finder für Entwicklermetadaten zum Suchen nach Metadaten im Rahmen dieser Tabelle.


createTextFinder(findText)

Erstellt eine Textsuche für die Tabelle, mit der Text in der Tabelle gesucht und ersetzt werden kann. Die Suche beginnt mit dem ersten Tabellenblatt der Tabelle.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

// Creates  a text finder.
var textFinder = spreadsheet.createTextFinder('dog');

// Returns the first occurrence of 'dog' in the spreadsheet.
var firstOccurrence = textFinder.findNext();

// Replaces the last found occurrence of 'dog' with 'cat' and returns the number
// of occurrences replaced.
var numOccurrencesReplaced = findOccurrence.replaceWith('cat');

Parameter

NameTypBeschreibung
findTextStringDer Text, nach dem gesucht werden soll.

Return

TextFinder: Der TextFinder für die Tabelle.


deleteActiveSheet()

Löscht das derzeit aktive Tabellenblatt.

// The code below deletes the currently active sheet and stores the new active sheet in a
// variable
var newSheet = SpreadsheetApp.getActiveSpreadsheet().deleteActiveSheet();

Return

Sheet: Das neue aktive 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

deleteColumn(columnPosition)

Löscht die Spalte an der angegebenen Spaltenposition.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first column
sheet.deleteColumn(1);

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der Spalte, beginnend bei 1 für die erste Spalte.

Return

Sheet – das Tabellenblatt, das für die Verkettung von Methoden nützlich ist

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

deleteColumns(columnPosition, howMany)

Löscht eine Reihe von Spalten ab der angegebenen Spaltenposition.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first two columns
sheet.deleteColumns(1, 2);

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der ersten zu löschenden Spalte.
howManyIntegerDie Anzahl der zu löschenden Spalten.

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

deleteRow(rowPosition)

Löscht die Zeile an der angegebenen Zeilenposition.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first row
sheet.deleteRow(1);

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der Zeile, beginnend bei 1 für die erste Zeile.

Return

Sheet – das Tabellenblatt, das für die Verkettung von Methoden nützlich ist

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

deleteRows(rowPosition, howMany)

Löscht eine bestimmte Anzahl von Zeilen ab der angegebenen Zeilenposition.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first two rows
sheet.deleteRows(1, 2);

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der ersten Zeile, die gelöscht werden soll.
howManyIntegerDie Anzahl der zu löschenden Zeilen.

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

deleteSheet(sheet)

Löscht das angegebene Tabellenblatt.

// The code below deletes the specified sheet.
var ss = SpreadsheetApp.getActive();
var sheet = ss.getSheetByName('My Sheet');
ss.deleteSheet(sheet);

Parameter

NameTypBeschreibung
sheetSheetDas zu löschende 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

duplicateActiveSheet()

Dupliziert das aktive Tabellenblatt und macht es zum aktiven Tabellenblatt.

// The code below makes a duplicate of the active sheet
SpreadsheetApp.getActiveSpreadsheet().duplicateActiveSheet();

Return

Sheet: Das neue 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

getActiveCell()

Gibt die aktive Zelle in diesem Tabellenblatt zurück.

Hinweis:Wir empfehlen die Verwendung von getCurrentCell(), da damit die aktuell markierte Zelle zurückgegeben wird.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Returns the active cell
var cell = sheet.getActiveCell();

Return

Range: die aktuell aktive Zelle

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

getActiveRange()

Gibt den ausgewählten Bereich im aktiven Tabellenblatt zurück oder null, wenn kein aktiver Bereich vorhanden ist Wenn mehrere Bereiche ausgewählt sind, gibt diese Methode nur den zuletzt ausgewählten Bereich zurück.

Der Begriff „aktiver Bereich“ bezieht sich auf den Bereich, den ein Nutzer im aktiven Tabellenblatt ausgewählt hat. In einer benutzerdefinierten Funktion bezieht er sich jedoch auf die Zelle, die aktiv neu berechnet wird.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var activeRange = sheet.getActiveRange();

Return

Range – der aktive Bereich

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

Weitere Informationen


getActiveRangeList()

Gibt die Liste der aktiven Bereiche im aktiven Tabellenblatt zurück oder null, wenn keine aktiven Bereiche vorhanden sind.

Wenn nur ein Bereich ausgewählt ist, verhält sich dies wie ein getActiveRange()-Aufruf.

var sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
var activeRangeList = sheet.getActiveRangeList();

Return

RangeList – die Liste der aktiven Bereiche

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

Weitere Informationen


getActiveSheet()

Ruft das aktive Tabellenblatt in einer Tabellenkalkulation ab.

Das aktive Tabellenblatt in einer Tabellenkalkulation ist das Tabellenblatt, das auf der Tabellen-UI angezeigt wird.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();

Return

Sheet: Das aktive Tabellenblatt in der Tabelle.


getAs(contentType)

Gibt die Daten in diesem Objekt als Blob zurück, das in den angegebenen Inhaltstyp konvertiert wurde. Bei dieser Methode wird dem Dateinamen die entsprechende Erweiterung hinzugefügt, z. B. "myfile.pdf". Dabei wird jedoch davon ausgegangen, dass der Teil des Dateinamens, der auf den letzten Punkt (falls vorhanden) folgt, eine vorhandene Erweiterung ist, die ersetzt werden sollte. Aus „ShoppingList.12.25.2014“ wird dann „ShoppingList.12.25.pdf“.

Informationen zu den Tageskontingenten für Conversions finden Sie unter Kontingente für Google-Dienste. Für neu erstellte Google Workspace-Domains gelten möglicherweise vorübergehend strengere Kontingente.

Parameter

NameTypBeschreibung
contentTypeStringDer MIME-Typ, in den konvertiert werden soll. Für die meisten Blobs ist 'application/pdf' die einzige gültige Option. Für Bilder im BMP-, GIF-, JPEG- oder PNG-Format sind auch 'image/bmp', 'image/gif', 'image/jpeg' oder 'image/png' gültig.

Return

Blob: Die Daten als Blob.


getBandings()

Gibt alle Bandings in dieser Tabellenkalkulation zurück.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets an array of the bandings in the spreadsheet.
const bandings = ss.getBandings();

// Logs the range of the first banding in the spreadsheet to the console.
console.log(bandings[0].getRange().getA1Notation());

Return

Banding[]: Die Streifen in dieser Tabelle.

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

getBlob()

Gibt die Daten in diesem Objekt als Blob zurück.

Return

Blob: Die Daten als Blob.


getColumnWidth(columnPosition)

Ruft die Breite der angegebenen Spalte in Pixeln ab.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.getColumnWidth(1));

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der zu untersuchenden Spalte.

Return

Integer: Spaltenbreite in Pixeln

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

getCurrentCell()

Gibt die aktuelle Zelle im aktiven Tabellenblatt zurück oder null, wenn keine Zelle vorhanden ist. Die aktuelle Zelle ist in der Benutzeroberfläche von Google Tabellen im Fokus und wird durch einen dunklen Rahmen hervorgehoben. Es gibt nie mehr als eine aktuelle Zelle. Wenn ein Nutzer einen oder mehrere Zellenbereiche auswählt, ist eine der Zellen in der Auswahl die aktuelle Zelle.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
// Returns the current highlighted cell in the one of the active ranges.
var currentCell = sheet.getCurrentCell();

Return

Range: die aktuelle Zelle

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

getDataRange()

Gibt eine Range zurück, die den Dimensionen entspricht, in denen Daten vorhanden sind.

Dies entspricht funktional der Erstellung eines durch A1 und (Sheet.getLastColumn(), Sheet.getLastRow()) begrenzten Bereichs.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This represents ALL the data
var range = sheet.getDataRange();
var values = range.getValues();

// This logs the spreadsheet in CSV format with a trailing comma
for (var i = 0; i < values.length; i++) {
  var row = "";
  for (var j = 0; j < values[i].length; j++) {
    if (values[i][j]) {
      row = row + values[i][j];
    }
    row = row + ",";
  }
  Logger.log(row);
}

Return

Range: ein Bereich, der aus allen Daten in der Tabelle besteht

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

getDataSourceFormulas()

Ruft alle Formeln für Datenquellen ab.

// Opens the spreadsheet by its ID. If you created your script from within a Google Sheets
// file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source formulas on Sheet1.
// To get an array of data source formulas for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceFormulas = sheet.getDataSourceFormulas();

// Logs the first data source formula in the array.
console.log(dataSourceFormulas[0].getFormula());

Return

DataSourceFormula[]: Eine Liste mit Datenquellenformeln.

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

getDataSourcePivotTables()

Ruft alle Pivot-Tabellen der Datenquelle ab.

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source pivot tables on Sheet1.
// To get an array of data source pivot tables for the entire
// spreadsheet, replace 'sheet' with 'ss'.
const dataSourcePivotTables = sheet.getDataSourcePivotTables();

// Logs the last time that the first pivot table in the array was refreshed.
console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

Return

DataSourcePivotTable[]: Eine Liste der Pivot-Tabellen der 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

getDataSourceRefreshSchedules()

Ruft die Aktualisierungspläne für diese Tabelle ab

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Activates BigQuery operations for the connected spreadsheet.
SpreadsheetApp.enableBigQueryExecution();

// Gets the frequency type of the first referesh schedule in the array.
const frequencyType = ss.getDataSourceRefreshSchedules()[0]
                        .getFrequency()
                        .getFrequencyType()
                        .toString();

// Logs the frequency type to the console.
console.log(frequencyType);

Return

DataSourceRefreshSchedule[]: Die Zeitpläne für die Aktualisierung dieser Tabelle.

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

getDataSourceSheets()

Gibt alle Datenquellentabellen in der Tabelle zurück.

// Turns data execution on for BigQuery data sources.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets the first data source sheet in the spreadsheet.
const dataSource = ss.getDataSourceSheets()[0];

// Gets the name of the data source sheet.
console.log(dataSource.asSheet().getName());

Return

DataSourceSheet[]: Ein Array aller Tabellenblätter der 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

getDataSourceTables()

Ruft alle Datenquellentabellen ab.

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of data source tables on Sheet1.
// To get an array of data source tables for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceTables = sheet.getDataSourceTables();

// Logs the last completed data execution time on the first data source table.
console.log(dataSourceTables[0].getStatus().getLastExecutionTime());

Return

DataSourceTable[]: Eine Liste mit Datenquellentabellen.

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

getDataSources()

Gibt alle Datenquellen in der Tabelle zurück.

// Turns data execution on for BigQuery data sources.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets the data sources on the spreadsheet.
const dataSources = ss.getDataSources();

// Logs the name of the first column on the first data source.
console.log(dataSources[0].getColumns()[0].getName());

Return

DataSource[]: Ein Array aller Datenquellen.

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

getDeveloperMetadata()

Ruft die mit der Tabelle auf oberster Ebene verknüpften Entwicklermetadaten ab.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds 'Google' as a key to the spreadsheet metadata.
ss.addDeveloperMetadata('Google');

// Gets the spreadsheet's metadata.
const ssMetadata = ss.getDeveloperMetadata();

// Gets the first set of the spreadsheet's metadata and logs the key to the console.
console.log(ssMetadata[0].getKey());

Return

DeveloperMetadata[]: Die mit diesem Bereich verknüpften Entwicklermetadaten.

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

getEditors()

Ruft die Liste der Bearbeiter für diesen Spreadsheet ab.

Return

User[]: Ein Array von Nutzern mit Bearbeitungsberechtigung.

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

getFormUrl()

Gibt die URL für das Formular zurück, das die Antworten an diese Tabelle sendet, oder null, wenn dieser Tabelle kein Formular zugeordnet ist Wenn Antworten von mehreren Formularen an diese Tabelle gesendet werden, ist die zurückgegebene Formular-URL unbestimmt. Alternativ können URL-Verknüpfungen pro Tabellenblatt über die Methode Sheet.getFormUrl() abgerufen werden.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets the form URL from the spreadsheet.
const formUrl = ss.getFormUrl();

// Logs the form URL to the console.
console.log(formUrl);

Return

String: Die URL für das Formular, über das die Antworten in diese Tabelle eingefügt werden, oder null, wenn es kein zugehöriges Formular gibt.

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

getFrozenColumns()

Gibt die Anzahl der fixierten Spalten zurück

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log("Number of frozen columns: %s", sheet.getFrozenColumns());

Return

Integer: die Anzahl der fixierten Spalten

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

getFrozenRows()

Gibt die Anzahl der fixierten Zeilen zurück

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log("Number of frozen rows: %s", sheet.getFrozenRows());

Return

Integer: die Anzahl der fixierten Zeilen

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

getId()

Ruft eine eindeutige ID für diese Tabelle ab. Eine Tabellen-ID kann aus ihrer URL extrahiert werden. Die Tabellen-ID in der URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 lautet beispielsweise "abc1234567".

// The code below logs the ID for the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getId());

Return

String: Die eindeutige ID (oder der Schlüssel) der Tabelle.


getImages()

Gibt alle über das Raster gelegten Bilder im Tabellenblatt zurück.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the over-the-grid images from Sheet1.
// To get the over-the-grid images from the entire spreadsheet, use ss.getImages() instead.
const images = sheet.getImages();

// For each image, logs the anchor cell in A1 notation.
for (const image of images) {
 console.log(image.getAnchorCell().getA1Notation());
}

Return

OverGridImage[]: Ein Array von Bildern, die über das Raster gelegt werden.

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

getIterativeCalculationConvergenceThreshold()

Gibt den Grenzwert zurück, der während der iterativen Berechnung verwendet wird. Wenn die Ergebnisse einer sukzessiven Berechnung um weniger als dieser Wert abweichen, wird die iterative Berechnung beendet.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the iterative calculation convergence threshold for the spreadsheet.
ss.setIterativeCalculationConvergenceThreshold(2);

// Logs the threshold to the console.
console.log(ss.getIterativeCalculationConvergenceThreshold());

Return

Number: Der Konvergenzschwellenwert.

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

getLastColumn()

Gibt die Position der letzten Spalte mit Inhalt zurück.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

Return

Integer: Die letzte Spalte des Tabellenblatts, die Inhalte enthält.

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

getLastRow()

Gibt die Position der letzten Zeile mit Inhalt zurück.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

Return

Integer: die letzte Zeile des Tabellenblatts, die Inhalte enthält

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

getMaxIterativeCalculationCycles()

Gibt die maximale Anzahl der Iterationen für die iterative Berechnung zurück.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.getMaxIterativeCalculationCycles());

Return

Integer: Die maximale Anzahl der Berechnungsdurchläufe.

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

getName()

Ruft den Namen des Dokuments ab.

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getName());

Return

String: Der Name der Tabelle.

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

getNamedRanges()

Ruft alle benannten Bereiche in dieser Tabelle ab.

// The code below logs the name of the first named range.
var namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();
for (var i = 0; i < namedRanges.length; i++) {
  Logger.log(namedRanges[i].getName());
}

Return

NamedRange[]: Ein Array aller benannten Bereiche in der Tabelle.

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

getNumSheets()

Gibt die Anzahl der Tabellenblätter in dieser Tabelle zurück.

// The code below logs the number of sheets in the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getNumSheets());

Return

Integer: Die Anzahl der Tabellenblätter in der Tabelle.


getOwner()

Gibt den Eigentümer des Dokuments oder null für ein Dokument in einer geteilten Ablage zurück

var ss = SpreadsheetApp.getActiveSpreadsheet();
var owner = ss.getOwner();
Logger.log(owner.getEmail());

Return

User: Der Eigentümer des Dokuments oder null, wenn sich das Dokument in einer geteilten Ablage befindet.

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

getPredefinedSpreadsheetThemes()

Gibt die Liste der vordefinierten Themen zurück

// The code below returns the list of predefined themes.
var predefinedThemesList = SpreadsheetApp.getActiveSpreadsheet()
                               .getPredefinedSpreadsheetThemes();

Return

SpreadsheetTheme[]: Liste vordefinierter Themen.

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

getProtections(type)

Ruft ein Array mit Objekten ab, die alle geschützten Bereiche oder Tabellenblätter in der Tabelle darstellen.

// Remove all range protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}
// Remove all sheet protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.SHEET);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

Parameter

NameTypBeschreibung
typeProtectionTypeDer Typ des Schutzgebiets, entweder SpreadsheetApp.ProtectionType.RANGE oder SpreadsheetApp.ProtectionType.SHEET.

Return

Protection[]: ein Array mit Objekten, die alle geschützten Bereiche oder Tabellenblätter in der Tabelle darstellen

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

getRange(a1Notation)

Gibt den Bereich in der A1- oder R1C1-Notation zurück.

// Get a range A1:D4 on sheet titled "Invoices"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var range = ss.getRange("Invoices!A1:D4");

// Get cell A1 on the first sheet
var sheet = ss.getSheets()[0];
var cell = sheet.getRange("A1");

Parameter

NameTypBeschreibung
a1NotationStringDer zurückzugebende Bereich, wie in A1- oder R1C1-Notation angegeben.

Return

Range: der Bereich am festgelegten Ort

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

getRangeByName(name)

Gibt einen benannten Bereich oder null zurück, wenn kein Bereich mit dem angegebenen Namen gefunden wird. Wenn mehrere Tabellenblätter der Tabelle denselben Bereichsnamen haben, geben Sie den Namen des Tabellenblatts ohne zusätzliche Anführungszeichen an, z. B. getRangeByName('TaxRates') oder getRangeByName('Sheet Name!TaxRates'), aber nicht getRangeByName('"Sheet Name"!TaxRates').

// Log the number of columns for the range named 'TaxRates' in the active spreadsheet.
var range = SpreadsheetApp.getActiveSpreadsheet().getRangeByName('TaxRates');
if (range != null) {
  Logger.log(range.getNumColumns());
}

Parameter

NameTypBeschreibung
nameStringDer Name des abzurufenden Bereichs.

Return

Range: Zellenbereich mit dem angegebenen Namen.


getRangeList(a1Notations)

Gibt die Sammlung RangeList zurück, die die Bereiche im selben Tabellenblatt darstellt, die durch eine nicht leere Liste von A1- oder R1C1-Notationen angegeben werden.

// Get a list of ranges A1:D4, F1:H4.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var rangeList  = sheet.getRangeList(['A1:D4', 'F1:H4']);

Parameter

NameTypBeschreibung
a1NotationsString[]Die Liste der zurückzugebenden Bereiche gemäß A1- oder R1C1-Notation.

Return

RangeList: die Bereichsliste an dem angegebenen Standort

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

getRecalculationInterval()

Gibt das Berechnungsintervall für diese Tabellenkalkulation zurück.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Logs the calculation interval for the spreadsheet to the console.
console.log(ss.getRecalculationInterval().toString());

Return

RecalculationInterval: Das Berechnungsintervall für diese Tabelle.

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

getRowHeight(rowPosition)

Ruft die Höhe einer gegebenen Zeile in Pixeln ab.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.getRowHeight(1));

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der zu untersuchenden Zeile.

Return

Integer: Zeilenhöhe in Pixeln

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

getSelection()

Gibt die aktuelle Selection in der Tabelle zurück.

var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
var currentCell = selection.getCurrentCell();

Return

Selection – die aktuelle Auswahl

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

getSheetByName(name)

Gibt ein Tabellenblatt mit dem angegebenen Namen zurück.

Wenn mehrere Tabellenblätter denselben Namen haben, wird dasjenige ganz links zurückgegeben. Gibt null zurück, wenn kein Tabellenblatt mit dem angegebenen Namen vorhanden ist.

// The code below logs the index of a sheet named "Expenses"
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Expenses");
if (sheet != null) {
  Logger.log(sheet.getIndex());
}

Parameter

NameTypBeschreibung
nameStringDer Name des abzurufenden Tabellenblatts.

Return

Sheet: Das Tabellenblatt mit dem angegebenen Namen.


getSheetId()

Gibt die ID des durch dieses Objekt dargestellten Tabellenblatts zurück

Dies ist eine eindeutige ID für das Tabellenblatt. Die ID ist eine kontinuierlich ansteigende Ganzzahl, die beim Erstellen des Tabellenblatts zugewiesen wird und unabhängig von der Position des Tabellenblatts ist. Dies ist in Verbindung mit Methoden wie Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) nützlich, die einen gridId-Parameter anstelle einer Sheet-Instanz verwenden.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetId());

Return

Integer: die eindeutige ID des Arbeitsblatts in der Tabelle

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

getSheetName()

Gibt den Namen des Tabellenblatts zurück

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetName());

Return

String: der Name des Tabellenblatts

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(startRow, startColumn, numRows, numColumns)

Gibt das rechteckige Werteraster für diesen Bereich zurück, beginnend bei den angegebenen Koordinaten. Ein -1-Wert für die Zeilen- oder Spaltenposition entspricht dem Abrufen der letzten Zeile oder Spalte mit Daten im Tabellenblatt.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The two samples below produce the same output
var values = sheet.getSheetValues(1, 1, 3, 3);
Logger.log(values);

var range = sheet.getRange(1, 1, 3, 3);
values = range.getValues();
Logger.log(values);

Parameter

NameTypBeschreibung
startRowIntegerDie Position der Startzeile.
startColumnIntegerDie Position der Startspalte.
numRowsIntegerDie Anzahl der Zeilen, für die Werte zurückgegeben werden sollen.
numColumnsIntegerDie Anzahl der Spalten, für die Werte zurückgegeben werden sollen.

Return

Object[][]: ein zweidimensionales 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

getSheets()

Ruft alle Tabellenblätter in dieser Tabelle ab.

// The code below logs the name of the second sheet
var sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
if (sheets.length > 1) {
  Logger.log(sheets[1].getName());
}

Return

Sheet[]: ein Array aller Tabellenblätter in der Tabelle.


getSpreadsheetLocale()

Ruft das Gebietsschema für die Tabelle ab.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

Return

String: Das Gebietsschema der Tabelle.

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

getSpreadsheetTheme()

Gibt das aktuelle Design der Tabelle zurück oder null, wenn kein Design angewendet wird.

// The code below returns the current theme of the spreadsheet.
var currentTheme = SpreadsheetApp.getActiveSpreadsheet().getSpreadsheetTheme();

Return

SpreadsheetTheme: Das aktuell angewendete Design.

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

getSpreadsheetTimeZone()

Zeitzone der Tabelle abrufen.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

Return

String: Die Zeitzone im „long“-Format (z. B. „America/New_York“, wie auf Joda.org aufgeführt).

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

getUrl()

Gibt die URL für die angegebene Tabelle zurück.

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getUrl());

Return

String: Die URL der angegebenen Tabelle.

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

getViewers()

Liste der Betrachter und Kommentatoren für diesen Spreadsheet abrufen

Return

User[]: ein Array von Nutzern mit Lese- oder Kommentarberechtigung.

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

hideColumn(column)

Blendet die Spalte(n) im angegebenen Bereich aus.

let ss = SpreadsheetApp.getActiveSpreadsheet();
let sheet = ss.getSheets()[0];

// This hides the first column
let range = sheet.getRange("A1");
sheet.hideColumn(range);

// This hides the first 3 columns
let range = sheet.getRange("A:C");
sheet.hideColumn(range);

Parameter

NameTypBeschreibung
columnRangeDer Spaltenbereich, der ausgeblendet 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

hideRow(row)

Blendet die Zeilen im angegebenen Bereich aus.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This hides the first row
var range = sheet.getRange("A1");
sheet.hideRow(range);

Parameter

NameTypBeschreibung
rowRangeDer Zeilenbereich, der ausgeblendet 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

insertColumnAfter(afterPosition)

Fügt eine Spalte nach der angegebenen Spaltenposition ein.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a column after the first column position
sheet.insertColumnAfter(1);

Parameter

NameTypBeschreibung
afterPositionIntegerSpalte, nach der die neue Spalte hinzugefügt werden soll.

Return

Sheet – das Tabellenblatt, das für die Verkettung von Methoden nützlich ist

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

insertColumnBefore(beforePosition)

Fügt eine Spalte vor der angegebenen Spaltenposition ein.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a column in the first column position
sheet.insertColumnBefore(1);

Parameter

NameTypBeschreibung
beforePositionIntegerDie Spalte, vor der die neue Spalte eingefügt werden soll.

Return

Sheet – das Tabellenblatt, das für die Verkettung von Methoden nützlich ist

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

insertColumnsAfter(afterPosition, howMany)

Fügt eine bestimmte Anzahl von Spalten nach der angegebenen Spaltenposition ein.

let ss = SpreadsheetApp.getActiveSpreadsheet();
let sheet = ss.getSheets()[0];

// Inserts two columns after the first column on the first sheet of the spreadsheet.
sheet.insertColumnsAfter(1,2);

Parameter

NameTypBeschreibung
afterPositionIntegerSpalte, nach der die neue Spalte hinzugefügt werden soll.
howManyIntegerDie Anzahl der einzufügenden Spalten.

Return

Sheet – das Tabellenblatt, das für die Verkettung von Methoden nützlich ist

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

insertColumnsBefore(beforePosition, howMany)

Fügt eine bestimmte Anzahl von Spalten vor der angegebenen Spaltenposition ein.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five columns before the first column
sheet.insertColumnsBefore(1, 5);

Parameter

NameTypBeschreibung
beforePositionIntegerDie Spalte, vor der die neue Spalte eingefügt werden soll.
howManyIntegerDie Anzahl der einzufügenden Spalten.

Return

Sheet – das Tabellenblatt, das für die Verkettung von Methoden nützlich ist

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

insertDataSourceSheet(spec)

Fügt eine neue DataSourceSheet in die Tabelle ein und startet die Datenausführung. Dadurch wird das neue Tabellenblatt auch zum aktiven Tabellenblatt.

Löst 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 ermöglichen.

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Builds a data source specification.
// TODO (developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
 .asBigQuery()
 .setProjectId('project-id-1')
 .setTableProjectId('bigquery-public-data')
 .setDatasetId('ncaa_basketball')
 .setTableId('mbb_historical_teams_games')
 .build();

// Adds the data source and its data to the spreadsheet.
ss.insertDataSourceSheet(dataSourceSpec);

Parameter

NameTypBeschreibung
specDataSourceSpecDie Datenquellenspezifikation, die eingefügt werden soll.

Return

DataSourceSheet: Das neue Datenquellenblatt.

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

insertImage(blobSource, column, row)

Fügt ein Spreadsheet als Bild in das Dokument bei einer bestimmten Zeile und Spalte ein. Die Bildgröße wird aus dem Blob-Inhalt abgerufen. Blobs dürfen maximal 2 MB groß sein.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

Parameter

NameTypBeschreibung
blobSourceBlobSourceDas Blob mit dem Bildinhalt, dem MIME-Typ und (optional) dem Namen.
columnIntegerDie Spaltenposition.
rowIntegerDie Zeilenposition.

Return

OverGridImage: Das eingefügte Bild.

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

insertImage(blobSource, column, row, offsetX, offsetY)

Fügt im Dokument an einer bestimmten Zeile und Spalte ein Spreadsheet als Bild mit Pixelversatz ein. Die Bildgröße wird aus dem Blob-Inhalt abgerufen. Blobs dürfen maximal 2 MB groß sein.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

Parameter

NameTypBeschreibung
blobSourceBlobSourceDas Blob mit dem Bildinhalt, dem MIME-Typ und (optional) dem Namen.
columnIntegerDie Spaltenposition.
rowIntegerDie Zeilenposition.
offsetXIntegerDer horizontale Versatz von der Ecke der Zelle in Pixeln.
offsetYIntegerVertikaler Abstand von der Zellenecke in Pixel

Return

OverGridImage: Das eingefügte Bild.

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

insertImage(url, column, row)

Fügt in einer bestimmten Zeile und Spalte ein Bild in das Dokument ein.

Die angegebene URL muss öffentlich zugänglich sein.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1);

Parameter

NameTypBeschreibung
urlStringDie URL des Bildes.
columnIntegerDie Position der Rasterspalte.
rowIntegerDie Position der Rasterzeile.

Return

OverGridImage: Das eingefügte Bild.

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

insertImage(url, column, row, offsetX, offsetY)

Fügt im Dokument ein Bild mit einem Pixelversatz in einer bestimmten Zeile und Spalte ein.

Die angegebene URL muss öffentlich zugänglich sein.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1, 10, 10);

Parameter

NameTypBeschreibung
urlStringDie URL für das Bild.
columnIntegerDie Spaltenposition.
rowIntegerDie Zeilenposition.
offsetXIntegerDer horizontale Versatz von der Ecke der Zelle in Pixeln.
offsetYIntegerVertikaler Abstand von der Zellenecke in Pixel

Return

OverGridImage: Das eingefügte Bild.

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

insertRowAfter(afterPosition)

Fügt eine Zeile nach der angegebenen Zeilenposition ein.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a row after the first row position
sheet.insertRowAfter(1);

Parameter

NameTypBeschreibung
afterPositionIntegerZeile, nach der die neue Zeile eingefügt werden soll

Return

Sheet – das Tabellenblatt, das für die Verkettung von Methoden nützlich ist

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

insertRowBefore(beforePosition)

Fügt eine Zeile vor der angegebenen Zeilenposition ein.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a row before the first row position
sheet.insertRowBefore(1);

Parameter

NameTypBeschreibung
beforePositionIntegerZeile, vor der die neue Zeile eingefügt werden soll

Return

Sheet – das Tabellenblatt, das für die Verkettung von Methoden nützlich ist

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

insertRowsAfter(afterPosition, howMany)

Fügt eine bestimmte Anzahl von Zeilen nach der angegebenen Zeilenposition ein.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five rows after the first row
sheet.insertRowsAfter(1, 5);

Parameter

NameTypBeschreibung
afterPositionIntegerDie Zeile, nach der die neuen Zeilen hinzugefügt werden sollen.
howManyIntegerDie Anzahl der einzufügenden Zeilen.

Return

Sheet – das Tabellenblatt, das für die Verkettung von Methoden nützlich ist

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

insertRowsBefore(beforePosition, howMany)

Fügt eine bestimmte Anzahl von Zeilen vor der angegebenen Zeilenposition ein.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five rows before the first row
sheet.insertRowsBefore(1, 5);

Parameter

NameTypBeschreibung
beforePositionIntegerDie Zeile, vor der die neuen Zeilen eingefügt werden sollen.
howManyIntegerDie Anzahl der einzufügenden Zeilen.

Return

Sheet – das Tabellenblatt, das für die Verkettung von Methoden nützlich ist

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

insertSheet()

Fügt ein neues Tabellenblatt unter Verwendung eines Standardtabellennamens in die Tabellenkalkulation ein. Das neue Tabellenblatt wird zum aktiven Tabellenblatt.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet();

Return

Sheet: Das neue 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

insertSheet(sheetIndex)

Fügt beim angegebenen Index ein neues Tabellenblatt in die Tabellenkalkulation ein. Das neue Tabellenblatt wird zum aktiven Tabellenblatt.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet(1);

Parameter

NameTypBeschreibung
sheetIndexIntegerDer Index des neu erstellten Tabellenblatts. Wenn Sie ein Tabellenblatt als erstes in die Tabelle einfügen möchten, setzen Sie den Wert auf „0“.

Return

Sheet: Das neue 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

insertSheet(sheetIndex, options)

Fügt am angegebenen Index ein neues Tabellenblatt in die Tabelle ein und verwendet optionale erweiterte Argumente. Das neue Tabellenblatt wird zum aktiven Tabellenblatt.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet(1, {template: templateSheet});

Parameter

NameTypBeschreibung
sheetIndexIntegerDer Index des neu erstellten Tabellenblatts. Wenn Sie ein Tabellenblatt als erstes in die Tabelle einfügen möchten, setzen Sie den Wert auf „0“.
optionsObjectOptionale erweiterte JavaScript-Argumente.

Erweiterte Parameter

NameTypBeschreibung
templateSheetAlle Daten aus dem Vorlagentabellenobjekt werden in das neue Tabellenblatt kopiert. Die Tabellenblattvorlage muss eines der Tabellenblätter des Objekts „Tabellen“ sein.

Return

Sheet: Das neue 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

insertSheet(options)

Fügt ein neues Tabellenblatt in die Tabelle ein. Dabei werden ein Standardtabellenname und optionale erweiterte Argumente verwendet. Das neue Tabellenblatt wird zum aktiven Tabellenblatt.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet({template: templateSheet});

Parameter

NameTypBeschreibung
optionsObjectOptionale erweiterte JavaScript-Argumente (siehe unten).

Erweiterte Parameter

NameTypBeschreibung
templateSheetAlle Daten aus dem Vorlagentabellenobjekt werden in das neue Tabellenblatt kopiert. Die Tabellenblattvorlage muss eines der Tabellenblätter dieses Tabellenobjekts sein.

Return

Sheet: Das neue 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

insertSheet(sheetName)

Fügt in der Tabelle ein neues Tabellenblatt mit dem angegebenen Namen ein. Das neue Tabellenblatt wird zum aktiven Tabellenblatt.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet');

Parameter

NameTypBeschreibung
sheetNameStringDer Name des neuen Tabellenblatts.

Return

Sheet: Das neue 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

insertSheet(sheetName, sheetIndex)

Fügt ein neues Tabellenblatt mit dem angegebenen Namen am angegebenen Index in die Tabellenkalkulation ein. Das neue Tabellenblatt wird zum aktiven Tabellenblatt.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet', 1);

Parameter

NameTypBeschreibung
sheetNameStringDer Name des neuen Tabellenblatts.
sheetIndexIntegerDer Index des neu erstellten Tabellenblatts. Wenn Sie ein Tabellenblatt als erstes in die Tabelle einfügen möchten, setzen Sie den Wert auf „0“.

Return

Sheet: Das neue 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

insertSheet(sheetName, sheetIndex, options)

Fügt in die Tabelle ein neues Tabellenblatt mit dem angegebenen Namen am angegebenen Index ein und verwendet optionale erweiterte Argumente. Das neue Tabellenblatt wird zum aktiven Tabellenblatt.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', 1, {template: templateSheet});

Parameter

NameTypBeschreibung
sheetNameStringDer Name des neuen Tabellenblatts.
sheetIndexIntegerIndex des neu eingefügten Tabellenblatts Wenn Sie ein Tabellenblatt als erstes in eine Tabelle einfügen möchten, setzen Sie den Wert auf 0.
optionsObjectOptionale erweiterte JavaScript-Argumente.

Erweiterte Parameter

NameTypBeschreibung
templateSheetAlle Daten aus dem Vorlagentabellenobjekt werden in das neue Tabellenblatt kopiert. Die Tabellenblattvorlage muss eines der Tabellenblätter des Objekts „Tabellen“ sein.

Return

Sheet: Das neue 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

insertSheet(sheetName, options)

Fügt in die Tabelle ein neues Tabellenblatt mit dem angegebenen Namen ein und verwendet optionale erweiterte Argumente. Das neue Tabellenblatt wird zum aktiven Tabellenblatt.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', {template: templateSheet});

Parameter

NameTypBeschreibung
sheetNameStringDer Name des neuen Tabellenblatts.
optionsObjectOptionale erweiterte JavaScript-Argumente.

Erweiterte Parameter

NameTypBeschreibung
templateSheetAlle Daten aus dem Vorlagentabellenobjekt werden in das neue Tabellenblatt kopiert. Die Tabellenblattvorlage muss eines der Tabellenblätter des Objekts „Tabellen“ sein.

Return

Sheet: Das neue 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

insertSheetWithDataSourceTable(spec)

Fügt ein neues Tabellenblatt in die Tabelle ein, erstellt eine DataSourceTable, die das gesamte Tabellenblatt mit der angegebenen Datenquellenspezifikation umfasst, und startet die Datenausführung. Dadurch wird das neue Tabellenblatt zum aktiven Tabellenblatt.

Löst 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 ermöglichen.

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds a sheet and sets cell A1 as the parameter cell.
const parameterCell = ss.insertSheet('parameterSheet').getRange('A1');

// Sets the value of the parameter cell to 'Duke'.
parameterCell.setValue('Duke');

const query = 'select * from `bigquery-public-data`.`ncaa_basketball`.' +
  '`mbb_historical_tournament_games` WHERE win_school_ncaa = @SCHOOL';

// Adds a data source with a query parameter.
// TODO(developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
 .asBigQuery()
 .setProjectId('project-id-1')
 .setRawQuery(query)
 .setParameterFromCell('SCHOOL', 'parameterSheet!A1')
 .build();

// Adds sheets for the data source and data source table to the spreadsheet.
ss.insertSheetWithDataSourceTable(dataSourceSpec);

Parameter

NameTypBeschreibung
specDataSourceSpecDie Datenquellenspezifikation, die eingefügt werden soll.

Return

Sheet: Das neue 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

isColumnHiddenByUser(columnPosition)

Gibt zurück, ob die angegebene Spalte vom Nutzer ausgeblendet wurde.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.isColumnHiddenByUser(1));

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der zu untersuchenden Spalte.

Return

Boolean: true, wenn die Spalte ausgeblendet ist, andernfalls false.

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

isIterativeCalculationEnabled()

Gibt zurück, ob die iterative Berechnung in dieser Tabellenkalkulation aktiviert ist.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

Return

Boolean: true, wenn die iterative Berechnung aktiviert ist, andernfalls false.

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

isRowHiddenByFilter(rowPosition)

Gibt zurück, ob die angegebene Zeile durch einen Filter (nicht durch eine Filteransicht) ausgeblendet wurde.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByFilter(1));

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der zu untersuchenden Zeile.

Return

Boolean: true, wenn die Zeile ausgeblendet ist, andernfalls false.

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

isRowHiddenByUser(rowPosition)

Gibt zurück, ob die angegebene Zeile vom Nutzer ausgeblendet wurde.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByUser(1));

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der zu untersuchenden Zeile.

Return

Boolean: true, wenn die Zeile ausgeblendet ist, andernfalls false.

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

moveActiveSheet(pos)

Verschiebt das aktive Tabellenblatt an die angegebene Position in der Liste der Tabellenblätter. Löst eine Ausnahme aus, wenn die Position negativ oder größer als die Anzahl der Tabellenblätter ist.

// This example assumes that there are 2 sheets in the current
// active spreadsheet: one named "first" in position 1 and another named "second"
// in position 2.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// Gets the "first" sheet and activates it.
var sheet = spreadsheet.getSheetByName("first").activate();

// Logs 'Current index of sheet: 1'
console.log("Current index of sheet: %s", sheet.getIndex());

spreadsheet.moveActiveSheet(2);

// Logs 'New index of sheet: 2'
console.log("New index of sheet: %s", sheet.getIndex());

Parameter

NameTypBeschreibung
posIntegerDie 1-Index-Position, zu der das aktive Tabellenblatt in der Liste der Tabellenblätter verschoben 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

moveChartToObjectSheet(chart)

Erstellt ein neues SheetType.OBJECT-Tabellenblatt und verschiebt das angegebene Diagramm dorthin. Wenn sich das Diagramm bereits auf einem eigenen Tabellenblatt befindet, wird dieses Tabellenblatt zurückgegeben, ohne ein neues zu erstellen.

var sheet = SpreadsheetApp.getActiveSheet();
var chart = sheet.newChart().setPosition(1, 1, 0, 0).build();
sheet.insertChart(chart);
var objectSheet = SpreadsheetApp.getActive().moveChartToObjectSheet(chart);

Parameter

NameTypBeschreibung
chartEmbeddedChartDas zu verschiebende Diagramm

Return

Sheet: Das Tabellenblatt, auf dem sich das Diagramm befindet.

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

refreshAllDataSources()

Es werden alle unterstützten Datenquellen und die zugehörigen verknüpften Datenquellenobjekte aktualisiert. Ungültige Datenquellenobjekte werden dabei übersprungen.

Verwenden Sie SpreadsheetApp#enable...Execution()-Methoden, um die Datenausführung für einen bestimmten Datenquellentyp zu ermöglichen.

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets the first data source sheet on the spreadsheet.
const dataSheet = ss.getDataSourceSheets()[0];

// Refreshes all data sources on the spreadsheet.
ss.refreshAllDataSources();

// Logs the last refreshed time of the first data source sheet.
console.log(`Last refresh time: ${dataSheet.getStatus().getLastRefreshedTime()}`);

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

removeEditor(emailAddress)

Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Spreadsheet. Diese Methode verhindert nicht, dass Nutzer auf Spreadsheet zugreifen, wenn sie zu einer Klasse von Nutzern mit allgemeinen Zugriff gehören. Das ist z. B. der Fall, wenn Spreadsheet für die gesamte Domain des Nutzers freigegeben ist oder wenn sich Spreadsheet in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

Bei Drive-Dateien wird der Nutzer auch aus der Liste der Viewer entfernt.

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des Nutzers, der entfernt werden soll.

Return

Spreadsheet: Dieses Spreadsheet 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

removeEditor(user)

Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Spreadsheet. Diese Methode verhindert nicht, dass Nutzer auf Spreadsheet zugreifen, wenn sie zu einer Klasse von Nutzern mit allgemeinen Zugriff gehören. Das ist z. B. der Fall, wenn Spreadsheet für die gesamte Domain des Nutzers freigegeben ist oder wenn sich Spreadsheet in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

Bei Drive-Dateien wird der Nutzer auch aus der Liste der Viewer entfernt.

Parameter

NameTypBeschreibung
userUserEine Darstellung des Nutzers, der entfernt werden soll.

Return

Spreadsheet: Dieses Spreadsheet 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

removeMenu(name)

Entfernt eine Speisekarte, die von addMenu(name, subMenus) hinzugefügt wurde. Das Argument name muss denselben Wert wie der entsprechende Aufruf von addMenu(name, subMenus) haben.

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.addMenu("badMenu", [{name: "remove bad menu", functionName: "removeBadMenu"},
                                       {name: "foo", functionName: "foo"}]);
}
function removeBadMenu() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.removeMenu("badMenu");  // name must match the name used when added the menu
}
function foo(){
// Do nothing
}

Parameter

NameTypBeschreibung
nameStringDer Name des Menüs, das entfernt 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

removeNamedRange(name)

Löscht einen benannten Bereich mit dem angegebenen Namen. Löst eine Ausnahme aus, wenn kein Bereich mit dem angegebenen Namen in der Tabelle gefunden wird.

// The code below creates a new named range "foo", and then remove it.
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("foo", ss.getActiveRange());
ss.removeNamedRange("foo");

Parameter

NameTypBeschreibung
nameStringDer Bereichsname.

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

removeViewer(emailAddress)

Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für Spreadsheet. Diese Methode hat keine Auswirkungen, wenn der Nutzer Bearbeiter und kein Betrachter oder Kommentator ist. Außerdem wird durch diese Methode nicht verhindert, dass Nutzer auf Spreadsheet zugreifen, wenn sie zu einer Klasse von Nutzern mit allgemeinem Zugriff gehören, z. B. wenn die Spreadsheet für die gesamte Domain des Nutzers freigegeben ist oder wenn sich Spreadsheet in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

Bei Drive-Dateien wird der Nutzer auch aus der Liste der Bearbeiter entfernt.

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des Nutzers, der entfernt werden soll.

Return

Spreadsheet: Spreadsheet für 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

removeViewer(user)

Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für Spreadsheet. Diese Methode hat keine Auswirkungen, wenn der Nutzer Bearbeiter und kein Betrachter ist. Außerdem verhindert diese Methode nicht, dass Nutzer auf Spreadsheet zugreifen, wenn sie zu einer Klasse von Nutzern mit allgemeinem Zugriff gehören, z. B. wenn Spreadsheet für die gesamte Domain des Nutzers freigegeben ist oder wenn sich Spreadsheet in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

Bei Drive-Dateien wird der Nutzer auch aus der Liste der Bearbeiter entfernt.

Parameter

NameTypBeschreibung
userUserEine Darstellung des Nutzers, der entfernt werden soll.

Return

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

rename(newName)

Benennt das Dokument um.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.rename("This is the new name");

Parameter

NameTypBeschreibung
newNameStringDer neue Name des Dokuments.

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

renameActiveSheet(newName)

Benennt das aktuell aktive Tabellenblatt in den angegebenen neuen Namen um.

// The code below renames the active sheet to "Hello world"
SpreadsheetApp.getActiveSpreadsheet().renameActiveSheet("Hello world");

Parameter

NameTypBeschreibung
newNameStringDer neue Name für das aktuell aktive 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

resetSpreadsheetTheme()

Das angewendete Design wird entfernt und das Standarddesign der Tabelle festgelegt.

// The code below applies default theme on the spreadsheet.
SpreadsheetApp.getActiveSpreadsheet().resetSpreadsheetTheme();

Return

SpreadsheetTheme: Das Standarddesign.

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

setActiveRange(range)

Legt den angegebenen Bereich als active range im aktiven Tabellenblatt fest, wobei die linke obere Zelle im Bereich als current cell festgelegt ist.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var range = sheet.getRange('A1:D4');
sheet.setActiveRange(range);

var selection = sheet.getSelection();
// Current cell: A1
var currentCell = selection.getCurrentCell();
// Active Range: A1:D4
var activeRange = selection.getActiveRange();

Parameter

NameTypBeschreibung
rangeRangeBereich, der als aktiver Bereich festgelegt werden soll.

Return

Range: der neue aktive Bereich

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

setActiveRangeList(rangeList)

Legt die angegebene Liste von Bereichen als active ranges im aktiven Tabellenblatt fest. Der letzte Bereich in der Liste ist als active range festgelegt.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['D4', 'B2:C4']);
sheet.setActiveRangeList(rangeList);

var selection = sheet.getSelection();
// Current cell: B2
var currentCell = selection.getCurrentCell();
// Active range: B2:C4
var activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
var activeRangeList = selection.getActiveRangeList();

Parameter

NameTypBeschreibung
rangeListRangeListDie Liste der auszuwählenden Bereiche.

Return

RangeList: die neu ausgewählte Liste von Bereichen

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

setActiveSelection(range)

Legt den aktiven Auswahlbereich für dieses Tabellenblatt fest.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D4");
sheet.setActiveSelection(range);

Parameter

NameTypBeschreibung
rangeRangeDer Bereich, der als aktive Auswahl festgelegt werden soll.

Return

Range: der neue aktive Bereich

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

setActiveSelection(a1Notation)

Legt die aktive Auswahl wie in der A1- oder R1C1-Notation angegeben fest.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.setActiveSelection("A1:D4");

Parameter

NameTypBeschreibung
a1NotationStringDer Bereich, der als aktiv festgelegt werden soll, wie in der A1- oder R1C1-Notation angegeben.

Return

Range: der neue aktive Bereich

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

setActiveSheet(sheet)

Legt fest, dass das angegebene Tabellenblatt als aktives Tabellenblatt in der Tabelle festgelegt wird. In der Google Tabellen-UI wird das ausgewählte Tabellenblatt angezeigt, sofern es nicht zu einer anderen Tabelle gehört.

// The code below makes the first sheet active in the active spreadsheet.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
spreadsheet.setActiveSheet(spreadsheet.getSheets()[0]);

Parameter

NameTypBeschreibung
sheetSheetDas Tabellenblatt, das als aktives Tabellenblatt festgelegt werden soll.

Return

Sheet: Das aktive 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

setActiveSheet(sheet, restoreSelection)

Setzt das angegebene Tabellenblatt als aktives Blatt in der Tabelle und bietet eine Option zum Wiederherstellen der zuletzt ausgewählten Auswahl in diesem Tabellenblatt. In der Benutzeroberfläche von Google Tabellen wird das ausgewählte Tabellenblatt angezeigt, es sei denn, es gehört zu einer anderen Tabelle.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var firstSheet = spreadsheet.getSheets()[0];
var secondSheet = spreadsheet.getSheets()[1];
// Set the first sheet as the active sheet and select the range D4:F4.
spreadsheet.setActiveSheet(firstSheet).getRange('D4:F4').activate();

// Switch to the second sheet to do some work.
spreadsheet.setActiveSheet(secondSheet);
// Switch back to first sheet, and restore its selection.
spreadsheet.setActiveSheet(firstSheet, true);

// The selection of first sheet is restored, and it logs D4:F4
var range = spreadsheet.getActiveSheet().getSelection().getActiveRange();
Logger.log(range.getA1Notation());

Parameter

NameTypBeschreibung
sheetSheetDas neue aktive Tabellenblatt.
restoreSelectionBooleanWenn true aktiviert ist, wird die letzte Auswahl des neuen aktiven Tabellenblatts wieder ausgewählt, wenn das neue Tabellenblatt aktiv wird. Wenn false, wird das neue Tabellenblatt aktiv, ohne die aktuelle Auswahl zu ändern.

Return

Sheet: Das neue aktive 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

setColumnWidth(columnPosition, width)

Legt die Breite der angegebenen Spalte in Pixeln fest.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sets the first column to a width of 200 pixels
sheet.setColumnWidth(1, 200);

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der angegebenen Spalte, die festgelegt werden soll.
widthIntegerDie Breite in Pixeln, auf die sie festgelegt werden soll.

Return

Sheet – das Tabellenblatt, das für die Verkettung von Methoden nützlich ist

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

setCurrentCell(cell)

Legt die angegebene Zelle als current cell fest.

Wenn die angegebene Zelle in einem bereits ausgewählten Bereich vorhanden ist, wird dieser Bereich zum aktiven Bereich mit der Zelle als aktuelle Zelle.

Wenn die angegebene Zelle in keinem der ausgewählten Bereiche vorhanden ist, wird die vorhandene Auswahl entfernt und die Zelle wird zur aktuellen Zelle und zum aktiven Bereich.

Hinweis:Der angegebene Range muss aus einer Zelle bestehen. Andernfalls wird eine Ausnahme ausgelöst.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var cell = sheet.getRange('B5');
sheet.setCurrentCell(cell);

var selection = sheet.getSelection();
// Current cell: B5
var currentCell = selection.getCurrentCell();

Parameter

NameTypBeschreibung
cellRangeZelle, die als aktuelle Zelle festgelegt werden soll

Return

Range: die neu festgelegte aktuelle Zelle

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

setFrozenColumns(columns)

Fixiert die angegebene Anzahl von Spalten. Wenn Null, sind keine Spalten fixiert.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Freezes the first column
sheet.setFrozenColumns(1);

Parameter

NameTypBeschreibung
columnsIntegerDie Anzahl der Spalten, die fixiert werden sollen.

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

setFrozenRows(rows)

Fixiert die angegebene Anzahl von Zeilen. Wenn null, werden keine Zeilen fixiert.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Freezes the first row
sheet.setFrozenRows(1);

Parameter

NameTypBeschreibung
rowsIntegerDie Anzahl der zu fixierenden Zeilen.

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

setIterativeCalculationConvergenceThreshold(minThreshold)

Legt den Mindestgrenzwert für die iterative Berechnung fest. Wenn die Ergebnisse einer sukzessiven Berechnung um weniger als dieser Wert abweichen, wird die iterative Berechnung beendet. Dieser Wert darf nicht negativ sein und ist standardmäßig auf 0, 05 festgelegt.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the iterative calculation convergence threshold for the spreadsheet.
ss.setIterativeCalculationConvergenceThreshold(2);

// Logs the threshold to the console.
console.log(ss.getIterativeCalculationConvergenceThreshold());

Parameter

NameTypBeschreibung
minThresholdNumberDer minimale Konvergenzgrenzwert (darf nicht negativ sein).

Return

Spreadsheet: Diese Tabelle 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

setIterativeCalculationEnabled(isEnabled)

Legt fest, ob die iterative Berechnung in dieser Tabelle aktiviert ist. Wenn die maximale Anzahl von Berechnungszyklen und der Konvergenzgrenzwert beim Aktivieren der Berechnung nicht zuvor festgelegt wurden, werden standardmäßig 50 bzw.0,05 verwendet. Wenn einer der beiden Werte zuvor festgelegt wurde, werden die vorherigen Werte beibehalten.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

Parameter

NameTypBeschreibung
isEnabledBooleantrue, wenn die iterative Berechnung aktiviert werden soll, andernfalls false.

Return

Spreadsheet: Diese Tabelle 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

setMaxIterativeCalculationCycles(maxIterations)

Legt die maximale Anzahl der Berechnungsiterationen fest, die während der iterativen Berechnung ausgeführt werden sollen. Dieser Wert muss zwischen 1 und 10.000 (einschließlich) liegen. Der Standardwert ist 50.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.getMaxIterativeCalculationCycles());

Parameter

NameTypBeschreibung
maxIterationsIntegerDie maximale Anzahl der Berechnungsdurchläufe (zwischen 1 und 10.000).

Return

Spreadsheet: Diese Tabelle 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

setNamedRange(name, range)

Benennt einen Bereich.

// The code below creates a new named range "TaxRates" in the active spreadsheet
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("TaxRates", SpreadsheetApp.getActiveRange());

Parameter

NameTypBeschreibung
nameStringDer Name für den Bereich.
rangeRangeDie Bereichsspezifikation.

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

setRecalculationInterval(recalculationInterval)

Legt fest, wie oft diese Tabelle neu berechnet werden soll.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the  calculation interval for the spreadsheet to 'ON_CHANGE'.
const interval = ss.setRecalculationInterval(SpreadsheetApp.RecalculationInterval.ON_CHANGE);

// Logs the calculation interval to the console.
console.log(interval);

Parameter

NameTypBeschreibung
recalculationIntervalRecalculationIntervalDas neue Neuberechnungsintervall.

Return

Spreadsheet: Diese Tabelle 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

setRowHeight(rowPosition, height)

Legt die Zeilenhöhe der angegebenen Zeile in Pixeln fest. Standardmäßig passen Zeilen an den Zelleninhalt an. Wenn Sie Zeilen auf eine bestimmte Höhe erzwingen möchten, verwenden Sie Sheet.setRowHeightsForced(startRow, numRows, height).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

Parameter

NameTypBeschreibung
rowPositionIntegerDie zu ändernde Zeilenposition.
heightIntegerDie Höhe in Pixeln, auf die sie festgelegt werden soll.

Return

Sheet: Das Tabellenblatt, das für die Verkettung von Methoden nützlich ist.

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

setSpreadsheetLocale(locale)

Legt das Gebietsschema für die Tabelle fest.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the spreadsheet locale.
ss.setSpreadsheetLocale('fr');

// Gets the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

Parameter

NameTypBeschreibung
localeStringDer zu verwendende Gebietsschemacode (z. B. „en“, „fr“ oder „en_US“).

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

setSpreadsheetTheme(theme)

Legt ein Design für die Tabelle fest.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// The code below sets the second predefined theme as the current theme of the spreadsheet.
var predefinedThemesList = spreadsheet.getPredefinedSpreadsheetThemes();
spreadsheet.setSpreadsheetTheme(predefinedThemesList[1]);

Parameter

NameTypBeschreibung
themeSpreadsheetThemeDas anzuwendende Design.

Return

SpreadsheetTheme: Das neue aktuelle Design.

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

setSpreadsheetTimeZone(timezone)

Legt die Zeitzone für die Tabelle fest.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

Parameter

NameTypBeschreibung
timezoneStringDie Zeitzone im „long“-Format (z. B. „America/New_York“, wie auf Joda.org aufgeführt).

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

show(userInterface)

Zeigt eine benutzerdefinierte UI-Komponente in einem Dialogfeld an, das im Darstellungsbereich des Nutzers zentriert ist. Die Ausführung des serverseitigen Skripts wird nicht unterbrochen. Zur Kommunikation mit der Serverseite muss die Komponente der Benutzeroberfläche asynchrone Callbacks an das serverseitige Skript vornehmen.

Wenn durch das serverseitige Skript zuvor ein Dialogfeld angezeigt wurde, das noch nicht geschlossen wurde, wird das vorhandene Dialogfeld durch die Benutzeroberfläche des neu angeforderten Dialogfelds ersetzt.

Mit dem folgenden Code-Snippet wird eine einfache HtmlService-Anwendung in einem Dialogfeld mit dem angegebenen Titel, der Höhe und der Breite angezeigt:

var htmlApp = HtmlService
    .createHtmlOutput('<p>A change of speed, a change of style...</p>')
    .setTitle('My HtmlService Application')
    .setWidth(250)
    .setHeight(300);

SpreadsheetApp.getActiveSpreadsheet().show(htmlApp);

// The script resumes execution immediately after showing the dialog.

Parameter

NameTypBeschreibung
userInterfaceObjectEin HtmlOutput.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/script.container.ui

sort(columnPosition)

Sortiert ein Tabellenblatt aufsteigend nach Spalte.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, ascending
sheet.sort(1);

Parameter

NameTypBeschreibung
columnPositionIntegerDie Spalte, nach der sortiert werden soll.

Return

Sheet – das Tabellenblatt, das für die Verkettung von Methoden nützlich ist

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

sort(columnPosition, ascending)

Sortiert ein Tabellenblatt nach Spalten. Verwendet einen Parameter, um aufsteigend oder absteigend anzugeben.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

Parameter

NameTypBeschreibung
columnPositionIntegerDie Spalte, nach der sortiert werden soll.
ascendingBooleantrue für aufsteigende, false für absteigende Sortierungen.

Return

Sheet – das Tabellenblatt, das für die Verkettung von Methoden nützlich ist

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

toast(msg)

Zeigt unten rechts in der Tabelle ein Pop-up-Fenster mit der jeweiligen Nachricht an.

// Show a popup with the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started');

Parameter

NameTypBeschreibung
msgStringDie Nachricht, die im Toast angezeigt 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

toast(msg, title)

Zeigt unten rechts in der Tabelle ein Pop-up-Fenster mit der angegebenen Nachricht und dem Titel an.

// Show a popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status');

Parameter

NameTypBeschreibung
msgStringDie Nachricht, die im Toast angezeigt werden soll.
titleStringDer optionale Titel des Toasts.

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

toast(msg, title, timeoutSeconds)

Zeigt in der rechten unteren Ecke der Tabelle ein Pop-up-Fenster mit dem angegebenen Titel und der Nachricht an, das für einen bestimmten Zeitraum sichtbar bleibt.

// Show a 3-second popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status', 3);

Parameter

NameTypBeschreibung
msgStringDie Nachricht, die im Toast angezeigt werden soll.
titleStringDer optionale Titel des Toasts.
timeoutSecondsNumberDas Zeitlimit in Sekunden. Bei null wird der Toast standardmäßig auf 5 Sekunden eingestellt. Ist er negativ, bleibt der Toast bestehen, bis er geschlossen 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

unhideColumn(column)

Blendet die Spalte im angegebenen Bereich ein

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This unhides the first column if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideColumn(range);

Parameter

NameTypBeschreibung
columnRangeEinzublendender Bereich, falls ausgeblendet.

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

unhideRow(row)

Blendet die Zeile im angegebenen Bereich ein

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This unhides the first row if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideRow(range);

Parameter

NameTypBeschreibung
rowRangeEinzublendender Bereich, falls ausgeblendet.

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

updateMenu(name, subMenus)

Aktualisiert eine Speisekarte, die von addMenu(name, subMenus) hinzugefügt wurde. Funktioniert genauso wie addMenu(name, subMenus).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var menuEntries = [];
menuEntries.push({name: "Lone Menu Entry", functionName: "function1"});
ss.updateMenu("addMenuExample", menuEntries);

Parameter

NameTypBeschreibung
nameStringDer Name des Menüs, das aktualisiert werden soll.
subMenusObject[]Ein Array von JavaScript-Zuordnungen mit den Parametern name und functionName . Sie können Funktionen aus enthaltenen Bibliotheken wie Library.libFunction1 verwenden.

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Wartet, bis alle aktuellen Ausführungen in der Tabelle abgeschlossen sind, und endet nach der angegebenen Anzahl von Sekunden. Löst eine Ausnahme aus, wenn die Ausführungen bei einer Zeitüberschreitung nicht abgeschlossen sind, bricht die Datenausführungen jedoch nicht ab.

Parameter

NameTypBeschreibung
timeoutInSecondsIntegerDie Zeit in Sekunden, die auf Datenausführungen gewartet werden soll. Das Maximum beträgt 300 Sekunden.

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

Verworfene Methoden