Class SpreadsheetApp

Arkusz kalkulacyjnyaplikacja

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

Właściwości

WłaściwośćTypOpis
AutoFillSeriesAutoFillSeriesWyliczenie typów serii używanych do obliczania wartości autouzupełnianych.
BandingThemeBandingThemeWyliczenie możliwych motywów pasm.
BooleanCriteriaBooleanCriteriaWyliczenie kryteriów logicznych formatowania warunkowego.
BorderStyleBorderStyleWyliczenie prawidłowych stylów ustawiania obramowań w przypadku elementu Range.
ColorTypeColorTypeWyliczenie możliwych typów kolorów.
CopyPasteTypeCopyPasteTypeWyliczenie możliwych typów wklejania.
DataExecutionErrorCodeDataExecutionErrorCodeWyliczenie możliwych kodów błędów wykonania danych.
DataExecutionStateDataExecutionStateWyliczenie możliwych stanów wykonania danych.
DataSourceParameterTypeDataSourceParameterTypeWyliczenie możliwych typów parametrów źródła danych.
DataSourceRefreshScopeDataSourceRefreshScopeWyliczenie możliwych zakresów odświeżania źródła danych.
DataSourceTypeDataSourceTypeWyliczenie 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”.
DeveloperMetadataLocationTypeDeveloperMetadataLocationTypeWyliczenie możliwych typów lokalizacji metadanych dewelopera.
DeveloperMetadataVisibilityDeveloperMetadataVisibilityWyliczenie możliwych widoczności metadanych dewelopera.
DimensionDimensionWyliczenie możliwych wymiarów arkusza kalkulacyjnego.
DirectionDirectionWyliczenie możliwych kierunków, w których można się poruszać w arkuszu kalkulacyjnym za pomocą klawiszy strzałek.
FrequencyTypeFrequencyTypeWyliczenie możliwych typów częstotliwości.
GroupControlTogglePositionGroupControlTogglePositionWyliczenie pozycji, w których może znajdować się przełącznik sterowania grupą.
InterpolationTypeInterpolationTypeWyliczenie typów interpolacji gradientu formatowania warunkowego.
PivotTableSummarizeFunctionPivotTableSummarizeFunctionWyliczenie funkcji, których można używać do sumowania wartości w tabeli przestawnej.
PivotValueDisplayTypePivotValueDisplayTypeWyliczenie sposobów wyświetlania wartości w tabeli przestawnej.
ProtectionTypeProtectionTypeWyliczenie reprezentujące części arkusza kalkulacyjnego, które można chronić przed edycją.
RecalculationIntervalRecalculationIntervalWyliczenie możliwych interwałów, których można używać podczas ponownego obliczania arkusza kalkulacyjnego.
RelativeDateRelativeDateWyliczenie opcji dat względnych do obliczania wartości, która ma być używana w BooleanCriteria opartych na dacie.
SheetTypeSheetTypeWyliczenie różnych typów arkuszy, które mogą występować w arkuszu kalkulacyjnym.
SortOrderSortOrderWyliczenie kolejności sortowania.
TextDirectionTextDirectionWyliczenie prawidłowych kierunków tekstu.
TextToColumnsDelimiterTextToColumnsDelimiterWyliczenie gotowych ograniczników do dzielenia tekstu na kolumny.
ThemeColorTypeThemeColorTypeWyliczenie możliwych typów kolorów motywu.
ValueTypeValueTypeWyliczenie typów wartości zwracanych przez funkcje Range.getValue()Range.getValues() z klasy Range usługi Arkusze kalkulacyjne. Wartości wyliczenia wymienione poniżej są dodatkowe w stosunku do wartości Number, Boolean, DateString.
WrapStrategyWrapStrategyWyliczenie strategii używanych do zawijania komórek.

Metody

