Google Sheets API Integration Profile
Information and guides about integrating with Google Sheets API
Add Google Sheets Integration to Your ProductSheets Spreadsheets Values Batch Get in Google Sheets API
Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.
Input schema fields
| Field Name | API Key | Type | |
|---|---|---|---|
| Path Parameters | pathParameters | object | |
| Spreadsheet Id | pathParameters.spreadsheetId | string | |
| Query | query | object | |
| Access Token | query.access_token | string | |
| Alt | query.alt | string |
Output schema fields
| Field Name | API Key | Type | Description |
|---|---|---|---|
| Spreadsheet Id | spreadsheetId | string | The ID of the spreadsheet the data was retrieved from. |
| Value Ranges | valueRanges | array of items | The requested values. The order of the ValueRanges is the same as the order of the requested ranges. |
| Range | item.range | string | The range the values cover, in [A1 notation](/sheets/api/guides/concepts#cell). 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. |
| Major Dimension | item.majorDimension | string | 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. |
| Values | item.values | array of arrays | 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. |