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.constss=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.constdeveloperMetaData=ss.getDeveloperMetadata()[0];console.log(developerMetaData.getKey());

Parameters

Return

Spreadsheet — This spreadsheet, for chaining.

Authorization

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

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

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.constss=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.constdeveloperMetaData=ss.getDeveloperMetadata()[0];console.log(developerMetaData.getKey());console.log(`Key:${developerMetaData.getKey()},.             Visibility:${developerMetaData.getVisibility()}`);

Parameters

Return

Spreadsheet — This spreadsheet, for chaining.

Authorization

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

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

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.constss=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.constdeveloperMetaData=ss.getDeveloperMetadata()[0];console.log(developerMetaData.getKey());console.log(`Key:${developerMetaData.getKey()}, Value:${developerMetaData.getValue()}`,);

Parameters

Return

Spreadsheet — This spreadsheet, for chaining.

Authorization

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

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

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.constss=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.constdeveloperMetaData=ss.getDeveloperMetadata()[0];console.log(`Key:${developerMetaData.getKey()},             Value:${developerMetaData.getValue()},             Visibility:${developerMetaData.getVisibility()}`);

Parameters

Return

Spreadsheet — This spreadsheet, for chaining.

Authorization

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

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

Adds the given user to the list of editors for theSpreadsheet. If the user was alreadyon the list of viewers, this method promotes the user out of the list of viewers.

Parameters

Return

Spreadsheet — ThisSpreadsheet, for chaining.

Authorization

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

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

Adds the given user to the list of editors for theSpreadsheet. If the user was alreadyon the list of viewers, this method promotes the user out of the list of viewers.

Parameters

Return

Spreadsheet — ThisSpreadsheet, for chaining.

Authorization

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

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

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

Parameters

Return

Spreadsheet — ThisSpreadsheet, for chaining.

Authorization

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

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

Creates a new menu in the Spreadsheet UI.

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

// The onOpen function is executed automatically every time a Spreadsheet is// loadedfunctiononOpen(){constss=SpreadsheetApp.getActiveSpreadsheet();constmenuEntries=[];// 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 separatormenuEntries.push({name:'Menu Entry 2',functionName:'function2'});ss.addMenu('addMenuExample',menuEntries);}

Parameters

Authorization

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

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

Adds the given user to the list of viewers for theSpreadsheet. If the user was alreadyon the list of editors, this method has no effect.

Parameters

Return

Spreadsheet — ThisSpreadsheet, for chaining.

Authorization

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

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

Adds the given user to the list of viewers for theSpreadsheet. If the user was alreadyon the list of editors, this method has no effect.

Parameters

Return

Spreadsheet — ThisSpreadsheet, for chaining.

Authorization

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

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

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

Parameters

Return

Spreadsheet — ThisSpreadsheet, for chaining.

Authorization

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

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

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

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=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

Return

Sheet — The sheet, useful for method chaining.

Authorization

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

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

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

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=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 textsheet.autoResizeColumn(1);

Parameters

Return

Sheet — The sheet, useful for method chaining.

Authorization

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

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

Copies the spreadsheet and returns the new one.

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

Parameters

Return

Spreadsheet — This spreadsheet, for chaining.

Authorization

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

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

Returns aDeveloperMetadataFinder for finding developer metadata within the scope ofthis 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.constss=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.constdeveloperMetadataFinder=ss.createDeveloperMetadataFinder();// Finds the developer metadata objects with 'COMPANY' as the key.constgoogleMetadataFromSpreadsheet=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

DeveloperMetadataFinder — A developer metadata finder to search for metadata in the scope of this spreadsheet.

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

constspreadsheet=SpreadsheetApp.getActiveSpreadsheet();// Creates  a text finder.consttextFinder=spreadsheet.createTextFinder('dog');// Returns the first occurrence of 'dog' in the spreadsheet.constfirstOccurrence=textFinder.findNext();// Replaces the last found occurrence of 'dog' with 'cat' and returns the number// of occurrences replaced.constnumOccurrencesReplaced=textFinder.replaceWith('cat');

Parameters

Return

TextFinder — TheTextFinder for the spreadsheet.

Deletes the currently active sheet.

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

Return

Sheet — The new active sheet.

Authorization

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

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

Deletes the column at the given column position.

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

Parameters

