Class SpreadsheetApp

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

Rückflug

Spreadsheet – eine neue Tabelle

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

• 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
const ssNew = SpreadsheetApp.create('Finances', 50, 5);
Logger.log(ssNew.getUrl());

Parameter

Rückflug

Spreadsheet – eine neue Tabelle

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Hiermit wird die Datenausführung für alle Datenquellentypen aktiviert.

Bei der Datenausführung wird eine Ausnahme geworfen, wenn der Datenquellentyp nicht aktiviert ist. Mit dieser Methode können Sie die Datenausführung 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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

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

// 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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

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

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

Wendet alle ausstehenden Änderungen an der Tabelle an.

Tabellenvorgänge werden manchmal zusammengefasst, 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 Scripts zu zeigen.

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

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

Funktionen, die im Kontext einer Tabelle ausgeführt werden, können über diese 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Gibt den ausgewählten Bereich im aktiven Tabellenblatt zurück oder null, wenn kein aktiver Bereich vorhanden ist. Wenn mehrere Bereiche ausgewählt sind, gibt diese Methode nur den zuletzt ausgewählten Bereich zurück.

In der Regel bezieht sich dies auf den Bereich, den ein Nutzer in der aktiven Tabelle ausgewählt hat. In einer benutzerdefinierten Funktion bezieht es sich jedoch auf die Zelle, die aktiv 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Gibt die Liste der aktiven Bereiche im aktiven Tabellenblatt zurück oder null, wenn keine Bereiche ausgewählt sind. Der aktive Bereich, der die aktuell markierte Zelle enthält, wird an letzter Stelle in der Liste eingefügt.

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

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

Rückflug

RangeList – Liste der aktiven Bereiche

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

• 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 Blatt, 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 Tabellenobjekt

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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

Funktionen, die im Kontext einer Tabelle ausgeführt werden, können über diese 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Gibt die aktuelle (markierte) 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 – die aktuelle Zelle

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Gibt das 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Gibt eine Instanz der Benutzeroberfläche 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

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

Erstellt einen Builder für eine Color.

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

Rückflug

ColorBuilder – der neue Builder.

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.

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

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.

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

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.

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.

Öffnet die Tabelle, die dem angegebenen Dateiobjekt 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

Rückflug

Spreadsheet – Tabelle

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Öffnet die Tabelle mit der angegebenen ID. Eine Tabellen-ID kann aus der URL extrahiert werden. Angenommen, die Tabellen-ID in der URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 lautet „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

Rückflug

Spreadsheet: das Tabellenobjekt mit der angegebenen ID

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Öffnet die Tabelle mit der angegebenen URL. Eine Scripting-Ausnahme wird geworfen, wenn die URL nicht existiert oder der Nutzer keine Berechtigung zum 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

Rückflug

Spreadsheet: Das Tabellenobjekt mit der angegebenen URL.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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

In der Tabellenoberfläche wird das Tabellenblatt mit dem ausgewählten Bereich angezeigt und die darin definierten Zellen werden ausgewählt.

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

Rückflug

Range – neuer aktiver Bereich

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

Rückflug

RangeList: die neu ausgewählte Liste von Bereichen

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

• 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-Benutzeroberfläche 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.
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
SpreadsheetApp.setActiveSheet(spreadsheet.getSheets()[1]);

Parameter

Rückflug

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

Hiermit wird das aktive Tabellenblatt in einer Tabelle festgelegt. Außerdem können Sie die letzte Auswahl in diesem Tabellenblatt wiederherstellen. In der Google Tabellen-Benutzeroberfläche wird das ausgewählte Tabellenblatt angezeigt, es sei denn, es gehört zu einer anderen Tabelle.

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

Rückflug

Sheet – das neue aktive Tabellenblatt

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

• 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
const ss = SpreadsheetApp.openById('1234567890');
SpreadsheetApp.setActiveSpreadsheet(ss);

Parameter

Die angegebene Zelle wird als current cell festgelegt.

Wenn sich die angegebene Zelle in einem bereits ausgewählten Bereich befindet, wird dieser Bereich zum aktiven Bereich und die Zelle zur aktuellen Zelle.

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

Hinweis:Die angegebene Range muss aus einer einzelnen Zelle bestehen, andernfalls wird bei 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

Rückflug

Range: die neu festgelegte aktuelle Zelle

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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