Class Spreadsheet

Tabelle

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

Methoden

MethodeRückgabetypKurzbeschreibung
addDeveloperMetadata(key)SpreadsheetFügt Entwicklermetadaten mit dem angegebenen Schlüssel zur Tabelle auf oberster Ebene hinzu.
addDeveloperMetadata(key, visibility)SpreadsheetFügt der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel und der angegebenen Sichtbarkeit hinzu.
addDeveloperMetadata(key, value)SpreadsheetFügt der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel und Wert hinzu.
addDeveloperMetadata(key, value, visibility)SpreadsheetFügt der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel, Wert und der angegebenen Sichtbarkeit hinzu.
addEditor(emailAddress)SpreadsheetFügt den angegebenen Nutzer der Liste der Bearbeiter für Spreadsheet hinzu.
addEditor(user)SpreadsheetFügt den angegebenen Nutzer der Liste der Bearbeiter für Spreadsheet hinzu.
addEditors(emailAddresses)SpreadsheetFügt das angegebene Array von Nutzern der Liste der Bearbeiter für Spreadsheet hinzu.
addMenu(name, subMenus)voidErstellt ein neues Menü in der Benutzeroberfläche der Tabelle.
addViewer(emailAddress)SpreadsheetFügt den angegebenen Nutzer der Liste der Betrachter für das Spreadsheet hinzu.
addViewer(user)SpreadsheetFügt den angegebenen Nutzer der Liste der Betrachter für das Spreadsheet hinzu.
addViewers(emailAddresses)SpreadsheetFügt das angegebene Array von Nutzern der Betrachterliste für Spreadsheet hinzu.
appendRow(rowContents)SheetFügt eine Zeile am Ende des aktuellen Datenbereichs im Tabellenblatt an.
autoResizeColumn(columnPosition)SheetLegt die Breite der gegebenen Spalte so fest, dass sie ihrem Inhalt entspricht.
copy(name)SpreadsheetKopiert die Tabelle und gibt die neue Tabelle zurück.
createDeveloperMetadataFinder()DeveloperMetadataFinderGibt eine DeveloperMetadataFinder zurück, um Entwicklermetadaten im Bereich von diese Tabelle an.
createTextFinder(findText)TextFinderErstellt einen Textsucher für die Tabelle, mit dem Text in in der Tabellenkalkulation.
deleteActiveSheet()SheetLöscht das derzeit aktive Tabellenblatt.
deleteColumn(columnPosition)SheetLöscht die Spalte an der angegebenen Spaltenposition.
deleteColumns(columnPosition, howMany)voidLöscht eine Anzahl von Spalten ab der angegebenen Spaltenposition.
deleteRow(rowPosition)SheetLöscht die Zeile an der angegebenen Zeilenposition.
deleteRows(rowPosition, howMany)voidLöscht eine Anzahl von Zeilen ab der angegebenen Zeilenposition.
deleteSheet(sheet)voidLöscht das angegebene Tabellenblatt.
duplicateActiveSheet()SheetDupliziert das aktive Tabellenblatt und macht es zum aktiven Tabellenblatt.
getActiveCell()RangeGibt die aktive Zelle in diesem Tabellenblatt zurück.
getActiveRange()RangeGibt den ausgewählten Bereich im aktiven Tabellenblatt oder null zurück, wenn kein Bereich aktiv ist.
getActiveRangeList()RangeListGibt die Liste der aktiven Bereiche im aktiven Tabellenblatt oder null zurück, wenn keine aktiven Bereiche vorhanden sind Bereiche.
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 Bandings in dieser Tabellenkalkulation zurück.
getBlob()BlobGibt die Daten in diesem Objekt als Blob zurück.
getColumnWidth(columnPosition)IntegerRuft die Breite der gegebenen Spalte in Pixeln ab.
getCurrentCell()RangeGibt die aktuelle Zelle im aktiven Tabellenblatt oder null zurück, 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 für die Datenquelle ab.
getDataSourcePivotTables()DataSourcePivotTable[]Ruft alle Pivot-Tabellen der Datenquelle ab.
getDataSourceRefreshSchedules()DataSourceRefreshSchedule[]Ruft die Aktualisierungspläne dieser Tabelle ab.
getDataSourceSheets()DataSourceSheet[]Gibt alle Datenquellenblätter in der Tabelle zurück.
getDataSourceTables()DataSourceTable[]Ruft alle Datenquellentabellen ab.
getDataSources()DataSource[]Gibt alle Datenquellen in der Tabelle zurück.
getDeveloperMetadata()DeveloperMetadata[]Ruft die Entwicklermetadaten ab, die mit der Tabelle auf oberster Ebene verknüpft sind.
getEditors()User[]Ruft die Liste der Bearbeiter für dieses Spreadsheet-Element ab.
getFormUrl()StringGibt die URL für das Formular zurück, das die Antworten an diese Tabelle sendet, oder null, wenn dieser Tabelle ist kein Formular zugeordnet.
getFrozenColumns()IntegerGibt die Anzahl der fixierten Spalten zurück.
getFrozenRows()IntegerGibt die Anzahl der fixierten Zeilen zurück.
getId()StringRuft eine eindeutige Kennung für diese Tabelle ab.
getImages()OverGridImage[]Gibt alle über das Raster gelegten Bilder auf dem Tabellenblatt zurück.
getIterativeCalculationConvergenceThreshold()NumberGibt den Schwellenwert zurück, der während der iterativen Berechnung verwendet wird.
getLastColumn()IntegerGibt die Position der letzten Spalte mit Inhalt zurück.
getLastRow()IntegerGibt die Position der letzten Zeile mit Inhalt zurück
getMaxIterativeCalculationCycles()IntegerGibt die maximale Anzahl von Iterationen zurück, die während der iterativen Berechnung verwendet werden sollen.
getName()StringRuft den Namen des Dokuments ab.
getNamedRanges()NamedRange[]Ruft alle benannten Bereiche in dieser Tabelle ab.
getNumSheets()IntegerGibt die Anzahl der Tabellenblätter in dieser Tabelle zurück
getOwner()UserGibt den Eigentümer des Dokuments oder null für ein Dokument in einer geteilten Ablage zurück.
getPredefinedSpreadsheetThemes()SpreadsheetTheme[]Gibt die Liste der vordefinierten Designs zurück
getProtections(type)Protection[]Ruft ein Array von Objekten ab, die alle geschützten Bereiche oder Tabellenblätter in der Tabelle darstellen.
getRange(a1Notation)RangeGibt den Bereich entsprechend der A1-Schreibweise oder R1C1-Schreibweise zurück.
getRangeByName(name)RangeGibt einen benannten Bereich oder null zurück, wenn kein Bereich mit dem angegebenen Namen gefunden wird.
getRangeList(a1Notations)RangeListGibt die Sammlung RangeList zurück, die die Bereiche im angegebenen Tabellenblatt darstellt nicht leere Liste von A1- oder R1C1-Notationen.
getRecalculationInterval()RecalculationIntervalGibt das Berechnungsintervall für diese Tabellenkalkulation zurück.
getRowHeight(rowPosition)IntegerRuft die Höhe der angegebenen Zeile in Pixeln ab.
getSelection()SelectionGibt den aktuellen Wert für Selection in der Tabelle zurück.
getSheetByName(name)SheetGibt ein Tabellenblatt mit dem angegebenen Namen zurück.
getSheetId()IntegerGibt die ID des Tabellenblatts zurück, das durch dieses Objekt dargestellt wird.
getSheetName()StringGibt den Namen des Tabellenblatts zurück.
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]Gibt das rechteckige Werteraster für diesen Bereich zurück, beginnend bei den angegebenen Koordinaten.
getSheets()Sheet[]Ruft alle Tabellenblätter in dieser Tabelle ab.
getSpreadsheetLocale()StringRuft das Gebietsschema für die Tabelle ab.
getSpreadsheetTheme()SpreadsheetThemeGibt das aktuelle Design der Tabelle oder null zurück, 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 nach der angegebenen Spaltenposition eine bestimmte Anzahl von Spalten ein.
insertColumnsBefore(beforePosition, howMany)SheetFügt eine Anzahl von Spalten vor der angegebenen Spaltenposition ein.
insertDataSourceSheet(spec)DataSourceSheetFügt eine neue DataSourceSheet in die Tabelle ein und startet die Datenausführung.
insertImage(blobSource, column, row)OverGridImageFügt eine Spreadsheet als Bild an einer bestimmten Zeile und Spalte in das Dokument ein.
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageFügt ein Spreadsheet-Element an einer bestimmten Zeile und Spalte als Bild in das Dokument ein, mit einem Pixelversatz.
insertImage(url, column, row)OverGridImageFügt ein Bild an einer bestimmten Zeile und Spalte in das Dokument ein.
insertImage(url, column, row, offsetX, offsetY)OverGridImageFügt bei 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 Anzahl von Zeilen nach der angegebenen Zeilenposition ein.
insertRowsBefore(beforePosition, howMany)SheetFügt eine Anzahl von Zeilen vor der angegebenen Zeilenposition ein.
insertSheet()SheetFügt ein neues Tabellenblatt mit einem Standardnamen für das Tabellenblatt in die Tabelle ein.
insertSheet(sheetIndex)SheetFügt am angegebenen Index ein neues Tabellenblatt in die Tabelle ein.
insertSheet(sheetIndex, options)SheetFügt beim angegebenen Index ein neues Tabellenblatt in die Tabelle ein und verwendet optionale erweiterte Argumente.
insertSheet(options)SheetFügt ein neues Tabellenblatt in die Tabelle ein. Dabei werden ein Standardtabellenname und optionale erweiterte Optionen verwendet. Argumente.
insertSheet(sheetName)SheetFügt ein neues Tabellenblatt mit dem angegebenen Namen in die Tabelle ein.
insertSheet(sheetName, sheetIndex)SheetFügt ein neues Tabellenblatt mit dem angegebenen Namen am angegebenen Index in die Tabelle ein.
insertSheet(sheetName, sheetIndex, options)SheetFügt ein neues Tabellenblatt mit dem angegebenen Namen am angegebenen Index in die Tabelle ein und verwendet optionale erweiterte Argumente.
insertSheet(sheetName, options)SheetFügt ein neues Tabellenblatt mit dem angegebenen Namen in die Tabelle ein und verwendet optionale erweiterte Tabellen Argumente.
insertSheetWithDataSourceTable(spec)SheetFügt ein neues Tabellenblatt in die Tabelle ein und erstellt eine DataSourceTable über die mit der angegebenen Datenquellenspezifikation an und startet die Datenausführung.
isColumnHiddenByUser(columnPosition)BooleanGibt zurück, ob die angegebene Spalte vom Nutzer ausgeblendet ist.
isIterativeCalculationEnabled()BooleanGibt zurück, ob die iterative Berechnung in dieser Tabellenkalkulation aktiviert ist.
isRowHiddenByFilter(rowPosition)BooleanGibt zurück, ob die angegebene Zeile durch einen Filter (nicht durch eine Filteransicht) ausgeblendet ist.
isRowHiddenByUser(rowPosition)BooleanGibt zurück, ob die angegebene Zeile vom Nutzer ausgeblendet wurde.
moveActiveSheet(pos)voidVerschiebt das aktive Tabellenblatt an die angegebene Position in der Liste der Tabellenblätter.
moveChartToObjectSheet(chart)SheetErstellt ein neues SheetType.OBJECT-Tabellenblatt und verschiebt das angegebene Diagramm dorthin.
refreshAllDataSources()voidAlle unterstützten Datenquellen und die zugehörigen verknüpften Datenquellenobjekte werden aktualisiert. Ungültige Datenquellen werden übersprungen. Datenquellenobjekte.
removeEditor(emailAddress)SpreadsheetEntfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Spreadsheet.
removeEditor(user)SpreadsheetEntfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Spreadsheet.
removeMenu(name)voidEntfernt eine Speisekarte, die von addMenu(name, subMenus) hinzugefügt wurde.
removeNamedRange(name)voidLöscht einen benannten Bereich mit dem angegebenen Namen.
removeViewer(emailAddress)SpreadsheetEntfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für das Spreadsheet.
removeViewer(user)SpreadsheetEntfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für das Spreadsheet.
rename(newName)voidBenennt das Dokument um.
renameActiveSheet(newName)voidBenennt das derzeit 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 obere linke Zelle im Bereich als current cell.
setActiveRangeList(rangeList)RangeListLegt die angegebene Liste von Bereichen als active ranges in der aktiven Tabellenblatt.
setActiveSelection(range)RangeLegt den aktiven Auswahlbereich für dieses Tabellenblatt fest.
setActiveSelection(a1Notation)RangeLegt die aktive Auswahl entsprechend der A1-Schreibweise oder R1C1-Notation fest.
setActiveSheet(sheet)SheetLegt das angegebene Tabellenblatt als aktives Tabellenblatt in der Tabelle fest.
setActiveSheet(sheet, restoreSelection)SheetLegt fest, dass das angegebene Tabellenblatt das aktive Tabellenblatt in der Tabelle ist, mit der Option, das Tabellenblatt wiederherzustellen letzten Auswahl in diesem Tabellenblatt.
setColumnWidth(columnPosition, width)SheetLegt die Breite der gegebenen Spalte in Pixeln fest.
setCurrentCell(cell)RangeLegt die angegebene Zelle als current cell fest.
setFrozenColumns(columns)voidFixiert die angegebene Anzahl von Spalten.
setFrozenRows(rows)voidFixiert die angegebene Anzahl von Zeilen.
setIterativeCalculationConvergenceThreshold(minThreshold)SpreadsheetLegt den Mindestgrenzwert für die iterative Berechnung fest.
setIterativeCalculationEnabled(isEnabled)SpreadsheetLegt fest, ob die iterative Berechnung in dieser Tabellenkalkulation aktiviert wird.
setMaxIterativeCalculationCycles(maxIterations)SpreadsheetLegt die maximale Anzahl von Berechnungsiterationen fest, die während der iterativen Ausführung durchgeführt werden sollen Berechnung.
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 gegebenen Zeile in Pixeln fest.
setSpreadsheetLocale(locale)voidLegt das Gebietsschema für die Tabelle fest.
setSpreadsheetTheme(theme)SpreadsheetThemeLegt ein Design für die Tabelle fest.
setSpreadsheetTimeZone(timezone)voidLegt die Zeitzone für die Tabelle fest.
show(userInterface)voidZeigt eine benutzerdefinierte Komponente für die Benutzeroberfläche in einem Dialogfeld an, das im Browser des Nutzers zentriert ist Darstellungsbereich.
sort(columnPosition)SheetSortiert ein Tabellenblatt aufsteigend nach Spalten.
sort(columnPosition, ascending)SheetSortiert ein Tabellenblatt nach Spalte.
toast(msg)voidZeigt unten rechts in der Tabelle ein Pop-up-Fenster mit der angegebenen Nachricht an.
toast(msg, title)voidZeigt unten rechts in der Tabelle ein Pop-up-Fenster mit der angegebenen Nachricht und Titel.
toast(msg, title, timeoutSeconds)voidZeigt unten rechts in der Tabelle ein Pop-up-Fenster mit dem angegebenen Titel und angezeigt, die eine bestimmte Zeit lang sichtbar bleibt.
unhideColumn(column)voidBlendet die Spalte im angegebenen Bereich ein.
unhideRow(row)voidBlendet die Zeile im angegebenen Bereich ein
updateMenu(name, subMenus)voidAktualisiert eine Speisekarte, die von addMenu(name, subMenus) hinzugefügt wurde.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidWartet, bis alle aktuellen Ausführungen in der Tabelle abgeschlossen sind, wobei nach dem angegebene Anzahl von Sekunden.

