Sheets API Reference

Complete reference for all Sheets service methods and properties.

Sheets Class

python
from gspace import GSpace

gspace = GSpace.from_oauth(credentials_file, scopes=["sheets"])
sheets = gspace.sheets()

Methods

create_spreadsheet

Create a new spreadsheet.

python
def create_spreadsheet(
    title: str,
    sheets: list[dict] | None = None,
    **kwargs
) -> dict

get_spreadsheet

Get spreadsheet metadata and structure.

python
def get_spreadsheet(
    spreadsheet_id: str,
    ranges: list[str] | None = None,
    fields: str | None = None
) -> dict

get_values

Read values from a range.

python
def get_values(
    spreadsheet_id: str,
    range_name: str,
    value_render_option: str = "FORMATTED_VALUE"
) -> list[list]

update_values

Update values in a range.

python
def update_values(
    spreadsheet_id: str,
    range_name: str,
    values: list[list],
    value_input_option: str = "USER_ENTERED"
) -> dict

batch_update_values

Batch update multiple ranges.

python
def batch_update_values(
    spreadsheet_id: str,
    data: list[dict],
    value_input_option: str = "USER_ENTERED"
) -> dict

format_cells

Format cells in a range.

python
def format_cells(
    spreadsheet_id: str,
    range_name: str,
    format_properties: dict
) -> dict

add_sheet

Add a new sheet to the spreadsheet.

python
def add_sheet(
    spreadsheet_id: str,
    title: str,
    **kwargs
) -> dict

delete_sheet

Delete a sheet.

python
def delete_sheet(
    spreadsheet_id: str,
    sheet_id: int
) -> dict

apply_conditional_formatting

Apply conditional formatting rules.

python
def apply_conditional_formatting(
    spreadsheet_id: str,
    range_name: str,
    rule: dict
) -> dict

add_data_validation

Add data validation to cells.

python
def add_data_validation(
    spreadsheet_id: str,
    range_name: str,
    rule: dict
) -> dict

create_chart

Create a chart in the spreadsheet.

python
def create_chart(
    spreadsheet_id: str,
    sheet_id: int,
    chart: dict
) -> dict