Class Spreadsheet

Tabelle

Google Tabellen-Dateien aufrufen und bearbeiten Häufig werden neue Tabellenblätter und Mitbearbeiter hinzugefügt.

Methoden

MethodeRückgabetypKurzbeschreibung
addDeveloperMetadata(key)SpreadsheetFügt der obersten Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel hinzu.
addDeveloperMetadata(key, visibility)SpreadsheetFügt der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel und Sichtbarkeit hinzu.
addDeveloperMetadata(key, value)SpreadsheetFügt der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel und Wert hinzu.
addDeveloperMetadata(key, value, visibility)SpreadsheetFügt der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel, Wert und der Sichtbarkeit hinzu.
addEditor(emailAddress)SpreadsheetDer entsprechende Nutzer wird der Liste der Mitbearbeiter für Spreadsheet hinzugefügt.
addEditor(user)SpreadsheetDer entsprechende Nutzer wird der Liste der Mitbearbeiter für Spreadsheet hinzugefügt.
addEditors(emailAddresses)SpreadsheetFügt das angegebene Array von Nutzern der Liste der Mitbearbeiter für Spreadsheet hinzu.
addMenu(name, subMenus)voidErstellt ein neues Menü in der Benutzeroberfläche für Tabellen.
addViewer(emailAddress)SpreadsheetDer entsprechende Nutzer wird der Liste der Betrachter für Spreadsheet hinzugefügt.
addViewer(user)SpreadsheetDer entsprechende Nutzer wird der Liste der Betrachter für Spreadsheet hinzugefügt.
addViewers(emailAddresses)SpreadsheetFügt das angegebene Array von Nutzern der Liste der Betrachter für Spreadsheet hinzu.
appendRow(rowContents)SheetHängt eine Zeile am unteren Rand des aktuellen Datenbereichs im Tabellenblatt an.
autoResizeColumn(columnPosition)SheetLegt die Breite der jeweiligen Spalte für ihren Inhalt fest.
copy(name)SpreadsheetDie Tabelle wird kopiert und die neue Tabelle wird zurückgegeben.
createDeveloperMetadataFinder()DeveloperMetadataFinderGibt ein DeveloperMetadataFinder zurück, mit dem Entwicklermetadaten im Rahmen dieser Tabelle ermittelt werden.
createTextFinder(findText)TextFinderErstellt eine Textsuche für die Tabelle, mit der Text in der Tabelle gesucht und ersetzt werden kann.
deleteActiveSheet()SheetDas derzeit aktive Tabellenblatt wird gelöscht.
deleteColumn(columnPosition)SheetLöscht die Spalte an der angegebenen Spaltenposition.
deleteColumns(columnPosition, howMany)voidLöscht eine Reihe von Spalten ab der angegebenen Spaltenposition.
deleteRow(rowPosition)SheetLöscht die Zeile an der angegebenen Zeilenposition.
deleteRows(rowPosition, howMany)voidLöscht eine Reihe von Zeilen ab der angegebenen Zeilenposition.
deleteSheet(sheet)voidLöscht das angegebene Tabellenblatt
duplicateActiveSheet()SheetDas aktive Tabellenblatt wird dupliziert und 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 Bereich aktiv ist.
getActiveRangeList()RangeListGibt die Liste der aktiven Bereiche im aktiven Tabellenblatt zurück oder null, wenn keine aktiven Bereiche vorhanden sind.
getActiveSheet()SheetRuft das aktive Tabellenblatt in einer Tabelle ab
getAs(contentType)BlobGibt die Daten in diesem Objekt als Blob zurück, das in den angegebenen Inhaltstyp konvertiert wurde.
getBandings()Banding[]Gibt alle Streifen in dieser Tabelle zurück
getBlob()BlobGibt die Daten in diesem Objekt als Blob zurück.
getColumnWidth(columnPosition)IntegerRuft die Breite der angegebenen Spalte in Pixeln ab
getCurrentCell()RangeGibt die aktuelle Zelle im aktiven Tabellenblatt zurück oder null, wenn keine Zelle vorhanden ist.
getDataRange()RangeGibt ein Range zurück, das den Dimensionen entspricht, in denen Daten vorhanden sind.
getDataSourceFormulas()DataSourceFormula[]Ruft alle Formeln in Datenquellen ab
getDataSourcePivotTables()DataSourcePivotTable[]Ruft alle Datenquellen-Pivot-Tabellen ab.
getDataSourceRefreshSchedules()DataSourceRefreshSchedule[]Ruft die Aktualisierungspläne dieser Tabelle ab
getDataSourceSheets()DataSourceSheet[]Gibt alle Datenquellentabellenblätter in der Tabelle zurück.
getDataSourceTables()DataSourceTable[]Ruft alle Datenquellentabellen ab
getDataSources()DataSource[]Gibt alle Datenquellen in der Tabelle zurück
getDeveloperMetadata()DeveloperMetadata[]Rufen Sie die Entwicklermetadaten ab, die mit der Tabelle auf oberster Ebene verknüpft sind.
getEditors()User[]Ruft die Liste der Editoren für dieses Spreadsheet ab.
getFormUrl()StringGibt die URL für das Formular zurück, das die Antworten an diese Tabelle sendet. Wenn die Tabelle kein Formular hat, wird null zurückgegeben.
getFrozenColumns()IntegerGibt die Anzahl der eingefrorenen Spalten zurück.
getFrozenRows()IntegerGibt die Anzahl der eingefrorenen Zeilen zurück.
getId()StringRuft eine eindeutige ID für diese Tabelle ab
getImages()OverGridImage[]Gibt alle Rasterbilder auf dem Tabellenblatt zurück
getIterativeCalculationConvergenceThreshold()NumberGibt den Grenzwert zurück, der bei der iterativen Berechnung verwendet wird.
getLastColumn()IntegerGibt die Position der letzten Spalte mit Inhalten zurück.
getLastRow()IntegerGibt die Position der letzten Zeile mit Inhalten zurück.
getMaxIterativeCalculationCycles()IntegerGibt die maximale Anzahl der Iterationen zurück, die bei der iterativen Berechnung verwendet werden können.
getName()StringRuft den Namen des Dokuments ab.
getNamedRanges()NamedRange[]Ruft alle benannten Bereiche in dieser Tabelle ab
getNumSheets()IntegerGibt die Anzahl der Tabellen 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 vordefinierter Designs zurück
getProtections(type)Protection[]Ruft ein Array von Objekten ab, die alle geschützten Bereiche oder Tabellenblätter der Tabelle darstellen.
getRange(a1Notation)RangeGibt den Bereich in der A1- oder R1C1-Notation zurück.
getRangeByName(name)RangeGibt einen benannten Bereich zurück oder null, wenn kein Bereich mit dem angegebenen Namen gefunden wurde.
getRangeList(a1Notations)RangeListGibt die Sammlung RangeList zurück, die die Bereiche im selben Tabellenblatt darstellt, die durch eine nicht leere Liste von A1- oder R1C1-Notationen angegeben sind.
getRecalculationInterval()RecalculationIntervalGibt das Berechnungsintervall für diese Tabelle zurück.
getRowHeight(rowPosition)IntegerRuft die Höhe der angegebenen Zeile in Pixeln ab
getSelection()SelectionGibt das aktuelle Selection in der Tabelle zurück
getSheetByName(name)SheetGibt ein Tabellenblatt mit dem angegebenen Namen zurück.
getSheetId()IntegerGibt die ID des durch dieses Objekt dargestellten Tabellenblatts zurück
getSheetName()StringGibt den Namen des Tabellenblatts zurück
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]Gibt das rechteckige Raster von Werten für diesen Bereich zurück, beginnend an den angegebenen Koordinaten.
getSheets()Sheet[]Ruft alle Tabellenblätter in dieser Tabelle ab
getSpreadsheetLocale()StringRuft das Gebietsschema für die Tabelle ab
getSpreadsheetTheme()SpreadsheetThemeGibt das aktuelle Design der Tabelle zurück oder null, wenn kein Design angewendet wird.
getSpreadsheetTimeZone()StringRuft die Zeitzone für die Tabelle ab
getUrl()StringGibt die URL für die angegebene Tabelle zurück
getViewers()User[]Ruft die Liste der Betrachter und Kommentatoren für dieses 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 eine Reihe von Spalten nach der angegebenen Spaltenposition ein.
insertColumnsBefore(beforePosition, howMany)SheetFügt eine Reihe von Spalten vor der angegebenen Spaltenposition ein.
insertDataSourceSheet(spec)DataSourceSheetFügt ein neues DataSourceSheet-Element in die Tabelle ein und startet die Datenausführung.
insertImage(blobSource, column, row)OverGridImageFügt ein Spreadsheet-Element als Bild in das Dokument in einer bestimmten Zeile und Spalte ein.
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageFügt ein Spreadsheet-Bild als Bild in das Dokument in einer bestimmten Zeile und Spalte ein, mit Pixel-Offset.
insertImage(url, column, row)OverGridImageFügt in einer bestimmten Zeile und Spalte ein Bild in das Dokument ein.
insertImage(url, column, row, offsetX, offsetY)OverGridImageFügt in einer bestimmten Zeile und Spalte ein Bild mit einem Pixelversatz in das Dokument ein.
insertRowAfter(afterPosition)SheetFügt eine Zeile nach der angegebenen Zeilenposition ein.
insertRowBefore(beforePosition)SheetFügt eine Zeile vor der angegebenen Zeilenposition ein.
insertRowsAfter(afterPosition, howMany)SheetFügt eine Reihe von Zeilen nach der angegebenen Zeilenposition ein.
insertRowsBefore(beforePosition, howMany)SheetFügt eine Anzahl von Zeilen vor der angegebenen Zeilenposition ein.
insertSheet()SheetEin neues Tabellenblatt wird mit einem Standardnamen für das Tabellenblatt in die Tabelle eingefügt.
insertSheet(sheetIndex)SheetEin neues Tabellenblatt wird in die Tabelle im angegebenen Index eingefügt.
insertSheet(sheetIndex, options)SheetFügt ein neues Tabellenblatt in die Tabelle beim angegebenen Index ein und verwendet optionale erweiterte Argumente.
insertSheet(options)SheetEin neues Tabellenblatt wird mit einem Standardtabellennamen und optionalen erweiterten Argumenten in die Tabelle eingefügt.
insertSheet(sheetName)SheetEin neues Tabellenblatt mit dem angegebenen Namen wird in die Tabelle eingefügt.
insertSheet(sheetName, sheetIndex)SheetFügt ein neues Tabellenblatt mit dem angegebenen Namen im angegebenen Index in die Tabelle ein.
insertSheet(sheetName, sheetIndex, options)SheetFügt ein neues Tabellenblatt mit dem angegebenen Namen im 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)SheetEin neues Tabellenblatt wird in die Tabelle eingefügt, ein DataSourceTable, das das gesamte Tabellenblatt mit der angegebenen Datenquellenspezifikation enthält, wird erstellt und die Datenausführung wird gestartet.
isColumnHiddenByUser(columnPosition)BooleanGibt an, ob die jeweilige Spalte vom Nutzer ausgeblendet wurde.
isIterativeCalculationEnabled()BooleanGibt an, ob die iterative Berechnung in dieser Tabelle aktiviert ist.
isRowHiddenByFilter(rowPosition)BooleanGibt an, ob die jeweilige Zeile durch einen Filter (nicht eine Filteransicht) ausgeblendet wird.
isRowHiddenByUser(rowPosition)BooleanGibt an, ob die jeweilige Zeile für den Nutzer ausgeblendet ist.
moveActiveSheet(pos)voidDas aktive Tabellenblatt wird an die angegebene Position in der Liste der Tabellenblätter verschoben.
moveChartToObjectSheet(chart)SheetErstellt ein neues SheetType.OBJECT-Tabellenblatt und verschiebt das angegebene Diagramm in dieses.
refreshAllDataSources()voidAlle unterstützten Datenquellen und ihre verknüpften Datenquellenobjekte werden aktualisiert. Ungültige Datenquellenobjekte werden übersprungen.
removeEditor(emailAddress)SpreadsheetEntfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für Spreadsheet.
removeEditor(user)SpreadsheetEntfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für 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 Betrachter und Kommentatoren von Spreadsheet.
removeViewer(user)SpreadsheetEntfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren von Spreadsheet.
rename(newName)voidBenennt das Dokument um.
renameActiveSheet(newName)voidBenennt das aktuelle aktive Tabellenblatt in den angegebenen neuen Namen um.
resetSpreadsheetTheme()SpreadsheetThemeDas angewendete Design wird entfernt und das Standarddesign der Tabelle wird festgelegt.
setActiveRange(range)RangeLegt den angegebenen Bereich als active range im aktiven Tabellenblatt fest, wobei die linke obere Zelle im Bereich den Wert current cell hat.
setActiveRangeList(rangeList)RangeListLegt die angegebene Liste von Bereichen als active ranges im aktiven Tabellenblatt fest.
setActiveSelection(range)RangeLegt den aktiven Auswahlbereich für das Tabellenblatt fest.
setActiveSelection(a1Notation)RangeLegt die aktive Auswahl fest, wie in der A1- oder R1C1-Notation angegeben.
setActiveSheet(sheet)SheetDas angegebene Tabellenblatt wird als aktives Tabellenblatt in der Tabelle festgelegt.
setActiveSheet(sheet, restoreSelection)SheetDas angegebene Tabellenblatt wird als aktives Tabellenblatt in der Tabelle festgelegt. Sie haben die Möglichkeit, die letzte Auswahl innerhalb dieses Tabellenblatts wiederherzustellen.
setColumnWidth(columnPosition, width)SheetLegt die Breite der angegebenen Spalte in Pixeln fest.
setCurrentCell(cell)RangeLegt die angegebene Zelle als current cell fest.
setFrozenColumns(columns)voidEinfriert die angegebene Anzahl von Spalten.
setFrozenRows(rows)voidEinfriert die angegebene Anzahl von Zeilen ein.
setIterativeCalculationConvergenceThreshold(minThreshold)SpreadsheetLegt den minimalen Grenzwert 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 Berechnungsdurchläufen fest, die während der iterativen Berechnung ausgeführt werden sollen.
setNamedRange(name, range)voidBenennt einen Bereich.
setRecalculationInterval(recalculationInterval)SpreadsheetLegt fest, wie oft diese Tabelle neu berechnet werden soll.
setRowHeight(rowPosition, height)SheetLegt die Zeilenhöhe der jeweiligen Zeile in Pixeln fest.
setSpreadsheetLocale(locale)voidLegt das Gebietsschema für die Tabelle fest.
setSpreadsheetTheme(theme)SpreadsheetThemeEin Design für die Tabelle festlegen
setSpreadsheetTimeZone(timezone)voidLegt die Zeitzone für die Tabelle fest.
show(userInterface)voidZeigt eine benutzerdefinierte Komponente der Benutzeroberfläche in einem Dialogfeld an, das im Darstellungsbereich des Browsers angezeigt wird.
sort(columnPosition)SheetSortieren Sie ein Tabellenblatt aufsteigend.
sort(columnPosition, ascending)SheetSortiert eine Tabelle nach Spalte.
toast(msg)voidIn der rechten unteren Ecke der Tabelle wird ein Pop-up-Fenster mit der entsprechenden Nachricht angezeigt.
toast(msg, title)voidZeigt in der rechten unteren Ecke der Tabelle ein Pop-up-Fenster mit der angegebenen Nachricht und dem Titel an.
toast(msg, title, timeoutSeconds)voidEs wird ein Pop-up-Fenster in der rechten unteren Ecke der Tabelle mit dem angegebenen Titel und der Nachricht angezeigt, das für einen bestimmten Zeitraum sichtbar bleibt.
unhideColumn(column)voidBlendet die Spalte im angegebenen Bereich wieder ein.
unhideRow(row)voidBlendet die Zeile im angegebenen Bereich wieder ein.
updateMenu(name, subMenus)voidAktualisiert eine Speisekarte, die von addMenu(name, subMenus) hinzugefügt wurde.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidWartet, bis alle aktuellen Ausführungen in der Tabelle abgeschlossen sind, und zwar nach der angegebenen Anzahl von Sekunden.

