Class Spreadsheet

Tabelle

Auf Google Tabellen-Dateien zugreifen und sie ändern. Häufige Vorgänge sind das Hinzufügen neuer Tabellen und Mitbearbeiter.

Methoden

MethodeRückgabetypKurzbeschreibung
addDeveloperMetadata(key)SpreadsheetFügen Sie der Tabelle der obersten Ebene Entwicklermetadaten mit dem angegebenen Schlüssel hinzu.
addDeveloperMetadata(key, visibility)SpreadsheetFügen Sie der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel und der angegebenen Sichtbarkeit hinzu.
addDeveloperMetadata(key, value)SpreadsheetFügen Sie der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel und Wert hinzu.
addDeveloperMetadata(key, value, visibility)SpreadsheetFügen Sie der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel, Wert und der Sichtbarkeit hinzu.
addEditor(emailAddress)SpreadsheetDer angegebene Nutzer wird der Liste der Mitbearbeiter für die Spreadsheet hinzugefügt.
addEditor(user)SpreadsheetDer angegebene Nutzer wird der Liste der Mitbearbeiter für die Spreadsheet hinzugefügt.
addEditors(emailAddresses)SpreadsheetFügt der Liste der Mitbearbeiter für die Spreadsheet das angegebene Nutzerarray hinzu.
addMenu(name, subMenus)voidErstellt ein neues Menü in der Tabellenoberfläche.
addViewer(emailAddress)SpreadsheetDer angegebene Nutzer wird der Liste der Zuschauer für die Spreadsheet hinzugefügt.
addViewer(user)SpreadsheetDer angegebene Nutzer wird der Liste der Zuschauer für die Spreadsheet hinzugefügt.
addViewers(emailAddresses)SpreadsheetFügen Sie der Liste der Zuschauer für die Spreadsheet das angegebene Nutzerarray hinzu.
appendRow(rowContents)SheetFügt eine Zeile am Ende des aktuellen Datenbereichs im Tabellenblatt an.
autoResizeColumn(columnPosition)SheetDie Breite der angegebenen Spalte wird an den Inhalt angepasst.
copy(name)SpreadsheetKopiert die Tabelle und gibt die neue zurück.
createDeveloperMetadataFinder()DeveloperMetadataFinderGibt eine DeveloperMetadataFinder zurück, wenn Entwicklermetadaten in dieser Tabelle gefunden wurden.
createTextFinder(findText)TextFinderErstellt einen Textsuchmechanismus für die Tabelle, mit dem Text in der Tabelle gesucht und ersetzt werden kann.
deleteActiveSheet()SheetDas aktuell aktive Tabellenblatt wird gelöscht.
deleteColumn(columnPosition)SheetLöscht die Spalte an der angegebenen Spaltenposition.
deleteColumns(columnPosition, howMany)voidLöscht eine Reihe von Spalten, beginnend an der angegebenen Spaltenposition.
deleteRow(rowPosition)SheetLöscht die Zeile an der angegebenen Zeilenposition.
deleteRows(rowPosition, howMany)voidLöscht eine Reihe von Zeilen, beginnend an der angegebenen Zeilenposition.
deleteSheet(sheet)voidLöscht das angegebene Tabellenblatt.
duplicateActiveSheet()SheetDas aktive Tabellenblatt wird dupliziert und zum aktiven Tabellenblatt gemacht.
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 Tabelle ab.
getAs(contentType)BlobGibt die Daten in diesem Objekt als Blob zurück, der in den angegebenen Inhaltstyp konvertiert wurde.
getBandings()Banding[]Gibt alle Farbbänder in dieser Tabelle 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 aktuelle Zelle vorhanden ist.
getDataRange()RangeGibt ein Range zurück, das den Dimensionen entspricht, in denen Daten vorhanden sind.
getDataSourceFormulas()DataSourceFormula[]Hier werden alle Formeln der Datenquelle abgerufen.
getDataSourcePivotTables()DataSourcePivotTable[]Hier werden alle Pivot-Tabellen der Datenquelle abgerufen.
getDataSourceRefreshSchedules()DataSourceRefreshSchedule[]Ruft die Aktualisierungszeitpläne dieser Tabelle ab.
getDataSourceSheets()DataSourceSheet[]Gibt alle Tabellenblätter der Datenquelle in der Tabelle zurück.
getDataSourceTables()DataSourceTable[]Hier werden alle Tabellen der Datenquelle abgerufen.
getDataSources()DataSource[]Gibt alle Datenquellen in der Tabelle zurück.
getDeveloperMetadata()DeveloperMetadata[]Ruft die Entwicklermetadaten ab, die mit der Tabelle der obersten Ebene verknüpft sind.
getEditors()User[]Ruft die Liste der Mitbearbeiter für diese Spreadsheet ab.
getFormUrl()StringGibt die URL für das Formular zurück, das seine 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()StringEine eindeutige Kennung für diese Tabelle.
getImages()OverGridImage[]Gibt alle Bilder zurück, die über das Raster hinausragen.
getIterativeCalculationConvergenceThreshold()NumberGibt den Grenzwert zurück, der bei 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 von Iterationen zurück, die bei der iterativen Berechnung verwendet werden sollen.
getName()StringRuft den Namen des Dokuments ab.
getNamedRanges()NamedRange[]Hiermit werden alle benannten Bereiche in dieser Tabelle abgerufen.
getNumSheets()IntegerGibt die Anzahl der Blätter in dieser Tabelle zurück.
getOwner()UserGibt den Eigentümer des Dokuments zurück oder null für ein Dokument in einer geteilten Ablage.
getPredefinedSpreadsheetThemes()SpreadsheetTheme[]Liste der vordefinierten Designs zurückgeben
getProtections(type)Protection[]Hiermit wird ein Array von Objekten zurückgegeben, die alle geschützten Bereiche oder Tabellen in der Tabelle darstellen.
getRange(a1Notation)RangeGibt den Bereich in A1- oder R1C1-Notation zurück.
getRangeByName(name)RangeGibt einen benannten Bereich zurück oder null, wenn kein Bereich mit dem angegebenen Namen gefunden wird.
getRangeList(a1Notations)RangeListGibt die RangeList-Sammlung zurück, die die Bereiche auf demselben Tabellenblatt darstellt, die durch eine nicht leere Liste von A1- oder R1C1-Bezeichnungen angegeben sind.
getRecalculationInterval()RecalculationIntervalGibt das Berechnungsintervall für diese Tabelle zurück.
getRowHeight(rowPosition)IntegerDie Höhe der angegebenen Zeile in Pixeln.
getSelection()SelectionGibt das aktuelle Selection in der Tabelle zurück.
getSheetByName(name)SheetGibt eine Tabelle mit dem angegebenen Namen zurück.
getSheetId()IntegerGibt die ID des Tabellenblatts zurück, das durch dieses Objekt dargestellt wird.
getSheetName()StringGibt den Tabellennamen zurück.
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]Gibt das rechteckige Raster mit Werten für diesen Bereich ab den angegebenen Koordinaten zurück.
getSheets()Sheet[]Ruft alle Tabellen in dieser Tabelle ab.
getSpreadsheetLocale()StringRuft das Gebietsschema der Tabelle ab.
getSpreadsheetTheme()SpreadsheetThemeGibt das aktuelle Design der Tabelle zurück oder null, wenn kein Design angewendet wird.
getSpreadsheetTimeZone()StringDie Zeitzone der Tabelle.
getUrl()StringGibt die URL für die angegebene Tabelle zurück.
getViewers()User[]Ruft die Liste der Betrachter und Kommentatoren für diese Spreadsheet ab.
hideColumn(column)voidDie Spalte oder die Spalten im angegebenen Bereich werden ausgeblendet.
hideRow(row)voidBlendet die Zeilen im angegebenen Bereich aus.
insertColumnAfter(afterPosition)SheetFügt eine Spalte nach der angegebenen Spaltenposition ein.
insertColumnBefore(beforePosition)SheetHiermit wird eine Spalte vor der angegebenen Spaltenposition eingefügt.
insertColumnsAfter(afterPosition, howMany)SheetFügt nach der angegebenen Spaltenposition eine bestimmte Anzahl von Spalten ein.
insertColumnsBefore(beforePosition, howMany)SheetHiermit werden mehrere Spalten vor der angegebenen Spaltenposition eingefügt.
insertDataSourceSheet(spec)DataSourceSheetEs wird eine neue DataSourceSheet in die Tabelle eingefügt und die Datenausführung gestartet.
insertImage(blobSource, column, row)OverGridImageFügt ein Spreadsheet als Bild in das Dokument in einer bestimmten Zeile und Spalte ein.
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageFügt ein Spreadsheet als Bild in das Dokument in einer bestimmten Zeile und Spalte mit einem Pixelversatz ein.
insertImage(url, column, row)OverGridImageFügt ein Bild in das Dokument in einer bestimmten Zeile und Spalte ein.
insertImage(url, column, row, offsetX, offsetY)OverGridImageFügt ein Bild in das Dokument in einer bestimmten Zeile und Spalte mit einem Pixelversatz 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 nach der angegebenen Zeilenposition eine bestimmte Anzahl von Zeilen ein.
insertRowsBefore(beforePosition, howMany)SheetFügt vor der angegebenen Zeilenposition eine bestimmte Anzahl von Zeilen ein.
insertSheet()SheetEs wird ein neues Tabellenblatt mit einem Standardnamen in die Tabelle eingefügt.
insertSheet(sheetIndex)SheetFügen Sie der Tabelle an der angegebenen Position ein neues Tabellenblatt ein.
insertSheet(sheetIndex, options)SheetFügen Sie der Tabelle an der angegebenen Position ein neues Blatt ein und verwenden Sie optionale erweiterte Argumente.
insertSheet(options)SheetFügt der Tabelle ein neues Tabellenblatt mit einem Standardnamen und optionalen erweiterten Argumenten ein.
insertSheet(sheetName)SheetEs wird ein neues Tabellenblatt mit dem angegebenen Namen in die Tabelle eingefügt.
insertSheet(sheetName, sheetIndex)SheetFügt der Tabelle ein neues Tabellenblatt mit dem angegebenen Namen an der angegebenen Position ein.
insertSheet(sheetName, sheetIndex, options)SheetEs wird ein neues Tabellenblatt mit dem angegebenen Namen an der angegebenen Position in die Tabelle eingefügt. Dabei werden optionale erweiterte Argumente verwendet.
insertSheet(sheetName, options)SheetEs wird ein neues Tabellenblatt mit dem angegebenen Namen in die Tabelle eingefügt. Dabei werden optionale erweiterte Argumente verwendet.
insertSheetWithDataSourceTable(spec)SheetEs wird ein neues Tabellenblatt in die Tabelle eingefügt, eine DataSourceTable wird mit der angegebenen Datenquellenspezifikation über das gesamte Tabellenblatt erstellt und die Datenausführung wird gestartet.
isColumnHiddenByUser(columnPosition)BooleanGibt an, ob die angegebene Spalte vom Nutzer ausgeblendet ist.
isIterativeCalculationEnabled()BooleanGibt an, ob die iterative Berechnung in dieser Tabelle aktiviert ist.
isRowHiddenByFilter(rowPosition)BooleanGibt zurück, ob die angegebene Zeile durch einen Filter (nicht durch eine Filteransicht) ausgeblendet ist.
isRowHiddenByUser(rowPosition)BooleanGibt zurück, ob die angegebene Zeile vom Nutzer ausgeblendet ist.
moveActiveSheet(pos)voidVerschiebt das aktive Tabellenblatt an die angegebene Position in der Liste der Tabellenblätter.
moveChartToObjectSheet(chart)SheetHiermit wird eine neue SheetType.OBJECT-Tabelle erstellt und das bereitgestellte Diagramm wird dorthin verschoben.
refreshAllDataSources()voidAlle unterstützten Datenquellen und ihre verknüpften Datenquellenobjekte werden aktualisiert. Ungültige Datenquellenobjekte werden übersprungen.
removeEditor(emailAddress)SpreadsheetDer angegebene Nutzer wird aus der Liste der Mitbearbeiter der Spreadsheet entfernt.
removeEditor(user)SpreadsheetDer angegebene Nutzer wird aus der Liste der Mitbearbeiter der Spreadsheet entfernt.
removeMenu(name)voidEntfernt ein Menü, das von addMenu(name, subMenus) hinzugefügt wurde.
removeNamedRange(name)voidLöscht einen benannten Bereich mit dem angegebenen Namen.
removeViewer(emailAddress)SpreadsheetDer angegebene Nutzer wird aus der Liste der Zuschauer und Kommentatoren für die Spreadsheet entfernt.
removeViewer(user)SpreadsheetDer angegebene Nutzer wird aus der Liste der Zuschauer und Kommentatoren für die Spreadsheet entfernt.
rename(newName)voidBenennt das Dokument um.
renameActiveSheet(newName)voidDas aktuell aktive Tabellenblatt wird in den angegebenen neuen Namen umbenannt.
resetSpreadsheetTheme()SpreadsheetThemeEntfernt das angewendete Design und setzt das Standarddesign für die Tabelle.
setActiveRange(range)RangeDer angegebene Bereich wird als active range in der aktiven Tabelle festgelegt, wobei die linke obere Zelle im Bereich als current cell festgelegt wird.
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 fest, wie in A1- oder R1C1-Notation angegeben.
setActiveSheet(sheet)SheetDas angegebene Tabellenblatt wird zum aktiven Tabellenblatt in der Tabelle.
setActiveSheet(sheet, restoreSelection)SheetDas angegebene Tabellenblatt wird zum aktiven Tabellenblatt in der Tabelle. Es gibt eine Option, die letzte Auswahl in diesem Tabellenblatt wiederherzustellen.
setColumnWidth(columnPosition, width)SheetHiermit wird die Breite der angegebenen Spalte in Pixeln festgelegt.
setCurrentCell(cell)RangeDie angegebene Zelle wird als current cell festgelegt.
setFrozenColumns(columns)voidDie angegebene Anzahl von Spalten wird fixiert.
setFrozenRows(rows)voidDie angegebene Anzahl von Zeilen wird fixiert.
setIterativeCalculationConvergenceThreshold(minThreshold)SpreadsheetLegt den Mindestgrenzwert für die iterative Berechnung fest.
setIterativeCalculationEnabled(isEnabled)SpreadsheetHiermit wird festgelegt, ob die iterative Berechnung in dieser Tabelle aktiviert ist.
setMaxIterativeCalculationCycles(maxIterations)SpreadsheetLegt die maximale Anzahl von Berechnungsiterationen fest, die bei der iterativen Berechnung ausgeführt werden sollen.
setNamedRange(name, range)voidBenennt einen Bereich.
setRecalculationInterval(recalculationInterval)SpreadsheetHiermit wird festgelegt, wie oft diese Tabelle neu berechnet werden soll.
setRowHeight(rowPosition, height)SheetLegt die Zeilenhöhe der angegebenen Zeile in Pixeln fest.
setSpreadsheetLocale(locale)voidLegt die Sprache der Tabelle fest.
setSpreadsheetTheme(theme)SpreadsheetThemeHiermit wird ein Design für die Tabelle festgelegt.
setSpreadsheetTimeZone(timezone)voidHier legen Sie die Zeitzone für die Tabelle fest.
show(userInterface)voidEine benutzerdefinierte Benutzeroberflächenkomponente wird in einem Dialogfeld angezeigt, das im Browser des Nutzers zentriert ist.
sort(columnPosition)SheetSortiert ein Tabellenblatt nach Spalte in aufsteigender Reihenfolge.
sort(columnPosition, ascending)SheetSortiert ein Tabellenblatt nach Spalte.
toast(msg)voidEs wird rechts unten in der Tabelle ein Pop-up-Fenster mit der angegebenen Nachricht angezeigt.
toast(msg, title)voidEs wird ein Pop-up-Fenster mit der angegebenen Nachricht und dem Titel rechts unten in der Tabelle angezeigt.
toast(msg, title, timeoutSeconds)voidEs wird ein Pop-up-Fenster mit dem angegebenen Titel und der angegebenen Nachricht rechts unten in der Tabelle angezeigt, das für eine bestimmte Zeit sichtbar bleibt.
unhideColumn(column)voidDie Spalte im angegebenen Bereich wird eingeblendet.
unhideRow(row)voidBlendet die Zeile im angegebenen Bereich ein.
updateMenu(name, subMenus)voidAktualisiert ein Menü, das von addMenu(name, subMenus) hinzugefügt wurde.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidEs wird gewartet, bis alle aktuellen Ausführungen in der Tabelle abgeschlossen sind. Nach der angegebenen Anzahl von Sekunden wird ein Zeitüberschreitungsfehler ausgegeben.

