Class Spreadsheet

Arkusz kalkulacyjny

uzyskiwać dostęp do plików Arkuszy Google i je modyfikować; Częste operacje to dodawanie nowych arkuszy i współpracowników.

Metody

MetodaZwracany typKrótki opis
addDeveloperMetadata(key)SpreadsheetDodaje metadane dewelopera z określonym kluczem do arkusza kalkulacyjnego najwyższego poziomu.
addDeveloperMetadata(key, visibility)SpreadsheetDodaje do arkusza 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 o określonym kluczu, wartości i widoczności.
addEditor(emailAddress)SpreadsheetDodaje podanego użytkownika do listy edytujących Spreadsheet.
addEditor(user)SpreadsheetDodaje podanego użytkownika do listy edytujących Spreadsheet.
addEditors(emailAddresses)SpreadsheetDodaje podaną tablicę użytkowników do listy edytujących Spreadsheet.
addMenu(name, subMenus)voidTworzy nowe menu w interfejsie arkusza kalkulacyjnego.
addViewer(emailAddress)SpreadsheetDodaje podanego użytkownika do listy widzów Spreadsheet.
addViewer(user)SpreadsheetDodaje podanego użytkownika do listy widzów Spreadsheet.
addViewers(emailAddresses)SpreadsheetDodaje podaną tablicę użytkowników do listy widzów Spreadsheet.
appendRow(rowContents)SheetDodaje wiersz na dole bieżącego regionu danych w arkuszu.
autoResizeColumn(columnPosition)SheetUstawia szerokość danej kolumny tak, aby pasowała do jej zawartości.
copy(name)SpreadsheetKopiuje arkusz kalkulacyjny i zwraca nowy.
createDeveloperMetadataFinder()DeveloperMetadataFinderZwraca DeveloperMetadataFinder do wyszukiwania metadanych dewelopera w zakresie tego arkusza kalkulacyjnego.
createTextFinder(findText)TextFinderTworzy w arkuszu kalkulacyjnym narzędzie do wyszukiwania tekstu, które umożliwia wyszukiwanie i zamienianie tekstu w arkuszu.
deleteActiveSheet()SheetUsuwa aktualnie aktywny arkusz.
deleteColumn(columnPosition)SheetUsuwa kolumnę w podanym miejscu.
deleteColumns(columnPosition, howMany)voidUsuwa określoną liczbę kolumn, zaczynając od podanej pozycji kolumny.
deleteRow(rowPosition)SheetUsuwa wiersz w danym miejscu.
deleteRows(rowPosition, howMany)voidUsuwa określoną liczbę wierszy, zaczynając od podanego wiersza.
deleteSheet(sheet)voidUsuwa określony arkusz.
duplicateActiveSheet()SheetDuplikuje aktywny arkusz i ustawia go jako aktywny.
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 null, jeśli nie ma aktywnych zakresów.
getActiveSheet()SheetPobiera aktywny arkusz w arkuszu kalkulacyjnym.
getAs(contentType)BlobZwraca dane w tym obiekcie jako obiekt blob przekonwertowany na określony typ treści.
getBandings()Banding[]Zwraca wszystkie zakresy w tym arkuszu kalkulacyjnym.
getBlob()BlobZwraca dane w tym obiekcie jako obiekt blob.
getColumnWidth(columnPosition)IntegerPobiera szerokość podanej kolumny w pikselach.
getCurrentCell()RangeZwraca bieżącą komórkę w aktywnym arkuszu lub null, jeśli nie ma bieżącej komórki.
getDataRange()RangeZwraca Range odpowiadający wymiarom, w których występują dane.
getDataSourceFormulas()DataSourceFormula[]Pobiera wszystkie formuły źródła 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ę edytujących ten Spreadsheet.
getFormUrl()StringZwraca adres URL formularza, który wysyła odpowiedzi do tego arkusza kalkulacyjnego, lub null, jeśli ten arkusz nie jest powiązany z formularzem.
getFrozenColumns()IntegerZwraca liczbę zamrożonych kolumn.
getFrozenRows()IntegerZwraca liczbę zamrożonych wierszy.
getId()StringPobiera unikalny identyfikator tego arkusza kalkulacyjnego.
getImages()OverGridImage[]Zwraca wszystkie obrazy znajdujące się poza siatką 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, który zawiera treść.
getMaxIterativeCalculationCycles()IntegerZwraca maksymalną liczbę iteracji do użycia podczas obliczeń iteracyjnych.
getName()StringPobiera nazwę dokumentu.
getNamedRanges()NamedRange[]Pobiera wszystkie zakresy nazwane w tym arkuszu kalkulacyjnym.
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[]Zwraca tablicę obiektów reprezentujących wszystkie zakresy chronione lub arkusze w arkuszu kalkulacyjnym.
getRange(a1Notation)RangeZwraca zakres określony w notacji A1 lub R1C1.
getRangeByName(name)RangeZwraca nazwany zakres lub null, jeśli nie znaleziono zakresu o podanej nazwie.
getRangeList(a1Notations)RangeListZwraca kolekcję RangeList reprezentującą zakresy w tym samym arkuszu określone przez niepustą listę notacji A1 lub R1C1.
getRecalculationInterval()RecalculationIntervalZwraca interwał obliczeń dla tego arkusza kalkulacyjnego.
getRowHeight(rowPosition)IntegerPobiera wysokość podanego wiersza w pikselach.
getSelection()SelectionZwraca bieżącą Selection w arkuszu kalkulacyjnym.
getSheetById(id)SheetPobiera arkusz o podanym identyfikatorze.
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 dla tego zakresu, zaczynając od podanych współrzędnych.
getSheets()Sheet[]Pobiera wszystkie arkusze w tym arkuszu kalkulacyjnym.
getSpreadsheetLocale()StringPobiera ustawienia regionalne arkusza kalkulacyjnego.
getSpreadsheetTheme()SpreadsheetThemeZwraca bieżący motyw arkusza kalkulacyjnego lub null, jeśli nie jest stosowany żaden motyw.
getSpreadsheetTimeZone()StringPobiera strefę czasową arkusza kalkulacyjnego.
getUrl()StringZwraca adres URL danego arkusza kalkulacyjnego.
getViewers()User[]Pobiera listę przeglądających i komentujących dla tego Spreadsheet.
hideColumn(column)voidUkrywa kolumnę lub kolumny w danym 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 podaną liczbę kolumn po podanej pozycji kolumny.
insertColumnsBefore(beforePosition, howMany)SheetWstawia określoną liczbę kolumn przed podaną pozycją kolumny.
insertDataSourceSheet(spec)DataSourceSheetWstawia nowy DataSourceSheet w arkuszu kalkulacyjnym i rozpoczyna wykonywanie 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 w pikselach.
insertImage(url, column, row)OverGridImageWstawia obraz do dokumentu w danym wierszu i kolumnie.
insertImage(url, column, row, offsetX, offsetY)OverGridImageWstawia obraz do dokumentu w danym wierszu i kolumnie z przesunięciem w pikselach.
insertRowAfter(afterPosition)SheetWstawia wiersz po podanym wierszu.
insertRowBefore(beforePosition)SheetWstawia wiersz przed podaną pozycją wiersza.
insertRowsAfter(afterPosition, howMany)SheetWstawia określoną liczbę wierszy po podanym wierszu.
insertRowsBefore(beforePosition, howMany)SheetWstawia określoną liczbę wierszy przed podanym wierszem.
insertSheet()SheetWstawia do arkusza nowy arkusz z domyślną nazwą.
insertSheet(sheetIndex)SheetWstawia nowy arkusz do arkusza kalkulacyjnego pod podanym indeksem.
insertSheet(sheetIndex, options)SheetWstawia nowy arkusz do arkusza kalkulacyjnego pod podanym indeksem i używa opcjonalnych argumentów zaawansowanych.
insertSheet(options)SheetWstawia do arkusza kalkulacyjnego nowy arkusz z domyślną nazwą i opcjonalnymi argumentami zaawansowanymi.
insertSheet(sheetName)SheetWstawia do arkusza nowy arkusz o podanej nazwie.
insertSheet(sheetName, sheetIndex)SheetWstawia do arkusza nowy arkusz o podanej nazwie w określonym indeksie.
insertSheet(sheetName, sheetIndex, options)SheetWstawia do arkusza kalkulacyjnego nową kartę o podanej nazwie i w podanym indeksie oraz używa opcjonalnych argumentów zaawansowanych.
insertSheet(sheetName, options)SheetWstawia do arkusza kalkulacyjnego nową kartę o podanej nazwie i używa opcjonalnych argumentów zaawansowanych.
insertSheetWithDataSourceTable(spec)SheetWstawia do arkusza kalkulacyjnego nowy arkusz, tworzy w nim DataSourceTable obejmujący cały arkusz z podaną specyfikacją źródła danych i uruchamia wykonywanie danych.
isColumnHiddenByUser(columnPosition)BooleanZwraca informację, czy dana kolumna jest ukryta przez użytkownika.
isIterativeCalculationEnabled()BooleanZwraca informację, czy w tym arkuszu kalkulacyjnym jest aktywowane obliczanie iteracyjne.
isRowHiddenByFilter(rowPosition)BooleanZwraca informację, czy dany wiersz jest ukryty przez filtr (nie przez widok filtra).
isRowHiddenByUser(rowPosition)BooleanZwraca informację, czy dany wiersz jest ukryty przez użytkownika.
moveActiveSheet(pos)voidPrzenosi aktywny arkusz na podaną pozycję na liście arkuszy.
moveChartToObjectSheet(chart)SheetTworzy nowy arkusz SheetType.OBJECT i przenosi do niego podany wykres.
refreshAllDataSources()voidOdświeża wszystkie obsługiwane źródła danych i powiązane z nimi obiekty źródła danych, pomijając nieprawidłowe obiekty źródła danych.
removeEditor(emailAddress)SpreadsheetUsuwa podanego użytkownika z listy edytujących Spreadsheet.
removeEditor(user)SpreadsheetUsuwa podanego użytkownika z listy edytujących Spreadsheet.
removeMenu(name)voidUsuwa menu dodane przez 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 Spreadsheet.
removeViewer(user)SpreadsheetUsuwa danego użytkownika z listy przeglądających i komentujących Spreadsheet.
rename(newName)voidzmienia nazwę dokumentu,
renameActiveSheet(newName)voidZmienia nazwę bieżącego aktywnego arkusza na podaną nową nazwę.
resetSpreadsheetTheme()SpreadsheetThemeUsuwa zastosowany motyw i ustawia domyślny motyw arkusza kalkulacyjnego.
setActiveRange(range)RangeUstawia określony zakres jako active range w aktywnym arkuszu, a lewą górną komórkę w zakresie jako current cell.
setActiveRangeList(rangeList)RangeListUstawia określoną listę zakresów jako active ranges w aktywnym arkuszu.
setActiveSelection(range)RangeUstawia aktywny region zaznaczenia w tym arkuszu.
setActiveSelection(a1Notation)RangeUstawia aktywne zaznaczenie określone w notacji A1 lub R1C1.
setActiveSheet(sheet)SheetUstawia podany arkusz jako aktywny w arkuszu kalkulacyjnym.
setActiveSheet(sheet, restoreSelection)SheetUstawia podany arkusz jako aktywny w arkuszu kalkulacyjnym, z opcją przywrócenia ostatniego zaznaczenia w tym arkuszu.
setColumnWidth(columnPosition, width)SheetUstawia szerokość podanej 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 jest aktywowane obliczanie iteracyjne.
setMaxIterativeCalculationCycles(maxIterations)SpreadsheetOkreśla maksymalną liczbę iteracji obliczeń, które mają być wykonywane podczas obliczeń iteracyjnych.
setNamedRange(name, range)voidNazywa zakres.
setRecalculationInterval(recalculationInterval)SpreadsheetOkreśla, jak często ten arkusz kalkulacyjny ma być ponownie obliczany.
setRowHeight(rowPosition, height)SheetUstawia wysokość wiersza w pikselach.
setSpreadsheetLocale(locale)voidUstawia język arkusza kalkulacyjnego.
setSpreadsheetTheme(theme)SpreadsheetThemeUstawia motyw w arkuszu kalkulacyjnym.
setSpreadsheetTimeZone(timezone)voidUstawia strefę czasową arkusza kalkulacyjnego.
show(userInterface)voidWyświetla niestandardowy komponent interfejsu w oknie dialogowym wyśrodkowanym w obszarze widoku przeglądarki użytkownika.
sort(columnPosition)SheetSortuje arkusz według kolumny w kolejności rosnącej.
sort(columnPosition, ascending)SheetSortuje arkusz według kolumny.
toast(msg)voidWyświetla w prawym dolnym rogu arkusza kalkulacyjnego wyskakujące okienko z podaną wiadomością.
toast(msg, title)voidWyświetla w prawym dolnym rogu arkusza kalkulacyjnego okno z podanym komunikatem i tytułem.
toast(msg, title, timeoutSeconds)voidWyświetla w prawym dolnym rogu arkusza kalkulacyjnego wyskakujące okienko o podanym tytule i treści, które pozostaje widoczne przez określony czas.
unhideColumn(column)voidOdkrywa kolumnę w danym zakresie.
unhideRow(row)voidOdkrywa wiersz w danym zakresie.
updateMenu(name, subMenus)voidAktualizuje menu dodane przez addMenu(name, subMenus).
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidCzeka na zakończenie wszystkich bieżących wykonań w arkuszu kalkulacyjnym. Po upływie podanej liczby sekund następuje przekroczenie limitu czasu.