Detaillierte Dokumentation

addDeveloperMetadata(key)

Fügt der obersten Tabelle 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 wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 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 wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

addDeveloperMetadata(key, value, visibility)

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

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

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

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

Parameter

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

Rückflug

Spreadsheet: Diese Tabelle wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

addEditor(emailAddress)

Der entsprechende Nutzer wird der Liste der Mitbearbeiter für Spreadsheet hinzugefügt. Wenn der Nutzer bereits auf der Liste der Betrachter steht, wird er mit dieser Methode aus der Betrachterliste hochgestuft.

Parameter

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

Rückflug

Spreadsheet: Der Spreadsheet für eine Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

addEditor(user)

Der entsprechende Nutzer wird der Liste der Mitbearbeiter für Spreadsheet hinzugefügt. Wenn der Nutzer bereits auf der Liste der Betrachter steht, wird er mit dieser Methode aus der Betrachterliste hochgestuft.

Parameter

NameTypBeschreibung
userUserEine Darstellung des hinzuzufügenden Nutzers.

Rückflug

Spreadsheet: Der Spreadsheet für eine Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

addEditors(emailAddresses)

Fügt das angegebene Array von Nutzern der Liste der Mitbearbeiter für Spreadsheet hinzu. Wenn einer der Nutzer bereits auf der Liste der Betrachter steht, wird er mit dieser Methode aus der Betrachterliste hochgestuft.

