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

GET

spreadsheets

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

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://sheets.googleapis.com//v4/spreadsheets//values:batchGet'

Response Example

{
    "spreadsheetId": "string",
    "valueRanges": [
        {
            "majorDimension": "DIMENSION_UNSPECIFIED",
            "range": "string",
            "values": [
                [
                    null
                ]
            ]
        }
    ]
}

Request

Path Params

spreadsheetId

string

required

The ID of the spreadsheet to retrieve data from.

Query Params

dateTimeRenderOption

string

optional

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

string

optional

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

ranges

array[string]

optional

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

valueRenderOption

string

optional

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

Responses

🟢200Successful response

application/json

Body

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

spreadsheetId

string

optional

The ID of the spreadsheet the data was retrieved from.

valueRanges

array[object (ValueRange) {3}]

optional

The requested values. The order of the ValueRanges is the same as the order of the requested ranges.

majorDimension

enum<string>

optional

The major dimension of the values. For output, 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]]. For input, with range=A1:B2,majorDimension=ROWS then [[1,2],[3,4]] will set A1=1,B1=2,A2=3,B2=4. With range=A1:B2,majorDimension=COLUMNS then [[1,2],[3,4]] will set A1=1,B1=3,A2=2,B2=4. When writing, if this field is not set, it defaults to ROWS.

Allowed values:

DIMENSION_UNSPECIFIEDROWSCOLUMNS

range

string

optional

The range the values cover, in A1 notation. For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended.

values

array [array]

optional

The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string.

/v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter

/v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter