Method: spreadsheets.values.get

Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.

HTTP request

GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values/{range}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
spreadsheetId

string

The ID of the spreadsheet to retrieve data from.

range

string

The A1 notation of the values to retrieve.

Query parameters

Parameters
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 an instance of ValueRange.

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