Detaillierte Dokumentation

addDeveloperMetadata(key)

Fügen Sie der Tabelle der obersten 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.

Rückflug

Spreadsheet – diese Tabelle, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

addDeveloperMetadata(key, visibility)

Fügen Sie der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel und der angegebenen 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.

Rückflug

Spreadsheet – diese Tabelle, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

addDeveloperMetadata(key, value)

Fügen Sie 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.

Rückflug

Spreadsheet – diese Tabelle, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

addDeveloperMetadata(key, value, visibility)

Fügen Sie 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.

Rückflug

Spreadsheet – diese Tabelle, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

addEditor(emailAddress)

Der angegebene Nutzer wird der Liste der Mitbearbeiter für die Spreadsheet hinzugefügt. Wenn der Nutzer bereits auf der Liste der Zuschauer stand, wird er durch diese Methode aus der Liste entfernt.

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des Nutzers, den Sie hinzufügen möchten.

Rückflug

Spreadsheet – Dieses Spreadsheet für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

addEditor(user)

Der angegebene Nutzer wird der Liste der Mitbearbeiter für die Spreadsheet hinzugefügt. Wenn der Nutzer bereits auf der Liste der Zuschauer stand, wird er durch diese Methode aus der Liste entfernt.

Parameter

NameTypBeschreibung
userUserEine Darstellung des hinzuzufügenden Nutzers.

