Googlesheets

Learn how to use Googlesheets with Composio

Overview

Enum

GOOGLESHEETS

Description

Google Sheets is a cloud-based spreadsheet tool enabling real-time collaboration, data analysis, and integration with other Google Workspace apps

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to https://www.googleapis.com/auth/spreadsheets,https://www.googleapis.com/auth/drive,https://www.googleapis.com/auth/userinfo.email

Actions

Adds a new sheet (worksheet) to a spreadsheet. use this tool to create a new tab within an existing google sheet, optionally specifying its title, index, size, and other properties.

Action Parameters

includeSpreadsheetInResponse
boolean
properties
object
responseIncludeGridData
boolean
spreadsheetId
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to append new rows or columns to a sheet, increasing its size. use when you need to add empty rows or columns to an existing sheet.

Action Parameters

dimension
stringRequired
length
integerRequired
sheet_id
integerRequired
spreadsheet_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to clear the basic filter from a sheet. use when you need to remove an existing basic filter from a specific sheet within a google spreadsheet.

Action Parameters

sheet_id
integerRequired
spreadsheet_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to delete specified rows or columns from a sheet in a google spreadsheet. use when you need to remove a range of rows or columns.

Action Parameters

delete_dimension_request
objectRequired
include_spreadsheet_in_response
boolean
response_include_grid_data
boolean
response_ranges
array
spreadsheet_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to delete a sheet (worksheet) from a spreadsheet. use when you need to remove a specific sheet from a google sheet document.

Action Parameters

sheet_id
integerRequired
spreadsheetId
stringRequired

Action Response

data
object
error
string
successful
boolean
Returns the spreadsheet at the given id, filtered by the specified data filters. use this tool when you need to retrieve specific subsets of data from a google sheet based on criteria like a1 notation, developer metadata, or grid ranges.

Action Parameters

dataFilters
arrayRequired
excludeTablesInBandedRanges
boolean
includeGridData
boolean
spreadsheetId
stringRequired

Action Response

data
object
error
string
successful
boolean
Retrieves comprehensive metadata for a google spreadsheet using its id, excluding cell data.

Action Parameters

spreadsheet_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to insert new rows or columns into a sheet at a specified location. use when you need to add empty rows or columns within an existing google sheet.

Action Parameters

include_spreadsheet_in_response
boolean
insert_dimension
objectRequired
response_include_grid_data
boolean
response_ranges
array
spreadsheet_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to search for developer metadata in a spreadsheet. use when you need to find specific metadata entries based on filters.

Action Parameters

dataFilters
arrayRequired
spreadsheetId
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to set a basic filter on a sheet in a google spreadsheet. use when you need to filter or sort data within a specific range on a sheet.

Action Parameters

filter
objectRequired
spreadsheetId
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to copy a single sheet from a spreadsheet to another spreadsheet. use when you need to duplicate a sheet into a different spreadsheet.

Action Parameters

destination_spreadsheet_id
stringRequired
sheet_id
integerRequired
spreadsheet_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to append values to a spreadsheet. use when you need to add new data to the end of an existing table in a google sheet.

Action Parameters

includeValuesInResponse
boolean
insertDataOption
string
majorDimension
string
range
stringRequired
responseDateTimeRenderOption
string
responseValueRenderOption
string
spreadsheetId
stringRequired
valueInputOption
stringRequired
values
arrayRequired

Action Response

data
object
error
string
successful
boolean
Tool to clear one or more ranges of values from a spreadsheet. use when you need to remove data from specific cells or ranges while keeping formatting and other properties intact.

Action Parameters

ranges
arrayRequired
spreadsheet_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Clears one or more ranges of values from a spreadsheet using data filters. 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.

Action Parameters

dataFilters
arrayRequired
spreadsheetId
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to return one or more ranges of values from a spreadsheet that match the specified data filters. use when you need to retrieve specific data sets based on filtering criteria rather than entire sheets or fixed ranges.

Action Parameters

dataFilters
arrayRequired
dateTimeRenderOption
string
majorDimension
string
spreadsheetId
stringRequired
valueRenderOption
string

Action Response

data
object
error
string
successful
boolean
Tool to update properties of a sheet (worksheet) within a google spreadsheet, such as its title, index, visibility, tab color, or grid properties. use this when you need to modify the metadata or appearance of a specific sheet.

Action Parameters

spreadsheetId
stringRequired
updateSheetProperties
objectRequired

Action Response

