Class SpreadsheetApp

SpreadsheetApp

Auf Google Tabellen-Dateien zugreifen und sie erstellen Diese Klasse ist die übergeordnete Klasse des Tabellendienstes.

Attribute

AttributTypBeschreibung
AutoFillSeriesAutoFillSeriesEine Aufzählung der Typen von Reihen, die zur Berechnung automatisch ausgefüllter Werte verwendet werden.
BandingThemeBandingThemeAufzählung der möglichen Banding-Themen.
BooleanCriteriaBooleanCriteriaEine Aufzählung von booleschen Kriterien für die bedingte Formatierung.
BorderStyleBorderStyleEine Aufzählung der gültigen Stile zum Festlegen von Rahmen für ein Range.
ColorTypeColorTypeEine Aufzählung möglicher Farbtypen.
CopyPasteTypeCopyPasteTypeEine Aufzählung der möglichen Einfügetypen.
DataExecutionErrorCodeDataExecutionErrorCodeEine Aufzählung der möglichen Fehlercodes bei der Datenausführung.
DataExecutionStateDataExecutionStateEine Aufzählung der möglichen Datenausführungsstatus.
DataSourceParameterTypeDataSourceParameterTypeEine Aufzählung der möglichen Datenquellenparametertypen.
DataSourceRefreshScopeDataSourceRefreshScopeEine Aufzählung der möglichen Aktualisierungsbereiche für Datenquellen.
DataSourceTypeDataSourceTypeEine Aufzählung der möglichen Datenquellentypen.
DataValidationCriteriaDataValidationCriteriaEine Aufzählung, die die Kriterien für die Datenvalidierung darstellt, die für einen Bereich festgelegt werden können.
DateTimeGroupingRuleTypeDateTimeGroupingRuleTypeEine Aufzählung der Datums-/Uhrzeit-Gruppierungsregel.
DeveloperMetadataLocationTypeDeveloperMetadataLocationTypeEine Aufzählung der möglichen Speicherorttypen für Entwicklermetadaten.
DeveloperMetadataVisibilityDeveloperMetadataVisibilityEine Aufzählung der möglichen Sichtbarkeiten von Entwicklermetadaten.
DimensionDimensionEine Aufzählung der möglichen Abmessungen einer Tabelle.
DirectionDirectionEine Aufzählung der möglichen Richtungen, die man innerhalb einer Tabelle mithilfe des Pfeils verschieben kann Schlüssel.
FrequencyTypeFrequencyTypeEine Aufzählung der möglichen Häufigkeitstypen.
GroupControlTogglePositionGroupControlTogglePositionEine Aufzählung der Positionen, an denen sich die Ein/Aus-Schaltfläche für die Gruppensteuerung befinden kann.
InterpolationTypeInterpolationTypeEine Aufzählung von Gradienteninterpolationstypen für das bedingte Format.
PivotTableSummarizeFunctionPivotTableSummarizeFunctionEine Aufzählung der Funktionen, mit denen Werte in einer Pivot-Tabelle zusammengefasst werden können.
PivotValueDisplayTypePivotValueDisplayTypeEine Aufzählung, wie ein Pivot-Wert angezeigt werden kann.
ProtectionTypeProtectionTypeEine Aufzählung, die die Teile einer Tabelle darstellt, die vor Bearbeitungen geschützt werden können.
RecalculationIntervalRecalculationIntervalEine Aufzählung der möglichen Intervalle, die bei der Neuberechnung in der Tabellenkalkulation verwendet werden können.
RelativeDateRelativeDateEine Aufzählung relativer Datumsoptionen zum Berechnen eines Werts, der in einer datumsbasierten BooleanCriteria verwendet werden soll.
SheetTypeSheetTypeEine Aufzählung der verschiedenen Arten von Tabellenblättern, die in einer Tabellenkalkulation vorhanden sein können.
SortOrderSortOrderEine Aufzählung der Sortierreihenfolge.
TextDirectionTextDirectionEine Aufzählung gültiger Wegbeschreibungen in Textform.
TextToColumnsDelimiterTextToColumnsDelimiterEine Aufzählung der voreingestellten Trennzeichen für das Aufteilen von Text in Spalten.
ThemeColorTypeThemeColorTypeEine Aufzählung möglicher Farbtypen für Designs.
ValueTypeValueTypeEine Aufzählung der Werttypen, die von Range.getValue() und Range.getValues() aus der Range-Klasse des Tabellendienstes zurückgegeben werden. Die Aufzählungswerte unten aufgeführt sind zusätzlich zu Number, Boolean, Date oder String.
WrapStrategyWrapStrategyEine Aufzählung der Strategien, die für das Umschließen von Zellen verwendet werden.