Parameter

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

Rückflug

Spreadsheet: Der Spreadsheet für eine Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

addMenu(name, subMenus)

Erstellt ein neues Menü in der Benutzeroberfläche für Tabellen.

In jedem Menüeintrag wird eine benutzerdefinierte Funktion ausgeführt. Normalerweise sollten Sie sie aus der Funktion onOpen() aufrufen, 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() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  var menuEntries = [];
  // When the user clicks on "addMenuExample" then "Menu Entry 1", the function function1 is
  // executed.
  menuEntries.push({name: "Menu Entry 1", functionName: "function1"});
  menuEntries.push(null); // line separator
  menuEntries.push({name: "Menu Entry 2", functionName: "function2"});

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

Parameter

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

addViewer(emailAddress)

Der entsprechende Nutzer wird der Liste der Betrachter für Spreadsheet hinzugefügt. Wenn sich der Nutzer bereits in der Liste der Bearbeiter befindet, hat diese Methode keine Auswirkungen.

Parameter

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

Rückflug

Spreadsheet: Der Spreadsheet für eine Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

addViewer(user)

Der entsprechende Nutzer wird der Liste der Betrachter für Spreadsheet hinzugefügt. Wenn sich der Nutzer bereits in der Liste der Bearbeiter befindet, hat diese Methode keine Auswirkungen.

