spreadsheets

Changed on

Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.

get/v4/spreadsheets/{spreadsheetId}/values:batchGet

Request

  • Base URL: https://sheets.googleapis.com
  • URL: https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchGet
  • Auth: one of:
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/drive) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/drive)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/drive.file) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/drive.file)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/drive.readonly) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/drive.readonly)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/spreadsheets) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/spreadsheets)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/spreadsheets.readonly) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/spreadsheets.readonly)

Path parameters

spreadsheetIdstring required

The ID of the spreadsheet to retrieve data from.

Query parameters

dateTimeRenderOption'SERIAL_NUMBER' | 'FORMATTED_STRING'

How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.

majorDimension'DIMENSION_UNSPECIFIED' | 'ROWS' | 'COLUMNS'

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

rangesstring[]

The A1 notation or R1C1 notation of the range to retrieve values from.

valueRenderOption'FORMATTED_VALUE' | 'UNFORMATTED_VALUE' | 'FORMULA'

How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.

Response

Successful response

Changes

  • c69ba34ec4e6Revision changes
    • breaking

      removed the media type */* for the response with the status

    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/spreadsheets.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/spreadsheets.readonly was removed from the endpoint's security scheme Oauth2c

  • f5bfb17ef851Revision changes
    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/spreadsheets.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/spreadsheets.readonly was removed from the endpoint's security scheme Oauth2c