Class Spreadsheet

Spreadsheet

Access and modify Google Sheets files. Common operations are adding new sheets and adding collaborators.

Methods

Method	Return type	Brief description
`add Developer Metadata(key)`	`Spreadsheet`	Adds developer metadata with the specified key to the top-level spreadsheet.
`add Developer Metadata(key, visibility)`	`Spreadsheet`	Adds developer metadata with the specified key and visibility to the spreadsheet.
`add Developer Metadata(key, value)`	`Spreadsheet`	Adds developer metadata with the specified key and value to the spreadsheet.
`add Developer Metadata(key, value, visibility)`	`Spreadsheet`	Adds developer metadata with the specified key, value, and visibility to the spreadsheet.
`add Editor(emailAddress)`	`Spreadsheet`	Adds the given user to the list of editors for the `Spreadsheet` .
`add Editor(user)`	`Spreadsheet`	Adds the given user to the list of editors for the `Spreadsheet` .
`add Editors(emailAddresses)`	`Spreadsheet`	Adds the given array of users to the list of editors for the `Spreadsheet` .
`add Menu(name, subMenus)`	`void`	Creates a new menu in the Spreadsheet UI.
`add Viewer(emailAddress)`	`Spreadsheet`	Adds the given user to the list of viewers for the `Spreadsheet` .
`add Viewer(user)`	`Spreadsheet`	Adds the given user to the list of viewers for the `Spreadsheet` .
`add Viewers(emailAddresses)`	`Spreadsheet`	Adds the given array of users to the list of viewers for the `Spreadsheet` .
`append Row(rowContents)`	`Sheet`	Appends a row to the bottom of the current data region in the sheet.
`auto Resize Column(columnPosition)`	`Sheet`	Sets the width of the given column to fit its contents.
`copy(name)`	`Spreadsheet`	Copies the spreadsheet and returns the new one.
`create Developer Metadata Finder()`	`Developer Metadata Finder`	Returns a `Developer Metadata Finder` for finding developer metadata within the scope of this spreadsheet.
`create Text Finder(findText)`	`Text Finder`	Creates a text finder for the spreadsheet, which can be used to find and replace text within the spreadsheet.
`delete Active Sheet()`	`Sheet`	Deletes the currently active sheet.
`delete Column(columnPosition)`	`Sheet`	Deletes the column at the given column position.
`delete Columns(columnPosition, howMany)`	`void`	Deletes a number of columns starting at the given column position.
`delete Row(rowPosition)`	`Sheet`	Deletes the row at the given row position.
`delete Rows(rowPosition, howMany)`	`void`	Deletes a number of rows starting at the given row position.
`delete Sheet(sheet)`	`void`	Deletes the specified sheet.
`duplicate Active Sheet()`	`Sheet`	Duplicates the active sheet and makes it the active sheet.
`get Active Cell()`	`Range`	Returns the active cell in this sheet.
`get Active Range()`	`Range`	Returns the selected range in the active sheet, or `null` if there is no active range.
`get Active Range List()`	`Range List`	Returns the list of active ranges in the active sheet or `null` if there are no active ranges.
`get Active Sheet()`	`Sheet`	Gets the active sheet in a spreadsheet.
`get As(contentType)`	`Blob`	Return the data inside this object as a blob converted to the specified content type.
`get Bandings()`	`Banding[]`	Returns all the bandings in this spreadsheet.
`get Blob()`	`Blob`	Return the data inside this object as a blob.
`get Column Width(columnPosition)`	`Integer`	Gets the width in pixels of the given column.
`get Current Cell()`	`Range`	Returns the current cell in the active sheet or `null` if there is no current cell.
`get Data Range()`	`Range`	Returns a `Range` corresponding to the dimensions in which data is present.
`get Data Source Formulas()`	`Data Source Formula[]`	Gets all the data source formulas.
`get Data Source Pivot Tables()`	`Data Source Pivot Table[]`	Gets all the data source pivot tables.
`get Data Source Refresh Schedules()`	`Data Source Refresh Schedule[]`	Gets the refresh schedules of this spreadsheet.
`get Data Source Sheets()`	`Data Source Sheet[]`	Returns all the data source sheets in the spreadsheet.
`get Data Source Tables()`	`Data Source Table[]`	Gets all the data source tables.
`get Data Sources()`	`Data Source[]`	Returns all the data sources in the spreadsheet.
`get Developer Metadata()`	`Developer Metadata[]`	Gets the developer metadata associated with the top-level spreadsheet.
`get Editors()`	`User[]`	Gets the list of editors for this `Spreadsheet` .
`get Form Url()`	`String`	Returns the URL for the form that sends its responses to this spreadsheet, or `null` if this spreadsheet has no associated form.
`get Frozen Columns()`	`Integer`	Returns the number of frozen columns.
`get Frozen Rows()`	`Integer`	Returns the number of frozen rows.
`get Id()`	`String`	Gets a unique identifier for this spreadsheet.
`get Images()`	`Over Grid Image[]`	Returns all over-the-grid images on the sheet.
`get Iterative Calculation Convergence Threshold()`	`Number`	Returns the threshold value used during iterative calculation.
`get Last Column()`	`Integer`	Returns the position of the last column that has content.
`get Last Row()`	`Integer`	Returns the position of the last row that has content.
`get Max Iterative Calculation Cycles()`	`Integer`	Returns the maximum number of iterations to use during iterative calculation.
`get Name()`	`String`	Gets the name of the document.
`get Named Ranges()`	`Named Range[]`	Gets all the named ranges in this spreadsheet.
`get Num Sheets()`	`Integer`	Returns the number of sheets in this spreadsheet.
`get Owner()`	`User`	Returns the owner of the document, or `null` for a document in a shared drive.
`get Predefined Spreadsheet Themes()`	`Spreadsheet Theme[]`	Returns the list of predefined themes.
`get Protections(type)`	`Protection[]`	Gets an array of objects representing all protected ranges or sheets in the spreadsheet.
`get Range(a1Notation)`	`Range`	Returns the range as specified in A1 notation or R1C1 notation.
`get Range By Name(name)`	`Range`	Returns a named range, or `null` if no range with the given name is found.
`get Range List(a1Notations)`	`Range List`	Returns the `Range List` collection representing the ranges in the same sheet specified by a non-empty list of A1 notations or R1C1 notations.
`get Recalculation Interval()`	`Recalculation Interval`	Returns the calculation interval for this spreadsheet.
`get Row Height(rowPosition)`	`Integer`	Gets the height in pixels of the given row.
`get Selection()`	`Selection`	Returns the current `Selection` in the spreadsheet.
`get Sheet By Id(id)`	`Sheet`	Gets the sheet with the given ID.
`get Sheet By Name(name)`	`Sheet`	Returns a sheet with the given name.
`get Sheet Id()`	`Integer`	Returns the ID of the sheet represented by this object.
`get Sheet Name()`	`String`	Returns the sheet name.
`get Sheet Values(startRow, startColumn, numRows, numColumns)`	`Object[][]`	Returns the rectangular grid of values for this range starting at the given coordinates.
`get Sheets()`	`Sheet[]`	Gets all the sheets in this spreadsheet.
`get Spreadsheet Locale()`	`String`	Gets the spreadsheet locale.
`get Spreadsheet Theme()`	`Spreadsheet Theme`	Returns the current theme of the spreadsheet, or `null` if no theme is applied.
`get Spreadsheet Time Zone()`	`String`	Gets the time zone for the spreadsheet.
`get Url()`	`String`	Returns the URL for the given spreadsheet.
`get Viewers()`	`User[]`	Gets the list of viewers and commenters for this `Spreadsheet` .
`hide Column(column)`	`void`	Hides the column or columns in the given range.
`hide Row(row)`	`void`	Hides the rows in the given range.
`insert Column After(afterPosition)`	`Sheet`	Inserts a column after the given column position.
`insert Column Before(beforePosition)`	`Sheet`	Inserts a column before the given column position.
`insert Columns After(afterPosition, howMany)`	`Sheet`	Inserts a given number of columns after the given column position.
`insert Columns Before(beforePosition, howMany)`	`Sheet`	Inserts a number of columns before the given column position.
`insert Data Source Sheet(spec)`	`Data Source Sheet`	Inserts a new `Data Source Sheet` in the spreadsheet and starts data execution.
`insert Image(blobSource, column, row)`	`Over Grid Image`	Inserts a `Spreadsheet` as an image in the document at a given row and column.
`insert Image(blobSource, column, row, offsetX, offsetY)`	`Over Grid Image`	Inserts a `Spreadsheet` as an image in the document at a given row and column, with a pixel offset.
`insert Image(url, column, row)`	`Over Grid Image`	Inserts an image in the document at a given row and column.
`insert Image(url, column, row, offsetX, offsetY)`	`Over Grid Image`	Inserts an image in the document at a given row and column, with a pixel offset.
`insert Row After(afterPosition)`	`Sheet`	Inserts a row after the given row position.
`insert Row Before(beforePosition)`	`Sheet`	Inserts a row before the given row position.
`insert Rows After(afterPosition, howMany)`	`Sheet`	Inserts a number of rows after the given row position.
`insert Rows Before(beforePosition, howMany)`	`Sheet`	Inserts a number of rows before the given row position.
`insert Sheet()`	`Sheet`	Inserts a new sheet into the spreadsheet, using a default sheet name.
`insert Sheet(sheetIndex)`	`Sheet`	Inserts a new sheet into the spreadsheet at the given index.
`insert Sheet(sheetIndex, options)`	`Sheet`	Inserts a new sheet into the spreadsheet at the given index and uses optional advanced arguments.
`insert Sheet(options)`	`Sheet`	Inserts a new sheet into the spreadsheet, using a default sheet name and optional advanced arguments.
`insert Sheet(sheetName)`	`Sheet`	Inserts a new sheet into the spreadsheet with the given name.
`insert Sheet(sheetName, sheetIndex)`	`Sheet`	Inserts a new sheet into the spreadsheet with the given name at the given index.
`insert Sheet(sheetName, sheetIndex, options)`	`Sheet`	Inserts a new sheet into the spreadsheet with the given name at the given index and uses optional advanced arguments.
`insert Sheet(sheetName, options)`	`Sheet`	Inserts a new sheet into the spreadsheet with the given name and uses optional advanced arguments.
`insert Sheet With Data Source Table(spec)`	`Sheet`	Inserts a new sheet in the spreadsheet, creates a `Data Source Table` spanning the entire sheet with the given data source specification, and starts data execution.
`is Column Hidden By User(columnPosition)`	`Boolean`	Returns whether the given column is hidden by the user.
`is Iterative Calculation Enabled()`	`Boolean`	Returns whether iterative calculation is activated in this spreadsheet.
`is Row Hidden By Filter(rowPosition)`	`Boolean`	Returns whether the given row is hidden by a filter (not a filter view).
`is Row Hidden By User(rowPosition)`	`Boolean`	Returns whether the given row is hidden by the user.
`move Active Sheet(pos)`	`void`	Moves the active sheet to the given position in the list of sheets.
`move Chart To Object Sheet(chart)`	`Sheet`	Creates a new `Sheet Type.OBJECT` sheet and moves the provided chart to it.
`refresh All Data Sources()`	`void`	Refreshes all supported data sources and their linked data source objects, skipping invalid data source objects.
`remove Editor(emailAddress)`	`Spreadsheet`	Removes the given user from the list of editors for the `Spreadsheet` .
`remove Editor(user)`	`Spreadsheet`	Removes the given user from the list of editors for the `Spreadsheet` .
`remove Menu(name)`	`void`	Removes a menu that was added by `add Menu(name, subMenus)` .
`remove Named Range(name)`	`void`	Deletes a named range with the given name.
`remove Viewer(emailAddress)`	`Spreadsheet`	Removes the given user from the list of viewers and commenters for the `Spreadsheet` .
`remove Viewer(user)`	`Spreadsheet`	Removes the given user from the list of viewers and commenters for the `Spreadsheet` .
`rename(newName)`	`void`	Renames the document.
`rename Active Sheet(newName)`	`void`	Renames the current active sheet to the given new name.
`reset Spreadsheet Theme()`	`Spreadsheet Theme`	Removes the applied theme and sets the default theme on the spreadsheet.
`set Active Range(range)`	`Range`	Sets the specified range as the `active range` in the active sheet, with the top left cell in the range as the `current cell` .
`set Active Range List(rangeList)`	`Range List`	Sets the specified list of ranges as the `active ranges` in the active sheet.
`set Active Selection(range)`	`Range`	Sets the active selection region for this sheet.
`set Active Selection(a1Notation)`	`Range`	Sets the active selection, as specified in A1 notation or R1C1 notation.
`set Active Sheet(sheet)`	`Sheet`	Sets the given sheet to be the active sheet in the spreadsheet.
`set Active Sheet(sheet, restoreSelection)`	`Sheet`	Sets the given sheet to be the active sheet in the spreadsheet, with an option to restore the most recent selection within that sheet.
`set Column Width(columnPosition, width)`	`Sheet`	Sets the width of the given column in pixels.
`set Current Cell(cell)`	`Range`	Sets the specified cell as the `current cell` .
`set Frozen Columns(columns)`	`void`	Freezes the given number of columns.
`set Frozen Rows(rows)`	`void`	Freezes the given number of rows.
`set Iterative Calculation Convergence Threshold(minThreshold)`	`Spreadsheet`	Sets the minimum threshold value for iterative calculation.
`set Iterative Calculation Enabled(isEnabled)`	`Spreadsheet`	Sets whether iterative calculation is activated in this spreadsheet.
`set Max Iterative Calculation Cycles(maxIterations)`	`Spreadsheet`	Sets the maximum number of calculation iterations that should be performed during iterative calculation.
`set Named Range(name, range)`	`void`	Names a range.
`set Recalculation Interval(recalculationInterval)`	`Spreadsheet`	Sets how often this spreadsheet should recalculate.
`set Row Height(rowPosition, height)`	`Sheet`	Sets the row height of the given row in pixels.
`set Spreadsheet Locale(locale)`	`void`	Sets the spreadsheet locale.
`set Spreadsheet Theme(theme)`	`Spreadsheet Theme`	Sets a theme on the spreadsheet.
`set Spreadsheet Time Zone(timezone)`	`void`	Sets the time zone for the spreadsheet.
`show(userInterface)`	`void`	Displays a custom user interface component in a dialog centered in the user's browser's viewport.
`sort(columnPosition)`	`Sheet`	Sorts a sheet by column, ascending.
`sort(columnPosition, ascending)`	`Sheet`	Sorts a sheet by column.
`toast(msg)`	`void`	Shows a popup window in the lower right corner of the spreadsheet with the given message.
`toast(msg, title)`	`void`	Shows a popup window in the lower right corner of the spreadsheet with the given message and title.
`toast(msg, title, timeoutSeconds)`	`void`	Shows a popup window in the lower right corner of the spreadsheet with the given title and message, that stays visible for a certain length of time.
`unhide Column(column)`	`void`	Unhides the column in the given range.
`unhide Row(row)`	`void`	Unhides the row in the given range.
`update Menu(name, subMenus)`	`void`	Updates a menu that was added by `add Menu(name, subMenus)` .
`wait For All Data Executions Completion(timeoutInSeconds)`	`void`	Waits until all the current executions in the spreadsheet complete, timing out after the provided number of seconds.

