Class SpreadsheetApp

TabellenkalkulationApp

Auf Google Sheets-Dateien zugreifen und sie erstellen Diese Klasse ist die übergeordnete Klasse für den Tabellendienst.

Attribute

AttributTypBeschreibung
AutoFillSeriesAutoFillSeriesEine Aufzählung der Arten von Reihen, die zum Berechnen automatisch ausgefüllter Werte verwendet werden.
BandingThemeBandingThemeEine Aufzählung der möglichen Themen für das Banding.
BooleanCriteriaBooleanCriteriaEine Aufzählung der 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 der möglichen Farbtypen.
CopyPasteTypeCopyPasteTypeEine Aufzählung der möglichen Einfügetypen.
DataExecutionErrorCodeDataExecutionErrorCodeEine Aufzählung der möglichen Fehlercodes für die Datenausführung.
DataExecutionStateDataExecutionStateEine Aufzählung der möglichen Ausführungsstatus von Daten.
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 von Gruppierungsregeln vom Typ „Datum/Uhrzeit“.
DeveloperMetadataLocationTypeDeveloperMetadataLocationTypeEine Aufzählung der möglichen Standorttypen für Entwicklermetadaten.
DeveloperMetadataVisibilityDeveloperMetadataVisibilityEine Aufzählung der möglichen Sichtbarkeiten von Entwicklermetadaten.
DimensionDimensionEine Aufzählung der möglichen Dimensionen einer Tabelle.
DirectionDirectionEine Aufzählung der möglichen Richtungen, in die man sich in einer Tabelle mit den Pfeiltasten bewegen kann.
FrequencyTypeFrequencyTypeEine Aufzählung der möglichen Häufigkeitstypen.
GroupControlTogglePositionGroupControlTogglePositionEine Aufzählung der Positionen, die der Schalter für die Gruppensteuerung einnehmen kann.
InterpolationTypeInterpolationTypeEine Aufzählung der Interpolationstypen für Farbverläufe bei der bedingten Formatierung.
PivotTableSummarizeFunctionPivotTableSummarizeFunctionEine Aufzählung der Funktionen, die zum Zusammenfassen von Werten in einer Pivot-Tabelle verwendet werden können.
PivotValueDisplayTypePivotValueDisplayTypeEine Aufzählung der Möglichkeiten, wie ein Pivot-Wert dargestellt werden kann.
ProtectionTypeProtectionTypeEine Aufzählung, die die Teile einer Tabelle darstellt, die vor Änderungen geschützt werden können.
RecalculationIntervalRecalculationIntervalEine Aufzählung der möglichen Intervalle, die bei der Neuberechnung von Tabellen verwendet werden können.
RelativeDateRelativeDateEine Aufzählung relativer Datumsoptionen zum Berechnen eines Werts, der in datumsbasierten BooleanCriteria verwendet werden soll.
SheetTypeSheetTypeEine Aufzählung der verschiedenen Arten von Tabellenblättern, die in einer Tabelle vorhanden sein können.
SortOrderSortOrderEine Aufzählung der Sortierreihenfolge.
TextDirectionTextDirectionEine Aufzählung gültiger Textrichtungen.
TextToColumnsDelimiterTextToColumnsDelimiterEine Aufzählung der voreingestellten Trennzeichen für das Aufteilen von Text in Spalten.
ThemeColorTypeThemeColorTypeEine Aufzählung der möglichen Farbtypen für Designs.
ValueTypeValueTypeEine Aufzählung von Wertetypen, die von Range.getValue() und Range.getValues() aus der Range-Klasse des Tabellendienstes zurückgegeben werden. Die unten aufgeführten Aufzählungswerte gelten zusätzlich zu Number, Boolean, Date oder String.
WrapStrategyWrapStrategyEine Aufzählung der Strategien, die zum Umbrechen 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.
enableLookerExecution()voidAktiviert die Datenabfrage für Looker-Datenquellen.
flush()voidWendet alle ausstehenden Tabellenänderungen an.
getActive()SpreadsheetGibt die derzeit aktive Tabelle oder null zurück, wenn keine vorhanden ist.
getActiveRange()RangeGibt den ausgewählten Bereich im aktiven Tabellenblatt zurück oder null, wenn kein aktiver Bereich vorhanden ist.
getActiveRangeList()RangeList|nullGibt die Liste der aktiven Bereiche im aktiven Tabellenblatt oder null zurück, wenn keine Bereiche ausgewählt sind.
getActiveSheet()SheetGibt das aktive Tabellenblatt in einer Tabelle zurück.
getActiveSpreadsheet()SpreadsheetGibt die derzeit aktive Tabelle oder null zurück, wenn keine vorhanden ist.
getCurrentCell()Range|nullGibt die aktuelle (hervorgehobene) Zelle zurück, die in einem der aktiven Bereiche im aktiven Tabellenblatt ausgewählt ist, oder null, wenn keine aktuelle Zelle vorhanden ist.
getSelection()SelectionGibt die aktuelle Selection in der Tabelle zurück.
getUi()UiGibt eine Instanz der Benutzeroberflächenumgebung der Tabelle zurück, mit der dem Script Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzugefügt werden können.
newCellImage()CellImageBuilderErstellt einen Builder für ein CellImage.
newColor()ColorBuilderErstellt einen Builder für ein Color.
newConditionalFormatRule()ConditionalFormatRuleBuilderErstellt einen Builder für eine Regel für die bedingte Formatierung.
newDataSourceSpec()DataSourceSpecBuilderErstellt einen Builder für ein DataSourceSpec.
newDataValidation()DataValidationBuilderErstellt einen Builder für eine Datenvalidierungsregel.
newFilterCriteria()FilterCriteriaBuilderErstellt einen Builder für ein 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, wobei die Zelle oben links im Bereich als current cell verwendet wird.
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. Optional kann die letzte Auswahl in diesem Tabellenblatt wiederhergestellt werden.
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
const ssNew = SpreadsheetApp.create('Finances');
Logger.log(ssNew.getUrl());

