Class SpreadsheetApp

SpreadsheetApp

uzyskiwać dostęp do plików Arkuszy Google i je tworzyć; Ta klasa jest klasą nadrzędną dla usługi Arkuszy kalkulacyjnych.

Właściwości

WłaściwośćTypOpis
AutoFillSeriesAutoFillSeriesLista typów serii używanych do obliczania wartości uzupełnionych automatycznie.
BandingThemeBandingThemeLista możliwych motywów pasma.
BooleanCriteriaBooleanCriteriaLista kryteriów wartości logicznych formatowania warunkowego.
BorderStyleBorderStyleLista prawidłowych stylów do ustawiania obramowań w elemencie Range.
ColorTypeColorTypeLista możliwych typów kolorów.
CopyPasteTypeCopyPasteTypeLista możliwych typów wklejania.
DataExecutionErrorCodeDataExecutionErrorCodeLista możliwych kodów błędów uruchamiania danych.
DataExecutionStateDataExecutionStateLista możliwych stanów wykonania danych.
DataSourceParameterTypeDataSourceParameterTypeLista możliwych typów parametrów źródła danych.
DataSourceRefreshScopeDataSourceRefreshScopeLista możliwych zakresów odświeżania źródła danych.
DataSourceTypeDataSourceTypeLista możliwych typów źródeł danych.
DataValidationCriteriaDataValidationCriteriaWyliczenie reprezentujące kryteria sprawdzania poprawności danych, które można ustawić w zakresie.
DateTimeGroupingRuleTypeDateTimeGroupingRuleTypeWyliczenie reguły grupowania „data i godzina”.
DeveloperMetadataLocationTypeDeveloperMetadataLocationTypeLista możliwych typów lokalizacji metadanych dewelopera.
DeveloperMetadataVisibilityDeveloperMetadataVisibilityLista możliwych widoczności metadanych dewelopera.
DimensionDimensionLista możliwych wymiarów arkusza kalkulacyjnego.
DirectionDirectionLista możliwych kierunków, którymi można poruszać się w obrębie arkusza kalkulacyjnego za pomocą strzałki klawiszy.
FrequencyTypeFrequencyTypeLista możliwych typów częstotliwości.
GroupControlTogglePositionGroupControlTogglePositionLista pozycji, w których może znajdować się przełącznik grupy.
InterpolationTypeInterpolationTypeWyliczenie typów interpolacji gradientu formatu warunkowego.
PivotTableSummarizeFunctionPivotTableSummarizeFunctionWyliczenie funkcji, których można użyć do podsumowania wartości w tabeli przestawnej.
PivotValueDisplayTypePivotValueDisplayTypeLista sposobów wyświetlania wartości w tabeli przestawnej.
ProtectionTypeProtectionTypeWyliczenie reprezentujące części arkusza kalkulacyjnego, które mogą być chronione przed edytowaniem.
RecalculationIntervalRecalculationIntervalLista możliwych przedziałów czasu, których można użyć podczas ponownego obliczania w arkuszu kalkulacyjnym.
RelativeDateRelativeDateLista opcji dat względnych służących do obliczania wartości do użycia w funkcji BooleanCriteria na podstawie daty.
SheetTypeSheetTypeLista różnych typów arkuszy, które mogą istnieć w arkuszu kalkulacyjnym.
SortOrderSortOrderOkreślenie kolejności sortowania.
TextDirectionTextDirectionLista prawidłowych kierunków tekstu.
TextToColumnsDelimiterTextToColumnsDelimiterLista gotowych separatorów, by podzielić tekst na kolumny.
ThemeColorTypeThemeColorTypeLista możliwych typów kolorów motywu.
ValueTypeValueTypeWyliczenie typów wartości zwracanych przez funkcje Range.getValue() i Range.getValues() z klasy Range usługi Arkusza kalkulacyjnego. Wartości wyliczenia wymienione poniżej są dodane do zasad Number, Boolean, Date i String.
WrapStrategyWrapStrategyLista strategii używanych do zawijania komórek.

Metody