Methoden

MethodeRückgabetypKurzbeschreibung
create(name)SpreadsheetErstellt eine neue Tabelle mit dem angegebenen Namen.
create(name, rows, columns)SpreadsheetErstellt eine neue Tabelle mit dem angegebenen Namen und der angegebenen Anzahl von Zeilen und Spalten.
enableAllDataSourcesExecution()voidAktiviert die Datenausführung für alle Arten von Datenquellen.
enableBigQueryExecution()voidAktiviert die Datenausführung für BigQuery-Datenquellen.
flush()voidAlle ausstehenden Tabellenänderungen werden angewendet.
getActive()SpreadsheetGibt die aktuell aktive Tabelle zurück oder null, wenn keine Tabelle vorhanden ist.
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 zurück oder null, wenn keine Bereiche vorhanden sind ausgewählt.
getActiveSheet()SheetRuft das aktive Tabellenblatt in einer Tabelle ab.
getActiveSpreadsheet()SpreadsheetGibt die aktuell aktive Tabelle zurück oder null, wenn keine Tabelle vorhanden ist.
getCurrentCell()RangeGibt die aktuelle (hervorgehobene) Zelle zurück, die in einem der aktiven Bereiche im aktives Tabellenblatt oder null, wenn keine Zelle vorhanden ist.
getSelection()SelectionGibt den aktuellen Wert für Selection in der Tabelle zurück.
getUi()UiGibt eine Instanz der Benutzeroberflächenumgebung der Tabelle zurück, die es dem Skript ermöglicht, Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzufügen.
newCellImage()CellImageBuilderErstellt einen Builder für einen CellImage.
newColor()ColorBuilderErstellt einen Builder für einen Color.
newConditionalFormatRule()ConditionalFormatRuleBuilderErstellt einen Builder für eine bedingte Formatierungsregel.
newDataSourceSpec()DataSourceSpecBuilderErstellt einen Builder für einen DataSourceSpec.
newDataValidation()DataValidationBuilderErstellt einen Builder für eine Datenvalidierungsregel.
newFilterCriteria()FilterCriteriaBuilderErstellt einen Builder für einen FilterCriteria.
newRichTextValue()RichTextValueBuilderErstellt einen Builder für einen Rich-Text-Wert.
newTextStyle()TextStyleBuilderErstellt einen Builder für einen Textstil.
open(file)SpreadsheetÖffnet die Tabelle, die dem angegebenen File-Objekt entspricht.
openById(id)SpreadsheetÖffnet die Tabelle mit der angegebenen ID.
openByUrl(url)SpreadsheetÖffnet die Tabelle mit der angegebenen URL.
setActiveRange(range)RangeLegt den angegebenen Bereich als active range fest, mit dem oberen linke Zelle im Bereich als current cell.
setActiveRangeList(rangeList)RangeListLegt die angegebene Liste von Bereichen als active ranges fest.
setActiveSheet(sheet)SheetLegt das aktive Tabellenblatt in einer Tabelle fest.
setActiveSheet(sheet, restoreSelection)SheetLegt das aktive Tabellenblatt in einer Tabelle fest, mit der Option, die letzte Auswahl wiederherzustellen innerhalb dieses Tabellenblatts.
setActiveSpreadsheet(newActiveSpreadsheet)voidLegt die aktive Tabelle fest.
setCurrentCell(cell)RangeLegt die angegebene Zelle als current cell fest.

Detaillierte Dokumentation

create(name)

Erstellt eine neue Tabelle mit dem angegebenen Namen.

// The code below creates a new spreadsheet "Finances" and logs the URL for it
var ssNew = SpreadsheetApp.create("Finances");
Logger.log(ssNew.getUrl());

Parameter

NameTypBeschreibung
nameStringDer Name der Tabelle.

Rückflug

Spreadsheet – eine neue Tabelle

Autorisierung

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

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

create(name, rows, columns)

Erstellt eine neue Tabelle mit dem angegebenen Namen und der angegebenen Anzahl von Zeilen und Spalten.

// The code below creates a new spreadsheet "Finances" with 50 rows and 5 columns and logs the
// URL for it
var ssNew = SpreadsheetApp.create("Finances", 50, 5);
Logger.log(ssNew.getUrl());

Parameter

NameTypBeschreibung
nameStringDer Name der Tabelle.
rowsIntegerDie Anzahl der Zeilen für die Tabelle.
columnsIntegerDie Anzahl der Spalten für die Tabelle.

Rückflug

