IntegrationsProductivity & DocsGoogleSheets

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

PyPI VersionLicensePython VersionsWheel StatusDownloads

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

Install

pip install arcade_google

pip installing the toolkit is only needed if you are self-hosting Arcade. You do not need to install the toolkit if you’re using Arcade Cloud.

Available Tools

These tools are currently available in the Arcade Sheets toolkit.

Tool NameDescription
CreateSpreadsheetCreate a new spreadsheet with a title and optional data.
GetSpreadsheetRetrieve spreadsheet properties and cell data for all sheets.
WriteToCellWrite 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.

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.

GetSpreadsheet

Retrieve all properties and cell data for every sheet in a spreadsheet.

Parameters

  • spreadsheet_id (string, required): The ID of the spreadsheet to retrieve.

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

GmailReference