Detaillierte Dokumentation

addDeveloperMetadata(key)

Fügt Entwicklermetadaten mit dem angegebenen Schlüssel zur Tabelle auf oberster Ebene 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 (Tabelle zur Verkettung)

Autorisierung

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

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

addDeveloperMetadata(key, visibility)

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

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

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

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

Parameter

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

Rückflug

Spreadsheet (Tabelle zur Verkettung)

Autorisierung

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

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

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 (Tabelle zur Verkettung)

Autorisierung

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

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

addDeveloperMetadata(key, value, visibility)

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

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

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

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

Parameter

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

Rückflug

Spreadsheet (Tabelle zur Verkettung)

Autorisierung

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

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

addEditor(emailAddress)

Fügt den angegebenen Nutzer der Liste der Bearbeiter für Spreadsheet hinzu. Wenn der Nutzer wird der Nutzer mit dieser Methode aus der Betrachterliste hochgestuft.

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des hinzuzufügenden Nutzers.

Rückflug

Spreadsheet: Diese Spreadsheet zur Verkettung.

Autorisierung

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

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

addEditor(user)

Fügt den angegebenen Nutzer der Liste der Bearbeiter für Spreadsheet hinzu. Wenn der Nutzer wird der Nutzer mit dieser Methode aus der Betrachterliste hochgestuft.