Rückflug

Spreadsheet – Dieses Spreadsheet für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

addEditors(emailAddresses)

Fügt der Liste der Mitbearbeiter für die Spreadsheet das angegebene Nutzerarray hinzu. Wenn sich einer der Nutzer bereits in der Liste der Zuschauer befand, wird er durch diese Methode aus der Liste entfernt.

Parameter

NameTypBeschreibung
emailAddressesString[]Ein Array mit den E-Mail-Adressen der Nutzer, die hinzugefügt werden sollen.

Rückflug

Spreadsheet – Dieses Spreadsheet für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

addMenu(name, subMenus)

Erstellt ein neues Menü in der Tabellenoberfläche.

Für jeden Menüeintrag wird eine benutzerdefinierte Funktion ausgeführt. Normalerweise sollten Sie die Funktion über die onOpen()-Funktion aufrufen, 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-Karten mit name- und functionName -Parametern. Sie können Funktionen aus den enthaltenen Bibliotheken wie Library.libFunction1 verwenden.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

addViewer(emailAddress)

Der angegebene Nutzer wird der Liste der Zuschauer für die Spreadsheet hinzugefügt. Wenn der Nutzer bereits in der Liste der Mitbearbeiter aufgeführt war, hat diese Methode keine Auswirkungen.

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des Nutzers, den Sie hinzufügen möchten.

