Class SpreadsheetApp

Tworzy nowy arkusz kalkulacyjny o podanej nazwie.

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

Parametry

Zwróć

Spreadsheet – nowy arkusz kalkulacyjny

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

Tworzy nowy arkusz kalkulacyjny z podaną nazwą oraz określoną liczbą wierszy i kolumn.

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

Parametry

Zwróć

Spreadsheet – nowy arkusz kalkulacyjny

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

Włącza wykonywanie danych dla wszystkich typów źródeł danych.

Wykonywanie danych zwraca wyjątek, jeśli typ źródła danych nie jest włączony. Użyj tej metody, aby umożliwić wykonywanie danych do wszystkich typów źródeł danych.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

Włącza wykonywanie danych dla źródła danych BigQuery.

Wykonywanie danych dla źródła danych BigQuery zgłasza wyjątek, jeśli nie jest włączony.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

Zastosowanie wszystkich oczekujących zmian w arkuszu kalkulacyjnym.

Operacje w arkuszach kalkulacyjnych są czasami łączone, aby zwiększyć wydajność, np. podczas wielokrotnych wywołań funkcji Range.getValue(). Czasami jednak możesz chcieć od razu wprowadzić wszystkie oczekujące zmiany, na przykład aby wyświetlić dane użytkowników podczas wykonywania skryptu.

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

Zwraca aktywny arkusz kalkulacyjny lub null, jeśli go nie ma.

Funkcje uruchamiane w kontekście arkusza kalkulacyjnego mogą uzyskać odwołanie do odpowiedniego obiektu arkusza kalkulacyjnego, wywołując tę funkcję.

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

Zwróć

Spreadsheet – aktywny obiekt Arkuszy

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

Zwraca wybrany zakres w aktywnym arkuszu lub null, jeśli nie ma aktywnego zakresu. Jeśli wybierzesz wiele zakresów, ta metoda zwróci tylko ostatni wybrany zakres.

Ogólnie oznacza to zakres wybrany przez użytkownika w aktywnym arkuszu, ale w funkcji niestandardowej odnosi się do komórki, która jest aktywnie przeliczana.

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

Zwróć

Range – aktywny zakres.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

Zwraca listę aktywnych zakresów w aktywnym arkuszu lub null, jeśli nie wybrano żadnych zakresów. Aktywny zakres zawierający aktualnie podświetloną komórkę jest umieszczany jako ostatni na liście.

Jeśli wybierzesz jeden zakres, będzie to działać jako wywołanie getActiveRange().

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

Zwróć

RangeList – lista aktywnych zakresów,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

Pobiera aktywny arkusz w arkuszu kalkulacyjnym.

Aktywny arkusz kalkulacyjny to arkusz, który jest wyświetlany w interfejsie arkusza kalkulacyjnego.

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

Zwróć

Sheet – aktywny obiekt Arkuszy

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

Zwraca aktywny arkusz kalkulacyjny lub null, jeśli go nie ma.

Funkcje uruchamiane w kontekście arkusza kalkulacyjnego mogą uzyskać odwołanie do odpowiedniego obiektu Spreadsheet, wywołując tę funkcję.

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

Zwróć

Spreadsheet – aktywny obiekt Arkuszy

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

Zwraca aktualną (wyróżnioną) komórkę wybraną w jednym z aktywnych zakresów w aktywnym arkuszu lub null, jeśli nie ma bieżącej komórki.

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

Zwróć

Range – bieżąca komórka,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

Zwraca aktualną wartość Selection w arkuszu kalkulacyjnym.

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

Zwróć

Selection – obecny wybór

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

Zwraca wystąpienie arkusza kalkulacyjnego i interfejsu użytkownika, które umożliwia skryptowi dodanie funkcji, takich jak menu, okna i paski boczne. Skrypt może wchodzić w interakcję z interfejsem tylko w przypadku bieżącego wystąpienia otwartego arkusza kalkulacyjnego i tylko wtedy, gdy jest on związany z arkuszem kalkulacyjnym. Więcej informacji znajdziesz w przewodnikach dotyczących menu oraz dialogów i pasków bocznych.

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