Parameter

NameTypBeschreibung
userUserEine Darstellung des hinzuzufügenden Nutzers.

Rückflug

Spreadsheet: Diese Spreadsheet zur Verkettung.

Autorisierung

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

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

addEditors(emailAddresses)

Fügt das angegebene Array von Nutzern der Liste der Bearbeiter für Spreadsheet hinzu. Wenn eines der Nutzer, die bereits auf der Liste der Betrachter stehen, werden sie mit dieser Methode aus der Liste der Zuschauer*innen.

Parameter

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

Rückflug

Spreadsheet: Diese Spreadsheet zur Verkettung.

Autorisierung

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

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

addMenu(name, subMenus)

Erstellt ein neues Menü in der Benutzeroberfläche der Tabelle.

Jeder Menüeintrag führt eine benutzerdefinierte Funktion aus. Normalerweise wird sie über die onOpen()-Funktion aufgerufen, 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
nameStringDer Name des zu erstellenden Menüs.
subMenusObject[]Ein Array von JavaScript-Zuordnungen mit den Parametern name und functionName . Sie können Funktionen aus enthaltenen Bibliotheken wie Library.libFunction1 verwenden.

Autorisierung

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

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

addViewer(emailAddress)

Fügt den angegebenen Nutzer der Liste der Betrachter für das Spreadsheet hinzu. Wenn der Nutzer auf der Liste der Bearbeiter enthält, hat diese Methode keine Auswirkungen.

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des hinzuzufügenden Nutzers.

Rückflug

Spreadsheet: Diese Spreadsheet zur Verkettung.

Autorisierung

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

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

addViewer(user)

Fügt den angegebenen Nutzer der Liste der Betrachter für das Spreadsheet hinzu. Wenn der Nutzer auf der Liste der Bearbeiter enthält, hat diese Methode keine Auswirkungen.

Parameter

NameTypBeschreibung
userUserEine Darstellung des hinzuzufügenden Nutzers.

Rückflug

Spreadsheet: Diese Spreadsheet zur Verkettung.

Autorisierung

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

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

addViewers(emailAddresses)

Fügt das angegebene Array von Nutzern der Betrachterliste für Spreadsheet hinzu. Wenn eines der Benutzer, die bereits auf der Liste der Bearbeiter waren, hat diese Methode keine Auswirkungen auf sie.

Parameter

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

Rückflug

Spreadsheet: Diese Spreadsheet zum Verketten.

Autorisierung

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

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

appendRow(rowContents)

Fügt eine Zeile am Ende des aktuellen Datenbereichs im Tabellenblatt an. Wenn der Inhalt einer Zelle beginnt mit = wird sie als Formel interpretiert.

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

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