Rückflug

Spreadsheet – Dieses Spreadsheet für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

addViewer(user)

Der angegebene Nutzer wird der Liste der Zuschauer für die Spreadsheet hinzugefügt. Wenn der Nutzer bereits in der Liste der Mitbearbeiter aufgeführt war, hat diese Methode keine Auswirkungen.

Parameter

NameTypBeschreibung
userUserEine Darstellung des hinzuzufügenden Nutzers.

Rückflug

Spreadsheet – Dieses Spreadsheet für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

addViewers(emailAddresses)

Fügen Sie der Liste der Zuschauer für die Spreadsheet das angegebene Nutzerarray hinzu. Wenn einer der Nutzer bereits in der Liste der Mitbearbeiter aufgeführt war, hat diese Methode keine Auswirkungen auf ihn.

Parameter

NameTypBeschreibung
emailAddressesString[]Ein Array mit den E-Mail-Adressen der Nutzer, die hinzugefügt werden sollen.

Rückflug

Spreadsheet – Dieses Spreadsheet für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

appendRow(rowContents)

Fügt eine Zeile am Ende des aktuellen Datenbereichs im Tabellenblatt an. Wenn der Inhalt einer Zelle mit = beginnt, wird er 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 mit Werten, die nach der letzten Zeile im Tabellenblatt eingefügt werden sollen.

Rückflug

Sheet: Das Tabellenblatt, nützlich für die Methodenverkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

autoResizeColumn(columnPosition)

Die Breite der angegebenen Spalte wird an den Inhalt angepasst.

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 Sie ändern möchten.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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.

Rückflug

Spreadsheet – diese Tabelle, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

createDeveloperMetadataFinder()

Gibt eine DeveloperMetadataFinder zurück, wenn Entwicklermetadaten in dieser Tabelle gefunden wurden. Standardmäßig werden alle Metadaten berücksichtigt, die mit der Tabelle, den Tabellen, Zeilen und Spalten verknüpft sind.

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

Rückflug

DeveloperMetadataFinder: Ein Tool zum Suchen nach Entwicklermetadaten in dieser Tabelle.


createTextFinder(findText)

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

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.

Rückflug

TextFinder: Das TextFinder für die Tabelle.


deleteActiveSheet()

Das aktuell aktive Tabellenblatt wird gelöscht.

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

Rückflug

Sheet: Das neue aktive Tabellenblatt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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 mit 1 für die erste Spalte.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

deleteColumns(columnPosition, howMany)

Löscht eine Reihe von Spalten, beginnend an 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 Spalte, die gelöscht werden soll.
howManyIntegerDie Anzahl der zu löschenden Spalten.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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 mit 1 für die erste Zeile.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

deleteRows(rowPosition, howMany)

Löscht eine Reihe von Zeilen, beginnend an 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

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

duplicateActiveSheet()

Das aktive Tabellenblatt wird dupliziert und zum aktiven Tabellenblatt gemacht.

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

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getActiveCell()

Gibt die aktive Zelle in diesem Tabellenblatt zurück.

Hinweis:Es wird empfohlen, getCurrentCell() zu verwenden, 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();

Rückflug

Range – die aktuelle aktive Zelle

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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 in der aktiven Tabelle 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();

Rückflug

Range – der aktive Bereich

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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 das Ganze wie ein getActiveRange()-Aufruf.

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

Rückflug

RangeList – Liste der aktiven Bereiche

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Weitere Informationen


getActiveSheet()

Ruft das aktive Tabellenblatt in einer Tabelle ab.

Das aktive Tabellenblatt in einer Tabelle ist das Blatt, das in der Benutzeroberfläche der Tabelle angezeigt wird.

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

Rückflug

Sheet: Das aktive Tabellenblatt in der Tabelle.


getAs(contentType)

Gibt die Daten in diesem Objekt als Blob zurück, der in den angegebenen Inhaltstyp konvertiert wurde. Bei dieser Methode wird dem Dateinamen die entsprechende Erweiterung hinzugefügt, z. B. „meinedatei.pdf“. Es wird jedoch davon ausgegangen, dass der Teil des Dateinamens, der auf den letzten Punkt (falls vorhanden) folgt, eine vorhandene Erweiterung ist, die ersetzt werden soll. Daraus wird „Einkaufsliste.25.12.2014“ zu „Einkaufsliste.25.12.pdf“.

Die täglichen Kontingente 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. Bei Bildern im BMP-, GIF-, JPEG- oder PNG-Format sind auch 'image/bmp', 'image/gif', 'image/jpeg' oder 'image/png' zulässig. Für ein Google Docs-Dokument ist auch 'text/markdown' zulässig.

Rückflug

Blob – Die Daten als Blob.


getBandings()

Gibt alle Farbbänder in dieser Tabelle 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());

Rückflug

Banding[] – die Farbbänder in dieser Tabelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getBlob()

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

Rückflug

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 prüfenden Spalte.

Rückflug

Integer: Spaltenbreite in Pixeln

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getCurrentCell()

Gibt die aktuelle Zelle im aktiven Tabellenblatt zurück oder null, wenn keine aktuelle Zelle vorhanden ist. Die aktuelle Zelle ist die Zelle, die in der Google Tabellen-Benutzeroberfläche den Fokus hat. Sie ist 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();

Rückflug

Range – die aktuelle Zelle

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getDataRange()

Gibt ein Range zurück, das den Dimensionen entspricht, in denen Daten vorhanden sind.

Das entspricht funktional dem Erstellen eines Bereichs, der durch A1 und (Sheet.getLastColumn(), Sheet.getLastRow()) begrenzt ist.

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

Rückflug

Range: ein Bereich, der alle Daten in der Tabelle enthält

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getDataSourceFormulas()

Hier werden alle Formeln der Datenquelle abgerufen.

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

Rückflug

DataSourceFormula[]: Liste der Datenquellenformeln.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getDataSourcePivotTables()

Hier werden alle Pivot-Tabellen der Datenquelle abgerufen.

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

Rückflug

DataSourcePivotTable[]: Liste der Pivot-Tabellen der Datenquelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getDataSourceRefreshSchedules()

Ruft die Aktualisierungszeitpläne dieser 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);

Rückflug

DataSourceRefreshSchedule[]: Die Aktualisierungszeitpläne dieser Tabelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getDataSourceSheets()

Gibt alle Tabellenblätter der Datenquelle 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());

Rückflug

DataSourceSheet[]: Ein Array aller Tabellenblätter der Datenquelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getDataSourceTables()

