Get Spreadsheet By Data Filter
GetSpreadsheetByDataFilter retrieves a spreadsheet, returning only the parts a data filter selects.
It calls POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:getByDataFilter.
The activity has 4 tabs: Configuration, Auth, Input, and Output.
Configuration
| Field | Required | Description |
|---|---|---|
| Name | Optional | Name of the step, should be unique within this workflow. |
| Description | Optional | Describe the purpose or function of this step. |
| Spreadsheet Id | Optional | Enter the ID of the spreadsheet to access its data. |
Auth
| Field | Required | Description |
|---|---|---|
| Auth Type | Optional | The authentication method for the request. OAuth 2 is the only option, and the default. |
| Auth Resource | Optional | OAuth 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.
| Field | Required | Data Type | Description |
|---|---|---|---|
| Target | Required | Object | The HTTP request. |
Output
The activity returns an httpResponse object.
| Field | Data Type | Description |
|---|---|---|
| status.code | Integer | Numeric HTTP status code. |
| status.message | String | Short message associated with the HTTP status. |
| headers | Object | HTTP response headers. |
| body | Object | Parsed body of the response. |
The response body carries:
| Field | Data Type | Description |
|---|---|---|
| spreadsheetId | String | The ID of the spreadsheet. This field is read-only. |
| properties | Object | Properties of a spreadsheet. |
| sheets | Array | — |
| namedRanges | Array | — |
| spreadsheetUrl | String | The url of the spreadsheet. This field is read-only. |
| dataSources | Array | — |