Parameter

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

Rückflug

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

Autorisierung

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

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

autoResizeColumn(columnPosition)

Legt die Breite der gegebenen Spalte so fest, dass sie ihrem Inhalt entspricht.

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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

copy(name)

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

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

Parameter

NameTypBeschreibung
nameStringDer Name der Kopie.

Rückflug

Spreadsheet (Tabelle zur Verkettung)

Autorisierung

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

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

createDeveloperMetadataFinder()

Gibt eine DeveloperMetadataFinder zurück, um Entwicklermetadaten im Bereich von diese Tabelle an. Standardmäßig werden alle mit der Tabelle verknüpften Metadaten berücksichtigt. Tabellen, Zeilen und Spalten.

// 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 (Entwickler-Metadatensuche), um nach Metadaten im Bereich dieser Tabelle zu suchen.


createTextFinder(findText)

Erstellt einen Textsucher für die Tabellenkalkulation, mit dem Text in in der Tabellenkalkulation. Die Suche beginnt beim 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
findTextStringText, nach dem gesucht werden soll

Rückflug

TextFinder: Der TextFinder für die Tabelle.


deleteActiveSheet()

Löscht das derzeit aktive Tabellenblatt.

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

Rückflug

Sheet: Das neue aktive Tabellenblatt.

Autorisierung

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

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

deleteColumn(columnPosition)

Löscht die Spalte an der angegebenen Spaltenposition.

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

Parameter

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

Rückflug

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

Autorisierung

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

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

deleteColumns(columnPosition, howMany)

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

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

Parameter

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

Autorisierung

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

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

deleteRow(rowPosition)

Löscht die Zeile an der angegebenen Zeilenposition.

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

Parameter

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

Rückflug

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

Autorisierung

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

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

deleteRows(rowPosition, howMany)

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

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

Parameter

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

Autorisierung

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

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

deleteSheet(sheet)

Löscht das angegebene Tabellenblatt.

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

Parameter

NameTypBeschreibung
sheetSheetDas Tabellenblatt, das gelöscht werden soll.

Autorisierung

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

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

duplicateActiveSheet()

Dupliziert das aktive Tabellenblatt und macht es zum aktiven Tabellenblatt.

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

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

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

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

getActiveCell()

Gibt die aktive Zelle in diesem Tabellenblatt zurück.

Hinweis: Wir empfehlen die Verwendung von getCurrentCell(), das den aktuellen Wert hervorgehobene Zelle.

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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getActiveRange()

Gibt den ausgewählten Bereich im aktiven Tabellenblatt oder null zurück, 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Weitere Informationen


getActiveRangeList()

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

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

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

Rückflug

RangeList – Liste der aktiven Bereiche

Autorisierung

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

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

Weitere Informationen


getActiveSheet()

Ruft das aktive Tabellenblatt in einer Tabelle ab.

Das aktive Blatt in einer Tabellenkalkulation ist das Blatt, das in der Tabellenkalkulation angezeigt wird. UI.

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. Dieses fügt dem Dateinamen die entsprechende Erweiterung hinzu, beispielsweise "meinedatei.pdf". Allerdings geht davon aus, dass der Teil des Dateinamens, der auf den letzten Punkt folgt (falls vorhanden), ein vorhandener die ersetzt werden soll. Daher lautet „Einkaufsliste.12.25.2014“. wird zu „Einkaufsliste.12.25.pdf“.

Die Tageskontingente für Conversions finden Sie unter Kontingente für Google Dienste. Neu erstellte Google Workspace-Domains unterliegen möglicherweise vorübergehend strengeren Richtlinien. Kontingenten.

Parameter

NameTypBeschreibung
contentTypeStringDer MIME-Typ, in den konvertiert werden soll. Für die meisten Blobs ist 'application/pdf' ist die einzige gültige Option. Für Bilder im BMP-, GIF-, JPEG- oder PNG-Format gilt auch Folgendes: 'image/bmp', 'image/gif', 'image/jpeg' oder 'image/png' gültig sein. Bei einem Google Docs-Dokument ist 'text/markdown' ebenfalls gültig.

Rückflug

Blob: Die Daten als Blob.


getBandings()

Gibt alle Bandings in dieser Tabellenkalkulation zurück.

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

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

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

Rückflug

Banding[] (Bandierungen) in dieser Tabelle.

Autorisierung

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

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

getBlob()

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

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 untersuchenden Spalte.

Rückflug

Integer – Spaltenbreite in Pixeln

Autorisierung

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

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

getCurrentCell()

Gibt die aktuelle Zelle im aktiven Tabellenblatt oder null zurück, wenn keine Zelle vorhanden ist. Die Die aktuelle Zelle ist die Zelle, die in der Benutzeroberfläche von Google Tabellen hervorgehoben ist und mit einem dunklen Rahmen. Es gibt nie mehr als eine Zelle. Wenn Nutzende einen oder mehrere Zellenbereiche auswählen, Eine der Zellen in der Auswahl ist 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getDataRange()

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

Funktional entspricht dies der Erstellung eines durch A1 begrenzten Bereichs (Sheet.getLastColumn(), Sheet.getLastRow()).

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

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

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

Rückflug

Range: ein Bereich, der alle Daten der Tabelle umfasst

Autorisierung

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

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

getDataSourceFormulas()

Ruft alle Formeln für die Datenquelle ab.

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

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

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

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

Rückflug

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

Autorisierung

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

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

getDataSourcePivotTables()

Ruft alle Pivot-Tabellen der Datenquelle ab.

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

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

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

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

Rückflug

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

Autorisierung

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

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

getDataSourceRefreshSchedules()

Ruft die Aktualisierungspläne dieser Tabelle ab.

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

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

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

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

Rückflug

DataSourceRefreshSchedule[]: Der Aktualisierungsplan dieser Tabelle.

Autorisierung

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

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

getDataSourceSheets()

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

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

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

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

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

Rückflug

DataSourceSheet[]: Ein Array aller Datenquellentabellen.

Autorisierung

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

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

getDataSourceTables()

Ruft alle Datenquellentabellen ab.

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

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

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

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

Rückflug

DataSourceTable[]: Eine Liste der Datenquellentabellen.

Autorisierung

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

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

getDataSources()

Gibt alle Datenquellen in der Tabelle zurück.

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

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

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

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

Rückflug

DataSource[]: Ein Array aller Datenquellen.

Autorisierung

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

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

getDeveloperMetadata()

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

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

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

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

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

Rückflug

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

Autorisierung

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

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

getEditors()

Ruft die Liste der Bearbeiter für dieses Spreadsheet-Element ab.

