Class Spreadsheet

Arkusz kalkulacyjny

Uzyskiwanie dostępu do plików Arkuszy Google i modyfikowanie ich. Typowym działaniem jest dodawanie nowych arkuszy i współpracowników.

Metody

MetodaZwracany typKrótki opis
addDeveloperMetadata(key)SpreadsheetDodaje do arkusza kalkulacyjnego najwyższego poziomu metadane dewelopera z określonym kluczem.
addDeveloperMetadata(key, visibility)SpreadsheetDodaje do arkusza kalkulacyjnego metadane dewelopera z określonym kluczem i widocznością.
addDeveloperMetadata(key, value)SpreadsheetDodaje do arkusza kalkulacyjnego metadane dewelopera z określonym kluczem i wartością.
addDeveloperMetadata(key, value, visibility)SpreadsheetDodaje do arkusza kalkulacyjnego metadane dewelopera z określonym kluczem, wartością i widocznością.
addEditor(emailAddress)SpreadsheetDodaje wybranego użytkownika do listy edytorów Spreadsheet.
addEditor(user)SpreadsheetDodaje wybranego użytkownika do listy edytorów Spreadsheet.
addEditors(emailAddresses)SpreadsheetDodaje podaną tablicę użytkowników do listy edytorów Spreadsheet.
addMenu(name, subMenus)voidTworzy nowe menu w interfejsie arkusza kalkulacyjnego.
addViewer(emailAddress)SpreadsheetDodaje danego użytkownika do listy przeglądających stronę Spreadsheet.
addViewer(user)SpreadsheetDodaje danego użytkownika do listy przeglądających stronę Spreadsheet.
addViewers(emailAddresses)SpreadsheetDodaje podaną tablicę użytkowników do listy użytkowników elementu Spreadsheet.
appendRow(rowContents)SheetDodaje wiersz na dole bieżącego regionu danych w arkuszu.
autoResizeColumn(columnPosition)SheetUstawia szerokość danej kolumny, by pasowała do jej zawartości.
copy(name)SpreadsheetKopiuje arkusz kalkulacyjny i zwraca nowy.
createDeveloperMetadataFinder()DeveloperMetadataFinderZwraca wartość DeveloperMetadataFinder do znajdowania metadanych dewelopera w zakresie tego arkusza kalkulacyjnego.
createTextFinder(findText)TextFinderTworzy wyszukiwarkę tekstu w arkuszu kalkulacyjnym, której można używać do znajdowania i zastępowania tekstu w arkuszu kalkulacyjnym.
deleteActiveSheet()SheetUsuwa aktualnie aktywny arkusz.
deleteColumn(columnPosition)SheetUsuwa kolumnę znajdującą się w podanej pozycji.
deleteColumns(columnPosition, howMany)voidUsuwa liczbę kolumn, zaczynając od określonej pozycji kolumny.
deleteRow(rowPosition)SheetUsuwa wiersz od podanej pozycji.
deleteRows(rowPosition, howMany)voidUsuwa określoną liczbę wierszy, zaczynając od określonej pozycji wiersza.
deleteSheet(sheet)voidUsuwa określony arkusz.
duplicateActiveSheet()SheetPowoduje skopiowanie aktywnego arkusza i ustawienie go jako aktywnego.
getActiveCell()RangeZwraca aktywną komórkę w tym arkuszu.
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 funkcję null, jeśli nie ma aktywnych zakresów.
getActiveSheet()SheetPobiera aktywny arkusz z arkusza kalkulacyjnego.
getAs(contentType)BlobZwraca dane wewnątrz tego obiektu jako obiekt blob przekonwertowany na określony typ treści.
getBandings()Banding[]Zwraca wszystkie pasma w tym arkuszu kalkulacyjnym.
getBlob()BlobZwróć dane wewnątrz tego obiektu jako obiekt blob.
getColumnWidth(columnPosition)IntegerPobiera szerokość danej kolumny w pikselach.
getCurrentCell()RangeZwraca bieżącą komórkę w aktywnym arkuszu lub null, jeśli nie ma żadnej komórki.
getDataRange()RangeZwraca wartość Range odpowiadającą wymiarowi, w którym znajdują się dane.
getDataSourceFormulas()DataSourceFormula[]Pobiera wszystkie formuły źródeł danych.
getDataSourcePivotTables()DataSourcePivotTable[]Pobiera wszystkie tabele przestawne źródła danych.
getDataSourceRefreshSchedules()DataSourceRefreshSchedule[]Pobiera harmonogramy odświeżania tego arkusza kalkulacyjnego.
getDataSourceSheets()DataSourceSheet[]Zwraca wszystkie arkusze źródła danych w arkuszu kalkulacyjnym.
getDataSourceTables()DataSourceTable[]Pobiera wszystkie tabele źródeł danych.
getDataSources()DataSource[]Zwraca wszystkie źródła danych w arkuszu kalkulacyjnym.
getDeveloperMetadata()DeveloperMetadata[]Pobiera metadane dewelopera powiązane z arkuszem kalkulacyjnym najwyższego poziomu.
getEditors()User[]Pobiera listę redaktorów tego elementu (Spreadsheet).
getFormUrl()StringZwraca adres URL formularza, który wysyła odpowiedzi do tego arkusza kalkulacyjnego, lub null, jeśli arkusz kalkulacyjny nie ma powiązanego formularza.
getFrozenColumns()IntegerZwraca liczbę zablokowanych kolumn.
getFrozenRows()IntegerZwraca liczbę zablokowanych wierszy.
getId()StringPobiera unikalny identyfikator tego arkusza kalkulacyjnego.
getImages()OverGridImage[]Zwraca wszystkie obrazy znajdujące się w siatce w arkuszu.
getIterativeCalculationConvergenceThreshold()NumberZwraca wartość progową używaną podczas obliczeń iteracyjnych.
getLastColumn()IntegerZwraca pozycję ostatniej kolumny, która zawiera treść.
getLastRow()IntegerZwraca pozycję ostatniego wiersza zawierającego treść.
getMaxIterativeCalculationCycles()IntegerZwraca maksymalną liczbę iteracji do użycia podczas obliczeń iteracyjnych.
getName()StringPobiera nazwę dokumentu.
getNamedRanges()NamedRange[]Pobiera wszystkie zakresy nazwane z tego arkusza kalkulacyjnego.
getNumSheets()IntegerZwraca liczbę arkuszy w tym arkuszu kalkulacyjnym.
getOwner()UserZwraca właściciela dokumentu lub null w przypadku dokumentu na dysku współdzielonym.
getPredefinedSpreadsheetThemes()SpreadsheetTheme[]Zwraca listę wstępnie zdefiniowanych motywów.
getProtections(type)Protection[]Pobiera tablicę obiektów reprezentujących wszystkie chronione zakresy lub arkusze w arkuszu kalkulacyjnym.
getRange(a1Notation)RangeZwraca zakres określony w notacji A1 lub notacji R1C1.
getRangeByName(name)RangeZwraca zakres nazwany lub null, jeśli nie znaleziono zakresu o podanej nazwie.
getRangeList(a1Notations)RangeListZwraca kolekcję RangeList reprezentującą zakresy w tym samym arkuszu określoną za pomocą niepustej listy notacji A1 lub R1C1.
getRecalculationInterval()RecalculationIntervalZwraca interwał obliczeniowy dla tego arkusza kalkulacyjnego.
getRowHeight(rowPosition)IntegerPobiera wysokość w pikselach danego wiersza.
getSelection()SelectionZwraca bieżącą wartość Selection z arkusza kalkulacyjnego.
getSheetByName(name)SheetZwraca arkusz o podanej nazwie.
getSheetId()IntegerZwraca identyfikator arkusza reprezentowanego przez ten obiekt.
getSheetName()StringZwraca nazwę arkusza.
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]Zwraca prostokątną siatkę wartości z tego zakresu, zaczynając od podanych współrzędnych.
getSheets()Sheet[]Pobiera wszystkie arkusze z tego arkusza kalkulacyjnego.
getSpreadsheetLocale()StringPobiera ustawienia regionalne arkusza kalkulacyjnego.
getSpreadsheetTheme()SpreadsheetThemeZwraca bieżący motyw arkusza kalkulacyjnego lub wartość null, jeśli motyw nie został zastosowany.
getSpreadsheetTimeZone()StringPobiera strefę czasową arkusza kalkulacyjnego.
getUrl()StringZwraca adres URL podanego arkusza kalkulacyjnego.
getViewers()User[]Pobiera listę przeglądających i komentujących tego elementu (Spreadsheet).
hideColumn(column)voidUkrywa kolumnę lub kolumny w podanym zakresie.
hideRow(row)voidUkrywa wiersze w podanym zakresie.
insertColumnAfter(afterPosition)SheetWstawia kolumnę po podanej pozycji kolumny.
insertColumnBefore(beforePosition)SheetWstawia kolumnę przed podaną pozycją kolumny.
insertColumnsAfter(afterPosition, howMany)SheetWstawia liczbę kolumn po określonej pozycji kolumny.
insertColumnsBefore(beforePosition, howMany)SheetWstawia liczbę kolumn przed podaną pozycją kolumny.
insertDataSourceSheet(spec)DataSourceSheetWstawianie nowego elementu DataSourceSheet w arkuszu kalkulacyjnym i rozpoczynanie wykonywania danych.
insertImage(blobSource, column, row)OverGridImageWstawia Spreadsheet jako obraz w dokumencie w danym wierszu i kolumnie.
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageWstawia Spreadsheet jako obraz w dokumencie w danym wierszu i kolumnie z przesunięciem piksela.
insertImage(url, column, row)OverGridImageWstawia obraz w dokumencie w danym wierszu i kolumnie.
insertImage(url, column, row, offsetX, offsetY)OverGridImageWstawia obraz w dokumencie w danym wierszu i kolumnie z odsunięciem pikseli.
insertRowAfter(afterPosition)SheetWstawia wiersz po podanej pozycji wiersza.
insertRowBefore(beforePosition)SheetWstawia wiersz przed podaną pozycją wiersza.
insertRowsAfter(afterPosition, howMany)SheetWstawia liczbę wierszy po podanej pozycji wiersza.
insertRowsBefore(beforePosition, howMany)SheetWstawia liczbę wierszy przed podaną pozycją wiersza.
insertSheet()SheetWstawia do arkusza kalkulacyjnego nowy arkusz z domyślną nazwą arkusza.
insertSheet(sheetIndex)SheetWstawia do arkusza kalkulacyjnego nowy arkusz o podanym indeksie.
insertSheet(sheetIndex, options)SheetWstawianie do arkusza kalkulacyjnego nowego arkusza o podanym indeksie i przy użyciu opcjonalnych argumentów zaawansowanych.
insertSheet(options)SheetWstawia do arkusza kalkulacyjnego nowy arkusz z domyślną nazwą arkusza i opcjonalnymi argumentami zaawansowanymi.
insertSheet(sheetName)SheetWstawia do arkusza kalkulacyjnego nowy arkusz o podanej nazwie.
insertSheet(sheetName, sheetIndex)SheetWstawia do arkusza kalkulacyjnego nowy arkusz o podanej nazwie w podanym indeksie.
insertSheet(sheetName, sheetIndex, options)SheetWstawia do arkusza kalkulacyjnego nowy arkusz o podanej nazwie w podanym indeksie i używa opcjonalnych argumentów zaawansowanych.
insertSheet(sheetName, options)SheetWstawia do arkusza kalkulacyjnego nowy arkusz o podanej nazwie i używa opcjonalnych argumentów zaawansowanych.
insertSheetWithDataSourceTable(spec)SheetWstawia nowy arkusz w arkuszu kalkulacyjnym, tworzy obiekt DataSourceTable obejmujący cały arkusz o podanej specyfikacji źródła danych i rozpoczyna wykonywanie kodu.
isColumnHiddenByUser(columnPosition)BooleanZwraca, czy dana kolumna jest ukryta przez użytkownika.
isIterativeCalculationEnabled()BooleanWskazuje, czy w arkuszu kalkulacyjnym włączono obliczenia iteracyjne.
isRowHiddenByFilter(rowPosition)BooleanZwraca, czy dany wiersz jest ukryty przez filtr (a nie przez widok filtra).
isRowHiddenByUser(rowPosition)BooleanZwraca, czy dany wiersz jest ukryty przez użytkownika.
moveActiveSheet(pos)voidPrzenosi aktywny arkusz w określone miejsce na liście arkuszy.
moveChartToObjectSheet(chart)SheetTworzy nowy arkusz SheetType.OBJECT i przenosi do niego udostępniony wykres.
refreshAllDataSources()voidOdświeża wszystkie obsługiwane źródła danych i powiązane z nimi obiekty źródeł danych, pomijając nieprawidłowe obiekty źródeł danych.
removeEditor(emailAddress)SpreadsheetUsuwa danego użytkownika z listy edytorów Spreadsheet.
removeEditor(user)SpreadsheetUsuwa danego użytkownika z listy edytorów Spreadsheet.
removeMenu(name)voidUsuwa menu dodane przez użytkownika addMenu(name, subMenus).
removeNamedRange(name)voidUsuwa zakres nazwany o podanej nazwie.
removeViewer(emailAddress)SpreadsheetUsuwa danego użytkownika z listy przeglądających i komentujących elementu Spreadsheet.
removeViewer(user)SpreadsheetUsuwa danego użytkownika z listy przeglądających i komentujących elementu Spreadsheet.
rename(newName)voidZmienia nazwę dokumentu.
renameActiveSheet(newName)voidZmienia nazwę aktualnie aktywnego arkusza na podaną nową nazwę.
resetSpreadsheetTheme()SpreadsheetThemeUsuwa zastosowany motyw i ustawia motyw domyślny w arkuszu kalkulacyjnym.
setActiveRange(range)RangeUstawia określony zakres jako active range w aktywnym arkuszu, przy czym lewa górna komórka w zakresie to current cell.
setActiveRangeList(rangeList)RangeListUstawia określoną listę zakresów jako active ranges w aktywnym arkuszu.
setActiveSelection(range)RangeOkreśla aktywny region wyboru na potrzeby tego arkusza.
setActiveSelection(a1Notation)RangeUstawia aktywny wybór zgodnie z notacją A1 lub notacją R1C1.
setActiveSheet(sheet)SheetUstawia dany arkusz jako aktywny w arkuszu kalkulacyjnym.
setActiveSheet(sheet, restoreSelection)SheetUstawia dany arkusz jako aktywny w arkuszu kalkulacyjnym. Istnieje też możliwość przywrócenia ostatniego zaznaczenia w tym arkuszu.
setColumnWidth(columnPosition, width)SheetUstawia szerokość danej kolumny w pikselach.
setCurrentCell(cell)RangeUstawia określoną komórkę jako current cell.
setFrozenColumns(columns)voidBlokuje podaną liczbę kolumn.
setFrozenRows(rows)voidBlokuje podaną liczbę wierszy.
setIterativeCalculationConvergenceThreshold(minThreshold)SpreadsheetUstawia minimalną wartość progową dla obliczeń iteracyjnych.
setIterativeCalculationEnabled(isEnabled)SpreadsheetOkreśla, czy w tym arkuszu kalkulacyjnym mają być aktywowane obliczenia iteracyjne.
setMaxIterativeCalculationCycles(maxIterations)SpreadsheetOkreśla maksymalną liczbę iteracji obliczeń, które należy wykonać podczas obliczeń iteracyjnych.
setNamedRange(name, range)voidOkreśla zakres.
setRecalculationInterval(recalculationInterval)SpreadsheetOkreśla, jak często ten arkusz kalkulacyjny ma być przeliczany.
setRowHeight(rowPosition, height)SheetUstawia wysokość wiersza w danym wierszu w pikselach.
setSpreadsheetLocale(locale)voidOkreśla język arkusza kalkulacyjnego.
setSpreadsheetTheme(theme)SpreadsheetThemeUstawia motyw w arkuszu kalkulacyjnym.
setSpreadsheetTimeZone(timezone)voidUstawia strefę czasową dla arkusza kalkulacyjnego.
show(userInterface)voidWyświetla niestandardowy komponent interfejsu w oknie wyśrodkowanym w obszarze widocznym w przeglądarce użytkownika.
sort(columnPosition)SheetSortuje arkusz według kolumny rosnąco.
sort(columnPosition, ascending)SheetSortuje arkusz według kolumny.
toast(msg)voidW prawym dolnym rogu arkusza kalkulacyjnego wyświetla wyskakujące okienko z podaną wiadomością.
toast(msg, title)voidW prawym dolnym rogu arkusza kalkulacyjnego wyświetla wyskakujące okienko z wiadomością i tytułem.
toast(msg, title, timeoutSeconds)voidW prawym dolnym rogu arkusza kalkulacyjnego wyświetla wyskakujące okienko z podanym tytułem i komunikatem, które jest widoczne przez określony czas.
unhideColumn(column)voidOdkrywa kolumnę w podanym zakresie.
unhideRow(row)voidOdkrywa wiersz w podanym zakresie.
updateMenu(name, subMenus)voidAktualizuje menu dodane przez użytkownika addMenu(name, subMenus).
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidCzekam, aż wszystkie bieżące wykonania w arkuszu kalkulacyjnym zostaną ukończone, limit czasu następuje po podanej liczbie sekund.