Parameter

NameTypBeschreibung
userUserEine Darstellung des hinzuzufügenden Nutzers.

Rückflug

Spreadsheet: Der Spreadsheet für eine Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

addViewers(emailAddresses)

Fügt das angegebene Array von Nutzern der Liste der Betrachter für Spreadsheet hinzu. Wenn einer der Nutzer bereits auf der Liste der Mitbearbeiter steht, hat diese Methode keine Auswirkungen für ihn.

Parameter

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

Rückflug

Spreadsheet: Der Spreadsheet für eine Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

appendRow(rowContents)

Hängt eine Zeile am unteren Rand des aktuellen Datenbereichs im Tabellenblatt an.

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

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

Parameter

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

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

autoResizeColumn(columnPosition)

Legt die Breite der jeweiligen Spalte für ihren Inhalt fest.

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

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

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

Parameter

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

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

copy(name)

Die Tabelle wird kopiert und die neue Tabelle wird zurückgegeben.

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

Parameter

NameTypBeschreibung
nameStringDer Name der Kopie.

Rückflug

Spreadsheet: Diese Tabelle wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

createDeveloperMetadataFinder()

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

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

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

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

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

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

Rückflug

DeveloperMetadataFinder: Mit der Entwicklermetadatensuche können Sie in dieser Tabelle nach Metadaten suchen.


createTextFinder(findText)

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

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

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

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

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

Parameter

NameTypBeschreibung
findTextStringDer Text, nach dem gesucht werden soll.

Rückflug

TextFinder: Der TextFinder für die Tabelle.


deleteActiveSheet()

Das derzeit aktive Tabellenblatt wird gelöscht.

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

Rückflug

Sheet: Das neue aktive Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

deleteColumn(columnPosition)

Löscht die Spalte an der angegebenen Spaltenposition.

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

Parameter

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

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

deleteColumns(columnPosition, howMany)

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

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

Parameter

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

deleteRow(rowPosition)

Löscht die Zeile an der angegebenen Zeilenposition.

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

Parameter

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

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

deleteRows(rowPosition, howMany)

Löscht eine Reihe von Zeilen ab der angegebenen Zeilenposition.

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

Parameter

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

deleteSheet(sheet)

Löscht das angegebene Tabellenblatt

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

Parameter

NameTypBeschreibung
sheetSheetDas zu löschende Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

duplicateActiveSheet()

Das aktive Tabellenblatt wird dupliziert und zum aktiven Tabellenblatt.

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

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getActiveCell()

Gibt die aktive Zelle in diesem Tabellenblatt zurück.

Hinweis:Es wird empfohlen, getCurrentCell() zu verwenden, da das die aktuell markierte Zelle zurückgibt.

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

Rückflug

Range: die aktuell aktive Zelle

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 Bereich aktiv ist. Wenn mehrere Bereiche ausgewählt sind, gibt diese Methode nur den zuletzt ausgewählten Bereich zurück.

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

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

Rückflug

Range: Der aktive Bereich

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

Weitere Informationen


getActiveRangeList()

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

Wurde ein einzelner Bereich ausgewählt, entspricht dies einem getActiveRange()-Aufruf.

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

Rückflug

RangeList: die Liste mit aktiven Bereichen

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

Weitere Informationen


getActiveSheet()

Ruft das aktive Tabellenblatt in einer Tabelle ab

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

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

Rückflug

Sheet: Das aktive Tabellenblatt in der Tabelle.


getAs(contentType)

Gibt die Daten in diesem Objekt als Blob zurück, das in den angegebenen Inhaltstyp konvertiert wurde. Durch diese Methode wird dem Dateinamen die entsprechende Erweiterung hinzugefügt, z. B. „meinedatei.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. Daher wird „ShoppingList.12.25.2014“ in „ShoppingList.12.25.pdf“ geändert.

Informationen zu den täglichen Kontingenten für Conversions finden Sie unter Kontingente für Google-Dienste. Neu erstellte Google Workspace-Domains können vorübergehend strengeren Kontingenten unterliegen.

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 ist 'image/bmp', 'image/gif', 'image/jpeg' oder 'image/png' ebenfalls gültig.

Rückflug

Blob: Die Daten als Blob.


getBandings()

Gibt alle Streifen in dieser Tabelle zurück

Rückflug

Banding[]: Die Streifen in dieser Tabelle.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getBlob()

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

Rückflug

Blob: Die Daten als Blob.


getColumnWidth(columnPosition)

Ruft die Breite der angegebenen Spalte in Pixeln ab

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

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

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der zu prüfenden Spalte.

Rückflug

Integer: Spaltenbreite in Pixeln

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getCurrentCell()

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

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

Rückflug

Range: die aktuelle Zelle.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

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

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

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

Rückflug

Range: ein Bereich mit allen Daten in der Tabelle

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getDataSourceFormulas()

Ruft alle Formeln in Datenquellen ab

Rückflug

DataSourceFormula[]: Eine Liste mit Formeln für Datenquellen.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getDataSourcePivotTables()

Ruft alle Datenquellen-Pivot-Tabellen ab.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getDataSourceRefreshSchedules()

Ruft die Aktualisierungspläne dieser Tabelle ab

Rückflug