Rückflug

User[]: ein Array von Nutzern mit Bearbeitungsberechtigung.

Autorisierung

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

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

getFormUrl()

Gibt die URL für das Formular zurück, das die Antworten an diese Tabelle sendet, oder null, wenn dieser Tabelle ist kein Formular zugeordnet. Wenn mehrere Formulare Antworten an diese Tabelle senden, die zurückgegebene Formular-URL unbestimmt ist. Alternativ können URL-Verknüpfungen pro Tabellenblatt kann mit der Methode Sheet.getFormUrl() abgerufen werden.

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

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

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

Rückflug

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

Autorisierung

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

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

getFrozenColumns()

Gibt die Anzahl der fixierten Spalten zurück.

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

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

Rückflug

Integer – Die Anzahl der fixierten Spalten

Autorisierung

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

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

getFrozenRows()

Gibt die Anzahl der fixierten Zeilen zurück.

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

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

Rückflug

Integer – Anzahl der fixierten Zeilen

Autorisierung

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

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

getId()

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

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

Rückflug

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


getImages()

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

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

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

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

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

Rückflug

OverGridImage[]: Ein Array von über das Raster gelegten Bildern.

Autorisierung

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

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

getIterativeCalculationConvergenceThreshold()

Gibt den Schwellenwert zurück, der während der iterativen Berechnung verwendet wird. Wenn die Ergebnisse aufeinander Berechnung um kleiner als diesen Wert unterscheiden, wird die iterative Berechnung beendet.

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

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

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

Rückflug

Number: Der Konvergenzgrenzwert.

Autorisierung

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

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

getLastColumn()

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

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

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

Rückflug

Integer: die letzte Spalte des Tabellenblatts mit Inhalt

Autorisierung

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

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

getLastRow()

Gibt die Position der letzten Zeile mit Inhalt zurück

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

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

Rückflug

Integer: die letzte Zeile des Tabellenblatts mit Inhalt

Autorisierung

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

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

getMaxIterativeCalculationCycles()

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

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

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

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

Rückflug

Integer: Die maximale Anzahl von Berechnungsiterationen.

Autorisierung

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

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

getName()

Ruft den Namen des Dokuments ab.

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

Rückflug

String: Der Name der Tabelle.

Autorisierung

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

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

getNamedRanges()

Ruft alle benannten Bereiche in dieser Tabelle ab.

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

Rückflug

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

Autorisierung

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

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

getNumSheets()

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

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

Rückflug

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


getOwner()

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

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

Rückflug

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

Autorisierung

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

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

getPredefinedSpreadsheetThemes()

Gibt die Liste der vordefinierten Designs zurück

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

Rückflug

SpreadsheetTheme[]: Liste vordefinierter Themen.

Autorisierung

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

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

getProtections(type)

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

// Remove all range protections in the spreadsheet that the user has permission to edit.
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
typeProtectionTypeDie Art des Schutzgebiets, entweder SpreadsheetApp.ProtectionType.RANGE oder SpreadsheetApp.ProtectionType.SHEET.

Rückflug

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

Autorisierung

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

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

getRange(a1Notation)

Gibt den Bereich entsprechend der A1-Schreibweise oder R1C1-Schreibweise 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
a1NotationStringBereich, der gemäß A1-Schreibweise oder R1C1-Notation zurückgegeben werden soll.

Rückflug

Range: der Bereich am angegebenen Standort

Autorisierung

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

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

getRangeByName(name)

Gibt einen benannten Bereich oder null zurück, wenn kein Bereich mit dem angegebenen Namen gefunden wird. Falls mehrere Tabellenblätter der Tabelle haben denselben Bereichsnamen. Geben Sie den Namen des Tabellenblatts ohne zusätzliche Anführungszeichen setzen, 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 angegebenen Tabellenblatt darstellt nicht leere Liste von A1- oder R1C1-Notationen.

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

Parameter

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

Rückflug

RangeList – die Bereichsliste am angegebenen Standort

Autorisierung

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

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

getRecalculationInterval()

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

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

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

Rückflug

RecalculationInterval: Das Berechnungsintervall für diese Tabelle.

Autorisierung

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

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

getRowHeight(rowPosition)

Ruft die Höhe 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 untersuchenden Zeile.

Rückflug

Integer – Zeilenhöhe in Pixeln

Autorisierung

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

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

getSelection()

Gibt den aktuellen Wert für 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getSheetByName(name)

Gibt ein Tabellenblatt mit dem angegebenen Namen zurück.

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

// 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 Tabellenblatts zurück, das durch dieses Objekt dargestellt wird.

Dies ist eine eindeutige ID für das Tabellenblatt. Die ID ist ein monoton zunehmende Ganzzahl, die beim Erstellen des Tabellenblatts zugewiesen wurde, unabhängig von der Position des Tabellenblatts. Dieses 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 Arbeitsblatt dieser Tabelle

Autorisierung

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

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

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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getSheetValues(startRow, startColumn, numRows, numColumns)

Gibt das rechteckige Werteraster für diesen Bereich zurück, beginnend bei den angegebenen Koordinaten. A–1 Der als Zeilen- oder Spaltenposition angegebene Wert entspricht dem Abrufen der letzten Zeile oder Spalte. die Daten in der Tabelle 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 Startspalte.
numRowsIntegerDie Anzahl der Zeilen, für die Werte zurückgegeben werden sollen.
numColumnsIntegerDie Anzahl der Spalten, für die Werte zurückgegeben werden sollen.

Rückflug

Object[][] – ein zweidimensionales Array von Werten

Autorisierung

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

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

getSheets()

Ruft alle Tabellenblätter in dieser Tabelle ab.

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

Rückflug

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


getSpreadsheetLocale()

Ruft das Gebietsschema für die Tabelle ab.

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

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

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

Rückflug

String: Die Sprache der Tabelle.

Autorisierung

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

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

getSpreadsheetTheme()

Gibt das aktuelle Design der Tabelle oder null zurück, 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getSpreadsheetTimeZone()

Ruft die Zeitzone für die Tabelle ab.

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

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

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

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

Rückflug

String: die in "long" angegebene Zeitzone Format (z. B. "America/New_York", wie in der Liste von Joda.org)

Autorisierung

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

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

getUrl()

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

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

Rückflug

String: Die URL für die angegebene Tabelle.

Autorisierung

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

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

getViewers()

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

Rückflug

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

Autorisierung

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

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

hideColumn(column)

Blendet die Spalte(n) im angegebenen Bereich aus.

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

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

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

Parameter

NameTypBeschreibung
columnRangeDer Spaltenbereich, der ausgeblendet werden soll.