MetodaZwracany typKrótki opis
create(name)SpreadsheetTworzy nowy arkusz kalkulacyjny o podanej nazwie.
create(name, rows, columns)SpreadsheetTworzy nowy arkusz kalkulacyjny o podanej nazwie i 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 zapytań do bazy danych w przypadku źródeł danych Looker.
flush()voidStosuje wszystkie oczekujące zmiany w arkuszu kalkulacyjnym.
getActive()SpreadsheetZwraca obecnie aktywny arkusz kalkulacyjny lub null, jeśli nie ma żadnego.
getActiveRange()RangeZwraca wybrany zakres w aktywnym arkuszu lub null, jeśli nie ma aktywnego zakresu.
getActiveRangeList()RangeList|nullZwraca listę aktywnych zakresów w aktywnym arkuszu lub null, jeśli nie ma wybranych zakresów.
getActiveSheet()SheetPobiera aktywny arkusz w arkuszu kalkulacyjnym.
getActiveSpreadsheet()SpreadsheetZwraca obecnie aktywny arkusz kalkulacyjny lub null, jeśli nie ma żadnego.
getCurrentCell()Range|nullZwraca bieżącą (wyróżnioną) komórkę wybraną w jednym z aktywnych zakresów w aktywnym arkuszu lub null, jeśli nie ma bieżącej komórki.
getSelection()SelectionZwraca bieżącą Selection w arkuszu kalkulacyjnym.
getUi()UiZwraca instancję środowiska interfejsu użytkownika arkusza kalkulacyjnego, która umożliwia skryptowi dodawanie funkcji takich jak menu, okna i paski boczne.
newCellImage()CellImageBuilderTworzy kreator dla elementu CellImage.
newColor()ColorBuilderTworzy kreator dla elementu Color.
newConditionalFormatRule()ConditionalFormatRuleBuilderTworzy narzędzie do tworzenia reguły formatowania warunkowego.
newDataSourceSpec()DataSourceSpecBuilderTworzy kreator dla elementu DataSourceSpec.
newDataValidation()DataValidationBuilderTworzy narzędzie do tworzenia reguły sprawdzania poprawności danych.
newFilterCriteria()FilterCriteriaBuilderTworzy kreator dla elementu FilterCriteria.
newRichTextValue()RichTextValueBuilderTworzy narzędzie do tworzenia wartości sformatowanego tekstu.
newTextStyle()TextStyleBuilderTworzy kreator 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 o podanym adresie URL.
setActiveRange(range)RangeUstawia określony zakres jako active range, a lewą górną komórkę 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 z opcją przywrócenia ostatniego wyboru 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 kalkulacyjny o podanej nazwie.

// The code below creates a new spreadsheet "Finances" and logs the URL for it
const 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 użyciem co najmniej jednego z tych zakresów:

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

create(name, rows, columns)

Tworzy nowy arkusz kalkulacyjny o podanej nazwie i 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
const 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 użyciem co najmniej jednego 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.

Wykonanie danych zgłasza wyjątek, jeśli typ źródła danych nie jest włączony. Użyj tej metody, aby włączyć wykonywanie zapytań do bazy danych w przypadku wszystkich typów ź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 użyciem co najmniej jednego z tych zakresów:

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

enableBigQueryExecution()

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

Jeśli nie jest włączone, wykonywanie danych w przypadku źródła danych BigQuery zgłasza wyjątek.

// 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 użyciem co najmniej jednego z tych zakresów:

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

enableLookerExecution()

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

Jeśli ta opcja nie jest włączona, wykonanie danych w przypadku źródła danych Looker powoduje zgłoszenie wyjątku.

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

Stosuje wszystkie oczekujące zmiany w arkuszu kalkulacyjnym.

Operacje na arkuszach kalkulacyjnych są czasami łączone w pakiety, aby zwiększyć wydajność, np. podczas wykonywania wielu wywołań funkcji Range.getValue(). Czasami jednak możesz chcieć mieć pewność, że wszystkie oczekujące zmiany zostaną wprowadzone od razu, np. aby wyświetlać użytkownikom dane 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() {
  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()

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

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.getActive().getUrl());

Powrót

Spreadsheet – aktywny obiekt arkusza kalkulacyjnego;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 ostatni z nich.

Zwykle 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.
const 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 użyciem co najmniej jednego 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 wybranych zakresów. Aktywny zakres zawierający aktualnie wyróżnioną komórkę jest umieszczany na końcu listy.

Jeśli wybrano pojedynczy zakres, działa to jak wywołanie getActiveRange().

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

Powrót

RangeList|null – lista aktywnych zakresów.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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, który jest wyświetlany w interfejsie arkusza kalkulacyjnego.

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

Powrót

Sheet – aktywny obiekt arkusza;

Autoryzacja

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

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