Spreadsheet – eine neue Tabelle

Autorisierung

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

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

enableAllDataSourcesExecution()

Aktiviert die Datenausführung für alle Arten von Datenquellen.

Bei der Datenausführung wird eine Ausnahme ausgelöst, wenn der Datenquellentyp nicht aktiviert ist. Diese Methode verwenden um die Datenausführung für alle Datenquellentypen zu aktivieren.

// Turns data execution on for all types of data sources.
SpreadsheetApp.enableAllDataSourcesExecution();

// 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 the first data source sheet in the spreadsheet and refreshes the data.
ss.getDataSourceSheets()[0].refreshData();

Autorisierung

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

  • https://www.googleapis.com/auth/bigquery.readonly

enableBigQueryExecution()

Aktiviert die Datenausführung für BigQuery-Datenquellen.

Bei der Datenausführung für die BigQuery-Datenquelle wird eine Ausnahme ausgelöst, wenn sie nicht aktiviert ist.

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

// 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 the first data source sheet in the spreadsheet and refreshes the BigQuery data.
ss.getDataSourceSheets()[0].refreshData();

Autorisierung

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

  • https://www.googleapis.com/auth/bigquery.readonly

flush()

Alle ausstehenden Tabellenänderungen werden angewendet.

Tabellenkalkulationsvorgänge werden manchmal zur Verbesserung der Leistung zusammengefasst, z. B. wenn mehrere Aufrufe von Range.getValue() ausführen. Sie können jedoch auch sicherstellen, Ausstehende Änderungen werden sofort vorgenommen, z. B. um Nutzerdaten anzuzeigen, während ein Skript ausgeführt wird.

// The code below changes the background color of cells A1 and B1 twenty times. You should be
// able to see the updates live in the spreadsheet. If flush() is not called, the updates may
// be applied live or may all be applied at once when the script completes.
function colors() {
  var sheet = SpreadsheetApp.getActiveSheet();
  for (var i = 0; i < 20; i++) {
    if ((i % 2) == 0) {
      sheet.getRange('A1').setBackground('green');
      sheet.getRange('B1').setBackground('red');
    } else {
      sheet.getRange('A1').setBackground('red');
      sheet.getRange('B1').setBackground('green');
    }
    SpreadsheetApp.flush();
  }
}

getActive()

Gibt die aktuell aktive Tabelle zurück oder null, wenn keine Tabelle vorhanden ist.

Funktionen, die im Kontext einer Tabellenkalkulation ausgeführt werden, können einen Verweis auf die entsprechenden Tabellenobjekt enthält, indem Sie diese Funktion aufrufen.

// The code below logs the URL for the active spreadsheet.
Logger.log(SpreadsheetApp.getActive().getUrl());

Rückflug

Spreadsheet – das aktive Tabellenobjekt

Autorisierung

Skripts, die diese Methode 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.

Das ist im Allgemeinen der Bereich, den ein Nutzer auf dem aktiven Tabellenblatt, aber in einem benutzerdefinierten auf die Zelle, die aktiv neu berechnet wird.

// The code below logs the background color for the active range.
var colorObject = SpreadsheetApp.getActiveRange().getBackgroundObject();
// Assume the color has ColorType.RGB.
Logger.log(colorObject.asRgbColor().asHexString());

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

getActiveRangeList()

Gibt die Liste der aktiven Bereiche im aktiven Tabellenblatt zurück oder null, wenn keine Bereiche vorhanden sind ausgewählt. Der aktive Bereich mit der aktuell markierten Zelle wird in der Liste an letzter Stelle platziert.

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

// Returns the list of active ranges.
var rangeList = SpreadsheetApp.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

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.

// The code below logs the name of the active sheet.
Logger.log(SpreadsheetApp.getActiveSheet().getName());

Rückflug

Sheet: das aktive Tabellenblattobjekt

Autorisierung

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

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

getActiveSpreadsheet()

Gibt die aktuell aktive Tabelle zurück oder null, wenn keine Tabelle vorhanden ist.

Funktionen, die im Kontext einer Tabellenkalkulation ausgeführt werden, können einen Verweis auf die entsprechendes Spreadsheet-Objekt durch Aufrufen dieser Funktion.

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

Rückflug

Spreadsheet – das aktive Tabellenobjekt

Autorisierung

Skripts, die diese Methode 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 (hervorgehobene) Zelle zurück, die in einem der aktiven Bereiche im aktives Tabellenblatt oder null, wenn keine Zelle vorhanden ist.

// Returns the current highlighted cell in the one of the active ranges.
var currentCell = SpreadsheetApp.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

getSelection()

