Class Spreadsheet

Tabelle

Auf Google Sheets-Dateien zugreifen und sie bearbeiten. Häufige Vorgänge sind das Hinzufügen neuer Tabellenblätter und das Hinzufügen von Mitbearbeitern.

Methoden

MethodeRückgabetypKurzbeschreibung
addDeveloperMetadata(key)SpreadsheetFügt der Tabelle der obersten Ebene Entwicklermetadaten mit dem angegebenen Schlüssel hinzu.
addDeveloperMetadata(key, visibility)SpreadsheetFügt der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel und der angegebenen Sichtbarkeit hinzu.
addDeveloperMetadata(key, value)SpreadsheetFügt der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel und Wert hinzu.
addDeveloperMetadata(key, value, visibility)SpreadsheetFügt der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel, Wert und der angegebenen Sichtbarkeit hinzu.
addEditor(emailAddress)SpreadsheetFügt den angegebenen Nutzer der Liste der Bearbeiter für Spreadsheet hinzu.
addEditor(user)SpreadsheetFügt den angegebenen Nutzer der Liste der Bearbeiter für Spreadsheet hinzu.
addEditors(emailAddresses)SpreadsheetFügt das angegebene Nutzer-Array der Liste der Bearbeiter für die Spreadsheet hinzu.
addMenu(name, subMenus)voidErstellt ein neues Menü in der Tabellenoberfläche.
addViewer(emailAddress)SpreadsheetFügt den angegebenen Nutzer der Liste der Zuschauer für Spreadsheet hinzu.
addViewer(user)SpreadsheetFügt den angegebenen Nutzer der Liste der Zuschauer für Spreadsheet hinzu.
addViewers(emailAddresses)SpreadsheetFügt das angegebene Nutzer-Array der Liste der Zuschauer für Spreadsheet hinzu.
appendRow(rowContents)SheetFügt eine Zeile unten an den aktuellen Datenbereich im Tabellenblatt an.
autoResizeColumn(columnPosition)SheetLegt die Breite der angegebenen Spalte so fest, dass sie an den Inhalt angepasst wird.
copy(name)SpreadsheetKopiert die Tabelle und gibt die neue Tabelle zurück.
createDeveloperMetadataFinder()DeveloperMetadataFinderGibt ein DeveloperMetadataFinder zurück, um Entwicklermetadaten im Bereich dieses Tabellenblatts zu finden.
createTextFinder(findText)TextFinderErstellt eine Textsuche für das Tabellenblatt, mit der Text im Tabellenblatt gesucht und ersetzt werden kann.
deleteActiveSheet()SheetLöscht das aktuell aktive Tabellenblatt.
deleteColumn(columnPosition)SheetLöscht die Spalte an der angegebenen Spaltenposition.
deleteColumns(columnPosition, howMany)voidLöscht eine bestimmte Anzahl von Spalten ab der angegebenen Spaltenposition.
deleteRow(rowPosition)SheetLöscht die Zeile an der angegebenen Zeilenposition.
deleteRows(rowPosition, howMany)voidLöscht eine bestimmte Anzahl von Zeilen ab der angegebenen Zeilenposition.
deleteSheet(sheet)voidLöscht das angegebene Tabellenblatt.
duplicateActiveSheet()SheetDupliziert das aktive Tabellenblatt und macht es zum aktiven Tabellenblatt.
getActiveCell()RangeGibt die aktive Zelle in diesem Tabellenblatt zurück.
getActiveRange()RangeGibt den ausgewählten Bereich im aktiven Tabellenblatt zurück oder null, wenn kein aktiver Bereich vorhanden ist.
getActiveRangeList()RangeListGibt die Liste der aktiven Bereiche im aktiven Tabellenblatt oder null zurück, wenn keine aktiven Bereiche vorhanden sind.
getActiveSheet()SheetGibt das aktive Tabellenblatt in einer Tabelle zurück.
getAs(contentType)BlobGibt die Daten in diesem Objekt als Blob zurück, das in den angegebenen Inhaltstyp konvertiert wurde.
getBandings()Banding[]Gibt alle Bandings in dieser Tabelle zurück.
getBlob()BlobGibt die Daten in diesem Objekt als Blob zurück.
getColumnWidth(columnPosition)IntegerGibt die Breite der angegebenen Spalte in Pixeln zurück.
getCurrentCell()RangeGibt die aktuelle Zelle im aktiven Tabellenblatt oder null zurück, wenn keine aktuelle Zelle vorhanden ist.
getDataRange()RangeGibt ein Range zurück, das den Dimensionen entspricht, in denen Daten vorhanden sind.
getDataSourceFormulas()DataSourceFormula[]Ruft alle Datenquellenformeln ab.
getDataSourcePivotTables()DataSourcePivotTable[]Ruft alle Pivot-Tabellen der Datenquelle ab.
getDataSourceRefreshSchedules()DataSourceRefreshSchedule[]Ruft die Aktualisierungszeitpläne dieser Tabelle ab.
getDataSourceSheets()DataSourceSheet[]Gibt alle Datenquellenblätter in der Tabelle zurück.
getDataSourceTables()DataSourceTable[]Ruft alle Datenquellentabellen ab.
getDataSources()DataSource[]Gibt alle Datenquellen in der Tabelle zurück.
getDeveloperMetadata()DeveloperMetadata[]Ruft die 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, dessen Antworten an diese Tabelle gesendet werden, 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()StringGibt eine eindeutige Kennung für diese Tabelle zurück.
getImages()OverGridImage[]Gibt alle Bilder zurück, die sich nicht in Zellen befinden.
getIterativeCalculationConvergenceThreshold()NumberGibt den Schwellenwert 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 an Iterationen zurück, die bei der iterativen Berechnung verwendet werden sollen.
getName()StringRuft den Namen des Dokuments ab.
getNamedRanges()NamedRange[]Ruft alle benannten Bereiche in dieser Tabelle ab.
getNumSheets()IntegerGibt die Anzahl der Tabellenblätter in dieser Tabelle zurück.
getOwner()UserGibt den Eigentümer des Dokuments oder null für ein Dokument in einer geteilten Ablage zurück.
getPredefinedSpreadsheetThemes()SpreadsheetTheme[]Gibt die Liste der vordefinierten Designs zurück.
getProtections(type)Protection[]Ruft ein Array von Objekten ab, die alle geschützten Bereiche oder Tabellenblätter 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 im selben Tabellenblatt darstellt, die durch eine nicht leere Liste von A1- oder R1C1-Notationen angegeben werden.
getRecalculationInterval()RecalculationIntervalGibt das Berechnungsintervall für diese Tabelle zurück.
getRowHeight(rowPosition)IntegerGibt die Höhe der angegebenen Zeile in Pixeln zurück.
getSelection()SelectionGibt die aktuelle Selection in der Tabelle zurück.
getSheetById(id)SheetRuft das Tabellenblatt mit der angegebenen ID ab.
getSheetByName(name)SheetGibt ein Tabellenblatt mit dem angegebenen Namen zurück.
getSheetId()IntegerGibt die ID des Tabellenblatts zurück, das durch dieses Objekt dargestellt wird.
getSheetName()StringGibt den Namen des Tabellenblatts zurück.
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]Gibt das rechteckige Raster von Werten für diesen Bereich zurück, beginnend mit den angegebenen Koordinaten.
getSheets()Sheet[]Ruft alle Tabellenblätter in dieser Tabelle ab.
getSpreadsheetLocale()StringRuft das Gebietsschema der Tabelle ab.
getSpreadsheetTheme()SpreadsheetThemeGibt das aktuelle Design der Tabelle oder null zurück, wenn kein Design angewendet wird.
getSpreadsheetTimeZone()StringGibt die Zeitzone für die Tabelle zurück.
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)voidBlendet die Spalte(n) im angegebenen Bereich aus.
hideRow(row)voidBlendet die Zeilen im angegebenen Bereich aus.
insertColumnAfter(afterPosition)SheetFügt eine Spalte nach der angegebenen Spaltenposition ein.
insertColumnBefore(beforePosition)SheetFügt eine Spalte vor der angegebenen Spaltenposition ein.
insertColumnsAfter(afterPosition, howMany)SheetFügt nach der angegebenen Spaltenposition eine bestimmte Anzahl von Spalten ein.
insertColumnsBefore(beforePosition, howMany)SheetFügt eine bestimmte Anzahl von Spalten vor der angegebenen Spaltenposition ein.
insertDataSourceSheet(spec)DataSourceSheetFügt eine neue DataSourceSheet in die Tabelle ein und startet die Datenausführung.
insertImage(blobSource, column, row)OverGridImageFügt ein Spreadsheet als Bild in das Dokument 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 Pixel-Offset 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 mit einem Pixel-Offset in das Dokument an einer bestimmten Zeile und Spalte ein.
insertRowAfter(afterPosition)SheetFügt eine Zeile nach der angegebenen Zeilenposition ein.
insertRowBefore(beforePosition)SheetFügt eine Zeile vor der angegebenen Zeilenposition ein.
insertRowsAfter(afterPosition, howMany)SheetFügt nach der angegebenen Zeilenposition eine bestimmte Anzahl von Zeilen ein.
insertRowsBefore(beforePosition, howMany)SheetFügt eine bestimmte Anzahl von Zeilen vor der angegebenen Zeilenposition ein.
insertSheet()SheetFügt ein neues Tabellenblatt mit einem Standardnamen in die Tabelle ein.
insertSheet(sheetIndex)SheetFügt an der angegebenen Position ein neues Tabellenblatt in die Tabelle ein.
insertSheet(sheetIndex, options)SheetFügt ein neues Tabellenblatt an der angegebenen Position in die Tabelle ein und verwendet optionale erweiterte Argumente.
insertSheet(options)SheetFügt ein neues Tabellenblatt in die Tabelle ein. Dabei wird ein Standardname für das Tabellenblatt verwendet. Es können auch optionale erweiterte Argumente angegeben werden.
insertSheet(sheetName)SheetFügt der Tabelle ein neues Tabellenblatt mit dem angegebenen Namen hinzu.
insertSheet(sheetName, sheetIndex)SheetFügt ein neues Tabellenblatt mit dem angegebenen Namen an der angegebenen Indexposition in die Tabelle ein.
insertSheet(sheetName, sheetIndex, options)SheetFügt ein neues Tabellenblatt mit dem angegebenen Namen am angegebenen Index in die Tabelle ein und verwendet optionale erweiterte Argumente.
insertSheet(sheetName, options)SheetFügt ein neues Tabellenblatt mit dem angegebenen Namen in die Tabelle ein und verwendet optionale erweiterte Argumente.
insertSheetWithDataSourceTable(spec)SheetFügt ein neues Tabellenblatt in die Tabelle ein, erstellt eine DataSourceTable, die sich über das gesamte Tabellenblatt erstreckt, und startet die Datenausführung.
isColumnHiddenByUser(columnPosition)BooleanGibt zurück, ob die angegebene Spalte vom Nutzer ausgeblendet wurde.
isIterativeCalculationEnabled()BooleanGibt zurück, ob die iterative Berechnung in dieser Tabelle aktiviert ist.
isRowHiddenByFilter(rowPosition)BooleanGibt zurück, ob die angegebene Zeile durch einen Filter (nicht durch eine Filteransicht) ausgeblendet wird.
isRowHiddenByUser(rowPosition)BooleanGibt zurück, ob die angegebene Zeile vom Nutzer ausgeblendet wurde.
moveActiveSheet(pos)voidVerschiebt das aktive Tabellenblatt an die angegebene Position in der Liste der Tabellenblätter.
moveChartToObjectSheet(chart)SheetErstellt ein neues SheetType.OBJECT-Arbeitsblatt und verschiebt das bereitgestellte Diagramm dorthin.
refreshAllDataSources()voidAktualisiert alle unterstützten Datenquellen und die zugehörigen Datenquellenobjekte. Ungültige Datenquellenobjekte werden übersprungen.
removeEditor(emailAddress)SpreadsheetEntfernt den angegebenen Nutzer aus der Liste der Bearbeiter für die Spreadsheet.
removeEditor(user)SpreadsheetEntfernt den angegebenen Nutzer aus der Liste der Bearbeiter für die Spreadsheet.
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)SpreadsheetEntfernt den angegebenen Nutzer aus der Liste der Zuschauer und Kommentatoren für die Spreadsheet.
removeViewer(user)SpreadsheetEntfernt den angegebenen Nutzer aus der Liste der Zuschauer und Kommentatoren für die Spreadsheet.
rename(newName)voidBenennt das Dokument um.
renameActiveSheet(newName)voidBenennt das aktuell aktive Tabellenblatt in den angegebenen neuen Namen um.
resetSpreadsheetTheme()SpreadsheetThemeEntfernt das angewendete Design und legt das Standarddesign für die Tabelle fest.
setActiveRange(range)RangeLegt den angegebenen Bereich als active range im aktiven Tabellenblatt fest. Die obere linke Zelle im Bereich wird als current cell verwendet.
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 der A1- oder R1C1-Notation angegeben.
setActiveSheet(sheet)SheetLegt das angegebene Tabellenblatt als aktives Tabellenblatt in der Tabelle fest.
setActiveSheet(sheet, restoreSelection)SheetLegt das angegebene Tabellenblatt als aktives Tabellenblatt in der Tabelle fest. Optional kann die letzte Auswahl in diesem Tabellenblatt wiederhergestellt werden.
setColumnWidth(columnPosition, width)SheetLegt die Breite der angegebenen Spalte in Pixeln fest.
setCurrentCell(cell)RangeLegt die angegebene Zelle als current cell fest.
setFrozenColumns(columns)voidFriert die angegebene Anzahl von Spalten ein.
setFrozenRows(rows)voidFixiert die angegebene Anzahl von Zeilen.
setIterativeCalculationConvergenceThreshold(minThreshold)SpreadsheetLegt den Mindestschwellenwert für die iterative Berechnung fest.
setIterativeCalculationEnabled(isEnabled)SpreadsheetLegt fest, ob die iterative Berechnung in dieser Tabelle aktiviert ist.
setMaxIterativeCalculationCycles(maxIterations)SpreadsheetLegt die maximale Anzahl von Berechnungsiterationen fest, die bei der iterativen Berechnung ausgeführt werden sollen.
setNamedRange(name, range)voidBenennt einen Bereich.
setRecalculationInterval(recalculationInterval)SpreadsheetLegt fest, wie oft diese Tabelle neu berechnet werden soll.
setRowHeight(rowPosition, height)SheetLegt die Zeilenhöhe der angegebenen Zeile in Pixeln fest.
setSpreadsheetLocale(locale)voidLegt die Sprache der Tabelle fest.
setSpreadsheetTheme(theme)SpreadsheetThemeLegt ein Design für die Tabelle fest.
setSpreadsheetTimeZone(timezone)voidLegt die Zeitzone für die Tabelle fest.
show(userInterface)voidZeigt eine benutzerdefinierte Benutzeroberflächenkomponente in einem Dialogfeld an, das im Viewport des Browsers des Nutzers zentriert ist.
sort(columnPosition)SheetSortiert ein Tabellenblatt aufsteigend nach Spalte.
sort(columnPosition, ascending)SheetSortiert ein Tabellenblatt nach Spalte.
toast(msg)voidZeigt rechts unten in der Tabelle ein Pop-up-Fenster mit der angegebenen Nachricht an.
toast(msg, title)voidZeigt rechts unten in der Tabelle ein Pop-up-Fenster mit der angegebenen Nachricht und dem angegebenen Titel an.
toast(msg, title, timeoutSeconds)voidZeigt ein Pop-up-Fenster mit dem angegebenen Titel und der angegebenen Nachricht rechts unten in der Tabelle an, das für einen bestimmten Zeitraum sichtbar bleibt.
unhideColumn(column)voidMacht die Spalte im angegebenen Bereich wieder sichtbar.
unhideRow(row)voidMacht die Zeile im angegebenen Bereich wieder sichtbar.
updateMenu(name, subMenus)voidAktualisiert ein Menü, das von addMenu(name, subMenus) hinzugefügt wurde.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidWartet, bis alle aktuellen Ausführungen in der Tabelle abgeschlossen sind. Nach der angegebenen Anzahl von Sekunden wird ein Zeitlimit überschritten.