Hier werden alle Tabellen der Datenquelle abgerufen.

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

Rückflug

DataSourceTable[]: Liste der Tabellen der Datenquelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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

Rückflug

DataSource[]: Ein Array aller Datenquellen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getDeveloperMetadata()

Ruft die Entwicklermetadaten ab, die mit der Tabelle der obersten Ebene verknüpft sind.

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

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getEditors()

Ruft die Liste der Mitbearbeiter für diese Spreadsheet ab.

Rückflug

User[]: Ein Array von Nutzern mit Bearbeitungsberechtigung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getFormUrl()

Gibt die URL für das Formular zurück, das seine 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 nicht eindeutig. Alternativ können URL-Zuordnungen für Formulare pro Tabelle ü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);

Rückflug

String: Die URL des Formulars, dessen Antworten in diese Tabelle eingetragen werden. Wenn dieser Tabelle kein Formular zugewiesen ist, wird null angezeigt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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

Rückflug

Integer – die Anzahl der fixierten Spalten

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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

Rückflug

Integer – die Anzahl der fixierten Zeilen

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getId()

Eine eindeutige Kennung für diese Tabelle. Eine Tabellen-ID kann aus der 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());

Rückflug

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


getImages()

Gibt alle Bilder zurück, die über das Raster hinausragen.

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

Rückflug

OverGridImage[]: Eine Reihe von über das Raster gelegten Bildern.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getIterativeCalculationConvergenceThreshold()

Gibt den Grenzwert zurück, der bei der iterativen Berechnung verwendet wird. Wenn sich die Ergebnisse aufeinanderfolgender Berechnungen um weniger als diesen Wert unterscheiden, 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());

Rückflug

Number – der Konvergenzgrenzwert.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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

Rückflug

Integer: die letzte Spalte der Tabelle, die Inhalte enthält

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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

Rückflug

Integer: die letzte Zeile der Tabelle, die Inhalte enthält

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getMaxIterativeCalculationCycles()

Gibt die maximale Anzahl von Iterationen zurück, die bei der iterativen Berechnung verwendet werden sollen.

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

Rückflug

Integer: Die maximale Anzahl der Berechnungsiterationen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getName()

Ruft den Namen des Dokuments ab.

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

Rückflug

String: Der Name der Tabelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getNamedRanges()

Hiermit werden alle benannten Bereiche in dieser Tabelle abgerufen.

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

Rückflug

NamedRange[]: Ein Array mit allen benannten Bereichen in der Tabelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getNumSheets()

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

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

Rückflug

Integer – die Anzahl der Tabellen in der Tabelle.


getOwner()

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

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

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getPredefinedSpreadsheetThemes()

Liste der vordefinierten Designs zurückgeben

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

Rückflug

SpreadsheetTheme[]: Liste der vordefinierten Designs.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getProtections(type)

Hiermit wird ein Array von Objekten zurückgegeben, die alle geschützten Bereiche oder Tabellen 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.

Rückflug

Protection[]: Ein Array von Objekten, das alle geschützten Bereiche oder Tabellenblätter in der Tabelle darstellt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getRange(a1Notation)

Gibt den Bereich in 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 Bereich, der zurückgegeben werden soll, in A1- oder R1C1-Notation.

Rückflug

Range – der Bereich am angegebenen Standort

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getRangeByName(name)

Gibt einen benannten Bereich zurück oder null, wenn kein Bereich mit dem angegebenen Namen gefunden wird. Wenn in mehreren Tabellen der Tabelle derselbe Bereichsname verwendet wird, geben Sie den Tabellennamen 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 Bereichs, der abgerufen werden soll.

Rückflug

Range: Der Zellenbereich mit dem angegebenen Namen.


getRangeList(a1Notations)

Gibt die RangeList-Sammlung zurück, die die Bereiche auf demselben Tabellenblatt darstellt, die durch eine nicht leere Liste von A1- oder R1C1-Bezeichnungen 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[]Liste der zurückzugebenden Bereiche, angegeben in A1- oder R1C1-Notation.

Rückflug

RangeList – die Bereichsliste am angegebenen Standort

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getRecalculationInterval()

Gibt das Berechnungsintervall für diese Tabelle 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());

Rückflug

RecalculationInterval: Das Berechnungsintervall für diese Tabelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getRowHeight(rowPosition)

Die Höhe der angegebenen Zeile in Pixeln.

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

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

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der Zeile, die geprüft werden soll.

Rückflug

Integer – Zeilenhöhe in Pixeln

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getSelection()

Gibt das aktuelle Selection in der Tabelle zurück.

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

Rückflug

Selection – die aktuelle Auswahl

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getSheetByName(name)

Gibt eine Tabelle mit dem angegebenen Namen zurück.

Wenn mehrere Tabellen denselben Namen haben, wird die linkeste zurückgegeben. Gibt null zurück, wenn es keine Tabelle mit dem angegebenen Namen gibt.

// 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 zu erhaltenden Tabellenblatts.

Rückflug

Sheet: Das Tabellenblatt mit dem angegebenen Namen.


getSheetId()

Gibt die ID des Tabellenblatts zurück, das durch dieses Objekt dargestellt wird.

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

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

Logger.log(sheet.getSheetId());

Rückflug

Integer: Eine eindeutige ID für die Tabelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getSheetName()

Gibt den Tabellennamen zurück.

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

Logger.log(sheet.getSheetName());

Rückflug

String – der Name der Tabelle

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getSheetValues(startRow, startColumn, numRows, numColumns)

Gibt das rechteckige Raster mit Werten für diesen Bereich ab den angegebenen Koordinaten zurück. Wenn Sie als Zeilen- oder Spaltenposition den Wert „-1“ angeben, wird die letzte Zeile oder Spalte mit Daten im Tabellenblatt zurückgegeben.

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.

Rückflug

Object[][] – ein zweidimensionales Array von Werten

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getSheets()

Ruft alle Tabellen 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());
}

Rückflug

Sheet[]: Ein Array mit allen Tabellenblättern in der Tabelle.


getSpreadsheetLocale()

Ruft das Gebietsschema der 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);

Rückflug

String: Das Gebietsschema der Tabelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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

Rückflug

SpreadsheetTheme: Das aktuell angewendete Design.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getSpreadsheetTimeZone()

Die Zeitzone der Tabelle.

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

Rückflug

String – Die Zeitzone im Langformat (z. B. „America/New_York“, wie von Joda.org aufgeführt).

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getUrl()

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

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

Rückflug

String: Die URL der Tabelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getViewers()

Ruft die Liste der Betrachter und Kommentatoren für diese Spreadsheet ab.

