Create a tool from an API key.
Tool for reading data from a single range in Google Sheets.
Inherits from
BaseReadTool.
Reads data from a single range with support for various rendering options and data transformations.
Tool Output:
success (bool): Whether operation succeeded. spreadsheet_id (str): The spreadsheet ID. range (str): The actual range that was read (A1 notation). values (list): Processed data (2D array or list of dictionaries). major_dimension (str): The major dimension ('ROWS' or 'COLUMNS'). render_options (dict): Applied rendering options. processing_options (dict): Applied processing options.
Read data from a range:
from langchain_google_community.sheets import SheetsReadDataTool
tool = SheetsReadDataTool(api_key="your_api_key")
result = tool.run(
{
"spreadsheet_id": "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
"range_name": "A1:E10",
}
)
print(result["values"])Convert 2D array to list of dictionaries using first row as headers:
result = tool.run(
{
"spreadsheet_id": "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
"range_name": "A1:E10",
"convert_to_records": True,
}
)
# Returns: [{"Name": "Alice", "Age": 25, ...}, ...]Get unformatted values and formulas:
result = tool.run(
{
"spreadsheet_id": "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
"range_name": "A1:E10",
"value_render_option": "UNFORMATTED_VALUE",
}
)