Detaillierte Dokumentation

addDeveloperMetadata(key)

Fügt 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 zur Verkettung.

Autorisierung

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

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

addDeveloperMetadata(key, visibility)

Fügt 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 zur Verkettung.

Autorisierung

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

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

addDeveloperMetadata(key, value)

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

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

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

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

Parameter

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

Rückflug

Spreadsheet – Diese Tabelle zur Verkettung.

Autorisierung

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

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

addDeveloperMetadata(key, value, visibility)

Fügt der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel, Wert 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', 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 zur Verkettung.

Autorisierung

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

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

addEditor(emailAddress)

Fügt den angegebenen Nutzer der Liste der Bearbeiter für Spreadsheet hinzu. Wenn der Nutzer bereits auf der Liste der Zuschauer stand, wird er durch diese Methode aus der Liste der Zuschauer entfernt.

Parameter

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

Rückflug

Spreadsheet – Diese Spreadsheet zur Verkettung.

Autorisierung

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

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

addEditor(user)

Fügt den angegebenen Nutzer der Liste der Bearbeiter für Spreadsheet hinzu. Wenn der Nutzer bereits auf der Liste der Zuschauer stand, wird er durch diese Methode aus der Liste der Zuschauer entfernt.

Parameter

NameTypBeschreibung
userUserEine Darstellung des hinzuzufügenden Nutzers.