Rückflug

User[]: Ein Array von Nutzern mit der Berechtigung zum Ansehen oder Kommentieren.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

hideColumn(column)

Die Spalte oder die Spalten im angegebenen Bereich werden ausgeblendet.

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

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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 zu blendende Zeilenbereich.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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
afterPositionIntegerDie Spalte, nach der die neue Spalte eingefügt werden soll.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertColumnBefore(beforePosition)

Hiermit wird eine Spalte vor der angegebenen Spaltenposition eingefügt.

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.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertColumnsAfter(afterPosition, howMany)

Fügt nach der angegebenen Spaltenposition eine bestimmte Anzahl von Spalten 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
afterPositionIntegerDie Spalte, nach der die neue Spalte eingefügt werden soll.
howManyIntegerDie Anzahl der einzufügenden Spalten.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertColumnsBefore(beforePosition, howMany)

Fügt vor der angegebenen Spaltenposition eine Reihe von Spalten 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.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertDataSourceSheet(spec)

Es wird eine neue DataSourceSheet in die Tabelle eingefügt und die Datenausführung gestartet. Als Nebeneffekt wird die neue Tabelle dadurch auch zur aktiven Tabelle.

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

// 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, mit der eingefügt werden soll.

Rückflug

DataSourceSheet: Die neue Tabelle für die Datenquelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertImage(blobSource, column, row)

Fügt ein Spreadsheet als Bild in das Dokument in 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
blobSourceBlobSourceDer Blob mit dem Bildinhalt, dem MIME-Typ und (optional) dem Namen.
columnIntegerDie Spaltenposition.
rowIntegerDie Zeilenposition.

Rückflug

OverGridImage – das eingefügte Bild.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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

Fügt ein Spreadsheet als Bild in das Dokument in einer bestimmten Zeile und Spalte mit einem 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
blobSourceBlobSourceDer Blob mit dem Bildinhalt, dem MIME-Typ und (optional) dem Namen.
columnIntegerDie Spaltenposition.
rowIntegerDie Zeilenposition.
offsetXIntegerDer horizontale Abstand von der Zellenecke in Pixeln.
offsetYIntegerDer vertikale Offset von der Zellenecke in Pixeln.

Rückflug

OverGridImage – das eingefügte Bild.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertImage(url, column, row)

Fügt ein Bild in das Dokument 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);

Parameter

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

Rückflug

OverGridImage – das eingefügte Bild.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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

Fügt ein Bild in das Dokument in einer bestimmten Zeile und Spalte mit einem Pixelversatz 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 Abstand von der Zellenecke in Pixeln.
offsetYIntegerDer vertikale Offset von der Zellenecke in Pixeln.

Rückflug

OverGridImage – das eingefügte Bild.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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
afterPositionIntegerDie Zeile, nach der die neue Zeile eingefügt werden soll.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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
beforePositionIntegerDie Zeile, vor der die neue Zeile eingefügt werden soll.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertRowsAfter(afterPosition, howMany)

Fügt nach der angegebenen Zeilenposition eine bestimmte Anzahl von Zeilen 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 eingefügt werden sollen.
howManyIntegerDie Anzahl der einzufügenden Zeilen.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertRowsBefore(beforePosition, howMany)

Fügt vor der angegebenen Zeilenposition eine bestimmte Anzahl von Zeilen 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.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertSheet()

Es wird ein neues Tabellenblatt mit einem Standardnamen in die Tabelle eingefügt. Das neue Tabellenblatt wird zum aktiven Tabellenblatt.

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

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertSheet(sheetIndex)

Fügen Sie der Tabelle an der angegebenen Position ein neues Tabellenblatt 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“.

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertSheet(sheetIndex, options)

Fügen Sie der Tabelle an der angegebenen Position ein neues Blatt ein und verwenden Sie 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 Vorlagenblattobjekt werden in das neue Blatt kopiert. Die Tabellenvorlage muss eines der Tabellenblätter des Tabellenobjekts sein.

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertSheet(options)

Fügt der Tabelle ein neues Tabellenblatt mit einem Standardnamen und optionalen erweiterten Argumenten ein. 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 Vorlagenblattobjekt werden in das neue Blatt kopiert. Die Tabellenvorlage muss eines der Tabellenblätter dieses Tabellenobjekts sein.

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertSheet(sheetName)

Es wird ein neues Tabellenblatt mit dem angegebenen Namen in die Tabelle eingefügt. Das neue Tabellenblatt wird zum aktiven Tabellenblatt.

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

Parameter

NameTypBeschreibung
sheetNameStringDer Name des neuen Tabellenblatts.

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertSheet(sheetName, sheetIndex)

Fügt der Tabelle ein neues Tabellenblatt mit dem angegebenen Namen an der angegebenen Position 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“.

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertSheet(sheetName, sheetIndex, options)

Es wird ein neues Tabellenblatt mit dem angegebenen Namen an der angegebenen Position in die Tabelle eingefügt. Dabei werden optionale erweiterte Argumente verwendet. 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.
sheetIndexIntegerDer Index des neu eingefügten Tabellenblatts. Wenn Sie ein Tabellenblatt als erstes in eine Tabelle einfügen möchten, setzen Sie es auf „0“.
optionsObjectOptionale erweiterte JavaScript-Argumente.

Erweiterte Parameter

NameTypBeschreibung
templateSheetAlle Daten aus dem Vorlagenblattobjekt werden in das neue Blatt kopiert. Die Tabellenvorlage muss eines der Tabellenblätter des Tabellenobjekts sein.

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertSheet(sheetName, options)

Es wird ein neues Tabellenblatt mit dem angegebenen Namen in die Tabelle eingefügt. Dabei werden optionale erweiterte Argumente verwendet. 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 Vorlagenblattobjekt werden in das neue Blatt kopiert. Die Tabellenvorlage muss eines der Tabellenblätter des Tabellenobjekts sein.

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertSheetWithDataSourceTable(spec)

Es wird ein neues Tabellenblatt in die Tabelle eingefügt, eine DataSourceTable wird mit der angegebenen Datenquellenspezifikation über das gesamte Tabellenblatt erstellt und die Datenausführung wird gestartet. Als Nebeneffekt wird die neue Tabelle zur aktiven Tabelle.

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

// 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, mit der eingefügt werden soll.

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

isColumnHiddenByUser(columnPosition)

Gibt an, ob die angegebene Spalte vom Nutzer ausgeblendet ist.

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

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

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der zu prüfenden Spalte.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

isIterativeCalculationEnabled()