Zwróć

Ui – wystąpienie tego arkusza kalkulacyjnego oraz środowiska interfejsu użytkownika

Tworzy konstruktor CellImage.

Zwróć

CellImageBuilder – nowy konstruktor.

Tworzy konstruktor Color.

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

Zwróć

ColorBuilder – nowy konstruktor.

Tworzy konstruktor reguły formatowania warunkowego.

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

Zwróć

ConditionalFormatRuleBuilder – nowy konstruktor.

Tworzy konstruktor DataSourceSpec.

Zwróć

DataSourceSpecBuilder – nowy konstruktor.

Tworzy konstruktor reguły weryfikacji danych.

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

Zwróć

DataValidationBuilder – nowy konstruktor.

Tworzy konstruktor FilterCriteria.

Zwróć

FilterCriteriaBuilder – nowy konstruktor

Tworzy konstruktor dla wartości RTF.

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

Zwróć

RichTextValueBuilder – nowy konstruktor.

Tworzy konstruktor stylu tekstowego.

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

Zwróć

TextStyleBuilder – nowy konstruktor.

Otwiera arkusz kalkulacyjny odpowiadający danemu obiektowi w pliku.

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

Parametry

Zwróć

Spreadsheet – arkusz kalkulacyjny

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

Otwiera arkusz kalkulacyjny o podanym identyfikatorze. Identyfikator arkusza kalkulacyjnego można wyodrębnić z adresu URL. Na przykład identyfikator arkusza kalkulacyjnego w adresie URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 to "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());

Parametry

Zwróć

Spreadsheet – obiekt arkusza kalkulacyjnego o podanym identyfikatorze;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

Otwiera arkusz kalkulacyjny z podanym adresem URL. Jeśli URL nie istnieje lub użytkownik nie ma do niego dostępu, zwraca wyjątek skryptu.

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

Parametry

Zwróć

Spreadsheet – obiekt arkusza kalkulacyjnego o podanym identyfikatorze;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

Ustawia określony zakres jako active range, a lewa górna komórka w zakresie to current cell.

Interfejs arkusza kalkulacyjnego wyświetla arkusz zawierający wybrany zakres i wybiera komórki zdefiniowane w tym zakresie.

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

Parametry

Zwróć

Range – nowy aktywny zakres

Ustawia określoną listę zakresów na active ranges. Ostatni zakres na liście jest ustawiony na active range.

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

Parametry

Zwróć

RangeList – nowo wybrana lista zakresów,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

Ustawia aktywny arkusz w arkuszu kalkulacyjnym. Interfejs Arkuszy Google wyświetli wybrany arkusz, chyba że należy on do innego arkusza.

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

Parametry

Zwróć

Sheet – arkusz, który został utworzony jako nowy aktywny arkusz.

Ustawia aktywny arkusz w arkuszu kalkulacyjnym z możliwością przywrócenia ostatniego zaznaczenia w tym arkuszu. Interfejs Arkuszy Google wyświetla wybrany arkusz, chyba że należy on do innego arkusza.

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

Parametry

Zwróć

Sheet – nowy aktywny arkusz

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

Ustawia aktywny arkusz kalkulacyjny.

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

Parametry

Ustawia określoną komórkę jako current cell.

Jeśli określona komórka znajduje się w zakresie, który już wybrano, zakres ten stanie się aktywnym zakresem z tą komórką jako bieżącą.

Jeśli określona komórka nie znajduje się w żadnym zaznaczonym zakresie, istniejący wybór zostanie usunięty, a komórka stanie się bieżącą komórką i aktywnym zakresem.

Uwaga: określony Range musi zawierać jedną komórkę. W przeciwnym razie ta metoda zwróci wyjątek.

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

Parametry

Zwróć

Range – nowo ustawiona bieżąca komórka,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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