Google Sheets
Description: Enable agents to create, read, and update spreadsheets in Google Sheets.
Author: Arcade
Code: GitHub
Auth: User authorization via the Google auth provider
The Arcade Google Sheets toolkit provides pre-built tools for working with spreadsheets using the Google Sheets API. Use these tools to:
- Create new spreadsheets
- Retrieve spreadsheet data
- Update cell values
Available Tools
These tools are currently available in the Arcade Google Sheets toolkit.
| Tool Name | Description |
|---|---|
| GoogleSheets.CreateSpreadsheet | Create a new spreadsheet with a title and optional data. |
| GoogleSheets.GetSpreadsheet | Retrieve spreadsheet properties and cell data for all sheets. |
| GoogleSheets.WriteToCell | Write a value to a specific cell in a spreadsheet. |
If you need to perform an action that’s not listed here, you can get in touch with us to request a new tool, or create your own tools with the Google auth provider.
GoogleSheets.CreateSpreadsheet
Create a new spreadsheet with a custom title and optional data in the first sheet.
Parameters
title(string, required, default “Untitled spreadsheet”): The title of the new spreadsheet.data(string, optional): A JSON string representing a dictionary that maps row numbers to dictionaries. Each sub-dictionary maps column letters to cell values. For example,data[23]["C"]is the value for row 23, column C.
GoogleSheets.GetSpreadsheet
Retrieve the specified range of cells from a single sheet in a spreadsheet.
Parameters
spreadsheet_id(string, required): The ID of the spreadsheet to retrieve.sheet_position(int, optional, default 1): The position/tab of the sheet in the spreadsheet to get. A value of 1 represents the first (leftmost/Sheet1) sheet.sheet_id_or_name(string, optional, default None): The ID or name of the sheet to get. If not provided,sheet_positionwill be used.start_row(int, optional, default 1): Starting row number (1-indexed).start_col(string, optional, default ‘A’): Starting column letter(s) or 1-based column number.max_rows(int, optional, default 1000): Maximum number of rows to fetch for each sheet in the spreadsheet. Must be between 1 and 1000.max_cols(int, optional, default 100): Maximum number of columns to fetch for each sheet in the spreadsheet. Must be between 1 and 100.
GoogleSheets.WriteToCell
Write a value to a specific cell in a spreadsheet.
Parameters
spreadsheet_id(string, required): The ID of the spreadsheet.column(string, required): The column to write to (for example, “A”, “F”, or “AZ”).row(int, required): The row number to write to.value(string, required): The value to set in the specified cell.sheet_name(string, optional, default “Sheet1”): The name of the sheet to update.
Auth
The Arcade Google Sheets toolkit uses the Google auth provider to connect to users’ Google accounts.
With the hosted Arcade Engine, there’s nothing to configure. Your users will see Arcade as the name of the application that’s requesting permission.
With a self-hosted installation of Arcade, you need to configure the Google auth provider with your own Google app credentials.