Deprecated methods

Method	Return type	Brief description
~~`get Sheet Protection()`~~	~~`Page Protection`~~	Returns a ~~`Page Protection`~~ instance describing the permissions for the current sheet.
~~`is Anonymous View()`~~	`Boolean`	Indicates whether the document allows anonymous viewing.
~~`is Anonymous Write()`~~	`Boolean`	Indicates whether the document allows edits from anonymous users.
~~`set Anonymous Access(anonymousReadAllowed, anonymousWriteAllowed)`~~	`void`	Sets the document's policy on anonymous reading and writing.
~~`set Sheet Protection(permissions)`~~	`void`	Sets the permissions for the current sheet.

Detailed documentation

`add Developer Metadata(key)`

Adds developer metadata with the specified key to the top-level spreadsheet.

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

Parameters

Name	Type	Description
`key`	`String`	The key for the new developer metadata.

Return

Spreadsheet — This spreadsheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`add Developer Metadata(key, visibility)`

Adds developer metadata with the specified key and visibility to the spreadsheet.

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

Parameters

Name	Type	Description
`key`	`String`	The key for the new developer metadata.
`visibility`	`Developer Metadata Visibility`	The visibility of the new developer metadata.

Return

Spreadsheet — This spreadsheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`add Developer Metadata(key, value)`

