Googlesheets

Learn how to use Googlesheets with Composio

Overview

SLUG

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
bearer_token
string

Tools

SLUG: GOOGLESHEETS_ADD_SHEET

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
objectRequired
error
string
successful
booleanRequired

SLUG: GOOGLESHEETS_APPEND_DIMENSION

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
objectRequired
error
string
successful
booleanRequired

SLUG: GOOGLESHEETS_CLEAR_BASIC_FILTER

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
objectRequired
error
string
successful
booleanRequired

SLUG: GOOGLESHEETS_DELETE_DIMENSION

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
objectRequired
error
string
successful
booleanRequired

SLUG: GOOGLESHEETS_DELETE_SHEET

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
objectRequired
error
string
successful
booleanRequired

SLUG: GOOGLESHEETS_GET_SPREADSHEET_BY_DATA_FILTER

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
objectRequired
error
string
successful
booleanRequired

SLUG: GOOGLESHEETS_GET_SPREADSHEET_INFO

Retrieves comprehensive metadata for a google spreadsheet using its id, excluding cell data.

Action Parameters

spreadsheet_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: GOOGLESHEETS_INSERT_DIMENSION

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
objectRequired
error
string
successful
booleanRequired

SLUG: GOOGLESHEETS_SEARCH_DEVELOPER_METADATA

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
objectRequired
error
string
successful
booleanRequired

SLUG: GOOGLESHEETS_SET_BASIC_FILTER

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
objectRequired
error
string
successful
booleanRequired

SLUG: GOOGLESHEETS_SPREADSHEETS_SHEETS_COPY_TO

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
objectRequired
error
string
successful
booleanRequired

SLUG: GOOGLESHEETS_SPREADSHEETS_VALUES_APPEND

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
objectRequired
error
string
successful
booleanRequired

SLUG: GOOGLESHEETS_SPREADSHEETS_VALUES_BATCH_CLEAR

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
objectRequired
error
string
successful
booleanRequired

SLUG: GOOGLESHEETS_SPREADSHEETS_VALUES_BATCH_CLEAR_BY_DATA_FILTER

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
objectRequired
error
string
successful
booleanRequired

SLUG: GOOGLESHEETS_SPREADSHEETS_VALUES_BATCH_GET_BY_DATA_FILTER

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
objectRequired
error
string
successful
booleanRequired

SLUG: GOOGLESHEETS_UPDATE_SHEET_PROPERTIES

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
objectRequired
error
string
successful
booleanRequired

SLUG: GOOGLESHEETS_UPDATE_SPREADSHEET_PROPERTIES

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
objectRequired
error
string
successful
booleanRequired

SLUG: GOOGLESHEETS_AGGREGATE_COLUMN_DATA

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
objectRequired
error
string
successful
booleanRequired

SLUG: GOOGLESHEETS_BATCH_GET

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
objectRequired
error
string
successful
booleanRequired

SLUG: GOOGLESHEETS_BATCH_UPDATE

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
objectRequired
error
string
successful
booleanRequired