Szczegółowa dokumentacja

addDeveloperMetadata(key)

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

// 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 nowych metadanych dewelopera.

Powrót

Spreadsheet – ten arkusz kalkulacyjny do łączenia.

Autoryzacja

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

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

addDeveloperMetadata(key, visibility)

Dodaje do arkusza 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 nowych metadanych dewelopera.
visibilityDeveloperMetadataVisibilityWidoczność nowych metadanych dewelopera.

Powrót

Spreadsheet – ten arkusz kalkulacyjny do łączenia.

Autoryzacja

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

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

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 nowych metadanych dewelopera.
valueStringWartość nowych metadanych dewelopera.

Powrót

Spreadsheet – ten arkusz kalkulacyjny do łączenia.

Autoryzacja

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

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

addDeveloperMetadata(key, value, visibility)

Dodaje do arkusza kalkulacyjnego metadane dewelopera o określonym kluczu, 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 nowych metadanych dewelopera.
valueStringWartość nowych metadanych dewelopera.
visibilityDeveloperMetadataVisibilityWidoczność nowych metadanych dewelopera.

Powrót

Spreadsheet – ten arkusz kalkulacyjny do łączenia.

Autoryzacja

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

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

addEditor(emailAddress)

Dodaje podanego użytkownika do listy edytujących Spreadsheet. Jeśli użytkownik był już na liście widzów, ta metoda usuwa go z tej listy.