Parameter

NameTypBeschreibung
nameStringDer Name der Tabelle.

Rückflug

Spreadsheet – eine neue Tabelle

Autorisierung

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

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

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

  • 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. Mit dieser Methode können Sie die Datenabfrage für alle Datenquellentypen 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

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

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

enableBigQueryExecution()

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

Die Datenausführung für die BigQuery-Datenquelle löst eine Ausnahme aus, 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

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

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

enableLookerExecution()

Aktiviert die Datenabfrage für Looker-Datenquellen.

Die Datenausführung für Looker-Datenquellen löst eine Ausnahme aus, wenn sie nicht aktiviert ist.

// Turns data execution on for Looker data sources.
SpreadsheetApp.enableLookerExecution();

// 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
// associated Looker data.
ss.getDataSourceSheets()[0].refreshData();

flush()

Wendet alle ausstehenden Tabellenänderungen an.

Tabellenkalkulationsvorgänge werden manchmal gebündelt, um die Leistung zu verbessern, z. B. wenn mehrere Aufrufe von „Range.getValue()“ erfolgen. Manchmal möchten Sie jedoch sicherstellen, dass alle ausstehenden Änderungen sofort vorgenommen werden, z. B. um Nutzern Daten während der Ausführung eines Skripts anzuzeigen.