Adds developer metadata with the specified key and value to the spreadsheet.

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

Parameters

Name	Type	Description
`key`	`String`	The key for the new developer metadata.
`value`	`String`	The value for the new developer metadata.

Return

Spreadsheet — This spreadsheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`add Developer Metadata(key, value, visibility)`

Adds developer metadata with the specified key, value, and visibility to the spreadsheet.

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

Parameters

Name	Type	Description
`key`	`String`	The key for the new developer metadata.
`value`	`String`	The value for the new developer metadata.
`visibility`	`Developer Metadata Visibility`	The visibility of the new developer metadata.

Return

Spreadsheet — This spreadsheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`add Editor(emailAddress)`

Adds the given user to the list of editors for the Spreadsheet . If the user was already on the list of viewers, this method promotes the user out of the list of viewers.

Parameters

Name	Type	Description
`email Address`	`String`	The email address of the user to add.

Return

Spreadsheet — This Spreadsheet , for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`add Editor(user)`

Adds the given user to the list of editors for the Spreadsheet . If the user was already on the list of viewers, this method promotes the user out of the list of viewers.

Parameters

Name	Type	Description
`user`	`User`	A representation of the user to add.

Return

Spreadsheet — This Spreadsheet , for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`add Editors(emailAddresses)`

Adds the given array of users to the list of editors for the Spreadsheet . If any of the users were already on the list of viewers, this method promotes them out of the list of viewers.

Parameters

Name	Type	Description
`email Addresses`	`String[]`	An array of email addresses of the users to add.

Return

Spreadsheet — This Spreadsheet , for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`add Menu(name, subMenus)`

Creates a new menu in the Spreadsheet UI.

Each menu entry runs a user-defined function. Usually, you want to call it from the on Open() function so that the menu is automatically created when the spreadsheet is loaded.

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

Parameters

Name	Type	Description
`name`	`String`	The name of the menu to be created.
`sub Menus`	`Object[]`	An array of JavaScript maps with `name` and `function Name` parameters. You can use functions from included libraries, such as `Library.libFunction1` .

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`add Viewer(emailAddress)`

Adds the given user to the list of viewers for the Spreadsheet . If the user was already on the list of editors, this method has no effect.

Parameters

Name	Type	Description
`email Address`	`String`	The email address of the user to add.

Return

Spreadsheet — This Spreadsheet , for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`add Viewer(user)`

Adds the given user to the list of viewers for the Spreadsheet . If the user was already on the list of editors, this method has no effect.

Parameters

Name	Type	Description
`user`	`User`	A representation of the user to add.

Return

Spreadsheet — This Spreadsheet , for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`add Viewers(emailAddresses)`

Adds the given array of users to the list of viewers for the Spreadsheet . If any of the users were already on the list of editors, this method has no effect for them.

Parameters

Name	Type	Description
`email Addresses`	`String[]`	An array of email addresses of the users to add.

Return

Spreadsheet — This Spreadsheet , for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`append Row(rowContents)`

Appends a row to the bottom of the current data region in the sheet. If a cell's content begins with = , it's interpreted as a formula.

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

Parameters

Name	Type	Description
`row Contents`	`Object[]`	An array of values to insert after the last row in the sheet.

Return

Sheet — The sheet, useful for method chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`auto Resize Column(columnPosition)`

Sets the width of the given column to fit its contents.

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

Parameters

Name	Type	Description
`column Position`	`Integer`	The position of the given column to resize.

Return

Sheet — the sheet, useful for method chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`copy(name)`

Copies the spreadsheet and returns the new one.

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

Parameters

Name	Type	Description
`name`	`String`	The name of the copy.

Return

Spreadsheet — This spreadsheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`create Developer Metadata Finder()`

Returns a Developer Metadata Finder for finding developer metadata within the scope of this spreadsheet. By default this considers all metadata associated with the spreadsheet, sheets, rows, and columns.

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

Return

Developer Metadata Finder — A developer metadata finder to search for metadata in the scope of this spreadsheet.

`create Text Finder(findText)`

Creates a text finder for the spreadsheet, which can be used to find and replace text within the spreadsheet. The search starts from the first sheet of the spreadsheet.

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

Parameters

Name	Type	Description
`find Text`	`String`	The text to search for.

Return

Text Finder — The Text Finder for the spreadsheet.

`delete Active Sheet()`

Deletes the currently active sheet.

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

Return

Sheet — The new active sheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`delete Column(columnPosition)`

Deletes the column at the given column position.

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

Parameters

Name	Type	Description
`column Position`	`Integer`	The position of the column, starting at 1 for the first column.

Return

Sheet — the sheet, useful for method chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`delete Columns(columnPosition, howMany)`

Deletes a number of columns starting at the given column position.

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

Parameters

Name	Type	Description
`column Position`	`Integer`	The position of the first column to delete.
`how Many`	`Integer`	The number of columns to delete.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`delete Row(rowPosition)`

Deletes the row at the given row position.

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

Parameters

Name	Type	Description
`row Position`	`Integer`	The position of the row, starting at 1 for the first row.

Return

Sheet — the sheet, useful for method chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`delete Rows(rowPosition, howMany)`

Deletes a number of rows starting at the given row position.

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

Parameters

Name	Type	Description
`row Position`	`Integer`	The position of the first row to delete.
`how Many`	`Integer`	The number of rows to delete.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`delete Sheet(sheet)`

Deletes the specified sheet.

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

Parameters

Name	Type	Description
`sheet`	`Sheet`	The sheet to delete.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`duplicate Active Sheet()`

Duplicates the active sheet and makes it the active sheet.

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

Return

Sheet — The new sheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Active Cell()`

Returns the active cell in this sheet.

Note: It's preferable to use get Current Cell() , which returns the current highlighted cell.

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

Return

Range — the current active cell

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Active Range()`

Returns the selected range in the active sheet, or null if there is no active range. If multiple ranges are selected this method returns only the last selected range.

The term "active range" refers to the range that a user has selected in the active sheet, but in a custom function it refers to the cell being actively recalculated.

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

Return

Range — the active range

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Active Range List()`

Returns the list of active ranges in the active sheet or null if there are no active ranges.

If there is a single range selected, this behaves as a get Active Range() call.

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

Return

Range List — the list of active ranges

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Active Sheet()`

Gets the active sheet in a spreadsheet.

The active sheet in a spreadsheet is the sheet that is being displayed in the spreadsheet UI.

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

Return

Sheet — The active sheet in the spreadsheet.

`get As(contentType)`

Return the data inside this object as a blob converted to the specified content type. This method adds the appropriate extension to the filename—for example, "myfile.pdf". However, it assumes that the part of the filename that follows the last period (if any) is an existing extension that should be replaced. Consequently, "ShoppingList.12.25.2014" becomes "ShoppingList.12.25.pdf".

To view the daily quotas for conversions, see Quotas for Google Services . Newly created Google Workspace domains might be temporarily subject to stricter quotas.

Parameters

Name	Type	Description
`content Type`	`String`	The MIME type to convert to. For most blobs, `'application/pdf'` is the only valid option. For images in BMP, GIF, JPEG, or PNG format, any of `'image/bmp'` , `'image/gif'` , `'image/jpeg'` , or `'image/png'` are also valid. For a Google Docs document, `'text/markdown'` is also valid.

Return

Blob — The data as a blob.

`get Bandings()`