Szczegółowa dokumentacja

addDeveloperMetadata(key)

Dodaje do arkusza kalkulacyjnego najwyższego poziomu metadane dewelopera z określonym kluczem.

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

// Adds the key 'NAME' in the developer metadata for the spreadsheet.
ss.addDeveloperMetadata('NAME')

// Gets the first developer metadata object and logs its key.
const developerMetaData = ss.getDeveloperMetadata()[0]
console.log(developerMetaData.getKey())

Parametry

NazwaTypOpis
keyStringKlucz do nowych metadanych dewelopera.

Powrót

Spreadsheet – arkusz kalkulacyjny służący do tworzenia łańcuchów.

Upoważnienie

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

addDeveloperMetadata(key, visibility)

Dodaje do arkusza kalkulacyjnego metadane dewelopera z określonym kluczem i widocznością.

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

// Adds the key 'NAME' in the developer metadata for the spreadsheet and sets the visibility
// to the developer project that created the metadata.
ss.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

// Gets the first developer metadata object and logs its key and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()},
.             Visibility: ${developerMetaData.getVisibility()}`);

Parametry

NazwaTypOpis
keyStringKlucz do nowych metadanych dewelopera.
visibilityDeveloperMetadataVisibilityWidoczność nowych metadanych dewelopera.

Powrót

Spreadsheet – arkusz kalkulacyjny służący do tworzenia łańcuchów.

Upoważnienie

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

addDeveloperMetadata(key, value)

Dodaje do arkusza kalkulacyjnego metadane dewelopera z określonym kluczem i wartością.

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

// Adds the key 'NAME' and sets the value to 'GOOGLE' in the developer metadata for the
// spreadsheet.
ss.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the first developer metadata object and logs its key and value.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()}, Value: ${developerMetaData.getValue()}`);

Parametry

NazwaTypOpis
keyStringKlucz do nowych metadanych dewelopera.
valueStringWartość nowych metadanych dewelopera.

Powrót

Spreadsheet – arkusz kalkulacyjny służący do tworzenia łańcuchów.

Upoważnienie

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

addDeveloperMetadata(key, value, visibility)