DataSourceRefreshSchedule[]: Die Aktualisierungspläne dieser Tabelle.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getDataSourceSheets()

Gibt alle Datenquellentabellenblätter in der Tabelle zurück.

Rückflug

DataSourceSheet[]: ein Array aus allen Datenquellentabellen.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getDataSourceTables()

Ruft alle Datenquellentabellen ab

Rückflug

DataSourceTable[]: Eine Liste der Datenquellentabellen.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getDataSources()

Gibt alle Datenquellen in der Tabelle zurück

Rückflug

DataSource[]: ein Array aller Datenquellen.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getDeveloperMetadata()

Rufen Sie die Entwicklermetadaten ab, die mit der Tabelle auf oberster Ebene verknüpft sind.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getEditors()

Ruft die Liste der Editoren für dieses Spreadsheet ab.

Rückflug

User[]: ein Array von Nutzern mit Bearbeitungsberechtigung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getFormUrl()

Gibt die URL für das Formular zurück, das die Antworten an diese Tabelle sendet. Wenn die Tabelle kein Formular hat, wird null zurückgegeben. Wenn mehrere Formulare Antworten an diese Tabelle senden, ist die zurückgegebene Formular-URL unbestimmt. Alternativ können URL-Verknüpfungen pro Blatt mithilfe der Methode Sheet.getFormUrl() abgerufen werden.

Rückflug

String: die URL für das Formular, in dem die Antworten in dieser Tabelle gespeichert werden, oder null, wenn dieser Tabelle kein Formular zugeordnet ist.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getFrozenColumns()

Gibt die Anzahl der eingefrorenen Spalten zurück.

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

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

Rückflug

Integer: die Anzahl der eingefrorenen Spalten

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getFrozenRows()

Gibt die Anzahl der eingefrorenen Zeilen zurück.

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

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

Rückflug

Integer: die Anzahl der eingefrorenen Zeilen

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getId()

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

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

Rückflug

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


getImages()

Gibt alle Rasterbilder auf dem Tabellenblatt zurück

Rückflug

OverGridImage[]: ein Array von Bildern ohne Raster

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getIterativeCalculationConvergenceThreshold()

Gibt den Grenzwert zurück, der bei der iterativen Berechnung verwendet wird. Wenn die Ergebnisse der aufeinanderfolgenden Berechnung um weniger als diesen Wert abweichen, wird die iterative Berechnung beendet.

Rückflug

Number: Der Konvergenzgrenzwert.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getLastColumn()

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

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

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

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getLastRow()

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

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

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

Rückflug

Integer: Die letzte Zeile des Tabellenblatts, das Inhalte enthält.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getMaxIterativeCalculationCycles()

Gibt die maximale Anzahl der Iterationen zurück, die bei der iterativen Berechnung verwendet werden können.

Rückflug

Integer: die maximale Anzahl von Berechnungsdurchläufen.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getName()

Ruft den Namen des Dokuments ab.

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

Rückflug

String: Der Name der Tabelle.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getNamedRanges()

Ruft alle benannten Bereiche in dieser Tabelle ab

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

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getNumSheets()

Gibt die Anzahl der Tabellen in dieser Tabelle zurück.

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

Rückflug

Integer: die Anzahl der Tabellen in der Tabelle


getOwner()

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

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

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getPredefinedSpreadsheetThemes()

Gibt die Liste vordefinierter Designs zurück

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

Rückflug

SpreadsheetTheme[]: Liste vordefinierter Designs.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 der Tabelle darstellen.

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

Parameter

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

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getRange(a1Notation)

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

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

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

Parameter

NameTypBeschreibung
a1NotationStringDer Bereich, der zurückgegeben werden soll, wie in der A1- oder R1C1-Notation angegeben.

Rückflug

Range: Der Bereich am angegebenen Standort.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 wurde. Wenn für mehrere Tabellenblätter der gleiche Bereichsname verwendet wird, geben Sie den Namen des Tabellenblatts ohne zusätzliche Anführungszeichen an, z. B. getRangeByName('TaxRates') oder getRangeByName('Sheet Name!TaxRates'), aber nicht getRangeByName('"Sheet Name"!TaxRates').

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

Parameter

NameTypBeschreibung
nameStringDer Name des abzurufenden Bereichs.

Rückflug

Range: Der Zellenbereich mit dem angegebenen Namen.


getRangeList(a1Notations)

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

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

Parameter

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

Rückflug

RangeList: die Bereichsliste am angegebenen Standort

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getRecalculationInterval()

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

Rückflug

RecalculationInterval: Das Berechnungsintervall für diese Tabelle.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getRowHeight(rowPosition)

Ruft die Höhe der angegebenen Zeile in Pixeln ab

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

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

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der zu überprüfenden Zeile.

Rückflug

Integer: Zeilenhöhe in Pixeln

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getSelection()

Gibt das aktuelle Selection in der Tabelle zurück

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

Rückflug

Selection: die aktuelle Auswahl

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getSheetByName(name)

Gibt ein Tabellenblatt mit dem angegebenen Namen zurück.

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

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

Parameter

NameTypBeschreibung
nameStringDer Name des abzurufenden Tabellenblatts.

Rückflug

Sheet: Das Tabellenblatt mit dem angegebenen Namen.


getSheetId()

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

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

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

Logger.log(sheet.getSheetId());

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getSheetName()

Gibt den Namen des Tabellenblatts zurück

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

Logger.log(sheet.getSheetName());

Rückflug

String: der Name des Tabellenblatts

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 an den angegebenen Koordinaten. Ein Wert von -1, der als Zeilen- oder Spaltenposition angegeben wird, entspricht dem Abrufen der letzten Zeile oder Spalte, die Daten in dem Tabellenblatt enthält.

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

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

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

Parameter

NameTypBeschreibung
startRowIntegerDie Position der Startzeile.
startColumnIntegerDie Position der Ausgangsspalte.
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

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getSheets()

Ruft alle Tabellenblätter in dieser Tabelle ab

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

Rückflug

Sheet[]: ein Array aus allen Tabellenblättern in der Tabelle.


getSpreadsheetLocale()