Parametry

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

Powrót

Spreadsheet – ten Spreadsheet do tworzenia łańcuszków.

Autoryzacja

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

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

addEditor(user)

Dodaje podanego użytkownika do listy edytujących Spreadsheet. Jeśli użytkownik był już na liście widzów, ta metoda usuwa go z tej listy.

Parametry

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

Powrót

Spreadsheet – ten Spreadsheet do tworzenia łańcuszków.

Autoryzacja

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

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

addEditors(emailAddresses)

Dodaje podaną tablicę użytkowników do listy edytujących Spreadsheet. Jeśli któryś z użytkowników był już na liście widzów, ta metoda usunie go z tej listy.

Parametry

NazwaTypOpis
emailAddressesString[]Tablica adresów e-mail użytkowników, których chcesz dodać.

Powrót

Spreadsheet – ten Spreadsheet do tworzenia łańcuszków.

Autoryzacja

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

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

addMenu(name, subMenus)

Tworzy nowe menu w interfejsie arkusza kalkulacyjnego.

Każda pozycja menu uruchamia funkcję zdefiniowaną przez użytkownika. Zwykle warto wywołać ją z funkcji onOpen(), aby menu było tworzone automatycznie po wczytaniu arkusza kalkulacyjnego.

// The onOpen function is executed automatically every time a Spreadsheet is
// loaded
function onOpen() {
  const ss = SpreadsheetApp.getActiveSpreadsheet();
  const 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 namefunctionName . Możesz używać funkcji z dołączonych bibliotek, np. Library.libFunction1.

Autoryzacja

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

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

addViewer(emailAddress)

Dodaje podanego użytkownika do listy widzów Spreadsheet. Jeśli użytkownik był już na liście edytujących, ta metoda nie ma wpływu.

Parametry

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

Powrót

Spreadsheet – ten Spreadsheet do tworzenia łańcuszków.

Autoryzacja

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

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

addViewer(user)

Dodaje podanego użytkownika do listy widzów Spreadsheet. Jeśli użytkownik był już na liście edytujących, ta metoda nie ma wpływu.

Parametry

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

Powrót

Spreadsheet – ten Spreadsheet do tworzenia łańcuszków.

Autoryzacja

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

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

addViewers(emailAddresses)

Dodaje podaną tablicę użytkowników do listy widzów Spreadsheet. Jeśli któryś z użytkowników był już na liście edytujących, ta metoda nie będzie miała na niego wpływu.

Parametry

NazwaTypOpis
emailAddressesString[]Tablica adresów e-mail użytkowników, których chcesz dodać.

Powrót

Spreadsheet – ten Spreadsheet do tworzenia łańcuszków.

Autoryzacja

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

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

appendRow(rowContents)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 w przypadku łączenia metod.

Autoryzacja

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

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

autoResizeColumn(columnPosition)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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
columnPositionIntegerPołożenie danej kolumny, której rozmiar ma zostać zmieniony.

Powrót

Sheet – arkusz, przydatny w przypadku łączenia metod.

Autoryzacja

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

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

copy(name)

Kopiuje arkusz kalkulacyjny i zwraca nowy.

// This code makes a copy of the current spreadsheet and names it appropriately
const ss = SpreadsheetApp.getActiveSpreadsheet();
ss.copy(`Copy of ${ss.getName()}`);

Parametry

NazwaTypOpis
nameStringNazwa kopii.

Powrót

Spreadsheet – ten arkusz kalkulacyjny do łączenia.

Autoryzacja

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

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

createDeveloperMetadataFinder()

Zwraca DeveloperMetadataFinder do wyszukiwania metadanych dewelopera w zakresie tego arkusza kalkulacyjnego. Domyślnie uwzględnia 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 dewelopera, która umożliwia wyszukiwanie metadanych w zakresie tego arkusza kalkulacyjnego.


createTextFinder(findText)

Tworzy w arkuszu kalkulacyjnym narzędzie do wyszukiwania tekstu, które umożliwia wyszukiwanie i zamienianie tekstu w arkuszu. Wyszukiwanie rozpoczyna się od pierwszego arkusza.

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

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

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

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

Parametry

NazwaTypOpis
findTextStringTekst do wyszukania.

Powrót

TextFinder – TextFinder arkusza kalkulacyjnego.


deleteActiveSheet()

Usuwa aktualnie aktywny arkusz.

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

Powrót

Sheet – nowy aktywny arkusz.

Autoryzacja

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

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

deleteColumn(columnPosition)

Usuwa kolumnę w podanym miejscu.

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

Parametry

NazwaTypOpis
columnPositionIntegerPozycja kolumny, przy czym 1 oznacza pierwszą kolumnę.

Powrót

Sheet – arkusz, przydatny w przypadku łączenia metod.

Autoryzacja

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

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

deleteColumns(columnPosition, howMany)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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.

Autoryzacja

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

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

deleteRow(rowPosition)

Usuwa wiersz w danym miejscu.

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

Parametry

NazwaTypOpis
rowPositionIntegerPozycja wiersza, zaczynając od 1 dla pierwszego wiersza.

Powrót

Sheet – arkusz, przydatny w przypadku łączenia metod.

Autoryzacja

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

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

deleteRows(rowPosition, howMany)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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.

Autoryzacja

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

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

deleteSheet(sheet)

Usuwa określony arkusz.

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

Parametry

NazwaTypOpis
sheetSheetArkusz do usunięcia.

Autoryzacja

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

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

duplicateActiveSheet()

Duplikuje aktywny arkusz i ustawia go jako aktywny.

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

Powrót

Sheet – nowy arkusz.

Autoryzacja

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

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

getActiveCell()

Zwraca aktywną komórkę w tym arkuszu.

Uwaga: zalecamy używanie funkcji getCurrentCell(), która zwraca bieżącą wyróżnioną komórkę.

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

Powrót

Range – bieżąca aktywna komórka.

Autoryzacja

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

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

getActiveRange()

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

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

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

Powrót

Range – aktywny zakres.

Autoryzacja

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

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

Zobacz też


getActiveRangeList()

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

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

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

Powrót

RangeList – lista aktywnych zakresów.

Autoryzacja

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

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

Zobacz też


getActiveSheet()

Pobiera aktywny arkusz w arkuszu kalkulacyjnym.

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

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

Powrót

Sheet – aktywny arkusz w arkuszu kalkulacyjnym.


getAs(contentType)

Zwraca dane w tym obiekcie jako obiekt blob przekonwertowany na określony typ treści. Ta metoda dodaje do nazwy pliku odpowiednie rozszerzenie, np. „mójplik.pdf”. Zakłada jednak, że część nazwy pliku, która następuje po ostatniej kropce (jeśli występuje), jest istniejącym rozszerzeniem, które należy zastąpić. W konsekwencji nazwa „ShoppingList.12.25.2014” zmieni się na „ShoppingList.12.25.pdf”.

Aby wyświetlić dzienne limity konwersji, zapoznaj się z artykułem Limity usług Google. Nowo utworzone domeny Google Workspace mogą być tymczasowo objęte bardziej rygorystycznymi limitami.

Parametry

NazwaTypOpis
contentTypeStringTyp MIME, na który ma zostać przekonwertowany plik. 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 prawidłowe są też znaki 'image/bmp', 'image/gif', 'image/jpeg' i 'image/png'. W przypadku dokumentu w Dokumentach Google 'text/markdown' jest również prawidłowe.

Powrót

Blob – dane w formie obiektu blob.


getBandings()

Zwraca wszystkie zakresy 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[] – przedziały w tym arkuszu kalkulacyjnym.

Autoryzacja

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

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

getBlob()

Zwraca dane w tym obiekcie jako obiekt blob.

Powrót

Blob – dane w formie obiektu blob.


getColumnWidth(columnPosition)

Pobiera szerokość podanej kolumny w pikselach.

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

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

Parametry

NazwaTypOpis
columnPositionIntegerPozycja kolumny do sprawdzenia.

Powrót

Integer – szerokość kolumny w pikselach.

Autoryzacja

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

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

getCurrentCell()

Zwraca bieżącą komórkę w aktywnym arkuszu lub null, jeśli nie ma bieżącej komórki. Bieżąca komórka to komórka, która jest aktywna w interfejsie Arkuszy Google i jest wyróżniona ciemną ramką. Zawsze jest tylko jedna bieżąca komórka. Gdy użytkownik wybierze co najmniej 1 zakres komórek, jedną z nich będzie komórka bieżąca.

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

Powrót

Range – bieżąca komórka.

Autoryzacja

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

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

getDataRange()

Zwraca Range odpowiadający wymiarom, w których występują dane.

Jest to funkcjonalny odpowiednik utworzenia zakresu ograniczonego przez komórkę A1 i komórkę (Sheet.getLastColumn(), Sheet.getLastRow()).

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

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

// This logs the spreadsheet in CSV format with a trailing comma
for (let i = 0; i < values.length; i++) {
  let row = '';
  for (let 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 obejmujący wszystkie dane w arkuszu kalkulacyjnym.

Autoryzacja

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

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

getDataSourceFormulas()

Pobiera wszystkie formuły źródła 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.

Autoryzacja

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

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

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.

Autoryzacja

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

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

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 tego arkusza kalkulacyjnego.

Autoryzacja

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

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

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ódeł danych.

Autoryzacja

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

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

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.

Autoryzacja

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

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

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.

Autoryzacja

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

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

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.

Autoryzacja

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

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

getEditors()

Pobiera listę edytujących ten Spreadsheet.

Powrót

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

Autoryzacja

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

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

getFormUrl()

Zwraca adres URL formularza, który wysyła odpowiedzi do tego arkusza kalkulacyjnego, lub null, jeśli ten arkusz nie jest powiązany z formularzem. Jeśli wiele formularzy wysyła odpowiedzi do tego arkusza kalkulacyjnego, zwrócony adres URL formularza jest nieokreślony. Alternatywnie powiązania adresów URL formularzy z poszczególnymi arkuszami można pobrać za pomocą metody Sheet.getFormUrl(). Zgłasza wyjątek, jeśli użytkownik nie ma uprawnień do edytowania 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 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 ten arkusz kalkulacyjny nie ma powiązanego formularza.

Autoryzacja

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

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

getFrozenColumns()

Zwraca liczbę zamrożonych kolumn.

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

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

Powrót

Integer – liczba zablokowanych kolumn.

Autoryzacja

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

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

getFrozenRows()

Zwraca liczbę zamrożonych wierszy.

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

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

Powrót

Integer – liczba zablokowanych wierszy.

Autoryzacja

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

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

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ę poza siatką 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ą.

Autoryzacja

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

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

getIterativeCalculationConvergenceThreshold()

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

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

Autoryzacja

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

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

getLastColumn()

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

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

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

Powrót

Integer – ostatnia kolumna arkusza zawierająca treść.

Autoryzacja

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

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

getLastRow()

Zwraca pozycję ostatniego wiersza, który zawiera treść.

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

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

Powrót

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

Autoryzacja

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

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

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ń.

Autoryzacja

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

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

getName()

Pobiera nazwę dokumentu.

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

Powrót

String – nazwa arkusza kalkulacyjnego.

Autoryzacja

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

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

getNamedRanges()

Pobiera wszystkie zakresy nazwane w tym arkuszu kalkulacyjnym.

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

Powrót

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

Autoryzacja

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

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

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.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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.

Autoryzacja

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

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

getPredefinedSpreadsheetThemes()

Zwraca listę wstępnie zdefiniowanych motywów.

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

Powrót

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

Autoryzacja

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

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

getProtections(type)

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

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

Parametry

NazwaTypOpis
typeProtectionTypeTyp obszaru chronionego, czyli SpreadsheetApp.ProtectionType.RANGE lub SpreadsheetApp.ProtectionType.SHEET.

Powrót

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

Autoryzacja

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

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

getRange(a1Notation)

Zwraca zakres określony w notacji A1 lub R1C1.

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

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

Parametry

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

Powrót

Range – zakres w wyznaczonej lokalizacji.

Autoryzacja

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

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

getRangeByName(name)

Zwraca nazwany zakres lub null, jeśli nie znaleziono zakresu o podanej nazwie. Jeśli wiele arkuszy kalkulacyjnych używa tej samej nazwy zakresu, podaj nazwę arkusza bez dodatkowych cudzysłowów, np. 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.
const 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ślone przez niepustą listę notacji A1 lub R1C1.

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

Parametry

NazwaTypOpis
a1NotationsString[]Lista zakresów do zwrócenia w notacji A1 lub R1C1.

Powrót

RangeList – lista zakresów w wyznaczonej lokalizacji.

Autoryzacja

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

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

getRecalculationInterval()

Zwraca interwał obliczeń 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 – interwał obliczeń dla tego arkusza kalkulacyjnego.

Autoryzacja

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

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

getRowHeight(rowPosition)

Pobiera wysokość podanego wiersza w pikselach.

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

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

Parametry

NazwaTypOpis
rowPositionIntegerPozycja wiersza do sprawdzenia.

Powrót

Integer – wysokość wiersza w pikselach.

Autoryzacja

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

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

getSelection()

Zwraca bieżącą Selection w arkuszu kalkulacyjnym.

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

Powrót

Selection – aktualny wybór.

Autoryzacja

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

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

getSheetById(id)

Pobiera arkusz o podanym identyfikatorze. Użyj konta Sheet.getSheetId().

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetById(12345);

Parametry

NazwaTypOpis
idIntegerIdentyfikator arkusza do pobrania.

Powrót

Sheet – arkusz o podanym identyfikatorze lub null, jeśli nie znaleziono arkusza.


getSheetByName(name)

Zwraca arkusz o podanej nazwie.

Jeśli wiele arkuszy ma taką samą nazwę, zwracany jest arkusz znajdujący się najbardziej po lewej stronie. Zwraca null, jeśli nie ma arkusza o podanej nazwie.

// The code below logs the index of a sheet named "Expenses"
const 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 arkusza, który jest unikalny w arkuszu kalkulacyjnym. Jest to rosnąca liczba całkowita przypisywana w momencie tworzenia arkusza, 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 zamiast instancji Sheet.

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

Logger.log(sheet.getSheetId());

Powrót

Integer – identyfikator arkusza unikalny w arkuszu kalkulacyjnym.

Autoryzacja

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

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

getSheetName()

Zwraca nazwę arkusza.

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

Logger.log(sheet.getSheetName());

Powrót

String – nazwa arkusza.

Autoryzacja

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

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

getSheetValues(startRow, startColumn, numRows, numColumns)

Zwraca prostokątną siatkę wartości dla tego zakresu, zaczynając od podanych współrzędnych. Wartość -1 podana jako pozycja wiersza lub kolumny jest równoważna z uzyskaniem ostatniego wiersza lub kolumny, w których znajdują się dane w arkuszu.

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

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

const 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ą być zwracane wartości.

Powrót

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

Autoryzacja

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

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

getSheets()

Pobiera wszystkie arkusze w tym arkuszu kalkulacyjnym.

// The code below logs the name of the second sheet
const sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
// Iterates through the sheets and logs the name and ID of each sheet.
for (const sheet of sheets) {
  Logger.log(`name: ${sheet.getName()}, ID: ${sheet.getSheetId()}`);
}

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.

Autoryzacja

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

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

getSpreadsheetTheme()

Zwraca bieżący motyw arkusza kalkulacyjnego lub null, jeśli nie jest stosowany żaden motyw.

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

Powrót

SpreadsheetTheme – obecnie zastosowany motyw.

Autoryzacja

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

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

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. „America/New_York”, zgodnie z listą na stronie Joda.org).

Autoryzacja

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

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

getUrl()

Zwraca adres URL danego arkusza kalkulacyjnego.

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

Powrót

String – adres URL danego arkusza kalkulacyjnego.

Autoryzacja

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

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

getViewers()

Pobiera listę przeglądających i komentujących dla tego Spreadsheet.

Powrót

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

Autoryzacja

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

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

hideColumn(column)

Ukrywa kolumnę lub kolumny w danym zakresie.

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

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

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

Parametry

NazwaTypOpis
columnRangeZakres kolumn do ukrycia.

Autoryzacja

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

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

hideRow(row)

Ukrywa wiersze w podanym zakresie.

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

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

Parametry

NazwaTypOpis
rowRangeZakres wierszy do ukrycia.

Autoryzacja

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

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

insertColumnAfter(afterPosition)

Wstawia kolumnę po podanej pozycji kolumny.

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

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

Parametry

NazwaTypOpis
afterPositionIntegerKolumna, po której ma zostać dodana nowa kolumna.

Powrót

Sheet – arkusz, przydatny w przypadku łączenia metod.

Autoryzacja

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

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

insertColumnBefore(beforePosition)

Wstawia kolumnę przed podaną pozycją kolumny.

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

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

Parametry

NazwaTypOpis
beforePositionIntegerKolumna, przed którą należy dodać nową kolumnę.

Powrót

Sheet – arkusz, przydatny w przypadku łączenia metod.

Autoryzacja

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

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

insertColumnsAfter(afterPosition, howMany)

Wstawia podaną liczbę kolumn po podanej pozycji kolumny.

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

// Inserts two columns after the first column on the first sheet of the
// spreadsheet.
sheet.insertColumnsAfter(1, 2);

Parametry

NazwaTypOpis
afterPositionIntegerKolumna, po której ma zostać dodana nowa kolumna.
howManyIntegerLiczba kolumn do wstawienia.

Powrót

Sheet – arkusz, przydatny w przypadku łączenia metod.

Autoryzacja

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

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

insertColumnsBefore(beforePosition, howMany)

Wstawia określoną liczbę kolumn przed podaną pozycją kolumny.

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

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

Parametry

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

Powrót

Sheet – arkusz, przydatny w przypadku łączenia metod.

Autoryzacja

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

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

insertDataSourceSheet(spec)

Wstawia nowy DataSourceSheet w arkuszu kalkulacyjnym i rozpoczyna wykonywanie danych. W efekcie nowy arkusz staje się też aktywnym arkuszem.

Zgłasza wyjątek, jeśli typ źródła danych nie jest włączony. Użyj metod SpreadsheetApp#enable...Execution(), aby umożliwić wykonywanie zapytań do bazy 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 do wstawienia.

Powrót

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

Autoryzacja

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

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

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.

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

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

Parametry

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

Powrót

OverGridImage – wstawiony obraz.

Autoryzacja

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

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

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

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

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

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

Parametry

NazwaTypOpis
blobSourceBlobSourceObiekt blob zawierający treść obrazu, typ MIME i (opcjonalnie) nazwę.
columnIntegerPozycja kolumny.
rowIntegerPozycja wiersza.
offsetXIntegerPoziome przesunięcie od rogu komórki w pikselach.
offsetYIntegerPionowe przesunięcie od rogu komórki w pikselach.

Powrót

OverGridImage – wstawiony obraz.

Autoryzacja

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

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

insertImage(url, column, row)

Wstawia obraz do dokumentu w danym wierszu i kolumnie.

Podany adres URL musi być publicznie dostępny.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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.

Autoryzacja

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

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

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

Wstawia obraz do dokumentu w danym wierszu i kolumnie z przesunięciem w pikselach.

Podany adres URL musi być publicznie dostępny.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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.
offsetXIntegerPoziome przesunięcie od rogu komórki w pikselach.
offsetYIntegerPionowe przesunięcie od rogu komórki w pikselach.

Powrót

OverGridImage – wstawiony obraz.

Autoryzacja

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

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

insertRowAfter(afterPosition)

Wstawia wiersz po podanym wierszu.

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

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

Parametry

NazwaTypOpis
afterPositionIntegerWiersz, po którym ma zostać dodany nowy wiersz.

Powrót

Sheet – arkusz, przydatny w przypadku łączenia metod.

Autoryzacja

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

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

insertRowBefore(beforePosition)

Wstawia wiersz przed podaną pozycją wiersza.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 w przypadku łączenia metod.

Autoryzacja

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

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

insertRowsAfter(afterPosition, howMany)

Wstawia określoną liczbę wierszy po podanym wierszu.

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

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

Parametry

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

Powrót

Sheet – arkusz, przydatny w przypadku łączenia metod.

Autoryzacja

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

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

insertRowsBefore(beforePosition, howMany)

Wstawia określoną liczbę wierszy przed podanym wierszem.

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

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

Parametry

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

Powrót

Sheet – arkusz, przydatny w przypadku łączenia metod.

Autoryzacja

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

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

insertSheet()

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

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

Powrót

Sheet – nowy arkusz.

Autoryzacja

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

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

insertSheet(sheetIndex)

Wstawia nowy arkusz do arkusza kalkulacyjnego pod podanym indeksem. Nowy arkusz stanie się aktywny.

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

Parametry

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

Powrót

Sheet – nowy arkusz.

Autoryzacja

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

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

insertSheet(sheetIndex, options)

Wstawia nowy arkusz do arkusza kalkulacyjnego pod podanym indeksem i używa opcjonalnych argumentów zaawansowanych. Nowy arkusz stanie się aktywny.

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

Parametry

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

Parametry zaawansowane

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

Powrót

Sheet – nowy arkusz.

Autoryzacja

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

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

insertSheet(options)

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

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

Parametry

NazwaTypOpis
optionsObjectOpcjonalne argumenty zaawansowane JavaScriptu wymienione poniżej.

Parametry zaawansowane

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

Powrót

Sheet – nowy arkusz.

Autoryzacja

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

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

insertSheet(sheetName)

Wstawia do arkusza nowy arkusz o podanej nazwie. Nowy arkusz stanie się aktywny.

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

Parametry

NazwaTypOpis
sheetNameStringNazwa nowego arkusza.

Powrót

Sheet – nowy arkusz.

Autoryzacja

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

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

insertSheet(sheetName, sheetIndex)

Wstawia do arkusza nowy arkusz o podanej nazwie w określonym indeksie. Nowa karta stanie się aktywna.

const 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 kalkulacyjnym, ustaw wartość 0.

Powrót

Sheet – nowy arkusz.

Autoryzacja

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

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

insertSheet(sheetName, sheetIndex, options)

Wstawia do arkusza kalkulacyjnego nową kartę o podanej nazwie i w podanym indeksie oraz używa opcjonalnych argumentów zaawansowanych. Nowy arkusz stanie się aktywny.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 go na 0.
optionsObjectOpcjonalne argumenty zaawansowane JavaScriptu.

Parametry zaawansowane

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

Powrót

Sheet – nowy arkusz.

Autoryzacja

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

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

insertSheet(sheetName, options)

Wstawia do arkusza kalkulacyjnego nową kartę o podanej nazwie i używa opcjonalnych argumentów zaawansowanych. Nowy arkusz stanie się aktywny.

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

Parametry

NazwaTypOpis
sheetNameStringNazwa nowego arkusza.
optionsObjectOpcjonalne argumenty zaawansowane JavaScriptu.

Parametry zaawansowane

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

Powrót

Sheet – nowy arkusz.

Autoryzacja

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

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

insertSheetWithDataSourceTable(spec)

Wstawia do arkusza kalkulacyjnego nowy arkusz, tworzy w nim DataSourceTable obejmujący cały arkusz z podaną specyfikacją źródła danych i uruchamia wykonywanie danych. Przy okazji sprawia, że nowy arkusz staje się aktywny.

Zgłasza wyjątek, jeśli typ źródła danych nie jest włączony. Użyj metod SpreadsheetApp#enable...Execution(), aby umożliwić wykonywanie zapytań do bazy 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 do wstawienia.

Powrót

Sheet – nowy arkusz.

Autoryzacja

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

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

isColumnHiddenByUser(columnPosition)

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

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

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

Parametry

NazwaTypOpis
columnPositionIntegerPozycja kolumny do sprawdzenia.

Powrót

Boolean – true, jeśli kolumna jest ukryta, w przeciwnym razie false.

Autoryzacja

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

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

isIterativeCalculationEnabled()

Zwraca informację, czy w tym arkuszu kalkulacyjnym jest aktywowane obliczanie 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

Boolean – true, jeśli obliczenia iteracyjne są aktywne, false w przeciwnym razie.

Autoryzacja

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

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

isRowHiddenByFilter(rowPosition)

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

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

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

Parametry

NazwaTypOpis
rowPositionIntegerPozycja wiersza do sprawdzenia.

Powrót

Boolean – true, jeśli wiersz jest ukryty, w przeciwnym razie false.

Autoryzacja

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

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

isRowHiddenByUser(rowPosition)

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

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

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

Parametry

NazwaTypOpis
rowPositionIntegerPozycja wiersza do sprawdzenia.

Powrót

Boolean – true, jeśli wiersz jest ukryty, w przeciwnym razie false.

Autoryzacja

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

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

moveActiveSheet(pos)

Przenosi aktywny arkusz na podaną pozycję na liście arkuszy. Zgłasza wyjątek, jeśli pozycja jest ujemna lub większa niż liczba 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.
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// Gets the "first" sheet and activates it.
const 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 (liczona od 1) na liście arkuszy, na którą ma zostać przeniesiony aktywny arkusz.

Autoryzacja

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

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

moveChartToObjectSheet(chart)

Tworzy nowy arkusz SheetType.OBJECT i przenosi do niego podany wykres. Jeśli wykres znajduje się już na osobnej karcie, zwracana jest ta karta bez tworzenia nowej.

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

Parametry

NazwaTypOpis
chartEmbeddedChartWykres do przeniesienia.

Powrót

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

Autoryzacja

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

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

refreshAllDataSources()

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

Użyj metod SpreadsheetApp#enable...Execution(), aby umożliwić wykonywanie zapytań do bazy 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()}`,
);

Autoryzacja

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

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

removeEditor(emailAddress)

Usuwa podanego użytkownika z listy edytujących Spreadsheet. Ta metoda nie blokuje użytkownikom dostępu do Spreadsheet, jeśli należą oni do klasy użytkowników, którzy mają ogólny dostęp, np. jeśli Spreadsheet jest udostępniony całej domenie użytkownika lub jeśli Spreadsheet znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.

W przypadku plików na Dysku spowoduje to również usunięcie użytkownika z listy osób, które mogą je wyświetlać.

Parametry

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

Powrót

Spreadsheet – ten Spreadsheet do tworzenia łańcuszków.

Autoryzacja

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

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

removeEditor(user)

Usuwa podanego użytkownika z listy edytujących Spreadsheet. Ta metoda nie blokuje użytkownikom dostępu do Spreadsheet, jeśli należą oni do klasy użytkowników, którzy mają ogólny dostęp, np. jeśli Spreadsheet jest udostępniony całej domenie użytkownika lub jeśli Spreadsheet znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.

W przypadku plików na Dysku spowoduje to również usunięcie użytkownika z listy osób, które mogą je wyświetlać.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika do usunięcia.

Powrót

Spreadsheet – ten Spreadsheet do tworzenia łańcuszków.

Autoryzacja

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

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

removeMenu(name)

Usuwa menu dodane przez addMenu(name, subMenus). Argument name powinien mieć taką samą wartość jak odpowiednie wywołanie funkcji addMenu(name, subMenus).

// The onOpen function is executed automatically every time a Spreadsheet is
// loaded
function onOpen() {
  const ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.addMenu('badMenu', [
    {name: 'remove bad menu', functionName: 'removeBadMenu'},
    {name: 'foo', functionName: 'foo'},
  ]);
}
function removeBadMenu() {
  const 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.

Autoryzacja

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

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

removeNamedRange(name)

Usuwa zakres nazwany o podanej nazwie. Zwraca wyjątek, jeśli w arkuszu kalkulacyjnym nie znaleziono zakresu o podanej nazwie.

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

Parametry

NazwaTypOpis
nameStringNazwa zakresu.

Autoryzacja

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

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

removeViewer(emailAddress)

Usuwa danego użytkownika z listy przeglądających i komentujących Spreadsheet. Ta metoda nie ma wpływu, jeśli użytkownik jest edytującym, a nie przeglądającym lub komentującym. Ta metoda nie blokuje też dostępu do Spreadsheet użytkownikom, którzy należą do grupy użytkowników mających ogólny dostęp, np. jeśli Spreadsheet jest udostępniony całej domenie użytkownika lub jeśli Spreadsheet znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.Spreadsheet

W przypadku plików na Dysku spowoduje to również usunięcie użytkownika z listy edytujących.

Parametry

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

Powrót

Spreadsheet – ten znak Spreadsheet służy do łączenia.

Autoryzacja

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

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

removeViewer(user)

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

W przypadku plików na Dysku spowoduje to również usunięcie użytkownika z listy edytujących.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika do usunięcia.

Powrót

Spreadsheet – ten znak Spreadsheet służy do łączenia.

Autoryzacja

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

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

rename(newName)

zmienia nazwę dokumentu,

const ss = SpreadsheetApp.getActiveSpreadsheet();
ss.rename('This is the new name');

Parametry

NazwaTypOpis
newNameStringNowa nazwa dokumentu.

Autoryzacja

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

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

renameActiveSheet(newName)

Zmienia nazwę bieżącego 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.

Autoryzacja

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

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

resetSpreadsheetTheme()

Usuwa zastosowany motyw i ustawia domyślny motyw arkusza kalkulacyjnego.

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

Powrót

SpreadsheetTheme – motyw domyślny.

Autoryzacja

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

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

setActiveRange(range)

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

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

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

Parametry

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

Powrót

Range – nowo aktywny zakres.

Autoryzacja

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

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

setActiveRangeList(rangeList)

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

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

const selection = sheet.getSelection();
// Current cell: B2
const currentCell = selection.getCurrentCell();
// Active range: B2:C4
const activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
const activeRangeList = selection.getActiveRangeList();

Parametry

NazwaTypOpis
rangeListRangeListLista zakresów do wyboru.

Powrót

RangeList – nowo wybrana lista zakresów.

Autoryzacja

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

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

setActiveSelection(range)

Ustawia aktywny region zaznaczenia w tym arkuszu.

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

const range = sheet.getRange('A1:D4');
sheet.setActiveSelection(range);

Parametry

NazwaTypOpis
rangeRangeZakres, który ma być ustawiony jako aktywny wybór.

Powrót

Range – nowo aktywny zakres.

Autoryzacja

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

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

setActiveSelection(a1Notation)

Ustawia aktywne zaznaczenie określone w notacji A1 lub R1C1.

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

sheet.setActiveSelection('A1:D4');

Parametry

NazwaTypOpis
a1NotationStringZakres do ustawienia jako aktywny, określony w notacji A1 lub R1C1.

Powrót

Range – nowo aktywny zakres.

Autoryzacja

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

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

setActiveSheet(sheet)

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

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

Parametry

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

Powrót

Sheet – aktywny arkusz.

Autoryzacja

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

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

setActiveSheet(sheet, restoreSelection)

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

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const firstSheet = spreadsheet.getSheets()[0];
const secondSheet = spreadsheet.getSheets()[1];
// Set the first sheet as the active sheet and select the range D4:F4.
spreadsheet.setActiveSheet(firstSheet).getRange('D4:F4').activate();

// Switch to the second sheet to do some work.
spreadsheet.setActiveSheet(secondSheet);
// Switch back to first sheet, and restore its selection.
spreadsheet.setActiveSheet(firstSheet, true);

// The selection of first sheet is restored, and it logs D4:F4
const range = spreadsheet.getActiveSheet().getSelection().getActiveRange();
Logger.log(range.getA1Notation());

Parametry

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

Powrót

Sheet – nowy aktywny arkusz.

Autoryzacja

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

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

setColumnWidth(columnPosition, width)

Ustawia szerokość podanej kolumny w pikselach.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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ść w pikselach, na jaką ma zostać ustawiona.

Powrót

Sheet – arkusz, przydatny w przypadku łączenia metod.

Autoryzacja

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

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

setCurrentCell(cell)

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

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

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

Uwaga: określona Range musi składać się z 1 komórki. W przeciwnym razie zostanie zgłoszony wyjątek.

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

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

Parametry

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

Powrót

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

Autoryzacja

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

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

setFrozenColumns(columns)

Blokuje podaną liczbę kolumn. Jeśli wartość wynosi zero, żadne kolumny nie są wstrzymywane.

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

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

Parametry

NazwaTypOpis
columnsIntegerLiczba kolumn do zablokowania.

Autoryzacja

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

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

setFrozenRows(rows)

Blokuje podaną liczbę wierszy. Jeśli wartość wynosi 0, żadne wiersze nie są zamrażane.

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

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

Parametry

NazwaTypOpis
rowsIntegerLiczba wierszy do zablokowania.

Autoryzacja

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

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

setIterativeCalculationConvergenceThreshold(minThreshold)

Ustawia minimalną wartość progową dla obliczeń iteracyjnych. Gdy wyniki kolejnych obliczeń różnią się od siebie o mniej niż ta wartość, obliczenia iteracyjne zostają zatrzymane. Ta wartość musi być nieujemna, a domyślnie wynosi 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 – ten arkusz kalkulacyjny do łączenia.

Autoryzacja

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

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

setIterativeCalculationEnabled(isEnabled)

Określa, czy w tym arkuszu kalkulacyjnym jest aktywowane obliczanie iteracyjne. Jeśli maksymalna liczba cykli obliczeniowych i próg zbieżności nie zostały wcześniej ustawione podczas aktywacji obliczeń, domyślnie wynoszą one odpowiednio 50 i 0,05. Jeśli któryś z nich został wcześniej ustawiony, zachowuje poprzednią wartość.

// 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 obliczenia iteracyjne mają być włączone; false w przeciwnym razie.

Powrót

Spreadsheet – ten arkusz kalkulacyjny do łączenia.

Autoryzacja

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

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

setMaxIterativeCalculationCycles(maxIterations)

Określa maksymalną liczbę iteracji obliczeń, które mają być wykonywane podczas obliczeń iteracyjnych. Ta wartość musi mieścić się w przedziale 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 – ten arkusz kalkulacyjny do łączenia.

Autoryzacja

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

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

setNamedRange(name, range)

Nazywa zakres.

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

Parametry

NazwaTypOpis
nameStringNazwa, którą chcesz nadać zakresowi.
rangeRangeSpecyfikacja zakresu.

Autoryzacja

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

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

setRecalculationInterval(recalculationInterval)

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

// 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ł ponownego obliczania.

Powrót

Spreadsheet – ten arkusz kalkulacyjny do łączenia.

Autoryzacja

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

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

setRowHeight(rowPosition, height)

Ustawia wysokość wiersza w pikselach. Domyślnie wiersze rozszerzają się, aby dopasować się do zawartości komórek. Jeśli chcesz wymusić określoną wysokość wierszy, użyj Sheet.setRowHeightsForced(startRow, numRows, height).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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, na jaką ma zostać ustawiona.

Powrót

Sheet – arkusz, przydatny w przypadku łączenia metod.

Autoryzacja

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

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

setSpreadsheetLocale(locale)

Ustawia 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 języka do użycia (np. „en”, „fr” lub „en_US”).

Autoryzacja

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

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

setSpreadsheetTheme(theme)

Ustawia motyw w arkuszu kalkulacyjnym.

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

Parametry

NazwaTypOpis
themeSpreadsheetThemeMotyw do zastosowania.

Powrót

SpreadsheetTheme – nowy bieżący motyw.

Autoryzacja

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

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

setSpreadsheetTimeZone(timezone)

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

Parametry

NazwaTypOpis
timezoneStringStrefa czasowa podana w formacie „long” (np. „America/New_York”, zgodnie z listą na stronie Joda.org).

Autoryzacja

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

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

show(userInterface)

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

Jeśli skrypt po stronie serwera wyświetlił wcześniej okno, które nie zostało jeszcze zamknięte, istniejące okno zostanie zastąpione interfejsem nowo żądanego okna.

Poniższy fragment kodu wyświetla prostą aplikację HtmlService w oknie o określonym tytule, wysokości i szerokości:

const 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

Autoryzacja

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

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

sort(columnPosition)

Sortuje arkusz według kolumny w kolejności rosnącej.

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

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

Parametry

NazwaTypOpis
columnPositionIntegerKolumna, według której ma być wykonane sortowanie.

Powrót

Sheet – arkusz, przydatny w przypadku łączenia metod.

Autoryzacja

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

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

sort(columnPosition, ascending)

Sortuje arkusz według kolumny. Przyjmuje parametr określający kolejność rosnącą lub malejącą.

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

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

Parametry

NazwaTypOpis
columnPositionIntegerKolumna, według której ma być wykonane sortowanie.
ascendingBooleantrue – sortowanie rosnące, false – sortowanie malejące.

Powrót

Sheet – arkusz, przydatny w przypadku łączenia metod.

Autoryzacja

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

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

toast(msg)

Wyświetla w prawym dolnym rogu arkusza kalkulacyjnego 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 być wyświetlana w powiadomieniu.

Autoryzacja

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

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

toast(msg, title)

Wyświetla w prawym dolnym rogu arkusza kalkulacyjnego okno z podanym komunikatem 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 być wyświetlana w powiadomieniu.
titleStringOpcjonalny tytuł powiadomienia.

Autoryzacja

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

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

toast(msg, title, timeoutSeconds)

Wyświetla w prawym dolnym rogu arkusza kalkulacyjnego wyskakujące okienko o podanym tytule i treści, które pozostaje 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 być wyświetlana w powiadomieniu.
titleStringOpcjonalny tytuł powiadomienia.
timeoutSecondsNumberCzas oczekiwania w sekundach. Jeśli wartość to null, domyślny czas trwania powiadomienia to 5 sekund. Jeśli wartość jest ujemna, powiadomienie pozostaje widoczne do momentu zamknięcia.

Autoryzacja

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

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

unhideColumn(column)

Odkrywa kolumnę w danym zakresie.

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

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

Parametry

NazwaTypOpis
columnRangeZakres do odkrycia, jeśli jest ukryty.

Autoryzacja

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

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

unhideRow(row)

Odkrywa wiersz w danym zakresie.

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

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

Parametry

NazwaTypOpis
rowRangeZakres do odkrycia, jeśli jest ukryty.

Autoryzacja

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

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

updateMenu(name, subMenus)

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

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

Parametry

NazwaTypOpis
nameStringNazwa menu do zaktualizowania.
subMenusObject[]Tablica map JavaScript z parametrami namefunctionName . Możesz używać funkcji z dołączonych bibliotek, np. Library.libFunction1.

Autoryzacja

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

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Czeka na zakończenie wszystkich bieżących wykonań w arkuszu kalkulacyjnym. Po upływie podanej liczby sekund następuje przekroczenie limitu czasu. Zwraca wyjątek, jeśli wykonanie nie zostanie ukończone przed upływem limitu czasu, ale nie anuluje wykonania danych.

Parametry

NazwaTypOpis
timeoutInSecondsIntegerCzas oczekiwania na wykonanie zapytania do bazy danych w sekundach. Maksymalny czas to 300 sekund.

Autoryzacja

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

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

Wycofane metody