Returns all the bandings in this spreadsheet.

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

Return

Banding[] — The bandings in this spreadsheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Blob()`

Return the data inside this object as a blob.

Return

Blob — The data as a blob.

`get Column Width(columnPosition)`

Gets the width in pixels of the given column.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 // Columns start at 1 
 Logger 
 . 
 log 
 ( 
 sheet 
 . 
 getColumnWidth 
 ( 
 1 
 ));

Parameters

Name	Type	Description
`column Position`	`Integer`	The position of the column to examine.

Return

Integer — column width in pixels

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Current Cell()`

Returns the current cell in the active sheet or null if there is no current cell. The current cell is the cell that has focus in the Google Sheets UI, and is highlighted by a dark border. There is never more than one current cell. When a user selects one or more cell ranges, one of the cells in the selection is the current cell.

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

Return

Range — the current cell

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Data Range()`

Returns a Range corresponding to the dimensions in which data is present.

This is functionally equivalent to creating a Range bounded by A1 and (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 
 ); 
 }

Return

Range — a range consisting of all the data in the spreadsheet

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Data Source Formulas()`

Gets all the data source formulas.

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

Return

Data Source Formula[] — A list of data source formulas.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Data Source Pivot Tables()`

Gets all the data source pivot tables.

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

Return

Data Source Pivot Table[] — A list of data source pivot tables.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Data Source Refresh Schedules()`

Gets the refresh schedules of this spreadsheet.

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

Return

Data Source Refresh Schedule[] — The refresh schedules of this spreadsheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Data Source Sheets()`

Returns all the data source sheets in the spreadsheet.

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

Return

Data Source Sheet[] — An array of all the data source sheets.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Data Source Tables()`

Gets all the data source tables.

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

Return

Data Source Table[] — A list of data source tables.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Data Sources()`

Returns all the data sources in the spreadsheet.

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

Return

Data Source[] — An array of all the data sources.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Developer Metadata()`

Gets the developer metadata associated with the top-level spreadsheet.

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

Return

Developer Metadata[] — The developer metadata associated with this range.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Editors()`

Gets the list of editors for this Spreadsheet .

Return

User[] — An array of users with edit permission.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Form Url()`

Returns the URL for the form that sends its responses to this spreadsheet, or null if this spreadsheet has no associated form. If multiple forms send responses to this spreadsheet, the form URL returned is indeterminate. As an alternative, per sheet form URL associations can be retrieved through the Sheet.getFormUrl() method. Throws an exception if the user does not have permission to edit the spreadsheet.

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

Return

String — The URL for the form that places its responses in this spreadsheet, or null if this spreadsheet doesn't have an associated form.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Frozen Columns()`

Returns the number of frozen columns.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 Logger 
 . 
 log 
 ( 
 'Number of frozen columns: %s' 
 , 
  
 sheet 
 . 
 getFrozenColumns 
 ());

Return

Integer — the number of frozen columns

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Frozen Rows()`

Returns the number of frozen rows.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 Logger 
 . 
 log 
 ( 
 'Number of frozen rows: %s' 
 , 
  
 sheet 
 . 
 getFrozenRows 
 ());

Return

Integer — the number of frozen rows

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Id()`

Gets a unique identifier for this spreadsheet. A spreadsheet ID can be extracted from its URL. For example, the spreadsheet ID in the URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 is "abc1234567".

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

Return

String — The unique ID (or key) for the spreadsheet.

`get Images()`

Returns all over-the-grid images on the sheet.

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

Return

Over Grid Image[] — An array of over-the-grid images.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Iterative Calculation Convergence Threshold()`

Returns the threshold value used during iterative calculation. When the results of successive calculation differ by less than this value, the iterative calculation stops.

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

Return

Number — The convergence threshold.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Last Column()`

Returns the position of the last column that has content.

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

Return

Integer — the last column of the sheet that contains content

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Last Row()`

Returns the position of the last row that has content.

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

Return

Integer — the last row of the sheet that contains content

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Max Iterative Calculation Cycles()`

Returns the maximum number of iterations to use during iterative calculation.

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

Return

Integer — The maximum number of calculation iterations.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Name()`

Gets the name of the document.

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

Return

String — The name of the spreadsheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Named Ranges()`

Gets all the named ranges in this spreadsheet.

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

Return

Named Range[] — An array of all the named ranges in the spreadsheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Num Sheets()`

Returns the number of sheets in this spreadsheet.

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

Return

Integer — The number of sheets in the spreadsheet.

`get Owner()`

Returns the owner of the document, or null for a document in a shared drive.

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

Return

User — The owner of the document, or null if the document is in a shared drive.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Predefined Spreadsheet Themes()`

Returns the list of predefined themes.

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

Return

Spreadsheet Theme[] — List of predefined themes.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Protections(type)`

Gets an array of objects representing all protected ranges or sheets in the spreadsheet.

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

Parameters

Name	Type	Description
`type`	`Protection Type`	The type of protected area, either `Spreadsheet App.ProtectionType.RANGE` or `Spreadsheet App.ProtectionType.SHEET` .

Return

Protection[] — An array of objects representing all protected ranges or sheets in the spreadsheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Range(a1Notation)`

Returns the range as specified in A1 notation or R1C1 notation.

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

Parameters

Name	Type	Description
`a1Notation`	`String`	The range to return, as specified in A1 notation or R1C1 notation.

Return

Range — the range at the location designated

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Range By Name(name)`

Returns a named range, or null if no range with the given name is found. If multiple sheets of the spreadsheet use the same range name, specify the sheet name without additional quotation marks — for example, get Range By Name('TaxRates') or get Range By Name('Sheet Name!TaxRates') , but not get Range By Name('"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 
 ()); 
 }

Parameters

Name	Type	Description
`name`	`String`	The name of the range to get.

Return

Range — The range of cells with the given name.

`get Range List(a1Notations)`

Returns the Range List collection representing the ranges in the same sheet specified by a non-empty list of A1 notations or R1C1 notations.

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

Parameters

Name	Type	Description
`a1Notations`	`String[]`	The list of ranges to return, as specified in A1 notation or R1C1 notation.

Return

Range List — the range list at the location designated

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Recalculation Interval()`

Returns the calculation interval for this spreadsheet.

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

Return

Recalculation Interval — The calculation interval for this spreadsheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Row Height(rowPosition)`

Gets the height in pixels of the given row.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 // Rows start at 1 
 Logger 
 . 
 log 
 ( 
 sheet 
 . 
 getRowHeight 
 ( 
 1 
 ));

Parameters

Name	Type	Description
`row Position`	`Integer`	The position of the row to examine.

Return

Integer — row height in pixels

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Selection()`

Returns the current Selection in the spreadsheet.

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

Return

Selection — the current selection

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Sheet By Id(id)`

Gets the sheet with the given ID. Use Sheet.getSheetId() .

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

Parameters

Name	Type	Description
`id`	`Integer`	The ID of the sheet to get.

Return

Sheet — The sheet with the given ID or null if no sheet is found.

`get Sheet By Name(name)`

Returns a sheet with the given name.

If multiple sheets have the same name, the leftmost one is returned. Returns null if there is no sheet with the given name.

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

Parameters

Name	Type	Description
`name`	`String`	The name of the sheet to get.

Return

Sheet — The sheet with the given name.

`get Sheet Id()`

Returns the ID of the sheet represented by this object.

This is an ID for the sheet that is unique to the spreadsheet. The ID is a monotonically increasing integer assigned at sheet creation time that is independent of sheet position. This is useful in conjunction with methods such as Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) that take a grid Id parameter rather than a Sheet instance.

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

Return

Integer — an ID for the sheet unique to the spreadsheet

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Sheet Name()`

Returns the sheet name.

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

Return

String — the name of the sheet

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Sheet Values(startRow, startColumn, numRows, numColumns)`

Returns the rectangular grid of values for this range starting at the given coordinates. A -1 value given as the row or column position is equivalent to getting the very last row or column that has data in the sheet.

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

Parameters

Name	Type	Description
`start Row`	`Integer`	The position of the starting row.
`start Column`	`Integer`	The position of the starting column.
`num Rows`	`Integer`	The number of rows to return values for.
`num Columns`	`Integer`	The number of columns to return values for.

Return

Object[][] — a two-dimensional array of values

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Sheets()`