Rückflug

Spreadsheet – Diese Spreadsheet zur Verkettung.

Autorisierung

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

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

addEditors(emailAddresses)

Fügt das angegebene Nutzer-Array der Liste der Bearbeiter für die Spreadsheet hinzu. Wenn einer der Nutzer bereits in der Liste der Zuschauer war, wird er durch diese Methode aus der Liste der Zuschauer entfernt.

Parameter

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

Rückflug

Spreadsheet – Diese Spreadsheet zur Verkettung.

Autorisierung

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

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

addMenu(name, subMenus)

Erstellt ein neues Menü in der Tabellenoberfläche.

Für jeden Menüeintrag wird eine benutzerdefinierte Funktion ausgeführt. Normalerweise rufen Sie sie aus der Funktion onOpen() auf, damit das Menü automatisch erstellt wird, wenn die Tabelle geladen wird.

// The onOpen function is executed automatically every time a Spreadsheet is
// loaded
function onOpen() {
  const ss = SpreadsheetApp.getActiveSpreadsheet();
  const 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 den Parametern name und functionName . Sie können Funktionen aus enthaltenen Bibliotheken wie Library.libFunction1 verwenden.

Autorisierung

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

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

addViewer(emailAddress)

Fügt den angegebenen Nutzer der Liste der Zuschauer für Spreadsheet hinzu. Wenn der Nutzer bereits in der Liste der Bearbeiter enthalten war, hat diese Methode keine Auswirkungen.

Parameter

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

Rückflug

Spreadsheet – Diese Spreadsheet zur Verkettung.

Autorisierung

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

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

addViewer(user)

Fügt den angegebenen Nutzer der Liste der Zuschauer für Spreadsheet hinzu. Wenn der Nutzer bereits in der Liste der Bearbeiter enthalten war, hat diese Methode keine Auswirkungen.

Parameter

NameTypBeschreibung
userUserEine Darstellung des hinzuzufügenden Nutzers.

Rückflug

Spreadsheet – Diese Spreadsheet zur Verkettung.

Autorisierung

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

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

addViewers(emailAddresses)

Fügt das angegebene Nutzer-Array der Liste der Zuschauer für Spreadsheet hinzu. Wenn einer der Nutzer bereits in der Liste der Bearbeiter enthalten 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 – Diese Spreadsheet zur Verkettung.

Autorisierung

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

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

appendRow(rowContents)

Fügt eine Zeile unten an den aktuellen Datenbereich im Tabellenblatt an. Wenn der Inhalt einer Zelle mit = beginnt, wird er als Formel interpretiert.

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

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

Parameter

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

Rückflug

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

Autorisierung

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

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

autoResizeColumn(columnPosition)

Legt die Breite der angegebenen Spalte so fest, dass sie an den Inhalt angepasst wird.

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

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

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

Parameter

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

Rückflug

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

Autorisierung

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

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

copy(name)

Kopiert die Tabelle und gibt die neue Tabelle zurück.

// This code makes a copy of the current spreadsheet and names it appropriately
const ss = SpreadsheetApp.getActiveSpreadsheet();
ss.copy(`Copy of ${ss.getName()}`);

Parameter

NameTypBeschreibung
nameStringDer Name der Kopie.

Rückflug

Spreadsheet – Diese Tabelle zur Verkettung.

Autorisierung

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

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

createDeveloperMetadataFinder()

Gibt ein DeveloperMetadataFinder zurück, um Entwicklermetadaten im Bereich dieses Tabellenblatts zu finden. Standardmäßig werden alle Metadaten berücksichtigt, die mit der Tabelle, den Blättern, 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 im Bereich dieser Tabelle.


createTextFinder(findText)

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

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

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

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

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

Parameter

NameTypBeschreibung
findTextStringDer Text, nach dem gesucht werden soll.

Rückflug

TextFinder: Die TextFinder für die Tabelle.


deleteActiveSheet()

Löscht das aktuell aktive Tabellenblatt.

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

Rückflug

Sheet: Das neue aktive Tabellenblatt.

Autorisierung

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

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

deleteColumn(columnPosition)

Löscht die Spalte an der angegebenen Spaltenposition.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 Blatt, das für die Verkettung von Methoden nützlich ist.

Autorisierung

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

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

deleteColumns(columnPosition, howMany)

Löscht eine bestimmte Anzahl von Spalten ab der angegebenen Spaltenposition.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

deleteRow(rowPosition)

Löscht die Zeile an der angegebenen Zeilenposition.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 Blatt, das für die Verkettung von Methoden nützlich ist.

Autorisierung

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

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

deleteRows(rowPosition, howMany)

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

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

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der ersten zu löschenden Zeile.
howManyIntegerDie Anzahl der zu löschenden Zeilen.

Autorisierung

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

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

deleteSheet(sheet)

Löscht das angegebene Tabellenblatt.

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

Parameter

NameTypBeschreibung
sheetSheetDas zu löschende Tabellenblatt.

Autorisierung

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

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

duplicateActiveSheet()

Dupliziert das aktive Tabellenblatt und macht es zum aktiven Tabellenblatt.

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

  • 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 ist besser, getCurrentCell() zu verwenden, da damit die aktuell markierte Zelle zurückgegeben wird.

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

Rückflug

Range: Die aktuell aktive Zelle.

Autorisierung

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

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

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, wird mit dieser Methode nur der zuletzt ausgewählte Bereich zurückgegeben.

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

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

Rückflug

Range: Der aktive Bereich.

Autorisierung

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

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

Weitere Informationen


getActiveRangeList()

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

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

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

Rückflug

RangeList: Die Liste der aktiven Bereiche.

Autorisierung

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

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

Weitere Informationen


getActiveSheet()

Gibt das aktive Tabellenblatt in einer Tabelle zurück.

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

const 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, das in den angegebenen Inhaltstyp konvertiert wurde. Bei dieser Methode wird dem Dateinamen die entsprechende Erweiterung hinzugefügt, z. B. „meine_datei.pdf“. Dabei wird jedoch davon ausgegangen, dass der Teil des Dateinamens, der auf den letzten Punkt folgt (falls vorhanden), eine vorhandene Erweiterung ist, die ersetzt werden soll. Folglich wird aus „ShoppingList.12.25.2014“ „ShoppingList.12.25.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. Für Bilder im BMP-, GIF-, JPEG- oder PNG-Format sind auch 'image/bmp', 'image/gif', 'image/jpeg' oder 'image/png' gültig. Für ein Google Docs-Dokument ist auch 'text/markdown' gültig.

Rückflug

Blob: Die Daten als Blob.


getBandings()

Gibt alle Bandings 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 Bandings in dieser Tabelle.

Autorisierung

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

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

getBlob()

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

Rückflug

Blob: Die Daten als Blob.


getColumnWidth(columnPosition)

Gibt die Breite der angegebenen Spalte in Pixeln zurück.

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

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

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der zu untersuchenden Spalte.

Rückflug

Integer – Spaltenbreite in Pixeln.

Autorisierung

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

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

getCurrentCell()

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

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

Rückflug

Range: Die aktuelle Zelle.

Autorisierung

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

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

getDataRange()

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

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

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

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

// This logs the spreadsheet in CSV format with a trailing comma
for (let i = 0; i < values.length; i++) {
  let row = '';
  for (let 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getDataSourceFormulas()

Ruft alle Datenquellenformeln ab.

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

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

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

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

Rückflug

DataSourceFormula[]: Eine Liste mit Datenquellenformeln.

Autorisierung

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

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

getDataSourcePivotTables()

Ruft alle Pivot-Tabellen der Datenquelle ab.

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

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

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

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

Rückflug

DataSourcePivotTable[]: Eine Liste mit Pivot-Tabellen für Datenquellen.

Autorisierung

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

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

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

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

getDataSourceSheets()

Gibt alle Datenquellenblätter 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 mit allen Tabellenblättern der Datenquelle.

Autorisierung

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

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

getDataSourceTables()

Ruft alle Datenquellentabellen ab.

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

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

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

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

Rückflug

DataSourceTable[]: Eine Liste der Datenquellentabellen.

Autorisierung

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

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

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 mit allen Datenquellen.

Autorisierung

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

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

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

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

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

getFormUrl()

Gibt die URL für das Formular zurück, dessen Antworten an diese Tabelle gesendet werden, oder null, wenn dieser Tabelle kein Formular zugeordnet ist. Wenn mehrere Formulare Antworten an diese Tabelle senden, ist die zurückgegebene Formular-URL nicht eindeutig. Alternativ können URL-Zuordnungen pro Tabelle mit der Methode Sheet.getFormUrl() abgerufen werden. Löst eine Ausnahme aus, wenn der Nutzer nicht berechtigt ist, die Tabelle zu bearbeiten.

// 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 dieser Tabelle gespeichert werden, oder null, wenn dieser Tabelle kein Formular zugeordnet ist.

Autorisierung

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

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

getFrozenColumns()

Gibt die Anzahl der fixierten Spalten zurück.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getFrozenRows()

Gibt die Anzahl der fixierten Zeilen zurück.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getId()

Gibt eine eindeutige Kennung für diese Tabelle zurück. 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 ist 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 Schlüssel) für die Tabelle.


getImages()

Gibt alle Bilder zurück, die sich nicht in Zellen befinden.

// 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[]: Ein Array mit über das Raster gelegten Bildern.

Autorisierung

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

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

getIterativeCalculationConvergenceThreshold()

Gibt den Schwellenwert 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 Konvergenzschwellenwert.

Autorisierung

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

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

getLastColumn()

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

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

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

Rückflug

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

Autorisierung

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

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

getLastRow()

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

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

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

Rückflug

Integer: Die letzte Zeile des Blatts, die Inhalt enthält.

Autorisierung

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

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

getMaxIterativeCalculationCycles()

Gibt die maximale Anzahl an 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getName()

Ruft den Namen des Dokuments ab.

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

Rückflug

String: Der Name der Tabelle.

Autorisierung

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

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

getNamedRanges()

Ruft alle benannten Bereiche in dieser Tabelle ab.

// The code below logs the name of the first named range.
const namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();
for (let 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getNumSheets()

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

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

Rückflug

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


getOwner()

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getPredefinedSpreadsheetThemes()

Gibt die Liste der vordefinierten Designs zurück.

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

Rückflug

SpreadsheetTheme[]: Liste vordefinierter Designs.

Autorisierung

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

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

getProtections(type)

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

// Remove all range protections in the spreadsheet that the user has permission
// to edit.
const ss = SpreadsheetApp.getActive();
const protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (let i = 0; i < protections.length; i++) {
  const protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}
// Remove all sheet protections in the spreadsheet that the user has permission
// to edit.
const ss = SpreadsheetApp.getActive();
const protections = ss.getProtections(SpreadsheetApp.ProtectionType.SHEET);
for (let i = 0; i < protections.length; i++) {
  const 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const range = ss.getRange('Invoices!A1:D4');

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

Parameter

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

Rückflug

Range: Die Reichweite am angegebenen Standort.

Autorisierung

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

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

getRangeByName(name)

Gibt einen benannten Bereich zurück oder null, wenn kein Bereich mit dem angegebenen Namen gefunden wird. Wenn in mehreren Tabellenblättern der Tabelle derselbe Bereichsname verwendet wird, geben Sie den Tabellenblattnamen 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.
const range = SpreadsheetApp.getActiveSpreadsheet().getRangeByName('TaxRates');
if (range != null) {
  Logger.log(range.getNumColumns());
}

Parameter

NameTypBeschreibung
nameStringDer Name des abzurufenden Bereichs.

Rückflug

Range: Der Zellenbereich mit dem angegebenen Namen.


getRangeList(a1Notations)

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

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

Parameter

NameTypBeschreibung
a1NotationsString[]Die Liste der Bereiche, die zurückgegeben werden sollen, angegeben in A1- oder R1C1-Notation.

Rückflug

RangeList: Die Bereichsliste am angegebenen Ort.

Autorisierung

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

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

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

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

getRowHeight(rowPosition)

Gibt die Höhe der angegebenen Zeile in Pixeln zurück.

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

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

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der zu untersuchenden Zeile.

Rückflug

Integer – Zeilenhöhe in Pixeln.

Autorisierung

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

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

getSelection()

Gibt die aktuelle Selection in der Tabelle zurück.

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

Rückflug

Selection: Die aktuelle Auswahl.

Autorisierung

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

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

getSheetById(id)

Ruft das Tabellenblatt mit der angegebenen ID ab. Verwenden Sie Sheet.getSheetId().

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetById(12345);

Parameter

NameTypBeschreibung
idIntegerDie ID des abzurufenden Tabellenblatts.

Rückflug

Sheet: Das Tabellenblatt mit der angegebenen ID oder null, wenn kein Tabellenblatt gefunden wird.


getSheetByName(name)

Gibt ein Tabellenblatt mit dem angegebenen Namen zurück.

Wenn mehrere Tabellenblätter denselben Namen haben, wird das am weitesten links stehende zurückgegeben. Gibt null zurück, wenn es kein Tabellenblatt mit dem angegebenen Namen gibt.

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

Parameter

NameTypBeschreibung
nameStringDer Name des abzurufenden 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 ID für das Tabellenblatt, die für die Tabelle eindeutig ist. Die ID ist eine monoton steigende Ganzzahl, die bei der Erstellung des Tabellenblatts zugewiesen wird und unabhängig von der Position des Tabellenblatts ist. Das ist in Verbindung mit Methoden wie Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) nützlich, die einen gridId-Parameter anstelle einer Sheet-Instanz verwenden.

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

Logger.log(sheet.getSheetId());

Rückflug

Integer: Eine ID für das Tabellenblatt, die für die Tabelle eindeutig ist.

Autorisierung

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

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

getSheetName()

Gibt den Namen des Tabellenblatts zurück.

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

Logger.log(sheet.getSheetName());

Rückflug

String: Der Name des Tabellenblatts.

Autorisierung

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

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

getSheetValues(startRow, startColumn, numRows, numColumns)

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

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

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

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

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

getSheets()

Ruft alle Tabellenblätter in dieser Tabelle ab.

// The code below logs the name of the second sheet
const sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
// Iterates through the sheets and logs the name and ID of each sheet.
for (const sheet of sheets) {
  Logger.log(`name: ${sheet.getName()}, ID: ${sheet.getSheetId()}`);
}

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: Die Sprache der Tabelle.

Autorisierung

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

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

getSpreadsheetTheme()

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

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

Rückflug

SpreadsheetTheme: Das aktuell angewendete Design.

Autorisierung

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

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

getSpreadsheetTimeZone()

Gibt die Zeitzone für die 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',
);

// 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 Format „long“ (z. B. „America/New_York“, wie auf Joda.org aufgeführt).

Autorisierung

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

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

getUrl()

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

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

Rückflug

String – Die URL für die angegebene Tabelle.

Autorisierung

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

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

getViewers()

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

Rückflug

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

Autorisierung

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

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

hideColumn(column)

Blendet die Spalte(n) im angegebenen Bereich aus.

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

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

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

Parameter

NameTypBeschreibung
columnRangeDer Spaltenbereich, der ausgeblendet werden soll.

Autorisierung

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

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

hideRow(row)

Blendet die Zeilen im angegebenen Bereich aus.

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

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

Parameter

NameTypBeschreibung
rowRangeDer Zeilenbereich, der ausgeblendet werden soll.

Autorisierung

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

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

insertColumnAfter(afterPosition)

Fügt eine Spalte nach der angegebenen Spaltenposition ein.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 Blatt, das für die Verkettung von Methoden nützlich ist.

Autorisierung

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

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

insertColumnBefore(beforePosition)

Fügt eine Spalte vor der angegebenen Spaltenposition ein.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 Blatt, das für die Verkettung von Methoden nützlich ist.

Autorisierung

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

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

insertColumnsAfter(afterPosition, howMany)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 Blatt, das für die Verkettung von Methoden nützlich ist.

Autorisierung

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

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

insertColumnsBefore(beforePosition, howMany)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 Blatt, das für die Verkettung von Methoden nützlich ist.

Autorisierung

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

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

insertDataSourceSheet(spec)

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

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Mit SpreadsheetApp#enable...Execution()-Methoden können Sie die Datenabfrage 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, die eingefügt werden soll.

Rückflug

DataSourceSheet: Das neue Tabellenblatt für die Datenquelle.

Autorisierung

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

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

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. Die maximal unterstützte Blob-Größe beträgt 2 MB.

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

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

Parameter

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

Rückflug

OverGridImage: Das eingefügte Bild.

Autorisierung

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

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

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

Fügt ein Spreadsheet als Bild in das Dokument in einer bestimmten Zeile und Spalte mit einem Pixel-Offset ein. Die Bildgröße wird aus dem Blob-Inhalt abgerufen. Die maximal unterstützte Blob-Größe beträgt 2 MB.

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

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

Parameter

NameTypBeschreibung
blobSourceBlobSourceDas Blob mit dem Bildinhalt, dem MIME-Typ und optional dem Namen.
columnIntegerDie Spaltenposition.
rowIntegerDie Zeilenposition.
offsetXIntegerDer horizontale Offset 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 Spalte im Raster.
rowIntegerDie Position der Rasterzeile.

Rückflug

OverGridImage: Das eingefügte Bild.

Autorisierung

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

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

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

Fügt ein Bild mit einem Pixel-Offset in das Dokument an einer bestimmten Zeile und Spalte ein.

Die angegebene URL muss öffentlich zugänglich sein.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 Offset 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

insertRowAfter(afterPosition)

Fügt eine Zeile nach der angegebenen Zeilenposition ein.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 Blatt, das für die Verkettung von Methoden nützlich ist.

Autorisierung

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

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

insertRowBefore(beforePosition)

Fügt eine Zeile vor der angegebenen Zeilenposition ein.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 Blatt, das für die Verkettung von Methoden nützlich ist.

Autorisierung

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

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

insertRowsAfter(afterPosition, howMany)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 Blatt, das für die Verkettung von Methoden nützlich ist.

Autorisierung

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

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

insertRowsBefore(beforePosition, howMany)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 Blatt, das für die Verkettung von Methoden nützlich ist.

Autorisierung

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

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

insertSheet()

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

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

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

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

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

insertSheet(sheetIndex)

Fügt an der angegebenen Position ein neues Tabellenblatt in die Tabelle ein. Das neue Tabellenblatt wird zum aktiven Tabellenblatt.

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

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

insertSheet(sheetIndex, options)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 Tabellenblatt kopiert. Die Tabellenvorlage muss eines der Tabellenblätter des Tabellenobjekts sein.

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

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

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

insertSheet(options)

Fügt ein neues Tabellenblatt in die Tabelle ein. Dabei wird ein Standardname für das Tabellenblatt verwendet. Es können auch optionale erweiterte Argumente angegeben werden. Das neue Tabellenblatt wird zum aktiven Tabellenblatt.

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

Parameter

NameTypBeschreibung
optionsObjectOptionale erweiterte JavaScript-Argumente, die unten aufgeführt sind.

Erweiterte Parameter

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

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

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

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

insertSheet(sheetName)

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

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

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

insertSheet(sheetName, sheetIndex)

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

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

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

insertSheet(sheetName, sheetIndex, options)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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, legen Sie den Wert auf 0 fest.
optionsObjectOptionale erweiterte JavaScript-Argumente.

Erweiterte Parameter

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

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

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

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

insertSheet(sheetName, options)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 Tabellenblatt kopiert. Die Tabellenvorlage muss eines der Tabellenblätter des Tabellenobjekts sein.

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

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

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

insertSheetWithDataSourceTable(spec)

Fügt ein neues Tabellenblatt in die Tabelle ein, erstellt eine DataSourceTable, die sich über das gesamte Tabellenblatt erstreckt, und startet die Datenausführung. Dadurch wird das neue Tabellenblatt zum aktiven Tabellenblatt.

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Mit SpreadsheetApp#enable...Execution()-Methoden können Sie die Datenabfrage für einen bestimmten 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, die eingefügt werden soll.

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

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

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

isColumnHiddenByUser(columnPosition)

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

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

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

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der zu untersuchenden Spalte.

Rückflug

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

Autorisierung

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

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

isIterativeCalculationEnabled()

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

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

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

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

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der zu untersuchenden Zeile.

Rückflug

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

Autorisierung

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

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

isRowHiddenByUser(rowPosition)

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

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

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

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der zu untersuchenden Zeile.

Rückflug

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

Autorisierung

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

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

moveActiveSheet(pos)

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

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

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

spreadsheet.moveActiveSheet(2);

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

Parameter

NameTypBeschreibung
posIntegerDie 1-basierte Position, an die das aktive Tabellenblatt in der Liste der Tabellenblätter verschoben werden soll.

Autorisierung

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

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

moveChartToObjectSheet(chart)

Erstellt ein neues SheetType.OBJECT-Arbeitsblatt und verschiebt das bereitgestellte Diagramm dorthin. Wenn sich das Diagramm bereits auf einem eigenen Tabellenblatt befindet, wird dieses zurückgegeben, ohne dass ein neues erstellt wird.

const sheet = SpreadsheetApp.getActiveSheet();
const chart = sheet.newChart().setPosition(1, 1, 0, 0).build();
sheet.insertChart(chart);
const 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

refreshAllDataSources()

Aktualisiert alle unterstützten Datenquellen und die zugehörigen Datenquellenobjekte. Ungültige Datenquellenobjekte werden übersprungen.

Mit SpreadsheetApp#enable...Execution()-Methoden können Sie die Datenabfrage 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

removeEditor(emailAddress)

Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für die Spreadsheet. Mit dieser Methode wird der Zugriff auf die Spreadsheet nicht für Nutzer blockiert, die einer Nutzerklasse mit allgemeinem Zugriff angehören, z. B. 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 dadurch auch aus der Liste der Betrachter entfernt.

Parameter

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

Rückflug

Spreadsheet – Diese Spreadsheet zur Verkettung.

Autorisierung

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

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

removeEditor(user)

Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für die Spreadsheet. Mit dieser Methode wird der Zugriff auf die Spreadsheet nicht für Nutzer blockiert, die einer Nutzerklasse mit allgemeinem Zugriff angehören, z. B. 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 dadurch auch aus der Liste der Betrachter entfernt.

Parameter

NameTypBeschreibung
userUserEine Darstellung des zu entfernenden Nutzers.

Rückflug

Spreadsheet – Diese Spreadsheet zur Verkettung.

Autorisierung

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

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

removeMenu(name)

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

// The onOpen function is executed automatically every time a Spreadsheet is
// loaded
function onOpen() {
  const ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.addMenu('badMenu', [
    {name: 'remove bad menu', functionName: 'removeBadMenu'},
    {name: 'foo', functionName: 'foo'},
  ]);
}
function removeBadMenu() {
  const 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 zu entfernenden Menüs.

Autorisierung

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

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

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.
const ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange('foo', ss.getActiveRange());
ss.removeNamedRange('foo');

Parameter

NameTypBeschreibung
nameStringDer Bereichsname.

Autorisierung

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

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

removeViewer(emailAddress)

Entfernt den angegebenen Nutzer aus der Liste der Zuschauer und Kommentatoren für die Spreadsheet. Diese Methode hat keine Auswirkungen, wenn der Nutzer ein Bearbeiter und kein Betrachter oder Kommentator ist. Mit dieser Methode wird auch nicht verhindert, dass Nutzer auf die Spreadsheet zugreifen, wenn sie zu einer Nutzergruppe gehören, die allgemeinen Zugriff hat. Das ist beispielsweise der Fall, wenn die Spreadsheet für die gesamte Domain des Nutzers freigegeben ist oder wenn 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 Mitbearbeiter entfernt.

Parameter

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

Rückflug

Spreadsheet – Diese Spreadsheet für die Verkettung.

Autorisierung

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

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

removeViewer(user)

Entfernt den angegebenen Nutzer aus der Liste der Zuschauer und Kommentatoren für die Spreadsheet. Diese Methode hat keine Auswirkungen, wenn der Nutzer ein Bearbeiter und kein Betrachter ist. Mit dieser Methode wird auch nicht verhindert, dass Nutzer auf die Spreadsheet zugreifen, wenn sie zu einer Nutzerklasse gehören, die allgemeinen Zugriff hat. Das ist beispielsweise der Fall, wenn die Spreadsheet für die gesamte Domain des Nutzers freigegeben ist oder wenn 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 Mitbearbeiter entfernt.

Parameter

NameTypBeschreibung
userUserEine Darstellung des zu entfernenden Nutzers.

Rückflug

Spreadsheet – Diese Spreadsheet für die Verkettung.

Autorisierung

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

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

rename(newName)

Benennt das Dokument um.

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

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

renameActiveSheet(newName)

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

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

Parameter

NameTypBeschreibung
newNameStringDer neue Name für das aktuell aktive Tabellenblatt.

Autorisierung

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

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

resetSpreadsheetTheme()

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

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

Rückflug

SpreadsheetTheme: Das Standarddesign.

Autorisierung

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

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

setActiveRange(range)

Legt den angegebenen Bereich als active range im aktiven Tabellenblatt fest. Die obere linke Zelle im Bereich wird als current cell verwendet.

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

const selection = sheet.getSelection();
// Current cell: A1
const currentCell = selection.getCurrentCell();
// Active Range: A1:D4
const 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

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

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

Parameter

NameTypBeschreibung
rangeListRangeListDie Liste der auszuwählenden Bereiche.

Rückflug

RangeList: Die neu ausgewählte Liste von Bereichen.

Autorisierung

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

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

setActiveSelection(range)

Legt den aktiven Auswahlbereich für dieses Tabellenblatt fest.

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

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

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

setActiveSelection(a1Notation)

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

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

sheet.setActiveSelection('A1:D4');

Parameter

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

Rückflug

Range: Der neu aktive Bereich.

Autorisierung

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

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

setActiveSheet(sheet)

Legt das angegebene Tabellenblatt als aktives Tabellenblatt in der Tabelle fest. Auf der Google Sheets-Benutzeroberfläche wird das ausgewählte Tabellenblatt angezeigt, sofern es nicht zu einer anderen Tabelle gehört.

// The code below makes the first sheet active in the active spreadsheet.
const 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setActiveSheet(sheet, restoreSelection)

Legt das angegebene Tabellenblatt als aktives Tabellenblatt in der Tabelle fest. Optional kann die letzte Auswahl in diesem Tabellenblatt wiederhergestellt werden. Auf der Google Sheets-Benutzeroberfläche wird das ausgewählte Tabellenblatt angezeigt, sofern es nicht zu einer anderen Tabelle gehört.

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const firstSheet = spreadsheet.getSheets()[0];
const 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
const range = spreadsheet.getActiveSheet().getSelection().getActiveRange();
Logger.log(range.getA1Notation());

Parameter

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

Rückflug

Sheet: Das neue aktive Tabellenblatt.

Autorisierung

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

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

setColumnWidth(columnPosition, width)

Legt die Breite der angegebenen Spalte in Pixeln fest.

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

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

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der festzulegenden Spalte.
widthIntegerDie Breite in Pixeln, die festgelegt werden soll.

Rückflug

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

Autorisierung

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

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

setCurrentCell(cell)

Legt die angegebene Zelle als current cell fest.

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

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

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

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

const selection = sheet.getSelection();
// Current cell: B5
const 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setFrozenColumns(columns)

Friert die angegebene Anzahl von Spalten ein. Wenn der Wert null ist, werden keine Spalten fixiert.

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

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

Parameter

NameTypBeschreibung
columnsIntegerDie Anzahl der zu fixierenden Spalten.

Autorisierung

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

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

setFrozenRows(rows)

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

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

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

Parameter

NameTypBeschreibung
rowsIntegerDie Anzahl der zu fixierenden Zeilen.

Autorisierung

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

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

setIterativeCalculationConvergenceThreshold(minThreshold)

Legt den Mindestschwellenwert 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 minimale Konvergenzschwelle (muss nicht negativ sein).

Rückflug

Spreadsheet – Diese Tabelle zur Verkettung.

Autorisierung

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

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

setIterativeCalculationEnabled(isEnabled)

Legt fest, ob die iterative Berechnung in dieser Tabelle aktiviert ist. Wenn die maximale Anzahl von Berechnungszyklen und der Konvergenzschwellenwert nicht zuvor festgelegt wurden, als die Berechnung aktiviert wurde, werden standardmäßig 50 bzw.0,05 verwendet. Wenn einer der beiden Werte bereits festgelegt wurde, behalten sie ihre vorherigen Werte bei.

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

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

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

Parameter

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

Rückflug

Spreadsheet – Diese Tabelle zur Verkettung.

Autorisierung

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

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

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 zur Verkettung.

Autorisierung

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

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

setNamedRange(name, range)

Benennt einen Bereich.

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

Parameter

NameTypBeschreibung
nameStringDer Name, den Sie dem Bereich geben möchten.
rangeRangeDie Bereichsspezifikation.

Autorisierung

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

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

setRecalculationInterval(recalculationInterval)

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

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

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

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

Parameter

NameTypBeschreibung
recalculationIntervalRecalculationIntervalDas neue Neuberechnungsintervall.

Rückflug

Spreadsheet – Diese Tabelle zur Verkettung.

Autorisierung

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

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

setRowHeight(rowPosition, height)

Legt die Zeilenhöhe der angegebenen Zeile in Pixeln fest. Standardmäßig werden Zeilen so angepasst, dass sie den Zelleninhalt aufnehmen können. Wenn Sie Zeilen auf eine bestimmte Höhe festlegen möchten, verwenden Sie Sheet.setRowHeightsForced(startRow, numRows, height).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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, die festgelegt werden soll.

Rückflug

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

Autorisierung

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

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

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. „en“, „fr“ oder „en_US“.

Autorisierung

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

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

setSpreadsheetTheme(theme)

Legt ein Design für die Tabelle fest.

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// The code below sets the second predefined theme as the current theme of the
// spreadsheet.
const 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setSpreadsheetTimeZone(timezone)

Legt die Zeitzone für die Tabelle fest.

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

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

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

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

Parameter

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

Autorisierung

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

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

show(userInterface)

Zeigt eine benutzerdefinierte Benutzeroberflächenkomponente in einem Dialogfeld an, das im Viewport des Browsers des Nutzers zentriert ist. Die Ausführung des serverseitigen Skripts wird nicht unterbrochen. Um mit der Serverseite zu kommunizieren, muss die Benutzeroberflächenkomponente asynchrone Rückrufe an das serverseitige Skript senden.

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

Das folgende Code-Snippet zeigt eine einfache HtmlService-Anwendung in einem Dialogfeld mit dem angegebenen Titel, der angegebenen Höhe und der angegebenen Breite:

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

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

sort(columnPosition)

Sortiert ein Tabellenblatt aufsteigend nach Spalte.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 Blatt, das für die Verkettung von Methoden nützlich ist.

Autorisierung

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

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

sort(columnPosition, ascending)

Sortiert ein Tabellenblatt nach Spalte. Akzeptiert einen Parameter, um aufsteigend oder absteigend anzugeben.

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

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

Parameter

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

Rückflug

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

Autorisierung

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

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

toast(msg)

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

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

Parameter

NameTypBeschreibung
msgStringDie Meldung, die im Toast angezeigt werden soll.

Autorisierung

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

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

toast(msg, title)

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

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

Parameter

NameTypBeschreibung
msgStringDie Meldung, die im Toast angezeigt werden soll.
titleStringDer optionale Titel des Pop-up-Hinweises.

Autorisierung

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

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

toast(msg, title, timeoutSeconds)

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

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

Parameter

NameTypBeschreibung
msgStringDie Meldung, die im Toast angezeigt werden soll.
titleStringDer optionale Titel des Pop-up-Hinweises.
timeoutSecondsNumberDas Zeitlimit in Sekunden. Wenn null, wird für den Hinweis standardmäßig ein Zeitlimit von 5 Sekunden verwendet. Wenn der Wert negativ ist, bleibt der Hinweis so lange sichtbar, bis er geschlossen wird.

Autorisierung

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

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

unhideColumn(column)

Macht die Spalte im angegebenen Bereich wieder sichtbar.

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

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

Parameter

NameTypBeschreibung
columnRangeDer Bereich, der ein- oder ausgeblendet werden soll.

Autorisierung

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

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

unhideRow(row)

Macht die Zeile im angegebenen Bereich wieder sichtbar.

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

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

Parameter

NameTypBeschreibung
rowRangeDer Bereich, der ein- oder ausgeblendet werden soll.

Autorisierung

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

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

updateMenu(name, subMenus)

Aktualisiert ein Menü, das von addMenu(name, subMenus) hinzugefügt wurde. Funktioniert genau wie addMenu(name, subMenus).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 den Parametern name und functionName . Sie können Funktionen aus enthaltenen Bibliotheken wie Library.libFunction1 verwenden.

Autorisierung

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

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Wartet, bis alle aktuellen Ausführungen in der Tabelle abgeschlossen sind. Nach der angegebenen Anzahl von Sekunden wird ein Zeitlimit überschritten. Löst eine Ausnahme aus, wenn die Ausführungen beim Zeitüberschreiten nicht abgeschlossen sind, bricht die Datenausführungen jedoch nicht ab.

Parameter

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

Autorisierung

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

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

Eingestellte Methoden