What you can ask
- “What does Google Sheets have for the area or asset I'm working on?”
- “Pull the most recent Google Sheets records and put them in a table.”
- “What does Google Sheets cover, and how fresh is the data?”
About this source
Eight direct, bounded Google Sheets API v4 primitives authorized by drive.file for spreadsheets PatchOps created or the user explicitly opened. The model selects the method and supplies exact spreadsheet IDs and A1 ranges. Reads are response-capped; writes use closed schemas, bounded cell counts, and bounded JSON bodies. Generic batchUpdate is not exposed as an unchecked escape hatch.
Connector ID sheets
Provenance
Freshness & coverage
› Methods (18)
Technical detail for developers: parameters, pagination, units, and freshness per method.
getSpreadsheet
readGet bounded spreadsheet metadata; grid data is omitted unless explicitly requested and ranges can constrain it.
Required paramsspreadsheetIdPaginationnonegetSheetValues
readRead one bounded A1 range using exact Sheets value-rendering options.
Required paramsspreadsheetIdrangePaginationnonebatchGetSheetValues
readRead up to 50 bounded A1 ranges in one exact Sheets batchGet request.
Required paramsspreadsheetIdrangesPaginationnonecreateSpreadsheet
writeCreate one spreadsheet with up to 20 explicitly bounded initial sheets.
Required paramstitlePaginationnoneupdateCells
writeReplace values in one exact A1 range; accepts at most 100,000 scalar cells and a 2 MB JSON body.
Required paramsspreadsheetIdrangevaluesPaginationnoneappendRows
writeAppend bounded rows to the table found in one exact A1 range.
Required paramsspreadsheetIdrangevaluesPaginationnonecreateSheet
writeAdd one named sheet tab with optional bounded grid dimensions.
Required paramsspreadsheetIdtitlePaginationnoneformatRange
writeApply a closed subset of CellFormat to one sheet-qualified A1 range such as Sheet1!A1:D10 or 'Q1 Budget'!A1:D10.
Required paramsspreadsheetIdrangeformatPaginationnonespreadsheets_developermetadata_get
readOfficial sheets.spreadsheets.developerMetadata.get operation. Returns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata).
Required paramsmetadataIdspreadsheetIdPaginationnonespreadsheets_developermetadata_search
readOfficial sheets.spreadsheets.developerMetadata.search operation. Returns all developer metadata matching the specified DataFilter. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMetadata entries selected by it. If the DataFilter represents a location in a spreadsheet, this will return all developer metadata associated with locations intersecting that region.
Required paramsspreadsheetIdbodyPaginationnonespreadsheets_getbydatafilter
readOfficial sheets.spreadsheets.getByDataFilter operation. Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data in one of two ways: * Specify a [field mask](https://developers.google.com/workspace/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP. * Set the includeGridData parameter to `true`. If a field mask is set, the `includeGridData` parameter is ignored. For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want.
Required paramsspreadsheetIdbodyPaginationnonespreadsheets_sheets_copyto
writeOfficial sheets.spreadsheets.sheets.copyTo operation. Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet.
Required paramssheetIdspreadsheetIdbodyPaginationnonespreadsheets_values_batchclear
writeOfficial sheets.spreadsheets.values.batchClear operation. Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Only values are cleared -- all other properties of the cell (such as formatting and data validation) are kept.
Required paramsspreadsheetIdbodyPaginationnonespreadsheets_values_batchclearbydatafilter
writeOfficial sheets.spreadsheets.values.batchClearByDataFilter operation. Clears one or more ranges of values from a spreadsheet. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc.) are kept.
Required paramsspreadsheetIdbodyPaginationnonespreadsheets_values_batchgetbydatafilter
readOfficial sheets.spreadsheets.values.batchGetByDataFilter operation. Returns one or more ranges of values that match the specified data filters. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID and one or more DataFilters. Ranges that match any of the data filters in the request will be returned.
Required paramsspreadsheetIdbodyPaginationnonespreadsheets_values_batchupdate
writeOfficial sheets.spreadsheets.values.batchUpdate operation. Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges.
Required paramsspreadsheetIdbodyPaginationnonespreadsheets_values_batchupdatebydatafilter
writeOfficial sheets.spreadsheets.values.batchUpdateByDataFilter operation. Sets values in one or more ranges of a spreadsheet. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges.
Required paramsspreadsheetIdbodyPaginationnonespreadsheets_values_clear
writeOfficial sheets.spreadsheets.values.clear operation. Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.
Required paramsrangespreadsheetIdbodyPaginationnone