Gets all the sheets in this spreadsheet.

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

Return

Sheet[] — An array of all the sheets in the spreadsheet.

`get Spreadsheet Locale()`

Gets the spreadsheet locale.

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

Return

String — The spreadsheet locale.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Spreadsheet Theme()`

Returns the current theme of the spreadsheet, or null if no theme is applied.

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

Return

Spreadsheet Theme — The current applied theme.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Spreadsheet Time Zone()`

Gets the time zone for the spreadsheet.

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

Return

String — The time zone, specified in "long" format (for example, "America/New_York", as listed by Joda.org ).

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Url()`

Returns the URL for the given spreadsheet.

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

Return

String — The URL for the given spreadsheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`get Viewers()`

Gets the list of viewers and commenters for this Spreadsheet .

Return

User[] — An array of users with view or comment permission.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`hide Column(column)`

Hides the column or columns in the given range.

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

Parameters

Name	Type	Description
`column`	`Range`	The column range to hide.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`hide Row(row)`

Hides the rows in the given range.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 // This hides the first row 
 const 
  
 range 
  
 = 
  
 sheet 
 . 
 getRange 
 ( 
 'A1' 
 ); 
 sheet 
 . 
 hideRow 
 ( 
 range 
 );

Parameters

Name	Type	Description
`row`	`Range`	The row range to hide.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Column After(afterPosition)`

Inserts a column after the given column position.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 // This inserts a column after the first column position 
 sheet 
 . 
 insertColumnAfter 
 ( 
 1 
 );

Parameters

Name	Type	Description
`after Position`	`Integer`	The column after which the new column should be added.

Return

Sheet — the sheet, useful for method chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Column Before(beforePosition)`

Inserts a column before the given column position.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 // This inserts a column in the first column position 
 sheet 
 . 
 insertColumnBefore 
 ( 
 1 
 );

Parameters

Name	Type	Description
`before Position`	`Integer`	The column before which the new column should be added.

Return

Sheet — the sheet, useful for method chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Columns After(afterPosition, howMany)`

Inserts a given number of columns after the given column position.

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

Parameters

Name	Type	Description
`after Position`	`Integer`	The column after which the new column should be added.
`how Many`	`Integer`	The number of columns to insert.

Return

Sheet — the sheet, useful for method chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Columns Before(beforePosition, howMany)`

Inserts a number of columns before the given column position.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 // This inserts five columns before the first column 
 sheet 
 . 
 insertColumnsBefore 
 ( 
 1 
 , 
  
 5 
 );

Parameters

Name	Type	Description
`before Position`	`Integer`	The column before which the new column should be added.
`how Many`	`Integer`	The number of columns to insert.

Return

Sheet — the sheet, useful for method chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Data Source Sheet(spec)`

Inserts a new Data Source Sheet in the spreadsheet and starts data execution. As a side effect, this also makes the new sheet the active sheet.

Throws an exception if the data source type is not enabled. Use Spreadsheet App#enable...Execution() methods to enable data execution for specific data source type.

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

Parameters

Name	Type	Description
`spec`	`Data Source Spec`	The data source specification to insert with.

Return

Data Source Sheet — The new data source sheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Image(blobSource, column, row)`

Inserts a Spreadsheet as an image in the document at a given row and column. The image size is retrieved from the blob contents. The maximum supported blob size is 2MB.

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

Parameters

Name	Type	Description
`blob Source`	`Blob Source`	The blob containing the image contents, MIME type, and (optionally) name.
`column`	`Integer`	The column position.
`row`	`Integer`	The row position.

Return

Over Grid Image — The inserted image.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Image(blobSource, column, row, offsetX, offsetY)`

Inserts a Spreadsheet as an image in the document at a given row and column, with a pixel offset. The image size is retrieved from the blob contents. The maximum supported blob size is 2MB.

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

Parameters

Name	Type	Description
`blob Source`	`Blob Source`	The blob containing the image contents, MIME type, and (optionally) name.
`column`	`Integer`	The column position.
`row`	`Integer`	The row position.
`offsetX`	`Integer`	The horizontal offset from cell corner in pixels.
`offsetY`	`Integer`	The vertical offset from cell corner in pixels.

Return

Over Grid Image — The inserted image.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Image(url, column, row)`

Inserts an image in the document at a given row and column.

The provided URL must be publicly accessible.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 sheet 
 . 
 insertImage 
 ( 
 'https://www.google.com/images/srpr/logo3w.png' 
 , 
  
 1 
 , 
  
 1 
 );

Parameters

Name	Type	Description
`url`	`String`	The URL of the image.
`column`	`Integer`	The grid column position.
`row`	`Integer`	The grid row position.

Return

Over Grid Image — The inserted image.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Image(url, column, row, offsetX, offsetY)`

Inserts an image in the document at a given row and column, with a pixel offset.

The provided URL must be publicly accessible.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 sheet 
 . 
 insertImage 
 ( 
  
 'https://www.google.com/images/srpr/logo3w.png' 
 , 
  
 1 
 , 
  
 1 
 , 
  
 10 
 , 
  
 10 
 , 
 );

Parameters

Name	Type	Description
`url`	`String`	The URL for the image.
`column`	`Integer`	The column position.
`row`	`Integer`	The row position.
`offsetX`	`Integer`	The horizontal offset from cell corner in pixels.
`offsetY`	`Integer`	The vertical offset from cell corner in pixels.

Return

Over Grid Image — The Inserted image.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Row After(afterPosition)`

Inserts a row after the given row position.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 // This inserts a row after the first row position 
 sheet 
 . 
 insertRowAfter 
 ( 
 1 
 );

Parameters

Name	Type	Description
`after Position`	`Integer`	The row after which the new row should be added.

Return

Sheet — the sheet, useful for method chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Row Before(beforePosition)`

Inserts a row before the given row position.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 // This inserts a row before the first row position 
 sheet 
 . 
 insertRowBefore 
 ( 
 1 
 );

Parameters

Name	Type	Description
`before Position`	`Integer`	The row before which the new row should be added.

Return

Sheet — the sheet, useful for method chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Rows After(afterPosition, howMany)`

Inserts a number of rows after the given row position.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 // This inserts five rows after the first row 
 sheet 
 . 
 insertRowsAfter 
 ( 
 1 
 , 
  
 5 
 );

Parameters

Name	Type	Description
`after Position`	`Integer`	The row after which the new rows should be added.
`how Many`	`Integer`	The number of rows to insert.

Return

Sheet — the sheet, useful for method chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Rows Before(beforePosition, howMany)`

Inserts a number of rows before the given row position.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 // This inserts five rows before the first row 
 sheet 
 . 
 insertRowsBefore 
 ( 
 1 
 , 
  
 5 
 );

Parameters

Name	Type	Description
`before Position`	`Integer`	The row before which the new rows should be added.
`how Many`	`Integer`	The number of rows to insert.

Return

Sheet — the sheet, useful for method chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Sheet()`

Inserts a new sheet into the spreadsheet, using a default sheet name. The new sheet becomes the active sheet.

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

Return

Sheet — The new sheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Sheet(sheetIndex)`

Inserts a new sheet into the spreadsheet at the given index. The new sheet becomes the active sheet.

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

Parameters

Name	Type	Description
`sheet Index`	`Integer`	The index of the newly created sheet. To insert a sheet as the first one in the spreadsheet, set it to 0.

Return

Sheet — The new sheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Sheet(sheetIndex, options)`

Inserts a new sheet into the spreadsheet at the given index and uses optional advanced arguments. The new sheet becomes the active sheet.

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

Parameters

Name	Type	Description
`sheet Index`	`Integer`	The index of the newly created sheet. To insert a sheet as the first one in the spreadsheet, set it to 0.
`options`	`Object`	Optional JavaScript advanced arguments.

Advanced parameters

Name	Type	Description
`template`	`Sheet`	All data from the template sheet object is copied to the new sheet. The sheet template must be one of the sheets of the Spreadsheet object.

Return

Sheet — The new sheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Sheet(options)`