data
object
error
string
successful
boolean
Tool to update properties of a spreadsheet, such as its title, locale, or auto-recalculation settings. use when you need to modify the overall configuration of a google sheet.

Action Parameters

fields
stringRequired
properties
objectRequired
spreadsheetId
stringRequired

Action Response

data
object
error
string
successful
boolean
Searches for rows where a specific column matches a value and performs mathematical operations on data from another column.

Action Parameters

case_sensitive
booleanDefaults to True
has_header_row
booleanDefaults to True
operation
stringRequired
percentage_total
number
search_column
stringRequired
search_value
stringRequired
sheet_name
stringRequired
spreadsheet_id
stringRequired
target_column
stringRequired

Action Response

data
object
error
string
successful
boolean
Retrieves data from specified cell ranges in a google spreadsheet; ensure the spreadsheet has at least one worksheet and any explicitly referenced sheet names in ranges exist.

Action Parameters

ranges
array
spreadsheet_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Updates a specified range in a google sheet with given values, or appends them as new rows if `first cell location` is omitted; ensure the target sheet exists and the spreadsheet contains at least one worksheet.

Action Parameters

first_cell_location
string
includeValuesInResponse
boolean
sheet_name
stringRequired
spreadsheet_id
stringRequired
valueInputOption
stringDefaults to USER_ENTERED
values
arrayRequired

Action Response

data
object
error
string
successful
boolean
Tool to update values in ranges matching data filters. use when you need to update specific data in a google sheet based on criteria rather than fixed cell ranges.

Action Parameters

data
arrayRequired
includeValuesInResponse
boolean
responseDateTimeRenderOption
stringDefaults to SERIAL_NUMBER
responseValueRenderOption
stringDefaults to FORMATTED_VALUE
spreadsheetId
stringRequired
valueInputOption
stringRequired

Action Response

data
object
error
string
successful
boolean
Clears cell content (preserving formatting and notes) from a specified a1 notation range in a google spreadsheet; the range must correspond to an existing sheet and cells.

Action Parameters

range
stringRequired
spreadsheet_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Creates a new google spreadsheet in google drive using the provided title.

Action Parameters

title
stringRequired

Action Response

data
object
error
string
successful
boolean
Creates a new column in a google spreadsheet, requiring a valid `spreadsheet id` and an existing `sheet id`; an out-of-bounds `insert index` may append/prepend the column.

Action Parameters

inherit_from_before
boolean
insert_index
integer
sheet_id
integerRequired
spreadsheet_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Inserts a new, empty row into a specified sheet of a google spreadsheet at a given index, optionally inheriting formatting from the row above.

Action Parameters

inherit_from_before
boolean
insert_index
integer
sheet_id
integerRequired
spreadsheet_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Finds a worksheet by its exact, case-sensitive title within a google spreadsheet; returns a boolean indicating if found and the complete metadata of the entire spreadsheet, regardless of whether the target worksheet is found.

Action Parameters

spreadsheet_id
stringRequired
title
stringRequired

Action Response

data
object
error
string
successful
boolean
Applies text and background cell formatting to a specified range in a google sheets worksheet.

Action Parameters

blue
numberDefaults to 0.9
bold
boolean
end_column_index
integerRequired
end_row_index
integerRequired
fontSize
integerDefaults to 10
green
numberDefaults to 0.9
italic
boolean
red
numberDefaults to 0.9
spreadsheet_id
stringRequired
start_column_index
integerRequired
start_row_index
integerRequired
strikethrough
boolean
underline
boolean
worksheet_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Lists all worksheet names from a specified google spreadsheet (which must exist), useful for discovering sheets before further operations.

Action Parameters

spreadsheet_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Finds the first row in a google spreadsheet where a cell's entire content exactly matches the query string, searching within a specified a1 notation range or the first sheet by default.

Action Parameters

case_sensitive
boolean
query
stringRequired
range
string
spreadsheet_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Search for google spreadsheets using various filters including name, content, date ranges, and more.

Action Parameters

created_after
string
include_trashed
boolean
max_results
integerDefaults to 10
modified_after
string
order_by
stringDefaults to modifiedTime desc
query
string
shared_with_me
boolean
starred_only
boolean

Action Response

data
object
error
string
successful
boolean
Creates a new google spreadsheet and populates its first worksheet from `sheet json`, which must be non-empty as its first item's keys establish the headers.

Action Parameters

sheet_json
arrayRequired
sheet_name
stringRequired
title
stringRequired

Action Response

data
object
error
string
successful
boolean