Return

Sheet — The sheet, useful for method chaining.

Authorization

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

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

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

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

Parameters

Authorization

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

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

Deletes the row at the given row position.

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

Parameters

Return

Sheet — The sheet, useful for method chaining.

Authorization

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

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

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

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

Parameters

Authorization

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

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

Deletes the specified sheet.

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

Parameters

Authorization

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

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

Duplicates the active sheet and makes it the active sheet.

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

Return

Sheet — The new sheet.

Authorization

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

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

Returns the active cell in this sheet.

Note: It's preferable to usegetCurrentCell(), which returns the currenthighlighted cell.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// Returns the active cellconstcell=sheet.getActiveCell();

Return

Range — The current active cell.

Authorization

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

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

Returns the selected range in the active sheet, ornull if there is no active range. Ifmultiple 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.

constsheet=SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();constactiveRange=sheet.getActiveRange();

Return

Range — The active range.

Authorization

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

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

See also

• setActiveRange(range)

Returns the list of active ranges in the active sheet ornull if there are no activeranges.

If there is a single range selected, this behaves as agetActiveRange() call.

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

Return

RangeList — The list of active ranges.

Authorization

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

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

See also

• setActiveRangeList(rangeList)

Gets the active sheet in a spreadsheet.

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

constsheet=SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();

Return

Sheet — The active sheet in the spreadsheet.

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

To view the daily quotas for conversions, seeQuotas for GoogleServices. Newly created Google Workspace domains might be temporarily subject to stricterquotas.

Parameters

Return

Blob — The data as a blob.

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.constss=SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit',);// Gets an array of the bandings in the spreadsheet.constbandings=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 followingscopes:

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

Return the data inside this object as a blob.

Return

Blob — The data as a blob.

Gets the width in pixels of the given column.

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

Parameters

Return

Integer — Column width in pixels.

Authorization

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

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

Returns the current cell in the active sheet ornull if there is no current cell. Thecurrent cell is the cell that has focus in the Google Sheets UI, and is highlighted by a darkborder. 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.

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

Return

Range — The current cell.

Authorization

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

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

Returns aRange 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()).

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// This represents ALL the dataconstrange=sheet.getDataRange();constvalues=range.getValues();// This logs the spreadsheet in CSV format with a trailing commafor(leti=0;i <values.length;i++){letrow='';for(letj=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 followingscopes:

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

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.constss=SpreadsheetApp.openById('abc123456');// Gets Sheet1 by its name.constsheet=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'.constdataSourceFormulas=sheet.getDataSourceFormulas();// Logs the first data source formula in the array.console.log(dataSourceFormulas[0].getFormula());

Return

DataSourceFormula[] — A list of data source formulas.

Authorization

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

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

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.constss=SpreadsheetApp.openById('abc123456');// Gets Sheet1 by its name.constsheet=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'.constdataSourcePivotTables=sheet.getDataSourcePivotTables();// Logs the last time that the first pivot table in the array was refreshed.console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

Return

DataSourcePivotTable[] — A list of data source pivot tables.

Authorization

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

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

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.constss=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.constfrequencyType=ss.getDataSourceRefreshSchedules()[0].getFrequency().getFrequencyType().toString();// Logs the frequency type to the console.console.log(frequencyType);

Return

DataSourceRefreshSchedule[] — The refresh schedules of this spreadsheet.

Authorization

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

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

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.constss=SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit',);// Gets the first data source sheet in the spreadsheet.constdataSource=ss.getDataSourceSheets()[0];// Gets the name of the data source sheet.console.log(dataSource.asSheet().getName());

Return

DataSourceSheet[] — An array of all the data source sheets.

Authorization

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

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

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.constss=SpreadsheetApp.openById('abc123456');// Gets Sheet1 by its name.constsheet=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'.constdataSourceTables=sheet.getDataSourceTables();// Logs the last completed data execution time on the first data source table.console.log(dataSourceTables[0].getStatus().getLastExecutionTime());

Return

DataSourceTable[] — A list of data source tables.

Authorization

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

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

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.constss=SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit',);// Gets the data sources on the spreadsheet.constdataSources=ss.getDataSources();// Logs the name of the first column on the first data source.console.log(dataSources[0].getColumns()[0].getName());

Return

DataSource[] — An array of all the data sources.