// 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() {
  const sheet = SpreadsheetApp.getActiveSheet();
  for (let 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 derzeit aktive Tabelle oder null zurück, wenn keine vorhanden ist.

Funktionen, die im Kontext einer Tabelle ausgeführt werden, können durch Aufrufen dieser Funktion einen Verweis auf das entsprechende Tabellenobjekt abrufen.

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

Rückflug

Spreadsheet – das aktive Tabellenobjekt

Autorisierung

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

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

getActiveRange()

Gibt den ausgewählten Bereich im aktiven Tabellenblatt zurück oder null, wenn kein aktiver Bereich vorhanden ist. Wenn mehrere Bereiche ausgewählt sind, wird mit dieser Methode nur der zuletzt ausgewählte Bereich zurückgegeben.

Das bedeutet in der Regel den Bereich, den ein Nutzer im aktiven Tabellenblatt ausgewählt hat. In einer benutzerdefinierten Funktion bezieht es sich jedoch auf die Zelle, die gerade neu berechnet wird.

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

Rückflug

Range: Der aktive Bereich.

Autorisierung

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

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

getActiveRangeList()

Gibt die Liste der aktiven Bereiche im aktiven Tabellenblatt oder null zurück, wenn keine Bereiche ausgewählt sind. Der aktive Bereich, der die aktuell markierte Zelle enthält, wird als Letztes in der Liste aufgeführt.

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

// Returns the list of active ranges.
const rangeList = SpreadsheetApp.getActiveRangeList();

Rückflug

RangeList|null – die Liste der aktiven Bereiche

Autorisierung

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

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

getActiveSheet()

Gibt das aktive Tabellenblatt in einer Tabelle zurück.

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

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

Rückflug

Sheet: Das aktive Sheet-Objekt

Autorisierung

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

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

getActiveSpreadsheet()

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

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

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

Rückflug

Spreadsheet – das aktive Tabellenobjekt

Autorisierung

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

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

getCurrentCell()

Gibt die aktuelle (hervorgehobene) Zelle zurück, die in einem der aktiven Bereiche im aktiven Tabellenblatt ausgewählt ist, oder null, wenn keine aktuelle Zelle vorhanden ist.

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

Rückflug

Range|null: die aktuelle Zelle

Autorisierung

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

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

getSelection()

Gibt die aktuelle Selection in der Tabelle zurück.

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

Rückflug

Selection – die aktuelle Auswahl

Autorisierung

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

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

getUi()

Gibt eine Instanz der Benutzeroberflächenumgebung der Tabelle zurück, mit der dem Script Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzugefügt werden können. Ein Script kann nur mit der Benutzeroberfläche der aktuellen Instanz einer geöffneten Tabelle interagieren und nur, wenn das Script an die Tabelle gebunden ist. Weitere Informationen finden Sie in den 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äche dieser Tabelle


newCellImage()

Erstellt einen Builder für ein 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 ein Color.

const rgbColor = SpreadsheetApp.newColor().setRgbColor('#FF0000').build();

Rückflug

ColorBuilder – Der neue Builder.


newConditionalFormatRule()

Erstellt einen Builder für eine Regel für die bedingte Formatierung.

// 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.
const sheet = SpreadsheetApp.getActive().getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenNumberBetween(1, 10)
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Rückflug

ConditionalFormatRuleBuilder: Der neue Builder.


newDataSourceSpec()

Erstellt einen Builder für ein 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.

const cell = SpreadsheetApp.getActive().getRange('A1');
const 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 ein 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.
const cell = SpreadsheetApp.getActive().getRange('A1');
const bold = SpreadsheetApp.newTextStyle().setBold(true).build();
const 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.
const range = SpreadsheetApp.getActive().getRange('A1:B3');
const 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.
const files = DriveApp.searchFiles(
    `starred = true and mimeType = "${MimeType.GOOGLE_SHEETS}"`,
);
while (files.hasNext()) {
  const spreadsheet = SpreadsheetApp.open(files.next());
  const sheet = spreadsheet.getSheets()[0];
  Logger.log(sheet.getName());
}

Parameter

NameTypBeschreibung
fileFileDie zu öffnende Datei.

Rückflug

Spreadsheet – die Tabelle

Autorisierung

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

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

openById(id)

Öffnet die Tabelle mit der angegebenen ID. Eine Tabellen-ID kann aus der URL extrahiert werden. Die Tabellen-ID in der URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 ist beispielsweise „abc1234567“.

// The code below 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).
const ss = SpreadsheetApp.openById('abc1234567');
Logger.log(ss.getName());

Parameter

NameTypBeschreibung
idStringDie eindeutige Kennung für die Tabelle.

Rückflug

Spreadsheet: das Tabellenobjekt mit der angegebenen ID

Autorisierung

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

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

openByUrl(url)

Öffnet die Tabelle mit der angegebenen URL. Löst eine Scripting-Ausnahme aus, wenn die URL nicht vorhanden ist oder der Nutzer keine Berechtigung für den Zugriff darauf hat.

// 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).
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc1234567/edit',
);
console.log(ss.getName());

Parameter

NameTypBeschreibung
urlStringDie URL für die Tabelle.

Rückflug

Spreadsheet – Das Tabellenobjekt mit der angegebenen URL.

Autorisierung

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

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

setActiveRange(range)

Legt den angegebenen Bereich als active range fest, wobei die Zelle oben links im Bereich als current cell verwendet wird.

In der Tabellenblatt-Benutzeroberfläche wird das Tabellenblatt mit dem ausgewählten Bereich angezeigt und die Zellen im ausgewählten Bereich werden markiert.

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

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

Parameter

NameTypBeschreibung
rangeRangeDer Bereich, 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. Der letzte Bereich in der Liste wird als active range festgelegt.

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

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

Parameter

NameTypBeschreibung
rangeListRangeListDie Liste der auszuwählenden Bereiche.

Rückflug

RangeList – die neu ausgewählte Liste von Bereichen

Autorisierung

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

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

setActiveSheet(sheet)

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

// The code below makes the 2nd sheet active in the active spreadsheet.
const 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. Optional kann die letzte Auswahl in diesem Tabellenblatt wiederhergestellt werden. In der Google Tabellen-Benutzeroberfläche wird das ausgewählte Tabellenblatt angezeigt, sofern es nicht zu einer anderen Tabelle gehört.

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

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

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

Parameter

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

Rückflug

Sheet – das neue aktive Tabellenblatt

Autorisierung

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

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

setActiveSpreadsheet(newActiveSpreadsheet)

Legt die aktive Tabelle fest.

// The code below makes the spreadsheet with key "1234567890" the active
// spreadsheet
const 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 zum aktiven Bereich und die Zelle zur aktuellen Zelle.

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

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

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

const selection = SpreadsheetApp.getSelection();
// Current cell: B5
const currentCell = selection.getCurrentCell();

Parameter

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

Rückflug

Range – die neu festgelegte aktuelle Zelle

Autorisierung

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

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