Autorisierung

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

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

hideRow(row)

Blendet die Zeilen im angegebenen Bereich aus.

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

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

Parameter

NameTypBeschreibung
rowRangeDer Zeilenbereich, der ausgeblendet werden soll.

Autorisierung

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

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

insertColumnAfter(afterPosition)

Fügt eine Spalte nach der angegebenen Spaltenposition ein.

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

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

Parameter

NameTypBeschreibung
afterPositionIntegerDie Spalte, nach 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertColumnBefore(beforePosition)

Fügt eine Spalte vor der angegebenen Spaltenposition ein.

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

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

Parameter

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

Rückflug

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

Autorisierung

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

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

insertColumnsAfter(afterPosition, howMany)

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

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

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

Parameter

NameTypBeschreibung
afterPositionIntegerDie Spalte, nach der die neue Spalte 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertColumnsBefore(beforePosition, howMany)

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

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

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

Parameter

NameTypBeschreibung
beforePositionIntegerDie Spalte, vor der die neue Spalte 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertDataSourceSheet(spec)

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

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

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

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

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

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

Parameter

NameTypBeschreibung
specDataSourceSpecDie Datenquellenspezifikation, in die eingefügt werden soll.

Rückflug

DataSourceSheet: Das neue Tabellenblatt mit den Datenquellen.

Autorisierung

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

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

insertImage(blobSource, column, row)

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

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

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

Parameter

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

Rückflug

OverGridImage: Das eingefügte Bild.

Autorisierung

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

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

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

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

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) Namen.
columnIntegerDie Spaltenposition.
rowIntegerDie Zeilenposition.
offsetXIntegerDer horizontale Versatz von der Ecke der Zelle in Pixeln.
offsetYIntegerDer vertikale Versatz von der Ecke der Zelle in Pixeln.

Rückflug

OverGridImage: Das eingefügte Bild.

Autorisierung

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

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

insertImage(url, column, row)

Fügt ein Bild an einer bestimmten Zeile und Spalte 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

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

Fügt bei 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.
columnIntegerDie Spaltenposition.
rowIntegerDie Zeilenposition.
offsetXIntegerDer horizontale Versatz von der Ecke der Zelle in Pixeln.
offsetYIntegerDer vertikale Versatz von der Ecke der Zelle in Pixeln.

Rückflug

OverGridImage: Das eingefügte Bild.

Autorisierung

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

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

insertRowAfter(afterPosition)

Fügt eine Zeile nach der angegebenen Zeilenposition ein.

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

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

Parameter

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

Rückflug

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

Autorisierung

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

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

insertRowBefore(beforePosition)

Fügt eine Zeile vor der angegebenen Zeilenposition ein.

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

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

Parameter

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

Rückflug

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

Autorisierung

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

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

insertRowsAfter(afterPosition, howMany)

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

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

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

Parameter

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

Rückflug

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

Autorisierung

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

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

insertRowsBefore(beforePosition, howMany)

Fügt eine 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertSheet()

Fügt ein neues Tabellenblatt mit einem Standardnamen für das Tabellenblatt in die Tabelle ein. 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertSheet(sheetIndex)

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

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

Parameter

NameTypBeschreibung
sheetIndexIntegerDer Index des neu erstellten Tabellenblatts. Um ein Blatt als erstes in der Tabelle auf 0.

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

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

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

insertSheet(sheetIndex, options)

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

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

Parameter

NameTypBeschreibung
sheetIndexIntegerDer Index des neu erstellten Tabellenblatts. Um ein Blatt als erstes in der Tabelle auf 0.
optionsObjectOptionale erweiterte JavaScript-Argumente.

Erweiterte Parameter

NameTypBeschreibung
templateSheetAlle Daten aus dem Vorlagentabellenobjekt werden in den in einem neuen Tabellenblatt. Die Tabellenvorlage muss eines der Tabellenblätter des Tabellenobjekts sein.

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

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

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

insertSheet(options)

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

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

Parameter

NameTypBeschreibung
optionsObjectOptionale erweiterte JavaScript-Argumente (siehe unten).

Erweiterte Parameter

NameTypBeschreibung
templateSheetAlle Daten aus dem Vorlagentabellenobjekt werden in den in einem neuen Tabellenblatt. Die Tabellenvorlage muss eines der Tabellenblätter dieses Tabellenobjekts sein.

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

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

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

insertSheet(sheetName)

Fügt ein neues Tabellenblatt mit dem angegebenen Namen in die Tabelle ein. 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertSheet(sheetName, sheetIndex)

Fügt ein neues Tabellenblatt mit dem angegebenen Namen am angegebenen Index in die Tabelle ein. Das neue Tabellenblatt 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. Um ein Blatt als erstes in der Tabelle auf 0.

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

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

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

insertSheet(sheetName, sheetIndex, options)

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

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

Parameter

NameTypBeschreibung
sheetNameStringDer Name des neuen Tabellenblatts.
sheetIndexIntegerIndex des neu eingefügten Tabellenblatts Um ein Blatt als erstes in Tabelle auf 0 setzen.
optionsObjectOptionale erweiterte JavaScript-Argumente.

Erweiterte Parameter

NameTypBeschreibung
templateSheetAlle Daten aus dem Vorlagentabellenobjekt werden in den in einem neuen Tabellenblatt. Die Tabellenvorlage muss eines der Tabellenblätter des Tabellenobjekts sein.

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

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

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

insertSheet(sheetName, options)

Fügt ein neues Tabellenblatt mit dem angegebenen Namen in die Tabelle ein und verwendet optionale erweiterte Funktionen 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 den in einem neuen Tabellenblatt. Die Tabellenvorlage muss eines der Tabellenblätter des Tabellenobjekts sein.

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

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

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

insertSheetWithDataSourceTable(spec)

Fügt ein neues Tabellenblatt in die Tabelle ein und erstellt eine DataSourceTable über mit der angegebenen Datenquellenspezifikation an und startet die Datenausführung. Als Seite wird das neue Tabellenblatt zum aktiven Tabellenblatt.

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

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

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

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

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

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

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

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

Parameter

NameTypBeschreibung
specDataSourceSpecDie Datenquellenspezifikation, in die eingefügt werden soll.

Rückflug

Sheet: Das neue Tabellenblatt.

Autorisierung

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

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

isColumnHiddenByUser(columnPosition)

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

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

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

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der zu untersuchenden Spalte.

Rückflug

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

Autorisierung

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

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

isIterativeCalculationEnabled()

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

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

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

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

Rückflug

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

Autorisierung

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

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