Ruft das Gebietsschema für die Tabelle ab

Rückflug

String: Das Gebietsschema in der Tabelle.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getSpreadsheetTheme()

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

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

Rückflug

SpreadsheetTheme: Das aktuell angewendete Design.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getSpreadsheetTimeZone()

Ruft die Zeitzone für die Tabelle ab

Rückflug

String: die Zeitzone, angegeben im „long“-Format (z. B. „America/New_York“, wie von Joda.org aufgelistet).

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getUrl()

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

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

Rückflug

String: die URL für die angegebene Tabelle.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getViewers()

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

Rückflug

User[]: ein Array von Nutzern, die eine Lese- oder Kommentarberechtigung haben.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

hideColumn(column)

Blendet die Spalte(n) im angegebenen Bereich aus

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

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

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

Parameter

NameTypBeschreibung
columnRangeDer Spaltenbereich, der ausgeblendet werden soll.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

hideRow(row)

Blendet die Zeilen im angegebenen Bereich aus.

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

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

Parameter

NameTypBeschreibung
rowRangeDer zu ausblendende Zeilenbereich.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertColumnAfter(afterPosition)

Fügt eine Spalte nach der angegebenen Spaltenposition ein.

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

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

Parameter

NameTypBeschreibung
afterPositionIntegerDie Spalte, nach der die neue Spalte eingefügt werden soll.

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertColumnBefore(beforePosition)

Fügt eine Spalte vor der angegebenen Spaltenposition ein.

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

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

Parameter

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

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertColumnsAfter(afterPosition, howMany)

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

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

// This inserts a column in the second column position
sheet.insertColumnsAfter(1);

Parameter

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

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertColumnsBefore(beforePosition, howMany)

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

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

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

Parameter

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

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertDataSourceSheet(spec)

Fügt ein neues DataSourceSheet-Element in die Tabelle ein und startet die Datenausführung. Dies führt aber auch dazu, dass das neue Tabellenblatt zum aktiven Tabellenblatt wird.

Gibt eine Ausnahme aus, wenn der Typ der Datenquelle nicht aktiviert ist. Verwenden Sie die Methode SpreadsheetApp#enable...Execution(), um die Datenausführung für einen bestimmten Datenquellentyp zu aktivieren.

Parameter

NameTypBeschreibung
specDataSourceSpecDie Spezifikation der Datenquelle, in die die Daten eingefügt werden sollen.

Rückflug

DataSourceSheet: Das neue Datenquellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertImage(blobSource, column, row)

Fügt ein Spreadsheet-Element als Bild in das Dokument in einer bestimmten Zeile und Spalte ein. Die Bildgröße wird aus den Blob-Inhalten abgerufen. Die maximal zulässige Blob-Größe beträgt 2 MB.

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

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

Parameter

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

Rückflug

OverGridImage: Das eingefügte Bild.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

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

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

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

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

Parameter

NameTypBeschreibung
blobSourceBlobSourceDas Blob mit dem Bildinhalt, dem MIME-Typ und optional dem Namen.
columnIntegerSpaltenposition
rowIntegerDie Zeilenposition.
offsetXIntegerDer horizontale Abstand zur Zellenecke in Pixeln.
offsetYIntegerDer vertikale Abstand zur Zellenecke in Pixeln.

Rückflug

OverGridImage: Das eingefügte Bild.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertImage(url, column, row)

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

Die angegebene URL muss öffentlich zugänglich sein.

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

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

Parameter

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

Rückflug

OverGridImage: Das eingefügte Bild.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

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

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

Die angegebene URL muss öffentlich zugänglich sein.

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

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

Parameter

NameTypBeschreibung
urlStringDie URL für das Bild.
columnIntegerSpaltenposition
rowIntegerDie Zeilenposition.
offsetXIntegerDer horizontale Abstand zur Zellenecke in Pixeln.
offsetYIntegerDer vertikale Abstand zur Zellenecke in Pixeln.

Rückflug

OverGridImage: Das eingefügte Bild.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertRowAfter(afterPosition)

Fügt eine Zeile nach der angegebenen Zeilenposition ein.

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

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

Parameter

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

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertRowBefore(beforePosition)

Fügt eine Zeile vor der angegebenen Zeilenposition ein.

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

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

Parameter

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

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertRowsAfter(afterPosition, howMany)

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

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

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

Parameter

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

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertRowsBefore(beforePosition, howMany)

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

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

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

Parameter

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

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertSheet()

Ein neues Tabellenblatt wird mit einem Standardnamen für das Tabellenblatt in die Tabelle eingefügt. Das neue Tabellenblatt wird zum aktiven Tabellenblatt.

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

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertSheet(sheetIndex)

Ein neues Tabellenblatt wird in die Tabelle im angegebenen Index eingefügt. Das neue Tabellenblatt wird zum aktiven Tabellenblatt.

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