Inserts a new sheet into the spreadsheet, using a default sheet name and optional advanced arguments. The new sheet becomes the active sheet.

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

Parameters

Name	Type	Description
`options`	`Object`	Optional JavaScript advanced arguments, listed below.

Advanced parameters

Name	Type	Description
`template`	`Sheet`	All data from the template sheet object is copied to the new sheet. The sheet template must be one of the sheets of this Spreadsheet object.

Return

Sheet — The new sheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Sheet(sheetName)`

Inserts a new sheet into the spreadsheet with the given name. The new sheet becomes the active sheet.

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

Parameters

Name	Type	Description
`sheet Name`	`String`	The name of the new sheet.

Return

Sheet — The new sheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Sheet(sheetName, sheetIndex)`

Inserts a new sheet into the spreadsheet with the given name at the given index. The new sheet becomes the active sheet.

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

Parameters

Name	Type	Description
`sheet Name`	`String`	The name of the new sheet.
`sheet Index`	`Integer`	The index of the newly created sheet. To insert a sheet as the first one in the spreadsheet, set it to 0.

Return

Sheet — The new sheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Sheet(sheetName, sheetIndex, options)`

Inserts a new sheet into the spreadsheet with the given name at the given index and uses optional advanced arguments. The new sheet becomes the active sheet.

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

Parameters

Name	Type	Description
`sheet Name`	`String`	The name of the new sheet.
`sheet Index`	`Integer`	The index of the newly inserted sheet. To insert a sheet as the first one in a spreadsheet, set it to 0.
`options`	`Object`	Optional JavaScript advanced arguments.

Advanced parameters

Name	Type	Description
`template`	`Sheet`	All data from the template sheet object is copied to the new sheet. The sheet template must be one of the sheets of the Spreadsheet object.

Return

Sheet — The new sheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Sheet(sheetName, options)`

Inserts a new sheet into the spreadsheet with the given name and uses optional advanced arguments. The new sheet becomes the active sheet.

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

Parameters

Name	Type	Description
`sheet Name`	`String`	The name of the new sheet.
`options`	`Object`	Optional JavaScript advanced arguments.

Advanced parameters

Name	Type	Description
`template`	`Sheet`	All data from the template sheet object is copied to the new sheet. The sheet template must be one of the sheets of the Spreadsheet object.

Return

Sheet — The new sheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`insert Sheet With Data Source Table(spec)`

Inserts a new sheet in the spreadsheet, creates a Data Source Table spanning the entire sheet with the given data source specification, and starts data execution. As a side effect, makes the new sheet the active sheet.

Throws an exception if the data source type is not enabled. Use Spreadsheet App#enable...Execution() methods to enable data execution for specific data source type.

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

Parameters

Name	Type	Description
`spec`	`Data Source Spec`	The data source specification to insert with.

Return

Sheet — The new sheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`is Column Hidden By User(columnPosition)`

Returns whether the given column is hidden by the user.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 // Columns start at 1 
 Logger 
 . 
 log 
 ( 
 sheet 
 . 
 isColumnHiddenByUser 
 ( 
 1 
 ));

Parameters

Name	Type	Description
`column Position`	`Integer`	The position of the column to examine.

Return

Boolean — true if the column is hidden, false otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`is Iterative Calculation Enabled()`

Returns whether iterative calculation is activated in this spreadsheet.

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

Return

Boolean — true if iterative calculation is activated, false otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`is Row Hidden By Filter(rowPosition)`

Returns whether the given row is hidden by a filter (not a filter view).

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 // Rows start at 1 
 Logger 
 . 
 log 
 ( 
 sheet 
 . 
 isRowHiddenByFilter 
 ( 
 1 
 ));

Parameters

Name	Type	Description
`row Position`	`Integer`	The position of the row to examine.

Return

Boolean — true if the row is hidden, false otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`is Row Hidden By User(rowPosition)`

Returns whether the given row is hidden by the user.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 // Rows start at 1 
 Logger 
 . 
 log 
 ( 
 sheet 
 . 
 isRowHiddenByUser 
 ( 
 1 
 ));

Parameters

Name	Type	Description
`row Position`	`Integer`	The position of the row to examine.

Return

Boolean — true if the row is hidden, false otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`move Active Sheet(pos)`

Moves the active sheet to the given position in the list of sheets. Throws an exception if the position is negative or greater than the number of sheets.

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

Parameters

Name	Type	Description
`pos`	`Integer`	The 1-index position to move the active sheet to in the list of sheets.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`move Chart To Object Sheet(chart)`

Creates a new Sheet Type.OBJECT sheet and moves the provided chart to it. If the chart is already on its own sheet, that sheet is returned without creating a new one.

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

Parameters

Name	Type	Description
`chart`	`Embedded Chart`	The chart to move.

Return

Sheet — The sheet that the chart is on.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`refresh All Data Sources()`

Refreshes all supported data sources and their linked data source objects, skipping invalid data source objects.

Use Spreadsheet App#enable...Execution() methods to enable data execution for specific data source type.

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

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`remove Editor(emailAddress)`

Removes the given user from the list of editors for the Spreadsheet . This method doesn't block users from accessing the Spreadsheet if they belong to a class of users who have general access—for example, if the Spreadsheet is shared with the user's entire domain, or if the Spreadsheet is in a shared drive that the user can access.

For Drive files, this also removes the user from the list of viewers.

Parameters

Name	Type	Description
`email Address`	`String`	The email address of the user to remove.

Return

Spreadsheet — This Spreadsheet , for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`remove Editor(user)`

For Drive files, this also removes the user from the list of viewers.

Parameters

Name	Type	Description
`user`	`User`	A representation of the user to remove.

Return

Spreadsheet — This Spreadsheet , for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`remove Menu(name)`

Removes a menu that was added by add Menu(name, subMenus) . The name argument should have the same value as the corresponding call to add Menu(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 
 }

Parameters

Name	Type	Description
`name`	`String`	The name of the menu to remove.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`remove Named Range(name)`

Deletes a named range with the given name. Throws an exception if no range with the given name is found in the spreadsheet.

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

Parameters

Name	Type	Description
`name`	`String`	The range name.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`remove Viewer(emailAddress)`

Removes the given user from the list of viewers and commenters for the Spreadsheet . This method has no effect if the user is an editor, not a viewer or commenter. This method also doesn't block users from accessing the Spreadsheet if they belong to a class of users who have general access—for example, if the Spreadsheet is shared with the user's entire domain, or if the Spreadsheet is in a shared drive that the user can access.

For Drive files, this also removes the user from the list of editors.

Parameters

Name	Type	Description
`email Address`	`String`	The email address of the user to remove.

Return

Spreadsheet — This Spreadsheet for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`remove Viewer(user)`

Removes the given user from the list of viewers and commenters for the Spreadsheet . This method has no effect if the user is an editor, not a viewer. This method also doesn't block users from accessing the Spreadsheet if they belong to a class of users who have general access—for example, if the Spreadsheet is shared with the user's entire domain, or if the Spreadsheet is in a shared drive that the user can access.

For Drive files, this also removes the user from the list of editors.

Parameters

Name	Type	Description
`user`	`User`	A representation of the user to remove.

Return

Spreadsheet — This Spreadsheet for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`rename(newName)`

Renames the document.

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

Parameters

Name	Type	Description
`new Name`	`String`	The new name for the document.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`rename Active Sheet(newName)`

Renames the current active sheet to the given new name.

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

Parameters

Name	Type	Description
`new Name`	`String`	The new name for the current active sheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`reset Spreadsheet Theme()`

Removes the applied theme and sets the default theme on the spreadsheet.

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

Return

Spreadsheet Theme — The default theme.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`set Active Range(range)`

Sets the specified range as the active range in the active sheet, with the top left cell in the range as the 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 
 ();

Parameters

Name	Type	Description
`range`	`Range`	The range to set as the active range.

