Method: spreadsheets.values.batchGet

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 Google API HTTP annotation syntax.

Path parameters

Parameters
spreadsheetId

string

The ID of the spreadsheet to retrieve data from.

Query parameters

Parameters
ranges

string

The A1 notation of the values to retrieve.

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 range=A1:B2,majorDimension=ROWS will return [[1,2],[3,4]], whereas requesting range=A1:B2,majorDimension=COLUMNS will return [[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 [DateTimeRenderOption.SERIAL_NUMBER].

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

The response when retrieving more than one range of values in a spreadsheet.

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

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets
  • https://www.googleapis.com/auth/spreadsheets.readonly

For more information, see the Auth Guide.

Send feedback about...