MetodaZwracany typKrótki opis
create(name)SpreadsheetTworzy nowy arkusz o podanej nazwie.
create(name, rows, columns)SpreadsheetTworzy nowy arkusz kalkulacyjny o podanej nazwie oraz określonej liczbie wierszy i kolumn.
enableAllDataSourcesExecution()voidWłącza wykonywanie zapytań do bazy danych w przypadku wszystkich typów źródeł danych.
enableBigQueryExecution()voidWłącza wykonywanie danych w przypadku źródeł danych BigQuery.
enableLookerExecution()voidWłącza wykonywanie danych w przypadku źródeł danych Lookera.
flush()voidZastosowano wszystkie oczekujące zmiany w arkuszu kalkulacyjnym.
getActive()SpreadsheetZwraca obecnie aktywny arkusz kalkulacyjny lub wartość null, jeśli nie ma żadnego.
getActiveRange()RangeZwraca wybrany zakres w aktywnym arkuszu lub null, jeśli nie ma aktywnego zakresu.
getActiveRangeList()RangeListZwraca listę aktywnych zakresów w aktywnym arkuszu lub null, jeśli nie ma żadnych zakresów zaznaczono.
getActiveSheet()SheetPobiera aktywny arkusz w arkuszu kalkulacyjnym.
getActiveSpreadsheet()SpreadsheetZwraca obecnie aktywny arkusz kalkulacyjny lub wartość null, jeśli nie ma żadnego.
getCurrentCell()RangeZwraca bieżącą (podświetloną) komórkę, która jest zaznaczona w jednym z aktywnych zakresów aktywny arkusz, lub null, jeśli nie ma bieżącej komórki.
getSelection()SelectionZwraca bieżącą Selection z arkusza kalkulacyjnego.
getUi()UiZwraca wystąpienie środowiska interfejsu użytkownika arkusza kalkulacyjnego, które umożliwia skryptowi dodać funkcje, takie jak menu, okna dialogowe i paski boczne;
newCellImage()CellImageBuilderTworzy kreator dla: CellImage.
newColor()ColorBuilderTworzy kreator dla: Color.
newConditionalFormatRule()ConditionalFormatRuleBuilderTworzy konstruktora reguły formatowania warunkowego.
newDataSourceSpec()DataSourceSpecBuilderTworzy kreator dla: DataSourceSpec.
newDataValidation()DataValidationBuilderTworzy konstruktor na potrzeby reguły sprawdzania poprawności danych.
newFilterCriteria()FilterCriteriaBuilderTworzy kreator dla: FilterCriteria.
newRichTextValue()RichTextValueBuilderTworzy narzędzie do tworzenia wartości tekstu sformatowanego.
newTextStyle()TextStyleBuilderTworzy narzędzie do tworzenia stylu tekstu.
open(file)SpreadsheetOtwiera arkusz kalkulacyjny odpowiadający danemu obiektowi File.
openById(id)SpreadsheetOtwiera arkusz kalkulacyjny o podanym identyfikatorze.
openByUrl(url)SpreadsheetOtwiera arkusz kalkulacyjny z podanym adresem URL.
setActiveRange(range)RangeUstawia określony zakres jako active range, przy czym górna część to lewa komórka w zakresie jako current cell.
setActiveRangeList(rangeList)RangeListUstawia określoną listę zakresów jako active ranges.
setActiveSheet(sheet)SheetUstawia aktywny arkusz w arkuszu kalkulacyjnym.
setActiveSheet(sheet, restoreSelection)SheetUstawia aktywny arkusz w arkuszu kalkulacyjnym, umożliwiając przywrócenie ostatniego zaznaczenia w tym arkuszu.
setActiveSpreadsheet(newActiveSpreadsheet)voidUstawia aktywny arkusz kalkulacyjny.
setCurrentCell(cell)RangeUstawia określoną komórkę jako current cell.

Szczegółowa dokumentacja

create(name)

Tworzy nowy arkusz 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

NazwaTypOpis
nameStringNazwa arkusza kalkulacyjnego.

Powrót

Spreadsheet – nowy arkusz kalkulacyjny

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

create(name, rows, columns)

Tworzy nowy arkusz kalkulacyjny o podanej nazwie oraz określonej liczbie 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

NazwaTypOpis
nameStringNazwa arkusza kalkulacyjnego.
rowsIntegerLiczba wierszy w arkuszu kalkulacyjnym.
columnsIntegerLiczba kolumn arkusza kalkulacyjnego.

