Module●Since v3.0

write_sheet_tools

Functions

Classes

View source on GitHub

function

validate_range_name

Validate and normalize a range name.

Permissive A1 validator. Supports:

Single cells: 'A1', 'Z99'
Areas: 'A1:B2'
Whole columns: 'A:A', 'B:D'
Whole rows: '1:1', '5:10'
Sheet-qualified: 'Sheet1!A1', "'My Sheet'!A1:B2"
Named ranges: 'MyData', 'Sales_2024'

function

validate_spreadsheet_id

Validate and normalize a Google Spreadsheet ID.

class

SheetsBaseTool

Base class for Google Sheets tools.

Authentication:

api_resource: OAuth2 credentials for full access (read/write private sheets)
api_key: API key for read-only access (public sheets only)

Note

Write operations require OAuth2 credentials.

class

InsertDataOption

Google Sheets insert data options for append operations.

Determines how data should be inserted when appending to a table.

class

ValueInputOption

Google Sheets value input options for write operations.

Determines how input values should be interpreted when writing to cells.

class

WriteBaseSchema

Base schema for write operations with common fields.

class

UpdateValuesSchema

Input schema for SheetsUpdateValuesTool.

class

SheetsUpdateValuesTool

Tool for updating values in a single range of Google Sheets.

Inherits from SheetsBaseTool.

Updates cell values in a specified range, overwriting existing data.

Authentication Required

Requires OAuth2 authentication. Use api_resource parameter with authenticated Google Sheets service.

class

AppendValuesSchema

Input schema for SheetsAppendValuesTool.

class

SheetsAppendValuesTool

Tool for appending values to a Google Spreadsheet table.

Inherits from SheetsBaseTool.

Appends data to the end of a table, automatically finding the last row with data.

Authentication Required

Requires OAuth2 authentication. Use api_resource parameter with authenticated Google Sheets service.

class

ClearValuesSchema

Input schema for SheetsClearValuesTool.

class

SheetsClearValuesTool

Tool for clearing values from a Google Spreadsheet range.

Inherits from SheetsBaseTool.

Clears cell values from a specified range while preserving formatting and structure.

Authentication Required

Requires OAuth2 authentication. Use api_resource parameter with authenticated Google Sheets service.

Formatting Preserved

Only values are cleared. Formatting, borders, colors, fonts, and data validation rules remain intact.

class

BatchUpdateDataSchema

Schema for a single range update in batch operation.

class

BatchUpdateValuesSchema

Input schema for SheetsBatchUpdateValuesTool.

class

SheetsBatchUpdateValuesTool

Tool for batch updating multiple ranges in Google Sheets efficiently.

Inherits from SheetsBaseTool.

Updates multiple ranges in a single API call, dramatically improving efficiency.

Tools for writing data to Google Sheets.

LangChain Assistant

Menu

write_sheet_tools

Functions

Classes