Sheet Rows

Spreadsheet Files

Spreadsheet Tabs

Google Sheets

Creates a spreadsheet, returning the newly created spreadsheet.

Sheets Spreadsheets Create

Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: * Specify a [field mask](https://developers.google.com/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData URL 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. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using [A1 notation](/sheets/api/guides/concepts#cell). You can define a single cell (for example, `A1`) or multiple cells (for example, `A1:D5`). You can also get cells from other sheets within the same spreadsheet (for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example, `?ranges=A1:D5&ranges=Sheet2!A1:C4`). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges.

Sheets Spreadsheets Get

Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. 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 one of 2 ways: * Specify a [field mask](https://developers.google.com/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.

Sheets Spreadsheets Get By Data Filter

Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes.

Sheets Spreadsheets Batch Update

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

Sheets Spreadsheets Values Get

Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption.

Sheets Spreadsheets Values Update

Appends values to a spreadsheet. The input range is used to search for existing data and find a "table" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the [guide](/sheets/api/guides/values#appending_values) and [sample code](/sheets/api/samples/writing#append_values) for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to.

Sheets Spreadsheets Values Append

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.

Sheets Spreadsheets Values Clear

Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.

Sheets Spreadsheets Values Batch Get

Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges.

Sheets Spreadsheets Values Batch Update

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.

Sheets Spreadsheets Values Batch Clear

Returns one or more ranges of values that match the specified data filters. 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.

Sheets Spreadsheets Values Batch Get By Data Filter

Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges.

Sheets Spreadsheets Values Batch Update By Data Filter

Clears one or more ranges of values from a spreadsheet. 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.

Sheets Spreadsheets Values Batch Clear By Data Filter

Returns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId.

Sheets Spreadsheets Developer Metadata Get

Returns all developer metadata matching the specified DataFilter. 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.

Sheets Spreadsheets Developer Metadata Search

Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet.

Sheets Spreadsheets Sheets Copy To

The request for updating any aspect of a spreadsheet.

Determines if the update response should include the spreadsheet resource.

A list of updates to apply to the spreadsheet. Requests will be applied in the order they are specified. If any request is not valid, no requests will be applied.

A single kind of update to apply to a spreadsheet.

True if grid data should be returned. Meaningful only if include_spreadsheet_in_response is 'true'. This parameter is ignored if a field mask was set in the request.

Limits the ranges included in the response spreadsheet. Meaningful only if include_spreadsheet_in_response is 'true'.

Data

The reply for batch updating a spreadsheet.

The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty.

The result of adding a chart to a spreadsheet.

The result of adding a new protected range.

The result of adding a slicer to a spreadsheet.

The response from creating developer metadata.

The result of deleting a conditional format rule.

The response from deleting developer metadata.

The result of removing duplicates in a range.

The result of a filter view being duplicated.

The response from refreshing one or multiple data source objects.

The result of trimming whitespace in cells.

The result of updating a conditional format rule.

The response from updating developer metadata.

The result of updating an embedded object's position.

The spreadsheet the updates were applied to.

Output only. A list of data source refresh schedules.

Schedule for refreshing the data source. Data sources in the spreadsheet are refreshed within a time interval. You can specify the start time by clicking the Scheduled Refresh button in the Sheets editor, but the interval is fixed at 4 hours. For example, if you specify a start time of 8 AM , the refresh will take place between 8 AM and 12 PM every day.

A list of external data sources connected with the spreadsheet.

Information about an external data source in the spreadsheet.

The developer metadata associated with a spreadsheet.

Developer metadata associated with a location or object in a spreadsheet. Developer metadata may be used to associate arbitrary data with various parts of a spreadsheet and will remain associated at those locations as they move around and the spreadsheet is edited. For example, if developer metadata is associated with row 5 and another row is then subsequently inserted above row 5, that original metadata will still be associated with the row it was first associated with (what is now row 6). If the associated object is deleted its metadata is deleted too.

The named ranges defined in a spreadsheet.

The amount of time to wait before volatile functions are recalculated.

Settings to control how circular dependencies are resolved with iterative calculation.

The time zone of the spreadsheet, in CLDR format such as `America/New_York`. If the time zone isn't recognized, this may be a custom time zone such as `GMT-07:00`.

The sheets that are part of a spreadsheet.

The ID of the spreadsheet. This field is read-only.

The url of the spreadsheet. This field is read-only.

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

Field Name	API Key	Type	Description
Spreadsheet Id	spreadsheetId	string	The spreadsheet the updates were applied to.
Replies	replies	array of items	The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty.
Add Named Range	item.addNamedRange	object	The result of adding a named range.
Named Range	addNamedRange.namedRange	object	A named range.
Named Range Id	addNamedRange.namedRange.namedRangeId	string	The ID of the named range.

Google Sheets API Integration Profile

Sheets Spreadsheets Batch Update in Google Sheets API

Build every single integration your customers need with AI