getActiveSpreadsheet()

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

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

Powrót

Spreadsheet – aktywny obiekt arkusza kalkulacyjnego;

Autoryzacja

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

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

getCurrentCell()

Zwraca bieżącą (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.
const currentCell = SpreadsheetApp.getCurrentCell();

Powrót

Range|null – bieżąca komórka

Autoryzacja

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

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

getSelection()

Zwraca bieżącą Selection w arkuszu kalkulacyjnym.

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

Powrót

Selection – bieżący wybór;

Autoryzacja

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

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

getUi()

Zwraca instancję środowiska interfejsu użytkownika arkusza kalkulacyjnego, która umożliwia skryptowi dodawanie funkcji takich jak menu, okna i paski boczne. Skrypt może wchodzić w interakcję z interfejsem tylko w przypadku bieżącej instancji otwartego arkusza kalkulacyjnego i tylko wtedy, gdy jest powiązany z tym arkuszem. Więcej informacji znajdziesz w przewodnikach dotyczących menu oraz okien dialogowych 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();
}

Powrót

Ui – instancja środowiska interfejsu użytkownika tego arkusza kalkulacyjnego.


newCellImage()

Tworzy kreator dla elementu 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 elementu Color.

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

Powrót

ColorBuilder – nowy kreator.


newConditionalFormatRule()

Tworzy narzędzie do tworzenia 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.
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);

Powrót

ConditionalFormatRuleBuilder – nowy kreator.


newDataSourceSpec()

Tworzy kreator dla elementu 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 narzędzie do tworzenia reguły sprawdzania poprawności danych.

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

Powrót

DataValidationBuilder – nowy kreator.


newFilterCriteria()

Tworzy kreator dla elementu 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 sformatowanego tekstu.

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

Powrót

RichTextValueBuilder – nowy kreator.


newTextStyle()

Tworzy kreator stylu tekstu.

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

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

Parametry

NazwaTypOpis
fileFilePlik do otwarcia.

Powrót

Spreadsheet – arkusz kalkulacyjny

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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. 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).
const 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 użyciem co najmniej jednego z tych zakresów:

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

openByUrl(url)

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

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

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 użyciem co najmniej jednego z tych zakresów:

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

setActiveRange(range)

Ustawia określony zakres jako active range, a lewą górną komórkę w zakresie jako current cell.

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

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

Parametry

NazwaTypOpis
rangeRangeZakres, który ma stać się aktywny.

Powrót

Range – nowy aktywny zakres.


setActiveRangeList(rangeList)

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

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

Parametry

NazwaTypOpis
rangeListRangeListLista zakresów do wyboru.

Powrót

RangeList – nowo wybrana lista zakresów.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 należy on do innego arkusza kalkulacyjnego.

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

Parametry

NazwaTypOpis
sheetSheetNowy aktywny arkusz.

Powrót

Sheet – arkusz, który stał się nowym aktywnym arkuszem.


setActiveSheet(sheet, restoreSelection)

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

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

Parametry

NazwaTypOpis
sheetSheetNowy aktywny arkusz.
restoreSelectionBooleanJeśli true, ostatni wybór nowego aktywnego arkusza zostanie ponownie wybrany, gdy nowy arkusz stanie się aktywny; jeśli false, nowy arkusz stanie się aktywny bez zmiany bieżącego wyboru.

Powrót

Sheet – nowy aktywny arkusz.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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
const ss = SpreadsheetApp.openById('1234567890');
SpreadsheetApp.setActiveSpreadsheet(ss);

Parametry

NazwaTypOpis
newActiveSpreadsheetSpreadsheetArkusz kalkulacyjny, który ma stać się aktywnym arkuszem kalkulacyjnym.

setCurrentCell(cell)

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

Jeśli wskazana komórka znajduje się w już wybranym zakresie, ten zakres staje się aktywny, a komórka staje się bieżącą komórką.

Jeśli określona komórka nie występuje w żadnym z wybranych zakresów, bieżące zaznaczenie zostanie usunięte, a komórka stanie się bieżącą komórką i aktywnym zakresem.

Uwaga: określony zakres Range musi składać się z 1 komórki. W przeciwnym razie ta metoda zgłosi wyjątek.

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

Parametry

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

Powrót

Range – nowo ustawiona bieżąca komórka

Autoryzacja

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

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