Authorization

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

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

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.constss=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.constssMetadata=ss.getDeveloperMetadata();// Gets the first set of the spreadsheet's metadata and logs the key to the// console.console.log(ssMetadata[0].getKey());

Return

DeveloperMetadata[] — The developer metadata associated with this range.

Authorization

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

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

Gets the list of editors for thisSpreadsheet.

Return

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

Authorization

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

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

Returns the URL for the form that sends its responses to this spreadsheet, ornull ifthis 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 canbe retrieved through theSheet.getFormUrl() method. Throws an exception if the userdoes 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.constss=SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit',);// Gets the form URL from the spreadsheet.constformUrl=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, ornull if this spreadsheet doesn't have an associated form.

Authorization

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

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

Returns the number of frozen columns.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=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 followingscopes:

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

Returns the number of frozen rows.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=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 followingscopes:

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

Gets a unique identifier for this spreadsheet. A spreadsheet ID can be extracted from its URL.For example, the spreadsheet ID in the URLhttps://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.

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.constss=SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit',);// Gets Sheet1 by its name.constsheet=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.constimages=sheet.getImages();// For each image, logs the anchor cell in A1 notation.for(constimageofimages){console.log(image.getAnchorCell().getA1Notation());}

Return

OverGridImage[] — An array of over-the-grid images.

Authorization

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

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

Returns the threshold value used during iterative calculation. When the results of successivecalculation 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.constss=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 followingscopes:

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

Returns the position of the last column that has content.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// This logs the value in the very last cell of this sheetconstlastRow=sheet.getLastRow();constlastColumn=sheet.getLastColumn();constlastCell=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 followingscopes:

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

Returns the position of the last row that has content.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// This logs the value in the very last cell of this sheetconstlastRow=sheet.getLastRow();constlastColumn=sheet.getLastColumn();constlastCell=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 followingscopes:

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

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.constss=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 followingscopes:

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

Gets the name of the document.

constss=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 followingscopes:

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

Gets all the named ranges in this spreadsheet.

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

Return

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

Authorization

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

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

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.

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

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

Return

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

Authorization

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

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

Returns the list of predefined themes.

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

Return

SpreadsheetTheme[] — List of predefined themes.

Authorization

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

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

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.constss=SpreadsheetApp.getActive();constprotections=ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);for(leti=0;i <protections.length;i++){constprotection=protections[i];if(protection.canEdit()){protection.remove();}}

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

Parameters

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 followingscopes:

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

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

// Get a range A1:D4 on sheet titled "Invoices"constss=SpreadsheetApp.getActiveSpreadsheet();constrange=ss.getRange('Invoices!A1:D4');// Get cell A1 on the first sheetconstsheet=ss.getSheets()[0];constcell=sheet.getRange('A1');

Parameters

Return

Range — The range at the location designated.

Authorization

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

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

Returns a named range, ornull if no range with the given name is found. If multiplesheets of the spreadsheet use the same range name, specify the sheet name without additionalquotation marks — for example,getRangeByName('TaxRates') orgetRangeByName('Sheet Name!TaxRates'), but notgetRangeByName('"SheetName"!TaxRates').

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

Parameters

Return

Range — The range of cells with the given name.

Returns theRangeList collection representing the ranges in the same sheet specifiedby a non-empty list of A1 notations or R1C1 notations.

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

Parameters

Return

RangeList — The range list at the location designated.

Authorization

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

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

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.constss=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

RecalculationInterval — The calculation interval for this spreadsheet.

Authorization

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

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

Gets the height in pixels of the given row.

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

Parameters

Return

Integer — Row height in pixels.

Authorization

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

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

Returns the currentSelection in the spreadsheet.

constselection=SpreadsheetApp.getActiveSpreadsheet().getSelection();constcurrentCell=selection.getCurrentCell();

Return

Selection — The current selection.

Authorization

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

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

Gets the sheet with the given ID. UseSheet.getSheetId().

constsheet=SpreadsheetApp.getActiveSpreadsheet().getSheetById(12345);

Parameters

Return

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

Returns a sheet with the given name.

If multiple sheets have the same name, the leftmost one is returned. Returnsnull ifthere is no sheet with the given name.

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

Parameters

Return