Gibt den aktuellen Wert für Selection in der Tabelle zurück.

var selection = SpreadsheetApp.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

getUi()

Gibt eine Instanz der Benutzeroberflächenumgebung der Tabelle zurück, die es dem Skript ermöglicht, Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzufügen. Ein Skript kann nur mit der UI für den aktuelle Instanz einer geöffneten Tabelle und nur dann, wenn das Skript an die Tabelle gebunden ist. Weitere Informationen finden Sie unter Anleitungen zu Menüs und Dialogfeldern und Seitenleisten

// Add a custom menu to the active spreadsheet, including a separator and a sub-menu.
function onOpen(e) {
  SpreadsheetApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(SpreadsheetApp.getUi().createMenu('My sub-menu')
          .addItem('One sub-menu item', 'mySecondFunction')
          .addItem('Another sub-menu item', 'myThirdFunction'))
      .addToUi();
}

Rückflug

Ui: eine Instanz der Benutzeroberflächenumgebung dieser Tabelle


newCellImage()

Erstellt einen Builder für einen CellImage.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A1 on Sheet1.
const range = sheet.getRange('A1');

// Builds an image using a source URL.
const cellImage = SpreadsheetApp.newCellImage()
  .setSourceUrl('https://www.gstatic.com/images/branding/productlogos/apps_script/v10/web-64dp/logo_apps_script_color_1x_web_64dp.png')
  .build();

// Sets the image in cell A1.
range.setValue(cellImage);

Rückflug

CellImageBuilder: Der neue Builder.


newColor()

Erstellt einen Builder für einen Color.

var rgbColor = SpreadsheetApp.newColor().setRgbColor("#FF0000").build();

Rückflug

ColorBuilder: Der neue Builder.


newConditionalFormatRule()

Erstellt einen Builder für eine bedingte Formatierungsregel.

