Class SpreadsheetApp

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

Zurücksenden

Spreadsheet: eine neue Tabelle

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

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

Zurücksenden

Spreadsheet: eine neue Tabelle

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

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

Die Datenausführung löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Verwenden Sie diese Methode, um die Datenausführung für alle Datenquellentypen zu aktivieren.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

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

Wenn die Datenausführung für BigQuery-Datenquellen nicht aktiviert ist, wird eine Ausnahme ausgelöst.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

Alle ausstehenden Tabellenänderungen werden angewendet.

Tabellenvorgänge werden manchmal gebündelt, um die Leistung zu verbessern, z. B. bei mehreren Aufrufen von Range.getValue(). Es kann jedoch erforderlich sein, alle ausstehenden Änderungen sofort vorzunehmen, um beispielsweise Nutzerdaten 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() {
  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();
  }
}

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

Funktionen, die im Zusammenhang mit 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());

Zurücksenden

Spreadsheet: Das aktive Tabellenobjekt

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

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 letzten ausgewählten Bereich zurück.

Dies ist in der Regel der Bereich, den ein Nutzer im aktiven Tabellenblatt ausgewählt hat. In einer benutzerdefinierten Funktion bezieht sich dies jedoch 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());

Zurücksenden

Range: Der aktive Bereich.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

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

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

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

Zurücksenden

RangeList: Liste der aktiven Bereiche

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

Ruft das aktive Tabellenblatt in einer Tabelle ab.

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

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

Zurücksenden

Sheet: Das aktive Tabellenblatt-Objekt

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

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

Funktionen, die im Zusammenhang mit 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());

Zurücksenden

Spreadsheet: Das aktive Tabellenobjekt

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

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.
var currentCell = SpreadsheetApp.getCurrentCell();

Zurücksenden

Range: die aktuelle Zelle

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

Gibt die aktuelle Selection in der Tabelle zurück.

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

Zurücksenden

Selection: die aktuelle Auswahl

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

Gibt eine Instanz der Benutzeroberfläche der Tabelle zurück, über die das Skript Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzufügen kann. Ein Skript kann nur mit der UI für die aktuelle Instanz einer geöffneten Tabelle interagieren, wenn das Skript an die Tabelle gebunden ist. Weitere Informationen finden Sie in den Leitfäden 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();
}

Zurücksenden

Ui: Instanz der Benutzeroberfläche dieser Tabelle

Erstellt einen Builder für ein CellImage.

Zurücksenden

CellImageBuilder: Der neue Builder.

Erstellt einen Builder für ein Color.

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

Zurücksenden

ColorBuilder: Der neue Builder.

Erstellt einen Builder für eine Regel zur bedingten 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.
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);

Zurücksenden

ConditionalFormatRuleBuilder: Der neue Builder.

Erstellt einen Builder für ein DataSourceSpec.

Zurücksenden

DataSourceSpecBuilder: Der neue Builder.

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

Zurücksenden

DataValidationBuilder: Der neue Builder.

Erstellt einen Builder für ein FilterCriteria.

Zurücksenden

FilterCriteriaBuilder: der neue Builder

Erstellt einen Builder für einen RTF-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);

Zurücksenden

RichTextValueBuilder: Der neue Builder.

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

Zurücksenden

TextStyleBuilder: Der neue Builder.

Ö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

Zurücksenden

Spreadsheet: die Tabelle

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

Ö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 lautet 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

Zurücksenden

Spreadsheet: Das Tabellenobjekt mit der angegebenen ID.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

Öffnet die Tabelle mit der angegebenen URL. Löst eine Ausnahme aus, wenn die URL nicht vorhanden ist oder der Nutzer keine Zugriffsberechtigung dafür hat.

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

Parameter

Zurücksenden

Spreadsheet: Das Tabellenobjekt mit der angegebenen ID.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

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

In der UI der Tabelle wird das Tabellenblatt angezeigt, das den ausgewählten Bereich enthält, und es werden die Zellen ausgewählt, die im ausgewählten Bereich definiert sind.

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

Zurücksenden

Range: der neue aktive Bereich

Legt die angegebene Liste von Bereichen als active ranges fest. Der 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

Zurücksenden

RangeList: die neu ausgewählte Liste von Bereichen

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

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

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

Parameter

Zurücksenden

Sheet: Das Tabellenblatt, das zum neuen aktiven Tabellenblatt erstellt wurde.

Legt das aktive Tabellenblatt in einer Tabelle fest und hat die Möglichkeit, die letzte Auswahl in diesem Tabellenblatt wiederherzustellen. In der Google Tabellen-UI wird das ausgewählte Tabellenblatt angezeigt, es sei denn, es gehört zu einer anderen Tabelle.

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

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

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

Parameter

Zurücksenden

Sheet: das neue aktive Tabellenblatt

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

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

Legt die angegebene Zelle als current cell fest.

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

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

Hinweis: Die angegebene Range muss aus einer Zelle bestehen. Andernfalls löst diese Methode 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

Zurücksenden

Range: die neu festgelegte Zelle

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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