Google Sheets Logo

Google Sheets API Integration Profile

Information and guides about integrating with Google Sheets API

Add Google Sheets Integration to Your Product

Sheets Spreadsheets Values Get in Google Sheets API

Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.

Input schema fields
Field NameAPI KeyType
Path ParameterspathParametersobject
Spreadsheet IdpathParameters.spreadsheetIdstring
RangepathParameters.rangestring
Queryqueryobject
Access Tokenquery.access_tokenstring
Output schema fields
Field NameAPI KeyTypeDescription
RangerangestringThe 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 DimensionmajorDimensionstringThe 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.
Valuesvaluesarray of arraysThe 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.

Build every single integration your customers need with AI

Book a demo