Method: spreadsheets.values.batchGet
Stay organized with collections
Save and categorize content based on your preferences.
Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.
HTTP request
GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchGet
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
spreadsheetId |
string
The ID of the spreadsheet to retrieve data from.
|
Query parameters
| Parameters |
ranges[] |
string
The A1 notation or R1C1 notation of the range to retrieve values from.
|
majorDimension |
enum (Dimension)
The major dimension that results should use. For example, if the spreadsheet data is: A1=1,B1=2,A2=3,B2=4, then requesting ranges=["A1:B2"],majorDimension=ROWS returns [[1,2],[3,4]], whereas requesting ranges=["A1:B2"],majorDimension=COLUMNS returns [[1,3],[2,4]].
|
valueRenderOption |
enum (ValueRenderOption)
How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
|
dateTimeRenderOption |
enum (DateTimeRenderOption)
How dates, times, and durations should be represented in the output. This is ignored if valueRenderOption is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.
|
Request body
The request body must be empty.
Response body
The response when retrieving more than one range of values in a spreadsheet.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"spreadsheetId": string,
"valueRanges": [
{
object (ValueRange)
}
]
} |
| Fields |
spreadsheetId |
string
The ID of the spreadsheet the data was retrieved from.
|
valueRanges[] |
object (ValueRange)
The requested values. The order of the ValueRanges is the same as the order of the requested ranges.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/drivehttps://www.googleapis.com/auth/drive.readonlyhttps://www.googleapis.com/auth/drive.filehttps://www.googleapis.com/auth/spreadsheetshttps://www.googleapis.com/auth/spreadsheets.readonly
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-21 UTC.
[null,null,["Last updated 2025-03-21 UTC."],[],[],null,["# Method: spreadsheets.values.batchGet\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.BatchGetValuesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.\n\n### HTTP request\n\n`GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchGet`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------------|-----------------------------------------------------------|\n| `spreadsheetId` | `string` The ID of the spreadsheet to retrieve data from. |\n\n### Query parameters\n\n| Parameters ||\n|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ranges[]` | `string` The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the range to retrieve values from. |\n| `majorDimension` | `enum (`[Dimension](/workspace/sheets/api/reference/rest/v4/Dimension)`)` The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `ranges=[\"A1:B2\"],majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `ranges=[\"A1:B2\"],majorDimension=COLUMNS` returns `[[1,3],[2,4]]`. |\n| `valueRenderOption` | `enum (`[ValueRenderOption](/workspace/sheets/api/reference/rest/v4/ValueRenderOption)`)` How values should be represented in the output. The default render option is [ValueRenderOption.FORMATTED_VALUE](/workspace/sheets/api/reference/rest/v4/ValueRenderOption#ENUM_VALUES.FORMATTED_VALUE). |\n| `dateTimeRenderOption` | `enum (`[DateTimeRenderOption](/workspace/sheets/api/reference/rest/v4/DateTimeRenderOption)`)` How dates, times, and durations should be represented in the output. This is ignored if [valueRenderOption](/workspace/sheets/api/reference/rest/v4/spreadsheets.values/batchGet#body.QUERY_PARAMETERS.value_render_option) is [FORMATTED_VALUE](/workspace/sheets/api/reference/rest/v4/ValueRenderOption). The default dateTime render option is [SERIAL_NUMBER](/workspace/sheets/api/reference/rest/v4/DateTimeRenderOption). |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response when retrieving more than one range of values in a spreadsheet.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"spreadsheetId\": string, \"valueRanges\": [ { object (/workspace/sheets/api/reference/rest/v4/spreadsheets.values#ValueRange) } ] } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `spreadsheetId` | `string` The ID of the spreadsheet the data was retrieved from. |\n| `valueRanges[]` | `object (`[ValueRange](/workspace/sheets/api/reference/rest/v4/spreadsheets.values#ValueRange)`)` The requested values. The order of the ValueRanges is the same as the order of the requested ranges. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/drive`\n- `https://www.googleapis.com/auth/drive.readonly`\n- `https://www.googleapis.com/auth/drive.file`\n- `https://www.googleapis.com/auth/spreadsheets`\n- `https://www.googleapis.com/auth/spreadsheets.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