Return

Range — the newly active range

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`set Active Range List(rangeList)`

Sets the specified list of ranges as the active ranges in the active sheet. The last range in the list is set as the 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 
 ();

Parameters

Name	Type	Description
`range List`	`Range List`	The list of ranges to select.

Return

Range List — the newly selected list of ranges

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`set Active Selection(range)`

Sets the active selection region for this sheet.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 const 
  
 range 
  
 = 
  
 sheet 
 . 
 getRange 
 ( 
 'A1:D4' 
 ); 
 sheet 
 . 
 setActiveSelection 
 ( 
 range 
 );

Parameters

Name	Type	Description
`range`	`Range`	The range to set as the active selection.

Return

Range — the newly active range

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`set Active Selection(a1Notation)`

Sets the active selection, as specified in A1 notation or R1C1 notation.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 sheet 
 . 
 setActiveSelection 
 ( 
 'A1:D4' 
 );

Parameters

Name	Type	Description
`a1Notation`	`String`	The range to set as active, as specified in A1 notation or R1C1 notation.

Return

Range — the newly active range

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`set Active Sheet(sheet)`

Sets the given sheet to be the active sheet in the spreadsheet. The Google Sheets UI displays the chosen sheet unless the sheet belongs to a different spreadsheet.

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

Parameters

Name	Type	Description
`sheet`	`Sheet`	The sheet to set as the active sheet.

Return

Sheet — The active sheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`set Active Sheet(sheet, restoreSelection)`

Sets the given sheet to be the active sheet in the spreadsheet, with an option to restore the most recent selection within that sheet. The Google Sheets UI displays the chosen sheet unless the sheet belongs to a different spreadsheet.

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

Parameters

Name	Type	Description
`sheet`	`Sheet`	The new active sheet.
`restore Selection`	`Boolean`	Tf `true` , the most recent selection of the new active sheet becomes selected again as the new sheet becomes active; if `false` , the new sheet becomes active without changing the current selection.

Return

Sheet — The new active sheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`set Column Width(columnPosition, width)`

Sets the width of the given column in pixels.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 // Sets the first column to a width of 200 pixels 
 sheet 
 . 
 setColumnWidth 
 ( 
 1 
 , 
  
 200 
 );

Parameters

Name	Type	Description
`column Position`	`Integer`	The position of the given column to set.
`width`	`Integer`	The width in pixels to set it to.

Return

Sheet — the sheet, useful for method chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`set Current Cell(cell)`

Sets the specified cell as the current cell .

If the specified cell is present in an already selected range, then that range becomes the active range with the cell as the current cell.

If the specified cell is not present in any selected range, then any existing selection is removed and the cell becomes the current cell and the active range.

Note: The specified Range must consist of one cell, otherwise it throws an exception.

 const 
  
 sheet 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (). 
 getActiveSheet 
 (); 
 const 
  
 cell 
  
 = 
  
 sheet 
 . 
 getRange 
 ( 
 'B5' 
 ); 
 sheet 
 . 
 setCurrentCell 
 ( 
 cell 
 ); 
 const 
  
 selection 
  
 = 
  
 sheet 
 . 
 getSelection 
 (); 
 // Current cell: B5 
 const 
  
 currentCell 
  
 = 
  
 selection 
 . 
 getCurrentCell 
 ();

Parameters

Name	Type	Description
`cell`	`Range`	The cell to set as the current cell.

Return

Range — the newly set current cell

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`set Frozen Columns(columns)`

Freezes the given number of columns. If zero, no columns are frozen.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 // Freezes the first column 
 sheet 
 . 
 setFrozenColumns 
 ( 
 1 
 );

Parameters

Name	Type	Description
`columns`	`Integer`	The number of columns to freeze.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`set Frozen Rows(rows)`

Freezes the given number of rows. If zero, no rows are frozen.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 // Freezes the first row 
 sheet 
 . 
 setFrozenRows 
 ( 
 1 
 );

Parameters

Name	Type	Description
`rows`	`Integer`	The number of rows to freeze.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`set Iterative Calculation Convergence Threshold(minThreshold)`

Sets the minimum threshold value for iterative calculation. When the results of successive calculation differ by less than this value, the iterative calculation stops. This value must be non-negative, and defaults to 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 
 ());

Parameters

Name	Type	Description
`min Threshold`	`Number`	The minimum convergence threshold (must be non-negative).

Return

Spreadsheet — This spreadsheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`set Iterative Calculation Enabled(isEnabled)`

Sets whether iterative calculation is activated in this spreadsheet. If the maximum number of calculation cycles and convergence threshold have not previously been set when the calculation is activated, they default to 50 and 0.05 respectively. If either has been set previously, they retain their previous values.

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

Parameters

Name	Type	Description
`is Enabled`	`Boolean`	`true` if iterative calculation should be enabled; `false` otherwise.

Return

Spreadsheet — This spreadsheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`set Max Iterative Calculation Cycles(maxIterations)`

Sets the maximum number of calculation iterations that should be performed during iterative calculation. This value must be between 1 and 10,000 (inclusive), and defaults to 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 
 ());

Parameters

Name	Type	Description
`max Iterations`	`Integer`	The maximum number of calculation iterations (between 1 and 10,000).

Return

Spreadsheet — This spreadsheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`set Named Range(name, range)`

Names a range.

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

Parameters

Name	Type	Description
`name`	`String`	The name to give the range.
`range`	`Range`	The range specification.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`set Recalculation Interval(recalculationInterval)`

Sets how often this spreadsheet should recalculate.

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

Parameters

Name	Type	Description
`recalculation Interval`	`Recalculation Interval`	The new recalculation interval.

Return

Spreadsheet — This spreadsheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`set Row Height(rowPosition, height)`

Sets the row height of the given row in pixels. By default, rows grow to fit cell contents. If you want to force rows to a specified height, use 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 
 );

Parameters

Name	Type	Description
`row Position`	`Integer`	The row position to change.
`height`	`Integer`	The height in pixels to set it to.

Return

Sheet — The sheet, useful for method chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`set Spreadsheet Locale(locale)`

Sets the spreadsheet locale.

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

Parameters

Name	Type	Description
`locale`	`String`	The locale code to use (for example, 'en', 'fr', or 'en_US').

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`set Spreadsheet Theme(theme)`

Sets a theme on the spreadsheet.

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

Parameters

Name	Type	Description
`theme`	`Spreadsheet Theme`	The theme to apply.

Return

Spreadsheet Theme — The new current theme.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`set Spreadsheet Time Zone(timezone)`

Sets the time zone for the spreadsheet.

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

Parameters

Name	Type	Description
`timezone`	`String`	The time zone, specified in "long" format (for example, "America/New_York", as listed by Joda.org ).

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`show(userInterface)`

Displays a custom user interface component in a dialog centered in the user's browser's viewport. The server-side script's execution is not suspended. To communicate with the server side, the user interface component must make asynchronous callbacks to the server-side script.

If the server-side script previously displayed a dialog that has not yet been dismissed, then the existing dialog is replaced with the newly requested dialog's user interface.

The following code snippet displays a simple Html Service application in a dialog with the specified title, height, and width:

 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.

Parameters

Name	Type	Description
`user Interface`	`Object`	An `Html Output` .

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`sort(columnPosition)`

Sorts a sheet by column, ascending.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 // Sorts the sheet by the first column, ascending 
 sheet 
 . 
 sort 
 ( 
 1 
 );

Parameters

Name	Type	Description
`column Position`	`Integer`	The column to sort by.

Return

Sheet — the sheet, useful for method chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`sort(columnPosition, ascending)`

Sorts a sheet by column. Takes a parameter to specify ascending or descending.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 // Sorts the sheet by the first column, descending 
 sheet 
 . 
 sort 
 ( 
 1 
 , 
  
 false 
 );

Parameters

Name	Type	Description
`column Position`	`Integer`	The column to sort by.
`ascending`	`Boolean`	`true` for ascending sorts, `false` for descending.

Return

Sheet — the sheet, useful for method chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`toast(msg)`