Gibt an, ob die iterative Berechnung in dieser Tabelle 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());

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

isRowHiddenByFilter(rowPosition)

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

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

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

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der Zeile, die geprüft werden soll.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

isRowHiddenByUser(rowPosition)

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

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

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

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der Zeile, die geprüft werden soll.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

moveActiveSheet(pos)

Verschiebt das aktive Tabellenblatt an die angegebene Position in der Liste der Tabellenblätter. Es wird eine Ausnahme ausgelöst, wenn die Position negativ oder größer als die Anzahl der Blä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 Position 1, an die das aktive Tabellenblatt in der Liste der Tabellenblätter verschoben werden soll.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

moveChartToObjectSheet(chart)

Hiermit wird eine neue SheetType.OBJECT-Tabelle erstellt und das bereitgestellte Diagramm wird dorthin verschoben. Wenn sich das Diagramm bereits auf einem eigenen Tabellenblatt befindet, wird dieses zurückgegeben, ohne dass ein neues erstellt wird.

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.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

refreshAllDataSources()

Alle unterstützten Datenquellen und ihre verknüpften Datenquellenobjekte werden aktualisiert. Ungültige Datenquellenobjekte werden übersprungen.

Mit SpreadsheetApp#enable...Execution()-Methoden können Sie die Datenausführung für einen bestimmten Datenquellentyp aktivieren.

// 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

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

removeEditor(emailAddress)

Der angegebene Nutzer wird aus der Liste der Mitbearbeiter der Spreadsheet entfernt. Mit dieser Methode wird der Zugriff von Nutzern auf die Spreadsheet nicht blockiert, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören. Das ist beispielsweise der Fall, wenn die Spreadsheet für die gesamte Domain des Nutzers freigegeben wurde oder sich die Spreadsheet in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

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

Parameter

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

Rückflug

Spreadsheet – Dieses Spreadsheet für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

removeEditor(user)

Der angegebene Nutzer wird aus der Liste der Mitbearbeiter der Spreadsheet entfernt. Mit dieser Methode wird der Zugriff von Nutzern auf die Spreadsheet nicht blockiert, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören. Das ist beispielsweise der Fall, wenn die Spreadsheet für die gesamte Domain des Nutzers freigegeben wurde oder sich die Spreadsheet in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

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

Parameter

NameTypBeschreibung
userUserEine Darstellung des zu entfernenden Nutzers.

Rückflug

Spreadsheet – Dieses Spreadsheet für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

removeMenu(name)

Entfernt ein Menü, das von addMenu(name, subMenus) hinzugefügt wurde. Das Argument name muss denselben Wert haben wie der entsprechende Aufruf von addMenu(name, subMenus).

// 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

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

removeNamedRange(name)

Löscht einen benannten Bereich mit dem angegebenen Namen. Löst eine Ausnahme aus, wenn in der Tabelle kein Bereich mit dem angegebenen Namen 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

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

removeViewer(emailAddress)

Der angegebene Nutzer wird aus der Liste der Zuschauer und Kommentatoren für die Spreadsheet entfernt. Diese Methode hat keine Auswirkungen, wenn der Nutzer ein Mitbearbeiter und kein Betrachter oder Kommentator ist. Außerdem wird mit dieser Methode der Zugriff von Nutzern auf die Spreadsheet nicht blockiert, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören. Das ist beispielsweise der Fall, wenn die Spreadsheet für die gesamte Domain des Nutzers freigegeben wurde oder sich die Spreadsheet in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.Spreadsheet

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

Parameter

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

Rückflug

Spreadsheet – Dieses Spreadsheet für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

removeViewer(user)

Der angegebene Nutzer wird aus der Liste der Zuschauer und Kommentatoren für die Spreadsheet entfernt. Diese Methode hat keine Auswirkungen, wenn der Nutzer ein Mitbearbeiter und kein Betrachter ist. Außerdem wird mit dieser Methode der Zugriff von Nutzern auf die Spreadsheet nicht blockiert, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören. Das ist beispielsweise der Fall, wenn die Spreadsheet für die gesamte Domain des Nutzers freigegeben ist oder sich die Spreadsheet in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

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

Parameter

NameTypBeschreibung
userUserEine Darstellung des zu entfernenden Nutzers.

Rückflug

Spreadsheet – Dieses Spreadsheet für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

rename(newName)

Benennt das Dokument um.

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

Parameter

NameTypBeschreibung
newNameStringDer neue Name für das Dokument.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

renameActiveSheet(newName)

Das aktuell aktive Tabellenblatt wird in den angegebenen neuen Namen umbenannt.

// 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

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

resetSpreadsheetTheme()

Entfernt das angewendete Design und setzt das Standarddesign für die Tabelle.

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

Rückflug

SpreadsheetTheme: Das Standarddesign.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setActiveRange(range)

Der angegebene Bereich wird als active range in der aktiven Tabelle festgelegt, wobei die linke obere Zelle im Bereich als current cell festgelegt wird.

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
rangeRangeDer Bereich, der als aktiver Bereich festgelegt werden soll.

Rückflug

Range – der neu aktive Bereich

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setActiveRangeList(rangeList)

Legt die angegebene Liste von Bereichen als active ranges im aktiven Tabellenblatt fest. Der letzte Bereich in der Liste wird 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
rangeListRangeListListe der auszuwählenden Bereiche.

Rückflug

RangeList: die neu ausgewählte Liste von Bereichen

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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.

Rückflug

Range – der neu aktive Bereich

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setActiveSelection(a1Notation)

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

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

sheet.setActiveSelection("A1:D4");

Parameter

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

Rückflug

Range – der neu aktive Bereich

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setActiveSheet(sheet)

Das angegebene Tabellenblatt wird zum aktiven Tabellenblatt in der Tabelle. In der Google Tabellen-Benutzeroberfläche wird das ausgewählte Tabellenblatt angezeigt, es sei denn, es gehört zu einer anderen Tabelle.

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

Rückflug

Sheet: Das aktive Tabellenblatt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setActiveSheet(sheet, restoreSelection)

Das angegebene Tabellenblatt wird zum aktiven Tabellenblatt in der Tabelle. Es gibt eine Option, die letzte Auswahl in diesem Tabellenblatt wiederherzustellen. In der Google Tabellen-Benutzeroberfläche 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 ausgewählt ist, wird die letzte Auswahl des neuen aktiven Tabellenblatts wieder ausgewählt, wenn das neue Tabellenblatt aktiv wird. Bei false wird das neue Tabellenblatt aktiv, ohne dass sich die aktuelle Auswahl ändert.

