create_spreadsheet
Create a new Google Spreadsheet with custom title and optional sheet names for a specified user. Returns spreadsheet ID and URL for quick access.
Instructions
Creates a new Google Spreadsheet.
Args: user_google_email (str): The user's Google email address. Required. title (str): The title of the new spreadsheet. Required. sheet_names (Optional[List[str]]): List of sheet names to create. If not provided, creates one sheet with default name.
Returns: str: Information about the newly created spreadsheet including ID and URL.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sheet_names | No | ||
| title | Yes | ||
| user_google_email | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Implementation Reference
- gsheets/sheets_tools.py:259-305 (handler)The core handler function for the 'create_spreadsheet' tool. It creates a new Google Spreadsheet using the Google Sheets API v4, with optional initial sheet names. Includes authentication, error handling, and logging.
@server.tool() @handle_http_errors("create_spreadsheet", service_type="sheets") @require_google_service("sheets", "sheets_write") async def create_spreadsheet( service, user_google_email: str, title: str, sheet_names: Optional[List[str]] = None, ) -> str: """ Creates a new Google Spreadsheet. Args: user_google_email (str): The user's Google email address. Required. title (str): The title of the new spreadsheet. Required. sheet_names (Optional[List[str]]): List of sheet names to create. If not provided, creates one sheet with default name. Returns: str: Information about the newly created spreadsheet including ID and URL. """ logger.info(f"[create_spreadsheet] Invoked. Email: '{user_google_email}', Title: {title}") spreadsheet_body = { "properties": { "title": title } } if sheet_names: spreadsheet_body["sheets"] = [ {"properties": {"title": sheet_name}} for sheet_name in sheet_names ] spreadsheet = await asyncio.to_thread( service.spreadsheets().create(body=spreadsheet_body).execute ) spreadsheet_id = spreadsheet.get("spreadsheetId") spreadsheet_url = spreadsheet.get("spreadsheetUrl") text_output = ( f"Successfully created spreadsheet '{title}' for {user_google_email}. " f"ID: {spreadsheet_id} | URL: {spreadsheet_url}" ) logger.info(f"Successfully created spreadsheet for {user_google_email}. ID: {spreadsheet_id}") return text_output - gsheets/__init__.py:7-22 (registration)Registers and exports the 'create_spreadsheet' tool as part of the gsheets module's public API via import and __all__.
from .sheets_tools import ( list_spreadsheets, get_spreadsheet_info, read_sheet_values, modify_sheet_values, create_spreadsheet, create_sheet, ) __all__ = [ "list_spreadsheets", "get_spreadsheet_info", "read_sheet_values", "modify_sheet_values", "create_spreadsheet", "create_sheet", - gsheets/sheets_tools.py:262-277 (schema)Type hints and docstring defining the input schema (parameters) and output for the create_spreadsheet tool.
async def create_spreadsheet( service, user_google_email: str, title: str, sheet_names: Optional[List[str]] = None, ) -> str: """ Creates a new Google Spreadsheet. Args: user_google_email (str): The user's Google email address. Required. title (str): The title of the new spreadsheet. Required. sheet_names (Optional[List[str]]): List of sheet names to create. If not provided, creates one sheet with default name. Returns: str: Information about the newly created spreadsheet including ID and URL.