isRowHiddenByFilter(rowPosition)

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

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

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

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der zu untersuchenden Zeile.

Rückflug

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

Autorisierung

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

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

isRowHiddenByUser(rowPosition)

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

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

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

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der zu untersuchenden Zeile.

Rückflug

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

Autorisierung

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

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

moveActiveSheet(pos)

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

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

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

spreadsheet.moveActiveSheet(2);

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

Parameter

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

Autorisierung

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

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

moveChartToObjectSheet(chart)

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

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

Parameter

NameTypBeschreibung
chartEmbeddedChartDas zu verschiebende Diagramm.

Rückflug

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

Autorisierung

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

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

refreshAllDataSources()

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

Verwenden Sie SpreadsheetApp#enable...Execution()-Methoden, um die Datenausführung für Datenquellentyp ändern.

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

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

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

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

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

Autorisierung

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

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

removeEditor(emailAddress)

Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Spreadsheet. Bei dieser Methode werden keine Nutzer am Zugriff auf Spreadsheet blockieren, wenn sie zu einer Nutzerklasse gehören, die allgemeinen Zugriff haben, z. B. wenn die Spreadsheet für das gesamte Domain oder die Spreadsheet befindet sich in einer geteilten Ablage, auf die der Nutzer zugreifen kann.

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

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des zu entfernenden Nutzers.

Rückflug

Spreadsheet: Diese Spreadsheet zum Verketten.

Autorisierung

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

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

removeEditor(user)

Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Spreadsheet. Bei dieser Methode werden keine Nutzer am Zugriff auf Spreadsheet blockieren, wenn sie zu einer Nutzerklasse gehören, die allgemeinen Zugriff haben, z. B. wenn die Spreadsheet für das gesamte Domain oder die Spreadsheet befindet sich in einer geteilten Ablage, auf die der Nutzer zugreifen kann.

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

Parameter

NameTypBeschreibung
userUserEine Darstellung des zu entfernenden Nutzers.

Rückflug

Spreadsheet: Diese Spreadsheet zum Verketten.

Autorisierung

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

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

removeMenu(name)

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

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

Parameter

NameTypBeschreibung
nameStringDer Name des Menüs, das entfernt werden soll.

Autorisierung

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

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

removeNamedRange(name)

Löscht einen benannten Bereich mit dem angegebenen Namen. Löst eine Ausnahme aus, wenn kein Bereich mit dem angegebenen Namen vorhanden ist in der Tabellenkalkulation finden.

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

Parameter

NameTypBeschreibung
nameStringDer Bereichsname.

Autorisierung

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

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

removeViewer(emailAddress)

Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für das Spreadsheet. Dieses hat keine Auswirkungen, wenn der Nutzer ein Bearbeiter, kein Betrachter oder Kommentator ist. Bei dieser Methode Der Zugriff auf Spreadsheet wird nicht blockiert, wenn sie zu einer Klasse von Nutzern gehören, die allgemeinen Zugriff haben, z. B. wenn die Spreadsheet für das oder wenn sich die Spreadsheet in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

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

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des zu entfernenden Nutzers.

Rückflug

Spreadsheet: Diese Spreadsheet für die Verkettung.

Autorisierung

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

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

removeViewer(user)

Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für das Spreadsheet. Dieses hat keine Auswirkungen, wenn der Nutzer ein Bearbeiter und kein Betrachter ist. Diese Methode blockiert auch nicht Nutzer, die nicht auf die Spreadsheet zugreifen, wenn sie zu einer Nutzerklasse mit allgemeinen Zugriff haben, z. B. wenn die Spreadsheet für die gesamte Domain des Nutzers freigegeben ist oder Spreadsheet befindet sich in einer geteilten Ablage, auf die der Nutzer zugreifen kann.

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

Parameter

NameTypBeschreibung
userUserEine Darstellung des zu entfernenden Nutzers.

Rückflug

Spreadsheet: Diese Spreadsheet für die Verkettung.

Autorisierung

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

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

rename(newName)

Benennt das Dokument um.

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

Parameter

NameTypBeschreibung
newNameStringDer neue Name für das Dokument.

Autorisierung

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

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

renameActiveSheet(newName)

Benennt das derzeit 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 des aktuell aktiven Tabellenblatts.

Autorisierung

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

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

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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setActiveRange(range)

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

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 neue aktive Bereich

Autorisierung

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

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

setActiveRangeList(rangeList)

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

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

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

Parameter

NameTypBeschreibung
rangeListRangeListDie Liste der auszuwählenden Bereiche.

Rückflug

RangeList – die neu ausgewählte Liste von Bereichen

Autorisierung

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

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

setActiveSelection(range)

Legt den aktiven Auswahlbereich für dieses Tabellenblatt fest.

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

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

Parameter

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

Rückflug

Range – der neue aktive Bereich

Autorisierung

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

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

setActiveSelection(a1Notation)

Legt die aktive Auswahl entsprechend der A1-Schreibweise oder R1C1-Notation fest.

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

sheet.setActiveSelection("A1:D4");

Parameter

NameTypBeschreibung
a1NotationStringDer als aktiv festzulegende Bereich gemäß A1-Schreibweise oder R1C1-Notation.

Rückflug

Range – der neue aktive Bereich

Autorisierung

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

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

setActiveSheet(sheet)

Legt das angegebene Tabellenblatt als aktives Tabellenblatt in der Tabelle fest. Die Benutzeroberfläche von Google Tabellen wird angezeigt. das ausgewählte Tabellenblatt, es sei denn, das Tabellenblatt gehört zu einer anderen Tabelle.

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

Parameter

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

Rückflug

Sheet: Das aktive Tabellenblatt.

Autorisierung

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

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

setActiveSheet(sheet, restoreSelection)

Legt fest, dass das angegebene Tabellenblatt das aktive Tabellenblatt in der Tabelle ist, mit der Option, das Tabellenblatt wiederherzustellen letzten Auswahl in diesem Tabellenblatt. In der Benutzeroberfläche von Google Tabellen wird das ausgewählte Tabellenblatt angezeigt, es sei denn, zu einer anderen Tabellenkalkulation gehört.

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.
restoreSelectionBooleanTF true, die letzte Auswahl des neuen aktiven Tabellenblatts wird wieder ausgewählt, wenn das neue Tabellenblatt aktiv wird. Wenn false, wird das neue Tabellenblatt wird aktiv, ohne die aktuelle Auswahl zu ändern.

Rückflug

Sheet: Das neue aktive Tabellenblatt.

Autorisierung

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

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

setColumnWidth(columnPosition, width)

Legt die Breite der gegebenen 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 festzulegenden Spalte.
widthIntegerDie Breite in Pixeln, die festgelegt werden soll.

