Class NamedRange
Page Summary
Named ranges are spreadsheet ranges with associated string aliases that can be created, accessed, and modified.
Methods available for NamedRange include getting and setting the name and range, and removing the named range.
Accessing or modifying NamedRange properties requires specific authorization scopes.
Create, access and modify named ranges in a spreadsheet. Named ranges are ranges that haveassociated string aliases. They can be viewed and edited via the Sheets UI under theData >Named ranges... menu.
Methods
| Method | Return type | Brief description |
|---|---|---|
get | String | Gets the name of this named range. |
get | Range | Gets the range referenced by this named range. |
remove() | void | Deletes this named range. |
set | Named | Sets/updates the name of the named range. |
set | Named | Sets/updates the range for this named range. |
Detailed documentation
getName()
Gets the name of this named range.
Return
String — the name of this named range
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
getRange()
Gets the range referenced by this named range.
Return
Range — the spreadsheet range that is associated with this named range
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
remove()
Deletes this named range.
// The code below deletes all the named ranges in the spreadsheet.constnamedRanges=SpreadsheetApp.getActive().getNamedRanges();for(leti=0;i <namedRanges.length;i++){namedRanges[i].remove();}
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
setName(name)
Sets/updates the name of the named range.
// The code below updates the name for the first named range.constnamedRanges=SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();if(namedRanges.length >1){namedRanges[0].setName('UpdatedNamedRange');}
Parameters
| Name | Type | Description |
|---|---|---|
name | String | The new name of the named range. |
Return
Named — the range whose name was set by the call
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
setRange(range)
Sets/updates the range for this named range.
Parameters
| Name | Type | Description |
|---|---|---|
range | Range | The spreadsheet range to associate with this named range. |
Return
Named — the named range for which the spreadsheet range was set
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/spreadsheets.currentonlyhttps://www.googleapis.com/auth/spreadsheets
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-11 UTC.