Shows a popup window in the lower right corner of the spreadsheet with the given message.

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

Parameters

Name	Type	Description
`msg`	`String`	The message to be shown in the toast.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`toast(msg, title)`

Shows a popup window in the lower right corner of the spreadsheet with the given message and title.

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

Parameters

Name	Type	Description
`msg`	`String`	The message to be shown in the toast.
`title`	`String`	The optional title of the toast.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`toast(msg, title, timeoutSeconds)`

Shows a popup window in the lower right corner of the spreadsheet with the given title and message, that stays visible for a certain length of time.

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

Parameters

Name	Type	Description
`msg`	`String`	The message to be shown in the toast.
`title`	`String`	The optional title of the toast.
`timeout Seconds`	`Number`	The timeout in seconds; if `null` , the toast defaults to 5 seconds; if negative, the toast remains until dismissed.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`unhide Column(column)`

Unhides the column in the given range.

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

Parameters

Name	Type	Description
`column`	`Range`	The range to unhide, if hidden.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`unhide Row(row)`

Unhides the row in the given range.

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

Parameters

Name	Type	Description
`row`	`Range`	The range to unhide, if hidden.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`update Menu(name, subMenus)`

Updates a menu that was added by add Menu(name, subMenus) . Works exactly like add Menu(name, subMenus) .

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

Parameters

Name	Type	Description
`name`	`String`	The name of the menu to update.
`sub Menus`	`Object[]`	An array of JavaScript maps with `name` and `function Name` parameters. You can use functions from included libraries, such as `Library.libFunction1` .

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`wait For All Data Executions Completion(timeoutInSeconds)`

Waits until all the current executions in the spreadsheet complete, timing out after the provided number of seconds. Throws an exception if the executions are not completed when timing out, but does not cancel the data executions.

Parameters

Name	Type	Description
`timeout In Seconds`	`Integer`	The time to wait for data executions, in seconds. The maximum is 300 seconds.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

Deprecated methods

`get Sheet Protection()`

Deprecated.For spreadsheets created in the newer version of Google Sheets, use Sheet.getProtections(type) , which returns the more powerful Protection class. Although this method is deprecated, it remains available for compatibility with the older version of Sheets

Returns a ~~Page Protection~~ instance describing the permissions for the current sheet.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 const 
  
 permissions 
  
 = 
  
 sheet 
 . 
 getSheetProtection 
 (); 
 permissions 
 . 
 setProtected 
 ( 
 true 
 ); 
 permissions 
 . 
 addUser 
 ( 
 'user@example.com' 
 ); 
 // Logs the users that have access to edit this sheet. Note that this 
 // is different from access to the entire spreadsheet - getUsers() 
 // only returns users if permissions.isProtected() is set to true. 
 const 
  
 users 
  
 = 
  
 permissions 
 . 
 getUsers 
 (); 
 Logger 
 . 
 log 
 ( 
 users 
 );

Return

~~Page Protection~~ — an object describing sheet access permissions

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`is Anonymous View()`

Deprecated.As of January 2014 this function is deprecated and not available in the new version of Google Sheets.

Indicates whether the document allows anonymous viewing. As this is no longer supported in the new version of Google Sheets , use File.getSharingAccess() and File.getSharingPermission() instead.

 // Determine if the document allows anonymous viewing via the Drive API. 
 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 file 
  
 = 
  
 DriveApp 
 . 
 getFileById 
 ( 
 ss 
 . 
 getId 
 ()); 
 const 
  
 access 
  
 = 
  
 file 
 . 
 getSharingAccess 
 (); 
 const 
  
 permission 
  
 = 
  
 file 
 . 
 getSharingPermission 
 (); 
 const 
  
 isAnonymousAccess 
  
 = 
  
 access 
  
 === 
  
 DriveApp 
 . 
 Access 
 . 
 ANYONE 
  
 || 
  
 access 
  
 === 
  
 DriveApp 
 . 
 Access 
 . 
 ANYONE_WITH_LINK 
 ; 
 const 
  
 isAnonymousEdit 
  
 = 
  
 isAnonymousAccess 
 && 
 permission 
  
 !== 
  
 DriveApp 
 . 
 Permission 
 . 
 NONE 
 ;

Return

Boolean — true if the document allows anonymous viewing, false otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`is Anonymous Write()`

Deprecated.As of January 2014 this function is deprecated and not available in the new version of Google Sheets.

Indicates whether the document allows edits from anonymous users. As this is no longer supported in the new version of Google Sheets , use File.getSharingAccess() and File.getSharingPermission() instead.

 // Determine if the document allow anonymous edits via the Drive API. 
 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 file 
  
 = 
  
 DriveApp 
 . 
 getFileById 
 ( 
 ss 
 . 
 getId 
 ()); 
 const 
  
 access 
  
 = 
  
 file 
 . 
 getSharingAccess 
 (); 
 const 
  
 permission 
  
 = 
  
 file 
 . 
 getSharingPermission 
 (); 
 const 
  
 isAnonymousAccess 
  
 = 
  
 access 
  
 === 
  
 DriveApp 
 . 
 Access 
 . 
 ANYONE 
  
 || 
  
 access 
  
 === 
  
 DriveApp 
 . 
 Access 
 . 
 ANYONE_WITH_LINK 
 ; 
 const 
  
 isAnonymousEdit 
  
 = 
  
 isAnonymousAccess 
 && 
 permission 
  
 === 
  
 DriveApp 
 . 
 Permission 
 . 
 EDIT 
 ;

Return

Boolean — true if the document allows anonymous editing, false otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`set Anonymous Access(anonymousReadAllowed, anonymousWriteAllowed)`

Deprecated.As of January 2014 this function is deprecated and not available in the new version of Google Sheets.

Sets the document's policy on anonymous reading and writing. As this is no longer supported in the new version of Google Sheets , use File.setSharing(accessType, permissionType) as an alternative.

 // Set the document's policy on anonymous reading and writing via the Drive API. 
 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 file 
  
 = 
  
 DriveApp 
 . 
 getFileById 
 ( 
 ss 
 . 
 getId 
 ()); 
 // Set anonymous read. 
 file 
 . 
 setSharing 
 ( 
 DriveApp 
 . 
 Access 
 . 
 ANYONE 
 , 
  
 DriveApp 
 . 
 Permission 
 . 
 VIEW 
 ); 
 // Set anonymous write. 
 file 
 . 
 setSharing 
 ( 
 DriveApp 
 . 
 Access 
 . 
 ANYONE 
 , 
  
 DriveApp 
 . 
 Permission 
 . 
 EDIT 
 ); 
 // Disable anonymous access. 
 file 
 . 
 setSharing 
 ( 
 DriveApp 
 . 
 Access 
 . 
 PRIVATE 
 , 
  
 file 
 . 
 getSharingPermission 
 ());

Parameters

Name	Type	Description
`anonymous Read Allowed`	`Boolean`	`true` to allow anonymous reads; `false` otherwise.
`anonymous Write Allowed`	`Boolean`	`true` to allow anonymous reads; `false` otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

`set Sheet Protection(permissions)`

Deprecated.For spreadsheets created in the newer version of Google Sheets, use Sheet.protect() , which returns the more powerful Protection class. Although this method is deprecated, it remains available for compatibility with the older version of Sheets

Sets the permissions for the current sheet.

 const 
  
 ss 
  
 = 
  
 SpreadsheetApp 
 . 
 getActiveSpreadsheet 
 (); 
 const 
  
 sheet 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 0 
 ]; 
 const 
  
 permissions 
  
 = 
  
 sheet 
 . 
 getSheetProtection 
 (); 
 // This copies the permissions on the first sheet to the second sheet 
 const 
  
 sheetToClonePermissionsTo 
  
 = 
  
 ss 
 . 
 getSheets 
 ()[ 
 1 
 ]; 
 sheetToClonePermissionsTo 
 . 
 setSheetProtection 
 ( 
 permissions 
 );

Parameters

Name	Type	Description
`permissions`	~~`Page Protection`~~	The access permissions object to set on this sheet.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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