Use wide Google Sheets integration

With Ants & Apps platform you can connect Google Sheets with more than 4000 available apps, 600+ functional formulas to boost your productivity

Get Started for Free

Reference

  • spreadsheets

    • Return the spreadsheet at the given ID

      This action returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids will not be returned. You can include grid data one of two ways: * Specify a field mask 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, it is recommended to retrieve only the specific fields of the spreadsheet that you want. To retrieve only subsets of the spreadsheet, use the ranges URL parameter. Multiple ranges can be specified. Limiting the range will return only the portions of the spreadsheet that intersect the requested ranges. Ranges are specified using A1 notation.

      GETSheetsSpreadsheetsGet

      Request parameters

      • spreadsheetId*string

        The spreadsheet to request.

      • rangesstring

        The ranges to retrieve from the spreadsheet.

      • includeGridDataboolean

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

      Try this in action

    • Return the spreadsheet at the given ID

      This action 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 will return the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids will not be returned. You can include grid data one of two ways: * Specify a field mask 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, it is recommended to retrieve only the specific fields of the spreadsheet that you want.

      POSTSheetsSpreadsheetsGetByDataFilter

      Request parameters

      • spreadsheetId*string

        The spreadsheet to request.

      Request body

      • dataFiltersarray

        The DataFilters used to select which ranges to retrieve from the spreadsheet.

      • includeGridDataboolean

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

      Try this in action

    • Create a spreadsheet, returning the newly created spreadsheet

      This action creates a spreadsheet, returning the newly created spreadsheet.

      POSTSheetsSpreadsheetsCreate

      Request body

      • spreadsheetIdstring

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

      • namedRangesarray

        The named ranges defined in a spreadsheet.

      • developerMetadataarray

        The developer metadata associated with a spreadsheet.

      • sheetsarray

        The sheets that are part of a spreadsheet.

      • spreadsheetUrlstring

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

      • propertiesobject

        Overall properties of a spreadsheet.

      Try this in action

    • Apply one or more updates to the spreadsheet

      This action 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.

      POSTSheetsSpreadsheetsBatchUpdate

      Request parameters

      • spreadsheetId*string

        The spreadsheet to apply the updates to.

      Request body

      • includeSpreadsheetInResponseboolean

        Determines if the update response should include the spreadsheet resource.

      • responseRangesarray

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

      • responseIncludeGridDataboolean

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

      • requestsarray

        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.

      Try this in action

  • spreadsheets.developerMetadata

    • Return the developer metadata with the specified ID

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

      GETSheetsSpreadsheetsDeveloperMetadataGet

      Request parameters

      • spreadsheetId*string

        The ID of the spreadsheet to retrieve metadata from.

      • metadataId*integer

        The ID of the developer metadata to retrieve.

      Try this in action

    • Return all developer metadata matching the specified DataFilter

      This action 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.

      POSTSheetsSpreadsheetsDeveloperMetadataSearch

      Request parameters

      • spreadsheetId*string

        The ID of the spreadsheet to retrieve metadata from.

      Request body

      • dataFiltersarray

        The data filters describing the criteria used to determine which DeveloperMetadata entries to return. DeveloperMetadata matching any of the specified filters will be included in the response.

      Try this in action

  • spreadsheets.sheets

    • Copy a single sheet from a spreadsheet to another spreadsheet

      This action copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet.

      POSTSheetsSpreadsheetsSheetsCopyTo

      Request parameters

      • spreadsheetId*string

        The ID of the spreadsheet containing the sheet to copy.

      • sheetId*integer

        The ID of the sheet to copy.

      Request body

      • destinationSpreadsheetIdstring

        The ID of the spreadsheet to copy the sheet to.

      Try this in action

  • spreadsheets.values

    • Return a range of values from a spreadsheet

      This action returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.

      GETSheetsSpreadsheetsValuesGet

      Request parameters

      • spreadsheetId*string

        The ID of the spreadsheet to retrieve data from.

      • range*string

        The A1 notation of the values to retrieve.

      • majorDimensionstring

        The major dimension that results should use. For example, 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]]`.

      • valueRenderOptionstring

        How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.

      • dateTimeRenderOptionstring

        How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].

      Try this in action

    • Return one or more ranges of values from a spreadsheet

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

      GETSheetsSpreadsheetsValuesBatchGet

      Request parameters

      • spreadsheetId*string

        The ID of the spreadsheet to retrieve data from.

      • rangesstring

        The A1 notation of the values to retrieve.

      • majorDimensionstring

        The major dimension that results should use. For example, 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]]`.

      • valueRenderOptionstring

        How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.

      • dateTimeRenderOptionstring

        How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].

      Try this in action

    • Return one or more ranges of values that match the specified data filters

      This action 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.

      POSTSheetsSpreadsheetsValuesBatchGetByDataFilter

      Request parameters

      • spreadsheetId*string

        The ID of the spreadsheet to retrieve data from.

      Request body

      • dataFiltersarray

        The data filters used to match the ranges of values to retrieve. Ranges that match any of the specified data filters will be included in the response.

      • valueRenderOptionstring

        How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.

      • dateTimeRenderOptionstring

        How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].

      • majorDimensionstring

        The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then a request that selects that range and sets `majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas a request that sets `majorDimension=COLUMNS` will return `[[1,3],[2,4]]`.

      Try this in action

    • Clear one or more ranges of values from a spreadsheet

      This action 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, data validation, etc..) are kept.

      POSTSheetsSpreadsheetsValuesBatchClear

      Request parameters

      • spreadsheetId*string

        The ID of the spreadsheet to update.

      Request body

      • rangesarray

        The ranges to clear, in A1 notation.

      Try this in action

    • Set values in one or more ranges of a spreadsheet

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

      POSTSheetsSpreadsheetsValuesBatchUpdateByDataFilter

      Request parameters

      • spreadsheetId*string

        The ID of the spreadsheet to update.

      Request body

      • responseValueRenderOptionstring

        Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.

      • includeValuesInResponseboolean

        Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses will contain the updated values. If the range to write was larger than than the range actually written, the response will include all values in the requested range (excluding trailing empty rows and columns).

      • valueInputOptionstring

        How the input data should be interpreted.

      • dataarray

        The new values to apply to the spreadsheet. If more than one range is matched by the specified DataFilter the specified values will be applied to all of those ranges.

      • responseDateTimeRenderOptionstring

        Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is DateTimeRenderOption.SERIAL_NUMBER.

      Try this in action

    • Set values in one or more ranges of a spreadsheet

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

      POSTSheetsSpreadsheetsValuesBatchUpdate

      Request parameters

      • spreadsheetId*string

        The ID of the spreadsheet to update.

      Request body

      • responseValueRenderOptionstring

        Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.

      • includeValuesInResponseboolean

        Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses will contain the updated values. If the range to write was larger than than the range actually written, the response will include all values in the requested range (excluding trailing empty rows and columns).

      • valueInputOptionstring

        How the input data should be interpreted.

      • dataarray

        The new values to apply to the spreadsheet.

      • responseDateTimeRenderOptionstring

        Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is DateTimeRenderOption.SERIAL_NUMBER.

      Try this in action

    • Clear values from a spreadsheet

      This action 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.

      POSTSheetsSpreadsheetsValuesClear

      Request parameters

      • spreadsheetId*string

        The ID of the spreadsheet to update.

      • range*string

        The A1 notation of the values to clear.

      Try this in action

    • Clear one or more ranges of values from a spreadsheet

      This action 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.

      POSTSheetsSpreadsheetsValuesBatchClearByDataFilter

      Request parameters

      • spreadsheetId*string

        The ID of the spreadsheet to update.

      Request body

      • dataFiltersarray

        The DataFilters used to determine which ranges to clear.

      Try this in action

    • Append values to a spreadsheet

      This action 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.

      POSTSheetsSpreadsheetsValuesAppend

      Request parameters

      • spreadsheetId*string

        The ID of the spreadsheet to update.

      • valueInputOption*string

        How the input data should be interpreted.

      • range*string

        The A1 notation of a range to search for a logical table of data. Values will be appended after the last row of the table.

      • responseValueRenderOptionstring

        Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.

      • insertDataOptionstring

        How the input data should be inserted.

      • responseDateTimeRenderOptionstring

        Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].

      • includeValuesInResponseboolean

        Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values.

      Request body

      • rangestring

        The range the values cover, in A1 notation. 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.

      • majorDimensionstring

        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.

      • valuesarray

        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.

      Try this in action

    • Set values in a range of a spreadsheet

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

      PUTSheetsSpreadsheetsValuesUpdate

      Request parameters

      • range*string

        The A1 notation of the values to update.

      • spreadsheetId*string

        The ID of the spreadsheet to update.

      • valueInputOption*string

        How the input data should be interpreted.

      • includeValuesInResponseboolean

        Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than than the range actually written, the response will include all values in the requested range (excluding trailing empty rows and columns).

      • responseValueRenderOptionstring

        Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.

      • responseDateTimeRenderOptionstring

        Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is DateTimeRenderOption.SERIAL_NUMBER.

      Request body

      • rangestring

        The range the values cover, in A1 notation. 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.

      • majorDimensionstring

        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.

      • valuesarray

        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.

      Try this in action