Dodaje do arkusza kalkulacyjnego metadane dewelopera z określonym kluczem, wartością i widocznością.

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

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to any developer project with document access.
ss.addDeveloperMetadata('NAME', 'GOOGLE', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

// Gets the first developer metadata object and logs its key, value, and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(`Key: ${developerMetaData.getKey()},
             Value: ${developerMetaData.getValue()},
             Visibility: ${developerMetaData.getVisibility()}`);

Parametry

NazwaTypOpis
keyStringKlucz do nowych metadanych dewelopera.
valueStringWartość nowych metadanych dewelopera.
visibilityDeveloperMetadataVisibilityWidoczność nowych metadanych dewelopera.

Powrót

Spreadsheet – arkusz kalkulacyjny służący do tworzenia łańcuchów.

Upoważnienie

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

addEditor(emailAddress)

Dodaje wybranego użytkownika do listy edytorów Spreadsheet. Jeśli użytkownik był już na liście widzów, ta metoda promuje go z listy widzów.

Parametry

NazwaTypOpis
emailAddressStringAdres e-mail użytkownika, którego chcesz dodać.

Powrót

Spreadsheet – ten element (Spreadsheet) na potrzeby łańcuchów.

Upoważnienie

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

addEditor(user)

Dodaje wybranego użytkownika do listy edytorów Spreadsheet. Jeśli użytkownik był już na liście widzów, ta metoda promuje go z listy widzów.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika, którego chcesz dodać.

Powrót

Spreadsheet – ten element (Spreadsheet) na potrzeby łańcuchów.

Upoważnienie

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

addEditors(emailAddresses)

Dodaje podaną tablicę użytkowników do listy edytorów Spreadsheet. Jeśli którykolwiek z użytkowników był już na liście widzów, ta metoda spowoduje jego awansowanie z listy widzów.

Parametry

NazwaTypOpis
emailAddressesString[]Tablica adresów e-mail użytkowników do dodania.

Powrót

Spreadsheet – ten element (Spreadsheet) na potrzeby łańcuchów.

Upoważnienie

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

addMenu(name, subMenus)

Tworzy nowe menu w interfejsie arkusza kalkulacyjnego.

Każda pozycja menu uruchamia funkcję zdefiniowaną przez użytkownika. Zwykle trzeba je wywoływać z funkcji onOpen(), aby menu było tworzone automatycznie podczas wczytywania arkusza kalkulacyjnego.

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  var menuEntries = [];
  // When the user clicks on "addMenuExample" then "Menu Entry 1", the function function1 is
  // executed.
  menuEntries.push({name: "Menu Entry 1", functionName: "function1"});
  menuEntries.push(null); // line separator
  menuEntries.push({name: "Menu Entry 2", functionName: "function2"});

  ss.addMenu("addMenuExample", menuEntries);
}

Parametry

NazwaTypOpis
nameStringNazwa menu do utworzenia.
subMenusObject[]Tablica map JavaScript z parametrami name i functionName . Możesz używać funkcji z dołączonych bibliotek, takich jak Library.libFunction1.

Upoważnienie

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

addViewer(emailAddress)

Dodaje danego użytkownika do listy przeglądających stronę Spreadsheet. Jeśli użytkownik był już na liście edytorów, ta metoda nie działa.

Parametry

NazwaTypOpis
emailAddressStringAdres e-mail użytkownika, którego chcesz dodać.

Powrót

Spreadsheet – ten element (Spreadsheet) na potrzeby łańcuchów.

Upoważnienie

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

addViewer(user)

Dodaje danego użytkownika do listy przeglądających stronę Spreadsheet. Jeśli użytkownik był już na liście edytorów, ta metoda nie działa.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika, którego chcesz dodać.

Powrót

Spreadsheet – ten element (Spreadsheet) na potrzeby łańcuchów.

Upoważnienie

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

addViewers(emailAddresses)

Dodaje podaną tablicę użytkowników do listy użytkowników elementu Spreadsheet. Jeśli którykolwiek z użytkowników był już na liście edytorów, ta metoda nie ma dla niego żadnego wpływu.

Parametry

NazwaTypOpis
emailAddressesString[]Tablica adresów e-mail użytkowników do dodania.

Powrót

Spreadsheet – ten element (Spreadsheet) na potrzeby łańcuchów.

Upoważnienie

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

appendRow(rowContents)

Dodaje wiersz na dole bieżącego regionu danych w arkuszu. Jeśli zawartość komórki zaczyna się od =, jest ona interpretowana jako formuła.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Appends a new row with 3 columns to the bottom of the current
// data region in the sheet containing the values in the array.
sheet.appendRow(["a man", "a plan", "panama"]);

Parametry

NazwaTypOpis
rowContentsObject[]Tablica wartości do wstawienia po ostatnim wierszu w arkuszu.

Powrót

Sheet – arkusz przydatny do tworzenia łańcuchów metod.

Upoważnienie

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

autoResizeColumn(columnPosition)

Ustawia szerokość danej kolumny, by pasowała do jej zawartości.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.getRange('a1').setValue('Whenever it is a damp, drizzly November in my soul...');

// Sets the first column to a width which fits the text
sheet.autoResizeColumn(1);

Parametry

NazwaTypOpis
columnPositionIntegerPozycja danej kolumny, której rozmiar ma zostać zmieniony.

Powrót

Sheet – arkusz przydatny do tworzenia łańcuchów metod.

Upoważnienie

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

copy(name)

Kopiuje arkusz kalkulacyjny i zwraca nowy.

// This code makes a copy of the current spreadsheet and names it appropriately
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.copy("Copy of " + ss.getName());

Parametry

NazwaTypOpis
nameStringNazwa kopii.

Powrót

Spreadsheet – arkusz kalkulacyjny służący do tworzenia łańcuchów.

Upoważnienie

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

createDeveloperMetadataFinder()

Zwraca wartość DeveloperMetadataFinder do znajdowania metadanych dewelopera w zakresie tego arkusza kalkulacyjnego. Domyślnie uwzględniane są wszystkie metadane powiązane z arkuszem kalkulacyjnym, arkuszami, wierszami i kolumnami.

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

// Adds developer metadata to the spreadsheet.
ss.addDeveloperMetadata('NAME', 'CHARLIE');
ss.addDeveloperMetadata('COMPANY', 'EXAMPLE ORGANIZATION');
ss.addDeveloperMetadata('TECHNOLOGY', 'JAVASCRIPT');

// Creates a developer metadata finder.
const developerMetadataFinder = ss.createDeveloperMetadataFinder();

// Finds the developer metadata objects with 'COMPANY' as the key.
const googleMetadataFromSpreadsheet = developerMetadataFinder.withKey('COMPANY').find();

// Gets the first result of developer metadata that has the key 'COMPANY' and logs its value.
console.log(googleMetadataFromSpreadsheet[0].getValue());

Powrót

DeveloperMetadataFinder – wyszukiwarka metadanych dla programistów umożliwiająca wyszukiwanie metadanych w zakresie tego arkusza kalkulacyjnego.


createTextFinder(findText)

Tworzy wyszukiwarkę tekstu w arkuszu kalkulacyjnym, której można używać do znajdowania i zastępowania tekstu w arkuszu kalkulacyjnym. Wyszukiwanie rozpoczyna się od pierwszego arkusza arkusza kalkulacyjnego.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

// Creates  a text finder.
var textFinder = spreadsheet.createTextFinder('dog');

// Returns the first occurrence of 'dog' in the spreadsheet.
var firstOccurrence = textFinder.findNext();

// Replaces the last found occurrence of 'dog' with 'cat' and returns the number
// of occurrences replaced.
var numOccurrencesReplaced = findOccurrence.replaceWith('cat');

Parametry

NazwaTypOpis
findTextStringTekst do wyszukania.

Powrót

TextFinderTextFinder dla arkusza kalkulacyjnego.


deleteActiveSheet()

Usuwa aktualnie aktywny arkusz.

// The code below deletes the currently active sheet and stores the new active sheet in a
// variable
var newSheet = SpreadsheetApp.getActiveSpreadsheet().deleteActiveSheet();

Powrót

Sheet – nowy aktywny arkusz.

Upoważnienie

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

deleteColumn(columnPosition)

Usuwa kolumnę znajdującą się w podanej pozycji.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first column
sheet.deleteColumn(1);

Parametry

NazwaTypOpis
columnPositionIntegerPozycja kolumny, od 1 w pierwszej kolumnie.

Powrót

Sheet – arkusz przydatny do tworzenia łańcuchów metod.

Upoważnienie

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

deleteColumns(columnPosition, howMany)

Usuwa liczbę kolumn, zaczynając od określonej pozycji kolumny.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first two columns
sheet.deleteColumns(1, 2);

Parametry

NazwaTypOpis
columnPositionIntegerPozycja pierwszej kolumny do usunięcia.
howManyIntegerLiczba kolumn do usunięcia.

Upoważnienie

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

deleteRow(rowPosition)

Usuwa wiersz od podanej pozycji.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first row
sheet.deleteRow(1);

Parametry

NazwaTypOpis
rowPositionIntegerPozycja wiersza, zaczynająca się od 1 w pierwszym wierszu.

Powrót

Sheet – arkusz przydatny do tworzenia łańcuchów metod.

Upoważnienie

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

deleteRows(rowPosition, howMany)

Usuwa określoną liczbę wierszy, zaczynając od określonej pozycji wiersza.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first two rows
sheet.deleteRows(1, 2);

Parametry

NazwaTypOpis
rowPositionIntegerPozycja pierwszego wiersza do usunięcia.
howManyIntegerLiczba wierszy do usunięcia.

Upoważnienie

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

deleteSheet(sheet)

Usuwa określony arkusz.

// The code below deletes the specified sheet.
var ss = SpreadsheetApp.getActive();
var sheet = ss.getSheetByName('My Sheet');
ss.deleteSheet(sheet);

Parametry

NazwaTypOpis
sheetSheetArkusz do usunięcia.

Upoważnienie

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

duplicateActiveSheet()

Powoduje skopiowanie aktywnego arkusza i ustawienie go jako aktywnego.

// The code below makes a duplicate of the active sheet
SpreadsheetApp.getActiveSpreadsheet().duplicateActiveSheet();

Powrót

Sheet – nowy arkusz.

Upoważnienie

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

getActiveCell()

Zwraca aktywną komórkę w tym arkuszu.

Uwaga: zalecamy użycie getCurrentCell(), który zwraca aktualnie zaznaczoną komórkę.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Returns the active cell
var cell = sheet.getActiveCell();

Powrót

Range – bieżąca aktywna komórka,

Upoważnienie

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. W przypadku wybrania wielu zakresów ta metoda zwraca tylko ostatnio wybrany zakres.

Termin „zakres aktywny” odnosi się do zakresu wybranego przez użytkownika w aktywnym arkuszu, a w funkcji niestandardowej odnosi się do komórki, która jest aktywnie przeliczana.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var activeRange = sheet.getActiveRange();

Powrót

Range – aktywny zakres,

Upoważnienie

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

Zobacz też


getActiveRangeList()

Zwraca listę aktywnych zakresów w aktywnym arkuszu lub funkcję null, jeśli nie ma aktywnych zakresów.

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

var sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
var activeRangeList = sheet.getActiveRangeList();

Powrót

RangeList – lista aktywnych zakresów.

Upoważnienie

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

Zobacz też


getActiveSheet()

Pobiera aktywny arkusz z arkusza kalkulacyjnego.

Aktywny arkusz w arkuszu kalkulacyjnym to arkusz wyświetlany w jego interfejsie.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();

Powrót

Sheet – aktywny arkusz w arkuszu kalkulacyjnym.


getAs(contentType)

Zwraca dane wewnątrz tego obiektu jako obiekt blob przekonwertowany na określony typ treści. Ta metoda dodaje do nazwy pliku odpowiednie rozszerzenie, na przykład „mojplik.pdf”. Przyjmuje się jednak, że część nazwy pliku, która następuje po ostatniej kropce (jeśli występuje), jest rozszerzeniem, które należy zastąpić. W związku z tym „ShoppingList.12.25.2014” zmieni się na „ShoppingList.12.25.pdf”.

Informacje o dziennych limitach konwersji znajdziesz w artykule Limity w usługach Google. Nowo utworzone domeny Google Workspace mogą być tymczasowo objęte bardziej rygorystycznymi limitami.

Parametry

NazwaTypOpis
contentTypeStringTyp MIME, na który mają być konwertowane pliki. W przypadku większości obiektów blob jedyną prawidłową opcją jest 'application/pdf'. W przypadku obrazów w formacie BMP, GIF, JPEG lub PNG można użyć dowolnego z tych elementów: 'image/bmp', 'image/gif', 'image/jpeg' lub 'image/png'.

Powrót

Blob – dane w postaci obiektów blobów.


getBandings()

Zwraca wszystkie pasma w tym arkuszu kalkulacyjnym.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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 an array of the bandings in the spreadsheet.
const bandings = ss.getBandings();

// Logs the range of the first banding in the spreadsheet to the console.
console.log(bandings[0].getRange().getA1Notation());

Powrót

Banding[] – pasma w tym arkuszu kalkulacyjnym.

Upoważnienie

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

getBlob()

Zwróć dane wewnątrz tego obiektu jako obiekt blob.

Powrót

Blob – dane w postaci obiektów blobów.


getColumnWidth(columnPosition)

Pobiera szerokość danej kolumny w pikselach.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.getColumnWidth(1));

Parametry

NazwaTypOpis
columnPositionIntegerPołożenie kolumny do sprawdzenia.

Powrót

Integer – szerokość kolumny w pikselach

Upoważnienie

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ą komórkę w aktywnym arkuszu lub null, jeśli nie ma żadnej komórki. Bieżąca komórka to ta, która jest zaznaczona w interfejsie Arkuszy Google i jest podświetlona ciemną obwódką. Nie ma więcej niż jednej komórki. Gdy użytkownik wybierze co najmniej jeden zakres komórek, jedną z komórek w zaznaczeniu będzie bieżąca komórka.

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

Powrót

Range – bieżąca komórka,

Upoważnienie

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

getDataRange()

Zwraca wartość Range odpowiadającą wymiarowi, w którym znajdują się dane.

Jest to funkcjonalnie odpowiednik utworzenia zakresu ograniczonego przez komórki A1 i (Sheet.getLastColumn(), Sheet.getLastRow()).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This represents ALL the data
var range = sheet.getDataRange();
var values = range.getValues();

// This logs the spreadsheet in CSV format with a trailing comma
for (var i = 0; i < values.length; i++) {
  var row = "";
  for (var j = 0; j < values[i].length; j++) {
    if (values[i][j]) {
      row = row + values[i][j];
    }
    row = row + ",";
  }
  Logger.log(row);
}

Powrót

Range – zakres składający się ze wszystkich danych z arkusza kalkulacyjnego;

Upoważnienie

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

getDataSourceFormulas()

Pobiera wszystkie formuły źródeł danych.

// Opens the spreadsheet by its ID. If you created your script from within a Google Sheets
// file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source formulas on Sheet1.
// To get an array of data source formulas for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceFormulas = sheet.getDataSourceFormulas();

// Logs the first data source formula in the array.
console.log(dataSourceFormulas[0].getFormula());

Powrót

DataSourceFormula[] – lista formuł źródła danych.

Upoważnienie

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

getDataSourcePivotTables()

Pobiera wszystkie tabele przestawne źródła danych.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source pivot tables on Sheet1.
// To get an array of data source pivot tables for the entire
// spreadsheet, replace 'sheet' with 'ss'.
const dataSourcePivotTables = sheet.getDataSourcePivotTables();

// Logs the last time that the first pivot table in the array was refreshed.
console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

Powrót

DataSourcePivotTable[] – lista tabel przestawnych źródeł danych.

Upoważnienie

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

getDataSourceRefreshSchedules()

Pobiera harmonogramy odświeżania tego arkusza kalkulacyjnego.

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

// Activates BigQuery operations for the connected spreadsheet.
SpreadsheetApp.enableBigQueryExecution();

// Gets the frequency type of the first referesh schedule in the array.
const frequencyType = ss.getDataSourceRefreshSchedules()[0]
                        .getFrequency()
                        .getFrequencyType()
                        .toString();

// Logs the frequency type to the console.
console.log(frequencyType);

Powrót

DataSourceRefreshSchedule[] – harmonogramy odświeżania arkusza kalkulacyjnego.

Upoważnienie

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

getDataSourceSheets()

Zwraca wszystkie arkusze źródła danych w arkuszu kalkulacyjnym.

// Turns data execution on for BigQuery data sources.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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 the first data source sheet in the spreadsheet.
const dataSource = ss.getDataSourceSheets()[0];

// Gets the name of the data source sheet.
console.log(dataSource.asSheet().getName());

Powrót

DataSourceSheet[] – tablica wszystkich arkuszy źródła danych.

Upoważnienie

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

getDataSourceTables()

Pobiera wszystkie tabele źródeł danych.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of data source tables on Sheet1.
// To get an array of data source tables for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceTables = sheet.getDataSourceTables();

// Logs the last completed data execution time on the first data source table.
console.log(dataSourceTables[0].getStatus().getLastExecutionTime());

Powrót

DataSourceTable[] – lista tabel źródeł danych.

Upoważnienie

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

getDataSources()

Zwraca wszystkie źródła danych w arkuszu kalkulacyjnym.

// Turns data execution on for BigQuery data sources.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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 the data sources on the spreadsheet.
const dataSources = ss.getDataSources();

// Logs the name of the first column on the first data source.
console.log(dataSources[0].getColumns()[0].getName());

Powrót

DataSource[] – tablica wszystkich źródeł danych.

Upoważnienie

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

getDeveloperMetadata()

Pobiera metadane dewelopera powiązane z arkuszem kalkulacyjnym najwyższego poziomu.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Adds 'Google' as a key to the spreadsheet metadata.
ss.addDeveloperMetadata('Google');

// Gets the spreadsheet's metadata.
const ssMetadata = ss.getDeveloperMetadata();

// Gets the first set of the spreadsheet's metadata and logs the key to the console.
console.log(ssMetadata[0].getKey());

Powrót

DeveloperMetadata[] – metadane dewelopera powiązane z tym zakresem.

Upoważnienie

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

getEditors()

Pobiera listę redaktorów tego elementu (Spreadsheet).

Powrót

User[] – tablica użytkowników z uprawnieniami do edycji.

Upoważnienie

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

getFormUrl()

Zwraca adres URL formularza, który wysyła odpowiedzi do tego arkusza kalkulacyjnego, lub null, jeśli arkusz kalkulacyjny nie ma powiązanego formularza. Jeśli odpowiedzi są wysyłane do tego arkusza z wielu formularzy, zwracany URL formularza jest nieokreślony. Zamiast tego możesz pobierać powiązania adresów URL formularzy na podstawie arkusza za pomocą metody Sheet.getFormUrl().

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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 the form URL from the spreadsheet.
const formUrl = ss.getFormUrl();

// Logs the form URL to the console.
console.log(formUrl);

Powrót

String – adres URL formularza, który umieszcza odpowiedzi w tym arkuszu kalkulacyjnym, lub null, jeśli arkusz kalkulacyjny nie ma powiązanego formularza.

Upoważnienie

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

getFrozenColumns()

Zwraca liczbę zablokowanych kolumn.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log("Number of frozen columns: %s", sheet.getFrozenColumns());

Powrót

Integer – liczba zablokowanych kolumn;

Upoważnienie

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

getFrozenRows()

Zwraca liczbę zablokowanych wierszy.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log("Number of frozen rows: %s", sheet.getFrozenRows());

Powrót

Integer – liczba zablokowanych wierszy;

Upoważnienie

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

getId()

Pobiera unikalny identyfikator tego arkusza kalkulacyjnego. 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 logs the ID for the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getId());

Powrót

String – unikalny identyfikator (lub klucz) arkusza kalkulacyjnego.


getImages()

Zwraca wszystkie obrazy znajdujące się w siatce w arkuszu.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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 the over-the-grid images from Sheet1.
// To get the over-the-grid images from the entire spreadsheet, use ss.getImages() instead.
const images = sheet.getImages();

// For each image, logs the anchor cell in A1 notation.
for (const image of images) {
 console.log(image.getAnchorCell().getA1Notation());
}

Powrót

OverGridImage[] – tablica obrazów nad siatką.

Upoważnienie

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

getIterativeCalculationConvergenceThreshold()

Zwraca wartość progową używaną podczas obliczeń iteracyjnych. Gdy wyniki kolejnych obliczeń różnią się o mniej niż ta wartość, obliczenia iteracyjne są zatrzymywane.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Sets the iterative calculation convergence threshold for the spreadsheet.
ss.setIterativeCalculationConvergenceThreshold(2);

// Logs the threshold to the console.
console.log(ss.getIterativeCalculationConvergenceThreshold());

Powrót

Number – próg zbieżności.

Upoważnienie

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

getLastColumn()

Zwraca pozycję ostatniej kolumny, która zawiera treść.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

Powrót

Integer – ostatnia kolumna w arkuszu, który zawiera treść;

Upoważnienie

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

getLastRow()

Zwraca pozycję ostatniego wiersza zawierającego treść.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

Powrót

Integer – ostatni wiersz arkusza zawierający treść,

Upoważnienie

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

getMaxIterativeCalculationCycles()

Zwraca maksymalną liczbę iteracji do użycia podczas obliczeń iteracyjnych.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.getMaxIterativeCalculationCycles());

Powrót

Integer – maksymalna liczba iteracji obliczeń.

Upoważnienie

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

getName()

Pobiera nazwę dokumentu.

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getName());

Powrót

String – nazwa arkusza kalkulacyjnego.

Upoważnienie

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

getNamedRanges()

Pobiera wszystkie zakresy nazwane z tego arkusza kalkulacyjnego.

// The code below logs the name of the first named range.
var namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();
for (var i = 0; i < namedRanges.length; i++) {
  Logger.log(namedRanges[i].getName());
}

Powrót

NamedRange[] – tablica wszystkich nazwanych zakresów w arkuszu kalkulacyjnym.

Upoważnienie

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

getNumSheets()

Zwraca liczbę arkuszy w tym arkuszu kalkulacyjnym.

// The code below logs the number of sheets in the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getNumSheets());

Powrót

Integer – liczba arkuszy w arkuszu kalkulacyjnym.


getOwner()

Zwraca właściciela dokumentu lub null w przypadku dokumentu na dysku współdzielonym.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var owner = ss.getOwner();
Logger.log(owner.getEmail());

Powrót

User – właściciel dokumentu lub null, jeśli dokument znajduje się na dysku współdzielonym.

Upoważnienie

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

getPredefinedSpreadsheetThemes()

Zwraca listę wstępnie zdefiniowanych motywów.

// The code below returns the list of predefined themes.
var predefinedThemesList = SpreadsheetApp.getActiveSpreadsheet()
                               .getPredefinedSpreadsheetThemes();

Powrót

SpreadsheetTheme[] – lista wstępnie zdefiniowanych motywów.

Upoważnienie

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

getProtections(type)

Pobiera tablicę obiektów reprezentujących wszystkie chronione zakresy lub arkusze w arkuszu kalkulacyjnym.

// Remove all range protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}
// Remove all sheet protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.SHEET);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

Parametry

NazwaTypOpis
typeProtectionTypeTyp obszaru chronionego – SpreadsheetApp.ProtectionType.RANGE lub SpreadsheetApp.ProtectionType.SHEET.

Powrót

Protection[] – tablica obiektów reprezentująca wszystkie chronione zakresy lub arkusze w arkuszu kalkulacyjnym.

Upoważnienie

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

getRange(a1Notation)

Zwraca zakres określony w notacji A1 lub notacji R1C1.

// Get a range A1:D4 on sheet titled "Invoices"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var range = ss.getRange("Invoices!A1:D4");

// Get cell A1 on the first sheet
var sheet = ss.getSheets()[0];
var cell = sheet.getRange("A1");

Parametry

NazwaTypOpis
a1NotationStringZakres do zwrócenia określony w notacji A1 lub notacji R1C1.

Powrót

Range – zakres w lokalizacji wyznaczonej

Upoważnienie

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

getRangeByName(name)

Zwraca zakres nazwany lub null, jeśli nie znaleziono zakresu o podanej nazwie. Jeśli wiele arkuszy arkusza kalkulacyjnego ma tę samą nazwę zakresu, podaj nazwę bez dodatkowych cudzysłowów, na przykład getRangeByName('TaxRates') lub getRangeByName('Sheet Name!TaxRates'), ale nie getRangeByName('"Sheet Name"!TaxRates').

// Log the number of columns for the range named 'TaxRates' in the active spreadsheet.
var range = SpreadsheetApp.getActiveSpreadsheet().getRangeByName('TaxRates');
if (range != null) {
  Logger.log(range.getNumColumns());
}

Parametry

NazwaTypOpis
nameStringNazwa zakresu do pobrania.

Powrót

Range – zakres komórek o podanej nazwie.


getRangeList(a1Notations)

Zwraca kolekcję RangeList reprezentującą zakresy w tym samym arkuszu określoną za pomocą niepustej listy notacji A1 lub R1C1.

// Get a list of ranges A1:D4, F1:H4.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var rangeList  = sheet.getRangeList(['A1:D4', 'F1:H4']);

Parametry

NazwaTypOpis
a1NotationsString[]Lista zakresów do zwrócenia zgodnie z notacją A1 lub notacją R1C1.

Powrót

RangeList – lista zakresów w lokalizacji wyznaczonej

Upoważnienie

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

getRecalculationInterval()

Zwraca interwał obliczeniowy dla tego arkusza kalkulacyjnego.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Logs the calculation interval for the spreadsheet to the console.
console.log(ss.getRecalculationInterval().toString());

Powrót

RecalculationInterval – przedział obliczeniowy dla danego arkusza kalkulacyjnego.

Upoważnienie

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

getRowHeight(rowPosition)

Pobiera wysokość w pikselach danego wiersza.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.getRowHeight(1));

Parametry

NazwaTypOpis
rowPositionIntegerPołożenie wiersza do sprawdzenia.

Powrót

Integer – wysokość wiersza w pikselach

Upoważnienie

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ą wartość Selection z arkusza kalkulacyjnego.

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

Powrót

Selection – bieżący wybór.

Upoważnienie

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

getSheetByName(name)

Zwraca arkusz o podanej nazwie.

Jeśli wiele arkuszy ma taką samą nazwę, zwracany jest ten znajdujący się najbardziej na lewo. Zwraca wartość null, jeśli nie ma arkusza o podanej nazwie.

// The code below logs the index of a sheet named "Expenses"
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Expenses");
if (sheet != null) {
  Logger.log(sheet.getIndex());
}

Parametry

NazwaTypOpis
nameStringNazwa arkusza do pobrania.

Powrót

Sheet – arkusz o podanej nazwie.


getSheetId()

Zwraca identyfikator arkusza reprezentowanego przez ten obiekt.

Jest to identyfikator, który jest unikalny dla arkusza kalkulacyjnego. Jest to monotonicznie rosnąca liczba całkowita przypisana w momencie tworzenia arkusza i niezależna od jego pozycji. Jest to przydatne w połączeniu z metodami takimi jak Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd), które przyjmują parametr gridId, a nie wystąpienie Sheet.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetId());

Powrót

Integer – identyfikator arkusza unikalny dla arkusza kalkulacyjnego.

Upoważnienie

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

getSheetName()

Zwraca nazwę arkusza.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetName());

Powrót

String – nazwa arkusza.

Upoważnienie

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

getSheetValues(startRow, startColumn, numRows, numColumns)

Zwraca prostokątną siatkę wartości z tego zakresu, zaczynając od podanych współrzędnych. Wartość -1 podana jako pozycja wiersza lub kolumny odpowiada uzyskaniu ostatniego wiersza lub kolumny, które zawierają dane w arkuszu.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The two samples below produce the same output
var values = sheet.getSheetValues(1, 1, 3, 3);
Logger.log(values);

var range = sheet.getRange(1, 1, 3, 3);
values = range.getValues();
Logger.log(values);

Parametry

NazwaTypOpis
startRowIntegerPozycja wiersza początkowego.
startColumnIntegerPozycja kolumny początkowej.
numRowsIntegerLiczba wierszy, dla których mają zostać zwrócone wartości.
numColumnsIntegerLiczba kolumn, dla których mają zostać zwrócone wartości.

Powrót

Object[][] – dwuwymiarowa tablica wartości.

Upoważnienie

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

getSheets()

Pobiera wszystkie arkusze z tego arkusza kalkulacyjnego.

// The code below logs the name of the second sheet
var sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
if (sheets.length > 1) {
  Logger.log(sheets[1].getName());
}

Powrót

Sheet[] – tablica wszystkich arkuszy w arkuszu kalkulacyjnym.


getSpreadsheetLocale()

Pobiera ustawienia regionalne arkusza kalkulacyjnego.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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 the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

Powrót

String – język arkusza kalkulacyjnego.

Upoważnienie

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

getSpreadsheetTheme()

Zwraca bieżący motyw arkusza kalkulacyjnego lub wartość null, jeśli motyw nie został zastosowany.

// The code below returns the current theme of the spreadsheet.
var currentTheme = SpreadsheetApp.getActiveSpreadsheet().getSpreadsheetTheme();

Powrót

SpreadsheetTheme – aktualnie zastosowany motyw.

Upoważnienie

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

getSpreadsheetTimeZone()

Pobiera strefę czasową arkusza kalkulacyjnego.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

Powrót

String – strefa czasowa podana w formacie „long” (np. „Ameryka/Nowy_Jork” według nazwy Joda.org).

Upoważnienie

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

getUrl()

Zwraca adres URL podanego arkusza kalkulacyjnego.

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getUrl());

Powrót

String – adres URL danego arkusza kalkulacyjnego.

Upoważnienie

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

getViewers()

Pobiera listę przeglądających i komentujących tego elementu (Spreadsheet).

Powrót

User[] – tablica użytkowników z uprawnieniami do wyświetlania lub komentowania.

Upoważnienie

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

hideColumn(column)

Ukrywa kolumnę lub kolumny w podanym zakresie.

let ss = SpreadsheetApp.getActiveSpreadsheet();
let sheet = ss.getSheets()[0];

// This hides the first column
let range = sheet.getRange("A1");
sheet.hideColumn(range);

// This hides the first 3 columns
let range = sheet.getRange("A:C");
sheet.hideColumn(range);

Parametry

NazwaTypOpis
columnRangeZakres kolumn do ukrycia.

Upoważnienie

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

hideRow(row)

Ukrywa wiersze w podanym zakresie.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This hides the first row
var range = sheet.getRange("A1");
sheet.hideRow(range);

Parametry

NazwaTypOpis
rowRangeZakres wierszy do ukrycia.

Upoważnienie

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

insertColumnAfter(afterPosition)

Wstawia kolumnę po podanej pozycji kolumny.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a column after the first column position
sheet.insertColumnAfter(1);

Parametry

NazwaTypOpis
afterPositionIntegerKolumna, po której chcesz dodać nową kolumnę.

Powrót

Sheet – arkusz przydatny do tworzenia łańcuchów metod.

Upoważnienie

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

insertColumnBefore(beforePosition)

Wstawia kolumnę przed podaną pozycją kolumny.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a column in the first column position
sheet.insertColumnBefore(1);

Parametry

NazwaTypOpis
beforePositionIntegerKolumna, do której należy dodać nową kolumnę.

Powrót

Sheet – arkusz przydatny do tworzenia łańcuchów metod.

Upoważnienie

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

insertColumnsAfter(afterPosition, howMany)

Wstawia liczbę kolumn po określonej pozycji kolumny.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a column in the second column position
sheet.insertColumnsAfter(1);

Parametry

NazwaTypOpis
afterPositionIntegerKolumna, po której chcesz dodać nową kolumnę.
howManyIntegerLiczba kolumn do wstawienia.

Powrót

Sheet – arkusz przydatny do tworzenia łańcuchów metod.

Upoważnienie

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

insertColumnsBefore(beforePosition, howMany)

Wstawia liczbę kolumn przed podaną pozycją kolumny.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five columns before the first column
sheet.insertColumnsBefore(1, 5);

Parametry

NazwaTypOpis
beforePositionIntegerKolumna, do której należy dodać nową kolumnę.
howManyIntegerLiczba kolumn do wstawienia.

Powrót

Sheet – arkusz przydatny do tworzenia łańcuchów metod.

Upoważnienie

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

insertDataSourceSheet(spec)

Wstawianie nowego elementu DataSourceSheet w arkuszu kalkulacyjnym i rozpoczynanie wykonywania danych. Efektem ubocznym jest też to, że nowy arkusz stanie się aktywny.

Jeśli typ źródła danych nie jest włączony, zgłasza wyjątek. Użyj metod SpreadsheetApp#enable...Execution(), aby umożliwić wykonywanie danych w przypadku określonego typu źródła danych.

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

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

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

Parametry

NazwaTypOpis
specDataSourceSpecSpecyfikacja źródła danych, z którą ma być wstawiana.

Powrót

DataSourceSheet – nowy arkusz źródła danych.

Upoważnienie

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

insertImage(blobSource, column, row)

Wstawia Spreadsheet jako obraz w dokumencie w danym wierszu i kolumnie. Rozmiar obrazu jest pobierany z zawartości obiektu blob. Maksymalny obsługiwany rozmiar bloba to 2 MB.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

Parametry

NazwaTypOpis
blobSourceBlobSourceObiekt blob zawierający zawartość obrazu, typ MIME i (opcjonalnie) nazwę.
columnIntegerPozycja kolumny.
rowIntegerPozycja wiersza.

Powrót

OverGridImage – wstawiony obraz.

Upoważnienie

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

insertImage(blobSource, column, row, offsetX, offsetY)

Wstawia Spreadsheet jako obraz w dokumencie w danym wierszu i kolumnie z przesunięciem piksela. Rozmiar obrazu jest pobierany z zawartości obiektu blob. Maksymalny obsługiwany rozmiar bloba to 2 MB.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

Parametry

NazwaTypOpis
blobSourceBlobSourceObiekt blob zawierający zawartość obrazu, typ MIME i (opcjonalnie) nazwę.
columnIntegerPozycja kolumny.
rowIntegerPozycja wiersza.
offsetXIntegerPrzesunięcie w poziomie od narożnika komórki w pikselach.
offsetYIntegerPrzesunięcie w pionie od narożnika komórki w pikselach.

Powrót

OverGridImage – wstawiony obraz.

Upoważnienie

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

insertImage(url, column, row)

Wstawia obraz w dokumencie w danym wierszu i kolumnie.

Podany adres URL musi być dostępny publicznie.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1);

Parametry

NazwaTypOpis
urlStringAdres URL obrazu.
columnIntegerPozycja kolumny siatki.
rowIntegerPozycja wiersza siatki.

Powrót

OverGridImage – wstawiony obraz.

Upoważnienie

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

insertImage(url, column, row, offsetX, offsetY)

Wstawia obraz w dokumencie w danym wierszu i kolumnie z odsunięciem pikseli.

Podany adres URL musi być dostępny publicznie.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1, 10, 10);

Parametry

NazwaTypOpis
urlStringAdres URL obrazu.
columnIntegerPozycja kolumny.
rowIntegerPozycja wiersza.
offsetXIntegerPrzesunięcie w poziomie od narożnika komórki w pikselach.
offsetYIntegerPrzesunięcie w pionie od narożnika komórki w pikselach.

Powrót

OverGridImage – wstawiony obraz.

Upoważnienie

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

insertRowAfter(afterPosition)

Wstawia wiersz po podanej pozycji wiersza.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a row after the first row position
sheet.insertRowAfter(1);

Parametry

NazwaTypOpis
afterPositionIntegerWiersz, po którym należy dodać nowy wiersz.

Powrót

Sheet – arkusz przydatny do tworzenia łańcuchów metod.

Upoważnienie

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

insertRowBefore(beforePosition)

Wstawia wiersz przed podaną pozycją wiersza.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a row before the first row position
sheet.insertRowBefore(1);

Parametry

NazwaTypOpis
beforePositionIntegerWiersz, przed którym należy dodać nowy wiersz.

Powrót

Sheet – arkusz przydatny do tworzenia łańcuchów metod.

Upoważnienie

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

insertRowsAfter(afterPosition, howMany)

Wstawia liczbę wierszy po podanej pozycji wiersza.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five rows after the first row
sheet.insertRowsAfter(1, 5);

Parametry

NazwaTypOpis
afterPositionIntegerWiersz, po którym mają zostać dodane nowe wiersze.
howManyIntegerLiczba wierszy do wstawienia.

Powrót

Sheet – arkusz przydatny do tworzenia łańcuchów metod.

Upoważnienie

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

insertRowsBefore(beforePosition, howMany)

Wstawia liczbę wierszy przed podaną pozycją wiersza.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five rows before the first row
sheet.insertRowsBefore(1, 5);

Parametry

NazwaTypOpis
beforePositionIntegerWiersz, przed którym należy dodać nowe wiersze.
howManyIntegerLiczba wierszy do wstawienia.

Powrót

Sheet – arkusz przydatny do tworzenia łańcuchów metod.

Upoważnienie

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

insertSheet()

Wstawia do arkusza kalkulacyjnego nowy arkusz z domyślną nazwą arkusza. Nowy arkusz stanie się aktywnym.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet();

Powrót

Sheet – nowy arkusz.

Upoważnienie

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

insertSheet(sheetIndex)

Wstawia do arkusza kalkulacyjnego nowy arkusz o podanym indeksie. Nowy arkusz stanie się aktywnym arkuszem.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet(1);

Parametry

NazwaTypOpis
sheetIndexIntegerIndeks nowo utworzonego arkusza. Aby wstawić arkusz jako pierwszy w arkuszu, ustaw jego wartość na 0.

Powrót

Sheet – nowy arkusz.

Upoważnienie

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

insertSheet(sheetIndex, options)

Wstawianie do arkusza kalkulacyjnego nowego arkusza o podanym indeksie i przy użyciu opcjonalnych argumentów zaawansowanych. Nowy arkusz stanie się aktywnym.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet(1, {template: templateSheet});

Parametry

NazwaTypOpis
sheetIndexIntegerIndeks nowo utworzonego arkusza. Aby wstawić arkusz jako pierwszy w arkuszu, ustaw jego wartość na 0.
optionsObjectOpcjonalne argumenty zaawansowane JavaScript.

Parametry zaawansowane

NazwaTypOpis
templateSheetWszystkie dane z obiektu arkusza szablonu zostaną skopiowane do nowego arkusza. Szablon arkusza musi być jednym z arkuszy obiektu arkusza kalkulacyjnego.

Powrót

Sheet – nowy arkusz.

Upoważnienie

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

insertSheet(options)

Wstawia do arkusza kalkulacyjnego nowy arkusz z domyślną nazwą arkusza i opcjonalnymi argumentami zaawansowanymi. Nowy arkusz stanie się aktywnym.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet({template: templateSheet});

Parametry

NazwaTypOpis
optionsObjectPoniżej wymieniono opcjonalne argumenty zaawansowane JavaScript.

Parametry zaawansowane

NazwaTypOpis
templateSheetWszystkie dane z obiektu arkusza szablonu zostaną skopiowane do nowego arkusza. Szablon arkusza musi być jednym z arkuszy tego obiektu arkusza kalkulacyjnego.

Powrót

Sheet – nowy arkusz.

Upoważnienie

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

insertSheet(sheetName)

Wstawia do arkusza kalkulacyjnego nowy arkusz o podanej nazwie. Nowy arkusz stanie się aktywnym arkuszem.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet');

Parametry

NazwaTypOpis
sheetNameStringNazwa nowego arkusza.

Powrót

Sheet – nowy arkusz.

Upoważnienie

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

insertSheet(sheetName, sheetIndex)

Wstawia do arkusza kalkulacyjnego nowy arkusz o podanej nazwie w podanym indeksie. Nowy arkusz staje się aktywnym arkuszem.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet', 1);

Parametry

NazwaTypOpis
sheetNameStringNazwa nowego arkusza.
sheetIndexIntegerIndeks nowo utworzonego arkusza. Aby wstawić arkusz jako pierwszy w arkuszu, ustaw jego wartość na 0.

Powrót

Sheet – nowy arkusz.

Upoważnienie

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

insertSheet(sheetName, sheetIndex, options)

Wstawia do arkusza kalkulacyjnego nowy arkusz o podanej nazwie w podanym indeksie i używa opcjonalnych argumentów zaawansowanych. Nowy arkusz stanie się aktywnym.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', 1, {template: templateSheet});

Parametry

NazwaTypOpis
sheetNameStringNazwa nowego arkusza.
sheetIndexIntegerIndeks nowo wstawionego arkusza. Aby wstawić arkusz jako pierwszy w arkuszu kalkulacyjnym, ustaw jego wartość na 0.
optionsObjectOpcjonalne argumenty zaawansowane JavaScript.

Parametry zaawansowane

NazwaTypOpis
templateSheetWszystkie dane z obiektu arkusza szablonu zostaną skopiowane do nowego arkusza. Szablon arkusza musi być jednym z arkuszy obiektu arkusza kalkulacyjnego.

Powrót

Sheet – nowy arkusz.

Upoważnienie

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

insertSheet(sheetName, options)

Wstawia do arkusza kalkulacyjnego nowy arkusz o podanej nazwie i używa opcjonalnych argumentów zaawansowanych. Nowy arkusz stanie się aktywnym.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', {template: templateSheet});

Parametry

NazwaTypOpis
sheetNameStringNazwa nowego arkusza.
optionsObjectOpcjonalne argumenty zaawansowane JavaScript.

Parametry zaawansowane

NazwaTypOpis
templateSheetWszystkie dane z obiektu arkusza szablonu zostaną skopiowane do nowego arkusza. Szablon arkusza musi być jednym z arkuszy obiektu arkusza kalkulacyjnego.

Powrót

Sheet – nowy arkusz.

Upoważnienie

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

insertSheetWithDataSourceTable(spec)

Wstawia nowy arkusz w arkuszu kalkulacyjnym, tworzy obiekt DataSourceTable obejmujący cały arkusz o podanej specyfikacji źródła danych i rozpoczyna wykonywanie kodu. Efektem ubocznym jest ustawienie nowego arkusza jako aktywnego.

Jeśli typ źródła danych nie jest włączony, zgłasza wyjątek. Użyj metod SpreadsheetApp#enable...Execution(), aby umożliwić wykonywanie danych w przypadku określonego typu źródła danych.

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

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

// Adds a sheet and sets cell A1 as the parameter cell.
const parameterCell = ss.insertSheet('parameterSheet').getRange('A1');

// Sets the value of the parameter cell to 'Duke'.
parameterCell.setValue('Duke');

const query = 'select * from `bigquery-public-data`.`ncaa_basketball`.' +
  '`mbb_historical_tournament_games` WHERE win_school_ncaa = @SCHOOL';

// Adds a data source with a query parameter.
// TODO(developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
 .asBigQuery()
 .setProjectId('project-id-1')
 .setRawQuery(query)
 .setParameterFromCell('SCHOOL', 'parameterSheet!A1')
 .build();

// Adds sheets for the data source and data source table to the spreadsheet.
ss.insertSheetWithDataSourceTable(dataSourceSpec);

Parametry

NazwaTypOpis
specDataSourceSpecSpecyfikacja źródła danych, z którą ma być wstawiana.

Powrót

Sheet – nowy arkusz.

Upoważnienie

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

isColumnHiddenByUser(columnPosition)

Zwraca, czy dana kolumna jest ukryta przez użytkownika.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.isColumnHiddenByUser(1));

Parametry

NazwaTypOpis
columnPositionIntegerPołożenie kolumny do sprawdzenia.

Powrót

Booleantrue, jeśli kolumna jest ukryta. W przeciwnym razie: false.

Upoważnienie

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

isIterativeCalculationEnabled()

Wskazuje, czy w arkuszu kalkulacyjnym włączono obliczenia iteracyjne.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

Powrót

Booleantrue, jeśli włączono obliczenia iteracyjne. W przeciwnym razie false.

Upoważnienie

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

isRowHiddenByFilter(rowPosition)

Zwraca, czy dany wiersz jest ukryty przez filtr (a nie przez widok filtra).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByFilter(1));

Parametry

NazwaTypOpis
rowPositionIntegerPołożenie wiersza do sprawdzenia.

Powrót

Booleantrue, jeśli wiersz jest ukryty. W przeciwnym razie false.

Upoważnienie

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

isRowHiddenByUser(rowPosition)

Zwraca, czy dany wiersz jest ukryty przez użytkownika.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByUser(1));

Parametry

NazwaTypOpis
rowPositionIntegerPołożenie wiersza do sprawdzenia.

Powrót

Booleantrue, jeśli wiersz jest ukryty. W przeciwnym razie false.

Upoważnienie

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

moveActiveSheet(pos)

Przenosi aktywny arkusz w określone miejsce na liście arkuszy. Dodaje wyjątek, jeśli pozycja jest ujemna lub większa od liczby arkuszy.

// This example assumes that there are 2 sheets in the current
// active spreadsheet: one named "first" in position 1 and another named "second"
// in position 2.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// Gets the "first" sheet and activates it.
var sheet = spreadsheet.getSheetByName("first").activate();

// Logs 'Current index of sheet: 1'
console.log("Current index of sheet: %s", sheet.getIndex());

spreadsheet.moveActiveSheet(2);

// Logs 'New index of sheet: 2'
console.log("New index of sheet: %s", sheet.getIndex());

Parametry

NazwaTypOpis
posIntegerPozycja indeksu 1, na którą ma zostać przeniesiony aktywny arkusz na liście arkuszy.

Upoważnienie

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

moveChartToObjectSheet(chart)

Tworzy nowy arkusz SheetType.OBJECT i przenosi do niego udostępniony wykres. Jeśli wykres znajduje się już w osobnym arkuszu, jest on zwracany bez tworzenia nowego.

var sheet = SpreadsheetApp.getActiveSheet();
var chart = sheet.newChart().setPosition(1, 1, 0, 0).build();
sheet.insertChart(chart);
var objectSheet = SpreadsheetApp.getActive().moveChartToObjectSheet(chart);

Parametry

NazwaTypOpis
chartEmbeddedChartWykres do przeniesienia.

Powrót

Sheet – arkusz, w którym znajduje się wykres.

Upoważnienie

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

refreshAllDataSources()

Odświeża wszystkie obsługiwane źródła danych i powiązane z nimi obiekty źródeł danych, pomijając nieprawidłowe obiekty źródeł danych.

Użyj metod SpreadsheetApp#enable...Execution(), aby włączyć wykonywanie danych w przypadku określonego typu źródła danych.

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// 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 the first data source sheet on the spreadsheet.
const dataSheet = ss.getDataSourceSheets()[0];

// Refreshes all data sources on the spreadsheet.
ss.refreshAllDataSources();

// Logs the last refreshed time of the first data source sheet.
console.log(`Last refresh time: ${dataSheet.getStatus().getLastRefreshedTime()}`);

Upoważnienie

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

removeEditor(emailAddress)

Usuwa danego użytkownika z listy edytorów Spreadsheet. Ta metoda nie blokuje użytkownikom dostępu do Spreadsheet, jeśli należą do klasy użytkowników z dostępem ogólnym – na przykład gdy zasób Spreadsheet jest udostępniony całej domenie użytkownika lub Spreadsheet znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.

W przypadku plików na Dysku spowoduje to też usunięcie użytkownika z listy przeglądających.

Parametry

NazwaTypOpis
emailAddressStringAdres e-mail użytkownika, którego chcesz usunąć.

Powrót

Spreadsheet – ten element (Spreadsheet) na potrzeby łańcuchów.

Upoważnienie

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

removeEditor(user)

Usuwa danego użytkownika z listy edytorów Spreadsheet. Ta metoda nie blokuje użytkownikom dostępu do Spreadsheet, jeśli należą do klasy użytkowników z dostępem ogólnym – na przykład gdy zasób Spreadsheet jest udostępniony całej domenie użytkownika lub Spreadsheet znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.

W przypadku plików na Dysku spowoduje to też usunięcie użytkownika z listy przeglądających.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika, który ma zostać usunięty.

Powrót

Spreadsheet – ten element (Spreadsheet) na potrzeby łańcuchów.

Upoważnienie

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

removeMenu(name)

Usuwa menu dodane przez użytkownika addMenu(name, subMenus). Argument name powinien mieć tę samą wartość co odpowiadające mu wywołanie addMenu(name, subMenus).

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.addMenu("badMenu", [{name: "remove bad menu", functionName: "removeBadMenu"},
                                       {name: "foo", functionName: "foo"}]);
}
function removeBadMenu() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.removeMenu("badMenu");  // name must match the name used when added the menu
}
function foo(){
// Do nothing
}

Parametry

NazwaTypOpis
nameStringNazwa menu do usunięcia.

Upoważnienie

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

removeNamedRange(name)

Usuwa zakres nazwany o podanej nazwie. Jeśli w arkuszu kalkulacyjnym nie ma zakresu o podanej nazwie, robi się wyjątek.

// The code below creates a new named range "foo", and then remove it.
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("foo", ss.getActiveRange());
ss.removeNamedRange("foo");

Parametry

NazwaTypOpis
nameStringNazwa zakresu.

Upoważnienie

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

removeViewer(emailAddress)

Usuwa danego użytkownika z listy przeglądających i komentujących elementu Spreadsheet. Ta metoda nie działa, jeśli użytkownik jest edytującym, a nie przeglądającym lub komentującym. Ta metoda nie blokuje też użytkownikom dostępu do Spreadsheet, jeśli należą do klasy użytkowników z dostępem ogólnym – na przykład gdy Spreadsheet jest udostępniony całej domenie użytkownika lub Spreadsheet znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.

W przypadku plików na Dysku spowoduje to też usunięcie użytkownika z listy edytorów.

Parametry

NazwaTypOpis
emailAddressStringAdres e-mail użytkownika, którego chcesz usunąć.

Powrót

Spreadsheet – ten Spreadsheet do łańcuchów.

Upoważnienie

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

removeViewer(user)

Usuwa danego użytkownika z listy przeglądających i komentujących elementu Spreadsheet. Ta metoda nie działa, jeśli użytkownik jest edytorem, a nie przeglądającym. Ta metoda nie blokuje też użytkownikom dostępu do Spreadsheet, jeśli należą do klasy użytkowników z dostępem ogólnym – na przykład gdy zasób Spreadsheet jest udostępniony całej domenie użytkownika lub Spreadsheet znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.

W przypadku plików na Dysku spowoduje to też usunięcie użytkownika z listy edytorów.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika, który ma zostać usunięty.

Powrót

Spreadsheet – ten Spreadsheet do łańcuchów.

Upoważnienie

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

rename(newName)

Zmienia nazwę dokumentu.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.rename("This is the new name");

Parametry

NazwaTypOpis
newNameStringNowa nazwa dokumentu.

Upoważnienie

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

renameActiveSheet(newName)

Zmienia nazwę aktualnie aktywnego arkusza na podaną nową nazwę.

// The code below renames the active sheet to "Hello world"
SpreadsheetApp.getActiveSpreadsheet().renameActiveSheet("Hello world");

Parametry

NazwaTypOpis
newNameStringNowa nazwa bieżącego aktywnego arkusza.

Upoważnienie

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

resetSpreadsheetTheme()

Usuwa zastosowany motyw i ustawia motyw domyślny w arkuszu kalkulacyjnym.

// The code below applies default theme on the spreadsheet.
SpreadsheetApp.getActiveSpreadsheet().resetSpreadsheetTheme();

Powrót

SpreadsheetTheme – motyw domyślny.

Upoważnienie

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

setActiveRange(range)

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var range = sheet.getRange('A1:D4');
sheet.setActiveRange(range);

var selection = sheet.getSelection();
// Current cell: A1
var currentCell = selection.getCurrentCell();
// Active Range: A1:D4
var activeRange = selection.getActiveRange();

Parametry

NazwaTypOpis
rangeRangeZakres, który chcesz ustawić jako aktywny.

Powrót

Range – nowo aktywny zakres

Upoważnienie

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

setActiveRangeList(rangeList)

Ustawia określoną listę zakresów jako active ranges w aktywnym arkuszu. Ostatni zakres na liście to active range.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['D4', 'B2:C4']);
sheet.setActiveRangeList(rangeList);

var selection = sheet.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,

Upoważnienie

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

setActiveSelection(range)

Określa aktywny region wyboru na potrzeby tego arkusza.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D4");
sheet.setActiveSelection(range);

Parametry

NazwaTypOpis
rangeRangeZakres do ustawienia jako aktywny.

Powrót

Range – nowo aktywny zakres

Upoważnienie

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

setActiveSelection(a1Notation)

Ustawia aktywny wybór zgodnie z notacją A1 lub notacją R1C1.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.setActiveSelection("A1:D4");

Parametry

NazwaTypOpis
a1NotationStringZakres do ustawienia jako aktywny, zgodnie z zapisem A1 lub notacją R1C1.

Powrót

Range – nowo aktywny zakres

Upoważnienie

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

setActiveSheet(sheet)

Ustawia dany arkusz jako aktywny w arkuszu kalkulacyjnym. W interfejsie Arkuszy Google wyświetli się wybrany arkusz, chyba że należy on do innego arkusza kalkulacyjnego.

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

Parametry

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

Powrót

Sheet – aktywny arkusz.

Upoważnienie

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

setActiveSheet(sheet, restoreSelection)

Ustawia dany arkusz jako aktywny w arkuszu kalkulacyjnym. Istnieje też możliwość przywrócenia ostatniego zaznaczenia w tym arkuszu. W interfejsie Arkuszy Google wyświetli się wybrany arkusz, chyba że należy on do innego arkusza kalkulacyjnego.

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.
restoreSelectionBooleanW Tf true ostatni wybór nowego aktywnego arkusza stanie się ponownie aktywny, gdy nowy arkusz stanie się aktywny. Jeśli pole false stanie się aktywny, nowy arkusz stanie się aktywny bez zmiany bieżącego wyboru.

Powrót

Sheet – nowy aktywny arkusz.

Upoważnienie

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

setColumnWidth(columnPosition, width)

Ustawia szerokość danej kolumny w pikselach.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sets the first column to a width of 200 pixels
sheet.setColumnWidth(1, 200);

Parametry

NazwaTypOpis
columnPositionIntegerPozycja danej kolumny do ustawienia.
widthIntegerSzerokość, na jaką ma być ustawiona wartość w pikselach.

Powrót

Sheet – arkusz przydatny do tworzenia łańcuchów metod.

Upoważnienie

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

setCurrentCell(cell)

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

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

Jeśli określona komórka nie znajduje się w żadnym wybranym zakresie, wszystkie istniejące zaznaczenie zostaną usunięte, a komórka stanie się komórką bieżącą i aktywnym zakresem.

Uwaga: określony Range musi składać się z jednej komórki. W przeciwnym razie spowoduje zgłoszenie wyjątku.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var cell = sheet.getRange('B5');
sheet.setCurrentCell(cell);

var selection = sheet.getSelection();
// Current cell: B5
var currentCell = selection.getCurrentCell();

Parametry

NazwaTypOpis
cellRangeKomórka, która ma zostać ustawiona jako obecna komórka.

Powrót

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

Upoważnienie

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

setFrozenColumns(columns)

Blokuje podaną liczbę kolumn. Jeśli wartość wynosi zero, żadna kolumna nie jest zablokowana.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Freezes the first column
sheet.setFrozenColumns(1);

Parametry

NazwaTypOpis
columnsIntegerLiczba kolumn do zablokowania.

Upoważnienie

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

setFrozenRows(rows)

Blokuje podaną liczbę wierszy. Jeśli wartość wynosi zero, żaden wiersz nie jest zablokowany.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Freezes the first row
sheet.setFrozenRows(1);

Parametry

NazwaTypOpis
rowsIntegerLiczba wierszy do zablokowania.

Upoważnienie

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

setIterativeCalculationConvergenceThreshold(minThreshold)

Ustawia minimalną wartość progową dla obliczeń iteracyjnych. Gdy wyniki kolejnych obliczeń różnią się o mniej niż ta wartość, obliczenia iteracyjne są zatrzymywane. Ta wartość nie może być liczbą ujemną i domyślnie przyjmuje wartość 0, 05.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Sets the iterative calculation convergence threshold for the spreadsheet.
ss.setIterativeCalculationConvergenceThreshold(2);

// Logs the threshold to the console.
console.log(ss.getIterativeCalculationConvergenceThreshold());

Parametry

NazwaTypOpis
minThresholdNumberMinimalny próg zbieżności (musi być nieujemny).

Powrót

Spreadsheet – arkusz kalkulacyjny służący do tworzenia łańcuchów.

Upoważnienie

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

setIterativeCalculationEnabled(isEnabled)

Określa, czy w tym arkuszu kalkulacyjnym mają być aktywowane obliczenia iteracyjne. Jeśli po uruchomieniu obliczeń nie ustawiono wcześniej maksymalnej liczby cykli obliczeniowych ani progu zbieżności, przyjmuje się domyślnie wartość odpowiednio 50 i 0,05. Jeśli któraś z tych opcji została ustawiona wcześniej, zachowuje swoje poprzednie wartości.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

Parametry

NazwaTypOpis
isEnabledBooleantrue, jeśli powinno być włączone obliczenia iteracyjne; w przeciwnym razie false.

Powrót

Spreadsheet – arkusz kalkulacyjny służący do tworzenia łańcuchów.

Upoważnienie

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

setMaxIterativeCalculationCycles(maxIterations)

Określa maksymalną liczbę iteracji obliczeń, które należy wykonać podczas obliczeń iteracyjnych. Ta wartość musi mieścić się w zakresie od 1 do 10 000 (włącznie) i domyślnie wynosi 50.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.getMaxIterativeCalculationCycles());

Parametry

NazwaTypOpis
maxIterationsIntegerMaksymalna liczba iteracji obliczeń (od 1 do 10 000).

Powrót

Spreadsheet – arkusz kalkulacyjny służący do tworzenia łańcuchów.

Upoważnienie

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

setNamedRange(name, range)

Określa zakres.

// The code below creates a new named range "TaxRates" in the active spreadsheet
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("TaxRates", SpreadsheetApp.getActiveRange());

Parametry

NazwaTypOpis
nameStringNazwa zakresu.
rangeRangeSpecyfikacja zakresu.

Upoważnienie

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

setRecalculationInterval(recalculationInterval)

Określa, jak często ten arkusz kalkulacyjny ma być przeliczany.

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

// Sets the  calculation interval for the spreadsheet to 'ON_CHANGE'.
const interval = ss.setRecalculationInterval(SpreadsheetApp.RecalculationInterval.ON_CHANGE);

// Logs the calculation interval to the console.
console.log(interval);

Parametry

NazwaTypOpis
recalculationIntervalRecalculationIntervalNowy interwał przeliczenia.

Powrót

Spreadsheet – arkusz kalkulacyjny służący do tworzenia łańcuchów.

Upoważnienie

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

setRowHeight(rowPosition, height)

Ustawia wysokość wiersza w danym wierszu w pikselach. Domyślnie wiersze powiększają się, aby dopasować je do zawartości komórki. Jeśli chcesz wymusić konkretną wysokość wierszy, użyj Sheet.setRowHeightsForced(startRow, numRows, height).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

Parametry

NazwaTypOpis
rowPositionIntegerPozycja wiersza do zmiany.
heightIntegerWysokość w pikselach, która ma być ustawiona.

Powrót

Sheet – arkusz przydatny do tworzenia łańcuchów metod.

Upoważnienie

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

setSpreadsheetLocale(locale)

Określa język arkusza kalkulacyjnego.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Sets the spreadsheet locale.
ss.setSpreadsheetLocale('fr');

// Gets the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

Parametry

NazwaTypOpis
localeStringKod regionu, którego należy użyć (np. „en”, „fr” lub „en_US”).

Upoważnienie

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

setSpreadsheetTheme(theme)

Ustawia motyw w arkuszu kalkulacyjnym.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// The code below sets the second predefined theme as the current theme of the spreadsheet.
var predefinedThemesList = spreadsheet.getPredefinedSpreadsheetThemes();
spreadsheet.setSpreadsheetTheme(predefinedThemesList[1]);

Parametry

NazwaTypOpis
themeSpreadsheetThememotyw, który chcesz zastosować;

Powrót

SpreadsheetTheme – nowy, bieżący motyw.

Upoważnienie

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

setSpreadsheetTimeZone(timezone)

Ustawia strefę czasową dla arkusza kalkulacyjnego.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

Parametry

NazwaTypOpis
timezoneStringStrefa czasowa podana w formacie „długi” (na przykład „Ameryka/Nowy_Jork” podana przez Joda.org).

Upoważnienie

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

show(userInterface)

Wyświetla niestandardowy komponent interfejsu w oknie wyśrodkowanym w obszarze widocznym w przeglądarce użytkownika. Wykonanie skryptu po stronie serwera nie jest zawieszone. Aby komunikować się po stronie serwera, komponent interfejsu musi wykonywać asynchroniczne wywołania zwrotne do skryptu po stronie serwera.

Jeśli skrypt po stronie serwera wyświetlał wcześniej okno, które nie zostało jeszcze zamknięte, zostaje ono zastąpione interfejsem nowego.

Ten fragment kodu wyświetla prostą aplikację HtmlService w oknie z określonym tytułem, wysokością i szerokością:

var htmlApp = HtmlService
    .createHtmlOutput('<p>A change of speed, a change of style...</p>')
    .setTitle('My HtmlService Application')
    .setWidth(250)
    .setHeight(300);

SpreadsheetApp.getActiveSpreadsheet().show(htmlApp);

// The script resumes execution immediately after showing the dialog.

Parametry

NazwaTypOpis
userInterfaceObjectHtmlOutput.

Upoważnienie

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

  • https://www.googleapis.com/auth/script.container.ui

sort(columnPosition)

Sortuje arkusz według kolumny rosnąco.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, ascending
sheet.sort(1);

Parametry

NazwaTypOpis
columnPositionIntegerKolumna, według której chcesz sortować.

Powrót

Sheet – arkusz przydatny do tworzenia łańcuchów metod.

Upoważnienie

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

sort(columnPosition, ascending)

Sortuje arkusz według kolumny. Pobiera parametr, który określa rosnąco lub malejąco.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

Parametry

NazwaTypOpis
columnPositionIntegerKolumna, według której chcesz sortować.
ascendingBooleantrue – sortowanie rosnąco, false – malejąco.

Powrót

Sheet – arkusz przydatny do tworzenia łańcuchów metod.

Upoważnienie

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

toast(msg)

W prawym dolnym rogu arkusza kalkulacyjnego wyświetla wyskakujące okienko z podaną wiadomością.

// Show a popup with the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started');

Parametry

NazwaTypOpis
msgStringWiadomość, która ma zostać wyświetlona w toście.

Upoważnienie

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

toast(msg, title)

W prawym dolnym rogu arkusza kalkulacyjnego wyświetla wyskakujące okienko z wiadomością i tytułem.

// Show a popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status');

Parametry

NazwaTypOpis
msgStringWiadomość, która ma zostać wyświetlona w toście.
titleStringOpcjonalny tytuł tosta.

Upoważnienie

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

toast(msg, title, timeoutSeconds)

W prawym dolnym rogu arkusza kalkulacyjnego wyświetla wyskakujące okienko z podanym tytułem i komunikatem, które jest widoczne przez określony czas.

// Show a 3-second popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status', 3);

Parametry

NazwaTypOpis
msgStringWiadomość, która ma zostać wyświetlona w toście.
titleStringOpcjonalny tytuł tosta.
timeoutSecondsNumberLimit czasu oczekiwania w sekundach. Jeśli włączysz null, tost jest domyślnie ustawiony na 5 sekund. W przypadku negatywnej wartości tost pozostanie do czasu zamknięcia.

Upoważnienie

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

unhideColumn(column)

Odkrywa kolumnę w podanym zakresie.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This unhides the first column if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideColumn(range);

Parametry

NazwaTypOpis
columnRangeZakres do odkrycia, jeśli jest ukryty.

Upoważnienie

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

unhideRow(row)

Odkrywa wiersz w podanym zakresie.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This unhides the first row if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideRow(range);

Parametry

NazwaTypOpis
rowRangeZakres do odkrycia, jeśli jest ukryty.

Upoważnienie

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

updateMenu(name, subMenus)

Aktualizuje menu dodane przez użytkownika addMenu(name, subMenus). Działa dokładnie tak samo jak addMenu(name, subMenus).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var menuEntries = [];
menuEntries.push({name: "Lone Menu Entry", functionName: "function1"});
ss.updateMenu("addMenuExample", menuEntries);

Parametry

NazwaTypOpis
nameStringNazwa menu do aktualizacji.
subMenusObject[]Tablica map JavaScript z parametrami name i functionName . Możesz używać funkcji z dołączonych bibliotek, takich jak Library.libFunction1.

Upoważnienie

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Czekam, aż wszystkie bieżące wykonania w arkuszu kalkulacyjnym zostaną ukończone, limit czasu następuje po podanej liczbie sekund. Zgłasza wyjątek, jeśli wykonania nie zostaną ukończone po przekroczeniu limitu czasu, ale nie anuluje wykonywania operacji na danych.

Parametry

NazwaTypOpis
timeoutInSecondsIntegerCzas oczekiwania na wykonanie danych (w sekundach). Maksymalna wartość to 300 sekund.

Upoważnienie

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

Wycofane metody