// Adds a conditional format rule to a sheet that causes all cells in range A1:B3 to turn red
// if they contain a number between 1 and 10.
var sheet = SpreadsheetApp.getActive().getActiveSheet();
var range = sheet.getRange('A1:B3');
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberBetween(1, 10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build()
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Rückflug

ConditionalFormatRuleBuilder: der neue Builder.


newDataSourceSpec()

Erstellt einen Builder für einen DataSourceSpec.

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

// Enables BigQuery.
SpreadsheetApp.enableBigQueryExecution();

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

Rückflug

DataSourceSpecBuilder: Der neue Builder.


newDataValidation()

Erstellt einen Builder für eine Datenvalidierungsregel.

var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation()
    .requireNumberBetween(1, 100)
    .setAllowInvalid(false)
    .setHelpText('Number must be between 1 and 100.')
    .build();
cell.setDataValidation(rule);

Rückflug

DataValidationBuilder: Der neue Builder.


newFilterCriteria()

Erstellt einen Builder für einen FilterCriteria.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Sets the range to A1:D20.
const range = sheet.getRange('A1:D20');

// Creates a filter and applies it to the specified range.
range.createFilter();

// Gets the current filter for the range and creates filter criteria that only shows cells
// that aren't empty.
const filter = range.getFilter();
const criteria = SpreadsheetApp.newFilterCriteria().whenCellNotEmpty().build();

// Sets the criteria to  column C.
filter.setColumnFilterCriteria(3, criteria);

Rückflug

FilterCriteriaBuilder – der neue Builder


newRichTextValue()

Erstellt einen Builder für einen Rich-Text-Wert.

// Sets cell A1 to have the text "Hello world", with "Hello" bolded.
var cell = SpreadsheetApp.getActive().getRange('A1');
var bold = SpreadsheetApp.newTextStyle().setBold(true).build();
var value = SpreadsheetApp.newRichTextValue()
    .setText("Hello world")
    .setTextStyle(0, 5, bold)
    .build();
cell.setRichTextValue(value);

Rückflug

RichTextValueBuilder: Der neue Builder.


newTextStyle()

Erstellt einen Builder für einen Textstil.

// Sets range A1:B3 to have red, size 22, bolded, underlined text.
var range = SpreadsheetApp.getActive().getRange('A1:B3');
var style = SpreadsheetApp.newTextStyle()
    .setForegroundColor("red")
    .setFontSize(22)
    .setBold(true)
    .setUnderline(true)
    .build();
range.setTextStyle(style);

Rückflug

TextStyleBuilder: Der neue Builder.


open(file)

Öffnet die Tabelle, die dem angegebenen File-Objekt entspricht.

// Get any starred spreadsheets from Google Drive, then open the spreadsheets and log the name
// of the first sheet within each spreadsheet.
var files = DriveApp.searchFiles(
    'starred = true and mimeType = "' + MimeType.GOOGLE_SHEETS + '"');
while (files.hasNext()) {
  var spreadsheet = SpreadsheetApp.open(files.next());
  var sheet = spreadsheet.getSheets()[0];
  Logger.log(sheet.getName());
}

Parameter

NameTypBeschreibung
fileFileDie zu öffnende Datei.

Rückflug

Spreadsheet – die Tabelle

Autorisierung

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

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

openById(id)

Öffnet die Tabelle mit der angegebenen ID. Eine Tabellen-ID kann aus ihrer URL extrahiert werden. Für In der URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 lautet die Tabellen-ID beispielsweise „abc1234567“.

// The code below opens a spreadsheet using its ID and logs the name for it.
// Note that the spreadsheet is NOT physically opened on the client side.
// It is opened on the server only (for modification by the script).
var ss = SpreadsheetApp.openById("abc1234567");
Logger.log(ss.getName());

Parameter

NameTypBeschreibung
idStringDie eindeutige Kennung der Tabelle.

Rückflug

Spreadsheet – Das Tabellenobjekt mit der angegebenen ID

Autorisierung

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

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

openByUrl(url)

Öffnet die Tabelle mit der angegebenen URL. Löst eine Skriptausnahme aus, wenn die URL nicht vorhanden ist oder der Nutzer nicht darauf zugreifen darf.

// Opens a spreadsheet by its URL and logs its name.
// Note that the spreadsheet doesn't physically open on the client side.
// It opens on the server only (for modification by the script).
var ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc1234567/edit');
console.log(ss.getName());

Parameter

NameTypBeschreibung
urlStringDie URL der Tabelle.

Rückflug

Spreadsheet: Das Tabellenobjekt mit der angegebenen URL.

Autorisierung

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

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

setActiveRange(range)

Legt den angegebenen Bereich als active range fest, mit dem oberen linke Zelle im Bereich als current cell.

Die Benutzeroberfläche der Tabellenkalkulation zeigt das Tabellenblatt an, das den ausgewählten Bereich enthält, und wählt die Zellen aus Bereich definiert ist.

// The code below sets range C1:D4 in the first sheet as the active range.
var range = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('C1:D4');
SpreadsheetApp.setActiveRange(range);

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

Parameter

NameTypBeschreibung
rangeRangeBereich, der zum aktiven Bereich gemacht werden soll.

Rückflug

Range – der neue aktive Bereich


setActiveRangeList(rangeList)

Legt die angegebene Liste von Bereichen als active ranges fest. Die letzte Bereich in der Liste ist als active range festgelegt.

// The code below sets ranges [D4, B2:C4] in the active sheet as the active ranges.
var rangeList = SpreadsheetApp.getActiveSheet().getRanges(['D4', 'B2:C4']);
SpreadsheetApp.setActiveRangeList(rangeList);

var selection = SpreadsheetApp.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

setActiveSheet(sheet)

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

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

Parameter

NameTypBeschreibung
sheetSheetDas neue aktive Tabellenblatt.

Rückflug

Sheet: das Tabellenblatt, das zum neuen aktiven Tabellenblatt gemacht wurde


setActiveSheet(sheet, restoreSelection)

Legt das aktive Tabellenblatt in einer Tabelle fest, mit der Option, die letzte Auswahl wiederherzustellen innerhalb dieses Tabellenblatts. Auf der Benutzeroberfläche von Google Tabellen wird das ausgewählte Tabellenblatt angezeigt, es sei denn, es gehört zu einem Tabelle arbeiten.

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

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

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

Parameter

NameTypBeschreibung
sheetSheetDas neue aktive Tabellenblatt.
restoreSelectionBooleanWenn true, ist die letzte Auswahl des neuen aktiven Tabellenblatts die letzte Auswahl. 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

setActiveSpreadsheet(newActiveSpreadsheet)

Legt die aktive Tabelle fest.

// The code below makes the spreadsheet with key "1234567890" the active spreadsheet
var ss = SpreadsheetApp.openById("1234567890");
SpreadsheetApp.setActiveSpreadsheet(ss);

Parameter

NameTypBeschreibung
newActiveSpreadsheetSpreadsheetDie Tabelle, die zur aktiven Tabelle gemacht werden soll.

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, ist die 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 diese Methode verwendet. löst eine Ausnahme aus.

// The code below sets the cell B5 in the first sheet as the current cell.
var cell = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('B5');
SpreadsheetApp.setCurrentCell(cell);

var selection = SpreadsheetApp.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