Sheet — The sheet with the given name.

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 monotonicallyincreasing integer assigned at sheet creation time that is independent of sheet position. Thisis useful in conjunction with methods such asRange.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) that take agridId parameter rather than aSheet instance.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=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 followingscopes:

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

Returns the sheet name.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=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 followingscopes:

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

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

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// The two samples below produce the same outputletvalues=sheet.getSheetValues(1,1,3,3);Logger.log(values);constrange=sheet.getRange(1,1,3,3);values=range.getValues();Logger.log(values);

Parameters

Return

Object[][] — A two-dimensional array of values.

Authorization

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

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

Gets all the sheets in this spreadsheet.

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

Return

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

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.constss=SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit',);// Gets the spreadsheet locale.constssLocale=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 followingscopes:

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

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

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

Return

SpreadsheetTheme — The current applied theme.

Authorization

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

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

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.constss=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.constssTimeZone=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 byJoda.org).

Authorization

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

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

Returns the URL for the given spreadsheet.

constss=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 followingscopes:

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

Gets the list of viewers and commenters for thisSpreadsheet.

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 followingscopes:

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

Hides the column or columns in the given range.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// This hides the first columnletrange=sheet.getRange('A1');sheet.hideColumn(range);// This hides the first 3 columnsrange=sheet.getRange('A:C');sheet.hideColumn(range);

Parameters

Authorization

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

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

Hides the rows in the given range.

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

Parameters

Authorization

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

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

Inserts a column after the given column position.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// This inserts a column after the first column positionsheet.insertColumnAfter(1);

Parameters

Return

Sheet — The sheet, useful for method chaining.

Authorization

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

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

Inserts a column before the given column position.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// This inserts a column in the first column positionsheet.insertColumnBefore(1);

Parameters

Return

Sheet — The sheet, useful for method chaining.

Authorization

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

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

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

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// Inserts two columns after the first column on the first sheet of the// spreadsheet.sheet.insertColumnsAfter(1,2);

Parameters

Return

Sheet — The sheet, useful for method chaining.

Authorization

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

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

Inserts a number of columns before the given column position.

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

Parameters

Return

Sheet — The sheet, useful for method chaining.

Authorization

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

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

Inserts a newDataSourceSheet in the spreadsheet and starts data execution. As aside effect, this also makes the new sheet the active sheet.

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

// 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.constss=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.constdataSourceSpec=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

Return

DataSourceSheet — The new data source sheet.

Authorization

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

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

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

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];constbinaryData=[];// TODO(developer): Replace with your binary data.constblob=Utilities.newBlob(binaryData,'image/png','MyImageName');sheet.insertImage(blob,1,1);

Parameters

Return

OverGridImage — The inserted image.

Authorization

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

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

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

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];constbinaryData=[];// TODO(developer): Replace with your binary data.constblob=Utilities.newBlob(binaryData,'image/png','MyImageName');sheet.insertImage(blob,1,1,10,10);

Parameters

Return

OverGridImage — The inserted image.

Authorization

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

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

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

The provided URL must be publicly accessible.

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

Parameters

Return

OverGridImage — The inserted image.

Authorization

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

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

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

The provided URL must be publicly accessible.

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

Parameters

Return

OverGridImage — The Inserted image.

Authorization

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

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

Inserts a row after the given row position.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// This inserts a row after the first row positionsheet.insertRowAfter(1);

Parameters

Return

Sheet — The sheet, useful for method chaining.

Authorization

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

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

Inserts a row before the given row position.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// This inserts a row before the first row positionsheet.insertRowBefore(1);

Parameters

Return

Sheet — The sheet, useful for method chaining.

Authorization

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

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

Inserts a number of rows after the given row position.

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

Parameters

Return

Sheet — The sheet, useful for method chaining.

Authorization

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

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

Inserts a number of rows before the given row position.

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

Parameters

Return

Sheet — The sheet, useful for method chaining.

Authorization

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

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

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

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

Return

Sheet — The new sheet.

Authorization

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

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

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

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

Parameters

Return

Sheet — The new sheet.

Authorization

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

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

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

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

Parameters

Advanced parameters

Return

Sheet — The new sheet.

Authorization

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

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

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

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

Parameters

Advanced parameters

Return

Sheet — The new sheet.

Authorization

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

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

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

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

Parameters

Return

Sheet — The new sheet.