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

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
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
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
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
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
successful
boolean
Creates a new google spreadsheet in google drive using the provided title.

Action Parameters

title
stringRequired

Action Response

data
object
error
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
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
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
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
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
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
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
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
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
successful
boolean