Rückflug

Sheet: Das neue aktive Tabellenblatt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setColumnWidth(columnPosition, width)

Hiermit wird die Breite der angegebenen Spalte in Pixeln festgelegt.

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 zu setzenden Spalte.
widthIntegerDie Breite in Pixeln.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setCurrentCell(cell)

Die angegebene Zelle wird als current cell festgelegt.

Wenn sich die angegebene Zelle in einem bereits ausgewählten Bereich befindet, wird dieser Bereich zum aktiven Bereich und die Zelle zur aktuellen Zelle.

Wenn sich die angegebene Zelle in keinem ausgewählten Bereich befindet, wird die vorhandene Auswahl entfernt und die Zelle wird zur aktuellen Zelle und zum aktiven Bereich.

Hinweis:Die 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
cellRangeDie Zelle, die als aktuelle Zelle festgelegt werden soll.

Rückflug

Range: die neu festgelegte aktuelle Zelle

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setFrozenColumns(columns)

Die angegebene Anzahl von Spalten wird fixiert. Wenn der Wert „0“ ist, werden keine Spalten eingefroren.

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

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setFrozenRows(rows)

Die angegebene Anzahl von Zeilen wird fixiert. Wenn der Wert „0“ ist, werden keine Zeilen eingefroren.

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

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

Parameter

NameTypBeschreibung
rowsIntegerDie Anzahl der Zeilen, die fixiert werden sollen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setIterativeCalculationConvergenceThreshold(minThreshold)

Legt den Mindestgrenzwert für die iterative Berechnung fest. Wenn sich die Ergebnisse aufeinanderfolgender Berechnungen um weniger als diesen Wert unterscheiden, wird die iterative Berechnung beendet. Dieser Wert muss nicht negativ sein.Der Standardwert ist 0, 05.

// 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
minThresholdNumberDie Mindestkonvergenzschwelle (muss nicht negativ sein).

Rückflug

Spreadsheet – diese Tabelle, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setIterativeCalculationEnabled(isEnabled)

Hiermit wird festgelegt, ob die iterative Berechnung in dieser Tabelle aktiviert ist. Wenn die maximale Anzahl von Berechnungszyklen und der Konvergenzgrenzwert nicht zuvor festgelegt wurden, wenn die Berechnung aktiviert wurde, werden standardmäßig 50 und 0,05 verwendet. Wenn einer der beiden Werte bereits festgelegt wurde, bleibt er unverändert.

// 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, false andernfalls.

Rückflug

Spreadsheet – diese Tabelle, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setMaxIterativeCalculationCycles(maxIterations)

Legt die maximale Anzahl von Berechnungsiterationen fest, die bei 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 von Berechnungsiterationen (zwischen 1 und 10.000).

Rückflug

Spreadsheet – diese Tabelle, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setRecalculationInterval(recalculationInterval)

Hiermit wird festgelegt, 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.

Rückflug

Spreadsheet – diese Tabelle, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setRowHeight(rowPosition, height)

Legt die Zeilenhöhe der angegebenen Zeile in Pixeln fest. Standardmäßig werden Zeilen so lange erweitert, bis sie den Zelleninhalt umfassen. Wenn Sie Zeilen auf eine bestimmte Höhe festlegen 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.

Rückflug

Sheet: Das Tabellenblatt, nützlich für die Methodenverkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setSpreadsheetLocale(locale)

Legt die Sprache der 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 Sprachcode (z. B. „de“, „fr“ oder „en_US“).

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setSpreadsheetTheme(theme)

Hiermit wird ein Design für die Tabelle festgelegt.

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.

Rückflug

SpreadsheetTheme – das neue aktuelle Design.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setSpreadsheetTimeZone(timezone)

Hier legen Sie 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 Langformat (z. B. „America/New_York“, wie von Joda.org aufgeführt).

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

show(userInterface)

Eine benutzerdefinierte Benutzeroberflächenkomponente wird in einem Dialogfeld angezeigt, das im Browser des Nutzers zentriert ist. Die Ausführung des serverseitigen Scripts wird nicht ausgesetzt. Um mit der Serverseite zu kommunizieren, muss die Benutzeroberflächenkomponente asynchrone Rückrufe an das serverseitige Script senden.

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

Im 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

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

sort(columnPosition)

Sortiert ein Tabellenblatt nach Spalte in aufsteigender Reihenfolge.

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.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

sort(columnPosition, ascending)

Sortiert ein Tabellenblatt nach Spalte. Erforderlich ist ein 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 aufsteigend, false für absteigend.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

toast(msg)

Es wird rechts unten in der Tabelle ein Pop-up-Fenster mit der angegebenen Nachricht angezeigt.

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

Parameter

NameTypBeschreibung
msgStringDie Nachricht, die im Toast angezeigt werden soll.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

toast(msg, title)

Es wird ein Pop-up-Fenster mit der angegebenen Nachricht und dem Titel rechts unten in der Tabelle angezeigt.

// 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 der Benachrichtigung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

toast(msg, title, timeoutSeconds)

Es wird ein Pop-up-Fenster mit dem angegebenen Titel und der angegebenen Nachricht rechts unten in der Tabelle angezeigt, das für eine bestimmte Zeit 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 der Benachrichtigung.
timeoutSecondsNumberDas Zeitlimit in Sekunden. Wenn null festgelegt ist, beträgt die Standarddauer des Toasts 5 Sekunden. Ist der Wert negativ, bleibt das Toastfenster geöffnet, bis es geschlossen wird.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

unhideColumn(column)

Die Spalte im angegebenen Bereich wird eingeblendet.

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
columnRangeDer Bereich, der wieder eingeblendet werden soll, falls ausgeblendet.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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
rowRangeDer Bereich, der wieder eingeblendet werden soll, falls ausgeblendet.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

updateMenu(name, subMenus)

Aktualisiert ein Menü, das von addMenu(name, subMenus) hinzugefügt wurde. Funktioniert genau 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-Karten mit name- und functionName -Parametern. Sie können Funktionen aus den enthaltenen Bibliotheken wie Library.libFunction1 verwenden.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Es wird gewartet, bis alle aktuellen Ausführungen in der Tabelle abgeschlossen sind. Nach der angegebenen Anzahl von Sekunden wird ein Zeitüberschreitungsfehler ausgegeben. Löst eine Ausnahme aus, wenn die Ausführungen nicht abgeschlossen sind, wenn die Zeitüberschreitung eintritt, bricht die Datenausführungen aber nicht ab.

Parameter

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Eingestellte Methoden