Skip to main content

Batch Get Values

BatchGetValues reads several ranges of values in a single call.

It calls GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchGet.

The activity has 4 tabs: Configuration, Auth, Input, and Output.

Configuration

FieldRequiredDescription
NameOptionalName of the step, should be unique within this workflow.
DescriptionOptionalDescribe the purpose or function of this step.
Spreadsheet IdOptionalEnter the ID of the spreadsheet to access.
RangesOptionalEnter the ranges for the query, if applicable.
Major DimensionOptionalSpecify the major dimension for the data (e.g., ROWS or COLUMNS).
Date Time Render OptionOptionalSpecify how to render date and time values in the response.
Value Render OptionOptionalSpecify how to render the values in the response.

Auth

FieldRequiredDescription
Auth TypeOptionalThe authentication method for the request. OAuth 2 is the only option, and the default.
Auth ResourceOptionalOAuth resource containing credentials.

Input

This activity is built on the REST Client, so the Input tab is the generic HTTP request rather than a Google Sheets-shaped payload.

FieldRequiredData TypeDescription
TargetRequiredObjectThe HTTP request.

Output

The activity returns an httpResponse object.

FieldData TypeDescription
status.codeIntegerNumeric HTTP status code.
status.messageStringShort message associated with the HTTP status.
headersObjectHTTP response headers.
bodyObjectParsed body of the response.

The response body carries:

FieldData Type
spreadsheetIdString
valueRangesArray

The output schema names these fields without describing them.