Powrót

Spreadsheet – nowy arkusz kalkulacyjny

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

enableAllDataSourcesExecution()

Włącza wykonywanie zapytań do bazy danych w przypadku wszystkich typów źródeł danych.

Jeśli typ źródła danych nie jest włączony, uruchomienie danych powoduje zgłoszenie wyjątku. Użyj tej metody , aby włączyć wykonywanie danych we wszystkich typach źródeł danych.

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

enableBigQueryExecution()

Włącza wykonywanie danych w przypadku źródeł danych BigQuery.

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

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

enableLookerExecution()

Włącza wykonywanie danych w przypadku źródeł danych Lookera.

Wykonanie danych dla źródła danych Lookera zgłasza wyjątek, jeśli nie jest włączone.

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

Zastosowano wszystkie oczekujące zmiany w arkuszu kalkulacyjnym.

Operacje w arkuszu kalkulacyjnym są czasami łączone, by poprawić wydajność, na przykład wielokrotnych wywołań funkcji Range.getValue(). Czasami warto jednak upewnić się, że wszystkie zmiany oczekujące są wprowadzane natychmiast, na przykład w celu wyświetlania danych użytkowników w trakcie 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();
  }
}

getActive()

Zwraca obecnie aktywny arkusz kalkulacyjny lub wartość null, jeśli nie ma żadnego.

Funkcje uruchamiane w kontekście arkusza kalkulacyjnego mogą uzyskać odniesienie do funkcji odpowiadający obiektowi arkusza kalkulacyjnego przez wywołanie tej funkcji.

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

Powrót

Spreadsheet – aktywny obiekt arkusza kalkulacyjnego,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getActiveRange()

Zwraca wybrany zakres w aktywnym arkuszu lub null, jeśli nie ma aktywnego zakresu. Jeśli wybrano wiele zakresów. Ta metoda zwraca tylko ostatnio wybrany zakres.

Zwykle oznacza to zakres wybrany przez użytkownika w aktywnym arkuszu, ale w niestandardowym arkuszu oznacza komórkę, 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());

Powrót

Range – aktywny zakres.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getActiveRangeList()

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

Jeśli wybierzesz 1 zakres, ta operacja będzie działać jak wywołanie getActiveRange().

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

Powrót

RangeList – lista aktywnych zakresów

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getActiveSheet()

Pobiera aktywny arkusz w arkuszu kalkulacyjnym.

Aktywny arkusz w arkuszu kalkulacyjnym to arkusz wyświetlany w arkuszu kalkulacyjnym. Interfejs.

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

Powrót

Sheet – aktywny obiekt Arkuszy,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getActiveSpreadsheet()

Zwraca obecnie aktywny arkusz kalkulacyjny lub wartość null, jeśli nie ma żadnego.

Funkcje uruchamiane w kontekście arkusza kalkulacyjnego mogą uzyskać odniesienie do funkcji odpowiadającego odpowiedniemu obiektowi Spreadsheet przez wywołanie tej funkcji.

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

Powrót

Spreadsheet – aktywny obiekt arkusza kalkulacyjnego,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getCurrentCell()

Zwraca bieżącą (podświetloną) komórkę, która jest zaznaczona w jednym z aktywnych zakresów aktywny arkusz, 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();

Powrót

Range – bieżąca komórka,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getSelection()

Zwraca bieżącą Selection z arkusza kalkulacyjnego.

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

Powrót

Selection – bieżący wybór

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getUi()

Zwraca wystąpienie środowiska interfejsu użytkownika arkusza kalkulacyjnego, które umożliwia skryptowi dodać funkcje, takie jak menu, okna dialogowe i paski boczne; Skrypt może wchodzić w interakcje z interfejsem tylko w przypadku bieżącego wystąpienia otwartego arkusza kalkulacyjnego i tylko wtedy, gdy skrypt jest powiązany z tym arkuszem. Więcej informacji: przewodniki po menu oraz oknach i paskach 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();
}

Powrót

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


newCellImage()

Tworzy kreator dla: 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);

Powrót

CellImageBuilder – nowy kreator.


newColor()

Tworzy kreator dla: Color.

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

Powrót

ColorBuilder – nowy kreator.


newConditionalFormatRule()

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

Powrót