Rückflug

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

Autorisierung

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

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

setCurrentCell(cell)

Legt die angegebene Zelle als current cell fest.

Wenn die angegebene Zelle in einem bereits ausgewählten Bereich vorhanden ist, wird dieser Bereich zur aktiven Bereich, wobei die Zelle die aktuelle Zelle ist.

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

Hinweis:Die angegebene Range muss aus einer Zelle bestehen. Andernfalls wird ein Fehler ausgegeben. Ausnahme.

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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setFrozenColumns(columns)

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

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

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

Parameter

NameTypBeschreibung
columnsIntegerDie Anzahl der zu fixierenden Spalten.

Autorisierung

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

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

setFrozenRows(rows)

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

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

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

Parameter

NameTypBeschreibung
rowsIntegerDie Anzahl der Zeilen, die fixiert werden sollen.

Autorisierung

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

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

setIterativeCalculationConvergenceThreshold(minThreshold)

Legt den Mindestgrenzwert für die iterative Berechnung fest. Wenn die Ergebnisse aufeinander Berechnung um kleiner als diesen Wert unterscheiden, wird die iterative Berechnung beendet. Dieser Wert muss nicht-negativ und der Standardwert ist 0, 05.

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

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

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

Parameter

NameTypBeschreibung
minThresholdNumberDer minimale Konvergenzgrenzwert (muss nicht negativ sein).

Rückflug

Spreadsheet (Tabelle zur Verkettung)

Autorisierung

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

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

setIterativeCalculationEnabled(isEnabled)

Legt fest, ob die iterative Berechnung in dieser Tabellenkalkulation aktiviert wird. Wenn die maximale Anzahl von Berechnungszyklen und Konvergenzgrenzwert noch nicht festgelegt wurden, ist der Standardwert 50 bzw.0, 05. Wurde eines der beiden zuvor festgelegt, ihre vorherigen Werte beizubehalten.

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

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

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

Parameter

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

Rückflug

Spreadsheet (Tabelle zur Verkettung)

Autorisierung

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

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

setMaxIterativeCalculationCycles(maxIterations)

Legt die maximale Anzahl von Berechnungsiterationen fest, die während der iterativen Ausführung durchgeführt werden sollen Berechnung. Dieser Wert muss zwischen 1 und 10.000 liegen. Der Standardwert ist 50.

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

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

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

Parameter

NameTypBeschreibung
maxIterationsIntegerDie maximale Anzahl der Berechnungsiterationen (zwischen 1 und 10.000).

Rückflug

Spreadsheet (Tabelle zur Verkettung)

Autorisierung

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

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

setNamedRange(name, range)

Benennt einen Bereich.

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

Parameter

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

Autorisierung

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

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

setRecalculationInterval(recalculationInterval)

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

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

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

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

Parameter

NameTypBeschreibung
recalculationIntervalRecalculationIntervalDas neue Neuberechnungsintervall.

Rückflug

Spreadsheet (Tabelle zur Verkettung)

Autorisierung

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

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

setRowHeight(rowPosition, height)

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

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

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

Parameter

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

Rückflug

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

Autorisierung

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

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

setSpreadsheetLocale(locale)

Legt das Gebietsschema für die Tabelle fest.

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

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

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

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

Parameter

NameTypBeschreibung
localeStringDer zu verwendende Gebietsschemacode (z. B. "de", "fr" oder "de_DE").

Autorisierung

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

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

setSpreadsheetTheme(theme)

Legt ein Design für die Tabelle fest.

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

Parameter

NameTypBeschreibung
themeSpreadsheetThemeDas anzuwendende Design.

Rückflug

SpreadsheetTheme: Das neue aktuelle Design.

Autorisierung

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

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

setSpreadsheetTimeZone(timezone)

Legt die Zeitzone für die Tabelle fest.

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

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

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

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

Parameter

NameTypBeschreibung
timezoneStringDie in „long“ angegebene Zeitzone Format (z. B. "America/New_York", als aufgelistet bei Joda.org).

Autorisierung

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

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

show(userInterface)

Zeigt eine benutzerdefinierte Komponente für die Benutzeroberfläche in einem Dialogfeld an, das im Browser des Nutzers zentriert ist Darstellungsbereich. Die Ausführung des serverseitigen Skripts wird nicht unterbrochen. Um mit dem muss die Komponente der Benutzeroberfläche asynchrone Rückrufe an die serverseitige .

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

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

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

SpreadsheetApp.getActiveSpreadsheet().show(htmlApp);

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

Parameter

NameTypBeschreibung
userInterfaceObjectEin HtmlOutput.

Autorisierung

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

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

sort(columnPosition)

Sortiert ein Tabellenblatt aufsteigend nach Spalten.

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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

sort(columnPosition, ascending)

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

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

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

Parameter

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

Rückflug

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

Autorisierung

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

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

toast(msg)

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

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

Parameter

NameTypBeschreibung
msgStringDie Nachricht, die im Toast angezeigt wird.

Autorisierung

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

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

toast(msg, title)

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

// 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 wird.
titleStringDer optionale Titel des Toasts.

Autorisierung

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

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

toast(msg, title, timeoutSeconds)

Zeigt unten rechts in der Tabelle ein Pop-up-Fenster mit dem angegebenen Titel und angezeigt, die eine bestimmte Zeit lang 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 wird.
titleStringDer optionale Titel des Toasts.
timeoutSecondsNumberDas Zeitlimit in Sekunden. Bei null wird der Toast standardmäßig auf 5 Sekunden eingestellt. Falls negativ, bleibt der Toast bestehen, bis er geschlossen wird.

Autorisierung

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

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

unhideColumn(column)

Blendet die Spalte im angegebenen Bereich ein.

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

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

Parameter

NameTypBeschreibung
columnRangeDer Bereich, der eingeblendet werden soll, falls ausgeblendet.

Autorisierung

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

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

unhideRow(row)

Blendet die Zeile im angegebenen Bereich ein

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

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

Parameter

NameTypBeschreibung
rowRangeDer Bereich, der eingeblendet werden soll, falls ausgeblendet.

Autorisierung

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

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

updateMenu(name, subMenus)

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

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

Parameter

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

Autorisierung

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

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Wartet, bis alle aktuellen Ausführungen in der Tabelle abgeschlossen sind. Nach dem angegebene Anzahl von Sekunden. Löst eine Ausnahme aus, wenn die Ausführungen beim Timing nicht abgeschlossen sind ausgeführt, aber bricht die Datenausführungen nicht ab.

Parameter

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

Autorisierung

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

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

Verworfene Methoden