Parameter

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

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertSheet(sheetIndex, options)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet(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 es auf 0.
optionsObjectOptionale erweiterte JavaScript-Argumente.

Erweiterte Parameter

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

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertSheet(options)

Ein neues Tabellenblatt wird mit einem Standardtabellennamen und optionalen erweiterten Argumenten in die Tabelle eingefügt. Das neue Tabellenblatt wird zum aktiven Tabellenblatt.

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

Parameter

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

Erweiterte Parameter

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

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertSheet(sheetName)

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

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

Parameter

NameTypBeschreibung
sheetNameStringDer Name des neuen Tabellenblatts.

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 im angegebenen Index in die Tabelle ein. Das neue Tabellenblatt wird zum aktiven Tabellenblatt.

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

Parameter

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

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 im angegebenen Index in die Tabelle ein und verwendet optionale erweiterte Argumente. Das neue Tabellenblatt wird zum aktiven Tabellenblatt.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('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 einer Tabelle einfügen möchten, legen Sie es auf 0 fest.
optionsObjectOptionale erweiterte JavaScript-Argumente.

Erweiterte Parameter

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

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

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

Parameter

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

Erweiterte Parameter

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

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertSheetWithDataSourceTable(spec)

Ein neues Tabellenblatt wird in die Tabelle eingefügt, ein DataSourceTable, das das gesamte Tabellenblatt mit der angegebenen Datenquellenspezifikation enthält, wird erstellt und die Datenausführung wird gestartet. Das hat zur Folge, dass das neue Tabellenblatt zum aktiven Tabellenblatt wird.

Gibt eine Ausnahme aus, wenn der Typ der Datenquelle nicht aktiviert ist. Verwenden Sie die Methode SpreadsheetApp#enable...Execution(), um die Datenausführung für einen bestimmten Datenquellentyp zu aktivieren.

Parameter

NameTypBeschreibung
specDataSourceSpecDie Spezifikation der Datenquelle, in die die Daten eingefügt werden sollen.

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

isColumnHiddenByUser(columnPosition)

Gibt an, ob die jeweilige Spalte vom Nutzer ausgeblendet wurde.

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

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

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der zu prüfenden Spalte.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

isIterativeCalculationEnabled()

Gibt an, ob die iterative Berechnung in dieser Tabelle aktiviert ist.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

isRowHiddenByFilter(rowPosition)

Gibt an, ob die jeweilige Zeile durch einen Filter (nicht eine Filteransicht) ausgeblendet wird.

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

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

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der zu überprüfenden Zeile.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

isRowHiddenByUser(rowPosition)

Gibt an, ob die jeweilige Zeile für den Nutzer ausgeblendet ist.

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

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

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der zu überprüfenden Zeile.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

moveActiveSheet(pos)

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

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

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

spreadsheet.moveActiveSheet(2);

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

Parameter

NameTypBeschreibung
posIntegerDie Position des 1-Index, in die das aktive Tabellenblatt in die Liste der Tabellenblätter verschoben wird.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

moveChartToObjectSheet(chart)

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

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

Parameter

NameTypBeschreibung
chartEmbeddedChartDas Diagramm, das verschoben werden soll.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

refreshAllDataSources()

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

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

removeEditor(emailAddress)

Entfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für Spreadsheet. Diese Methode hindert Nutzer nicht daran, auf Spreadsheet zuzugreifen, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören, z. B. wenn die Spreadsheet für die gesamte Domain des Nutzers freigegeben ist oder wenn sich Spreadsheet in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

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

Parameter

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

Rückflug

Spreadsheet: Der Spreadsheet für eine Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

removeEditor(user)

Entfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für Spreadsheet. Diese Methode hindert Nutzer nicht daran, auf Spreadsheet zuzugreifen, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören, z. B. wenn die Spreadsheet für die gesamte Domain des Nutzers freigegeben ist oder wenn sich Spreadsheet in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

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

Parameter

NameTypBeschreibung
userUserDarstellung des zu entfernenden Nutzers

Rückflug

Spreadsheet: Der Spreadsheet für eine Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 haben wie der entsprechende Aufruf von addMenu(name, subMenus).

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

Parameter

NameTypBeschreibung
nameStringDer Name des zu entfernenden Menüs.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

removeNamedRange(name)

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

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

Parameter

NameTypBeschreibung
nameStringBereichsname

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

removeViewer(emailAddress)

Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren von Spreadsheet. Diese Methode hat keine Auswirkungen, wenn der Nutzer ein Bearbeiter ist, kein Betrachter oder Kommentator. Diese Methode verhindert auch nicht, dass Nutzer auf Spreadsheet zugreifen, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören, z. B. wenn die Spreadsheet für die gesamte Domain des Nutzers freigegeben ist oder wenn sich das 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: Spreadsheet für Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

removeViewer(user)

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

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

Parameter

NameTypBeschreibung
userUserDarstellung des zu entfernenden Nutzers

Rückflug

Spreadsheet: Spreadsheet für Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

rename(newName)

Benennt das Dokument um.

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

Parameter

NameTypBeschreibung
newNameStringDer neue Name des Dokuments.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

renameActiveSheet(newName)

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

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

Parameter

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

resetSpreadsheetTheme()

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

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

Rückflug

SpreadsheetTheme: Das Standarddesign.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setActiveRange(range)

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

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

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

Parameter

NameTypBeschreibung
rangeRangeDer Bereich, der als aktiver Bereich festgelegt werden soll.

Rückflug

Range: Der neu aktive Bereich

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 wurde als active range festgelegt.

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

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

Parameter

NameTypBeschreibung
rangeListRangeListDie Liste der auszuwählenden Bereiche.

Rückflug

RangeList: Die neu ausgewählte Liste von Bereichen

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setActiveSelection(range)

Legt den aktiven Auswahlbereich für das Tabellenblatt fest.

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

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

Parameter

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

Rückflug

Range: Der neu aktive Bereich

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

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

sheet.setActiveSelection("A1:D4");

Parameter

NameTypBeschreibung
a1NotationStringDer auf „aktiv“ eingestellte Bereich wie in A1- oder R1C1-Notation angegeben.

Rückflug

Range: Der neu aktive Bereich

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setActiveSheet(sheet)

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

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

Parameter

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

Rückflug

Sheet (Aktiv): Das aktive Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setActiveSheet(sheet, restoreSelection)

Das angegebene Tabellenblatt wird als aktives Tabellenblatt in der Tabelle festgelegt. Sie haben die Möglichkeit, die letzte Auswahl innerhalb dieses Tabellenblatts wiederherzustellen. Auf der Google Tabellen-Benutzeroberfläche wird das ausgewählte Tabellenblatt angezeigt, es sei denn, es gehört zu einer anderen Tabelle.

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

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

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

Parameter

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

Rückflug

Sheet: Das neue aktive Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setColumnWidth(columnPosition, width)

Legt die Breite der angegebenen Spalte in Pixeln fest.

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

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

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der angegebenen Spalte.
widthIntegerDie Breite in Pixeln, um sie festzulegen

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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, wobei die Zelle als aktuelle Zelle gilt.

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

Hinweis:Die angegebene Range muss aus einer Zelle bestehen, sonst wird eine Ausnahme ausgelöst.

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

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

Parameter

NameTypBeschreibung
cellRangeDie Zelle, die als aktuelle Zelle festgelegt werden soll.

Rückflug

Range: die neu festgelegte aktuelle Zelle

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setFrozenColumns(columns)

Einfriert die angegebene Anzahl von Spalten. Bei Null sind keine Spalten eingefroren.

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

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

Parameter

NameTypBeschreibung
columnsIntegerDie Anzahl der Spalten, die fixiert werden sollen.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setFrozenRows(rows)

Einfriert die angegebene Anzahl von Zeilen ein. Bei Null werden keine Zeilen eingefroren.

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

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

Parameter

NameTypBeschreibung
rowsIntegerDie Anzahl der zu fixierenden Zeilen.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setIterativeCalculationConvergenceThreshold(minThreshold)

Legt den minimalen Grenzwert für die iterative Berechnung fest. Wenn die Ergebnisse der aufeinanderfolgenden Berechnung um weniger als diesen Wert abweichen, wird die iterative Berechnung beendet. Dieser Wert darf nicht negativ sein und ist standardmäßig auf 0, 05 festgelegt.

Parameter

NameTypBeschreibung
minThresholdNumberDer Mindestkonvergenzgrenzwert (muss nicht negativ sein).

Rückflug

Spreadsheet: Diese Tabelle wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 bei der Aktivierung der Berechnung die maximale Anzahl von Conversion-Zyklen und der Konvergenzschwelle zuvor nicht festgelegt wurde, werden standardmäßig 50 und 0,05 verwendet. Wenn einer der beiden Werte bereits festgelegt wurde, behält er seine vorherigen Werte bei.

Parameter

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

Rückflug

Spreadsheet: Diese Tabelle wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setMaxIterativeCalculationCycles(maxIterations)

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

Parameter

NameTypBeschreibung
maxIterationsIntegerDie maximale Anzahl von Berechnungsdurchläufen (1 bis 10.000).

Rückflug

Spreadsheet: Diese Tabelle wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setNamedRange(name, range)

Benennt einen Bereich.

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

Parameter

NameTypBeschreibung
nameStringDer Name für den Bereich.
rangeRangeDie Bereichsspezifikation

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

Parameter

NameTypBeschreibung
recalculationIntervalRecalculationIntervalDas neue Neuberechnungsintervall

Rückflug

Spreadsheet: Diese Tabelle wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setRowHeight(rowPosition, height)

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

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

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

Parameter

NameTypBeschreibung
rowPositionIntegerDie zu ändernde Zeilenposition.
heightIntegerDie Höhe in Pixeln, um sie festzulegen

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setSpreadsheetLocale(locale)

Legt das Gebietsschema für die Tabelle fest.

Parameter

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setSpreadsheetTheme(theme)

Ein Design für die Tabelle festlegen

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

Parameter

NameTypBeschreibung
themeSpreadsheetThemeDas anzuwendende Design.

Rückflug

SpreadsheetTheme: Das neue aktuelle Design.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setSpreadsheetTimeZone(timezone)

Legt die Zeitzone für die Tabelle fest.

Parameter

NameTypBeschreibung
timezoneStringDie im Format „long“ angegebene Zeitzone (z. B. „America/New_York“, wie von Joda.org aufgelistet).

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

show(userInterface)

Zeigt eine benutzerdefinierte Komponente der Benutzeroberfläche in einem Dialogfeld an, das im Darstellungsbereich des Browsers angezeigt wird. Die Ausführung des serverseitigen Skripts ist nicht ausgesetzt. Zur Kommunikation mit dem Server muss die Komponente der Benutzeroberfläche asynchrone Callbacks für das serverseitige Skript ausführen.

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

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

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

SpreadsheetApp.getActiveSpreadsheet().show(htmlApp);

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

Parameter

NameTypBeschreibung
userInterfaceObjectEin HtmlOutput.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

sort(columnPosition)

Sortieren Sie ein Tabellenblatt aufsteigend.

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

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

Parameter

NameTypBeschreibung
columnPositionIntegerDie Spalte, nach der sortiert werden soll.

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

sort(columnPosition, ascending)

Sortiert eine Tabelle nach Spalte. Gibt einen Parameter an, mit dem aufsteigend oder absteigend angegeben wird.

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

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

Parameter

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

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

toast(msg)

In der rechten unteren Ecke der Tabelle wird ein Pop-up-Fenster mit der entsprechenden Nachricht angezeigt.

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

Parameter

NameTypBeschreibung
msgStringDie Nachricht, die im Toast angezeigt werden soll.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

toast(msg, title)

Zeigt in der rechten unteren Ecke der Tabelle ein Pop-up-Fenster mit der angegebenen Nachricht und dem Titel an.

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

Parameter

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

toast(msg, title, timeoutSeconds)

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

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

Parameter

NameTypBeschreibung
msgStringDie Nachricht, die im Toast angezeigt werden soll.
titleStringDer optionale Titel des Toasts.
timeoutSecondsNumberDas Zeitlimit in Sekunden; bei null beträgt der Toast standardmäßig 5 Sekunden. Bei einem negativen Wert bleibt der Toast bestehen, bis er geschlossen wird.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

unhideColumn(column)

Blendet die Spalte im angegebenen Bereich wieder ein.

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

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

Parameter

NameTypBeschreibung
columnRangeBereich, der eingeblendet werden soll, wenn er ausgeblendet ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

unhideRow(row)

Blendet die Zeile im angegebenen Bereich wieder ein.

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

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

Parameter

NameTypBeschreibung
rowRangeBereich, der eingeblendet werden soll, wenn er ausgeblendet ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

updateMenu(name, subMenus)

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

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

Parameter

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Wartet, bis alle aktuellen Ausführungen in der Tabelle abgeschlossen sind, und zwar nach der angegebenen Anzahl von Sekunden. Löst eine Ausnahme aus, wenn die Ausführungen beim Zeitlimit nicht abgeschlossen werden, die Datenausführungen aber nicht abbrechen.

Parameter

NameTypBeschreibung
timeoutInSecondsIntegerDie Wartezeit in Sekunden. Das Maximum beträgt 300 Sekunden.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

Verworfene Methoden