ConditionalFormatRuleBuilder – nowy kreator.


newDataSourceSpec()

Tworzy kreator dla: 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);

Powrót

DataSourceSpecBuilder – nowy kreator.


newDataValidation()

Tworzy konstruktor na potrzeby reguły sprawdzania poprawności 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);

Powrót

DataValidationBuilder – nowy kreator.


newFilterCriteria()

Tworzy kreator dla: 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);

Powrót

FilterCriteriaBuilder – nowy kreator


newRichTextValue()

Tworzy narzędzie do tworzenia wartości tekstu sformatowanego.

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

Powrót

RichTextValueBuilder – nowy kreator.


newTextStyle()

Tworzy narzędzie do tworzenia stylu tekstu.

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

Powrót

TextStyleBuilder – nowy kreator.


open(file)

Otwiera arkusz kalkulacyjny odpowiadający danemu obiektowi File.

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

NazwaTypOpis
fileFilePlik do otwarcia.

Powrót

Spreadsheet – arkusz kalkulacyjny

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

openById(id)

Otwiera arkusz kalkulacyjny o podanym identyfikatorze. Identyfikator arkusza kalkulacyjnego można wyodrębnić z jego adresu URL. Dla: np. 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

NazwaTypOpis
idStringUnikalny identyfikator arkusza kalkulacyjnego.

Powrót

Spreadsheet – obiekt arkusza kalkulacyjnego o podanym identyfikatorze;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

openByUrl(url)

Otwiera arkusz kalkulacyjny z podanym adresem URL. Zgłasza wyjątek skryptu, jeśli URL nie istnieje lub użytkownik nie ma uprawnień dostępu do pliku.

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

Parametry

NazwaTypOpis
urlStringAdres URL arkusza kalkulacyjnego.

Powrót

Spreadsheet – obiekt arkusza kalkulacyjnego o podanym adresie URL.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setActiveRange(range)

Ustawia określony zakres jako active range, przy czym górna część to lewa komórka w zakresie jako current cell.

Interfejs arkusza kalkulacyjnego wyświetla arkusz zawierający wybrany zakres i zaznacza komórki zdefiniowane w wybranym 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

NazwaTypOpis
rangeRangeZakres, który ma zostać ustawiony jako aktywny.

Powrót

Range – nowy aktywny zakres


setActiveRangeList(rangeList)

Ustawia określoną listę zakresów jako active ranges. Ostatni 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

NazwaTypOpis
rangeListRangeListLista zakresów do wyboru.

Powrót

RangeList – nowo wybrana lista zakresów.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setActiveSheet(sheet)

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

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

Parametry

NazwaTypOpis
sheetSheetNowy aktywny arkusz.

Powrót

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


setActiveSheet(sheet, restoreSelection)

Ustawia aktywny arkusz w arkuszu kalkulacyjnym, umożliwiając przywrócenie ostatniego zaznaczenia w tym arkuszu. Interfejs Arkuszy Google wyświetla wybrany arkusz, chyba że należy on do w innym arkuszu kalkulacyjnym.

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

NazwaTypOpis
sheetSheetNowy aktywny arkusz.
restoreSelectionBooleanJeśli true, ostatni zaznaczony nowy aktywny arkusz zostanie zaznaczony ponownie w miarę uaktywnienia nowego arkusza. jeśli false, nowy arkusz stanie się aktywne bez zmiany bieżącego wyboru.

Powrót

Sheet – nowy aktywny arkusz

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setActiveSpreadsheet(newActiveSpreadsheet)

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

NazwaTypOpis
newActiveSpreadsheetSpreadsheetArkusz kalkulacyjny, który ma zostać ustawiony jako aktywny.

setCurrentCell(cell)

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

Jeśli określona komórka znajduje się w już wybranym zakresie, zakres aktywny z komórką jako bieżącą.

Jeśli określonej komórki nie ma w żadnym wybranym zakresie, obecnie wybrana komórka jest zostanie usunięta, a komórka stanie się bieżącą komórką i aktywnym zakresem.

Uwaga: Range musi składać się z jednej komórki. W przeciwnym razie ta metoda zgłasza 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

NazwaTypOpis
cellRangeKomórka, która ma zostać ustawiona jako bieżąca.

Powrót

Range – nowo ustawiona komórka,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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