gspread の API リファレンス

gspread (burnash/gspread) の公開 API 145 件 —— クラス 11、関数 21、メソッド 113。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

種別	件数
クラス	11
関数	21
メソッド	113

API 一覧

classgspread.auth.FlowCallable

Protocol for OAuth flow callables.

funcgspread.auth.api_key(token:str, http_client:HTTPClientType=HTTPClient) -> Client

Authenticate using an API key.

func

gspread.auth.authorize(credentials:Credentials, http_client:HTTPClientType=HTTPClient, session:Optional[Session]=None) -> Client

funcgspread.auth.get_config_dir(config_dir_name:str='gspread', os_is_windows:bool=os.name == 'nt') -> Path

Construct a config dir path.

funcgspread.auth.local_server_flow(client_config:Mapping[str, Any], scopes:Iterable[str], port:int=0) -> OAuthCredentials

Run an OAuth flow using a local server strategy.

func

gspread.auth.service_account(filename:Union[Path, str]=DEFAULT_SERVICE_ACCOUNT_FILENAME, scopes:Iterable[str]=DEFAULT_SCOPES, http_client:HTTPClientType=HTTPClient) -> Client

Authenticate using a service account.

func

gspread.auth.service_account_from_dict(info:Mapping[str, Any], scopes:Iterable[str]=DEFAULT_SCOPES, http_client:HTTPClientType=HTTPClient) -> Client

Authenticate using a service account (json).

methodgspread.cell.Cell.address() -> str

Cell address in A1 notation.

methodgspread.cell.Cell.col() -> int

Column number of the cell.

methodgspread.cell.Cell.numeric_value() -> Optional[Union[int, float]]

Numeric value of this cell.

methodgspread.cell.Cell.row() -> int

Row number of the cell.

method

gspread.client.Client.copy(file_id:str, title:Optional[str]=None, copy_permissions:bool=False, folder_id:Optional[str]=None, copy_comments:bool=True) -> Spreadsheet

Copies a spreadsheet.

methodgspread.client.Client.create(title:str, folder_id:Optional[str]=None) -> Spreadsheet

Creates a new spreadsheet.

methodgspread.client.Client.del_spreadsheet(file_id:str) -> None

Deletes a spreadsheet.

methodgspread.client.Client.export(file_id:str, format:str=ExportFormat.PDF) -> bytes

Export the spreadsheet in the given format.

methodgspread.client.Client.import_csv(file_id:str, data:Union[str, bytes]) -> Any

Imports data into the first page of the spreadsheet.

method

gspread.client.Client.insert_permission(file_id:str, value:Optional[str]=None, perm_type:Optional[str]=None, role:Optional[str]=None, notify:bool=True, email_message:Optional[str]=None, with_link:bool=False) -> Response

Creates a new permission for a file.

methodgspread.client.Client.list_permissions(file_id:str) -> List[Dict[str, Union[str, bool]]]

Retrieve a list of permissions for a file.

methodgspread.client.Client.open(title:str, folder_id:Optional[str]=None) -> Spreadsheet

Opens a spreadsheet.

methodgspread.client.Client.open_by_key(key:str) -> Spreadsheet

Opens a spreadsheet specified by `key` (a.k.a Spreadsheet ID).

methodgspread.client.Client.open_by_url(url:str) -> Spreadsheet

Opens a spreadsheet specified by `url`.

methodgspread.client.Client.openall(title:Optional[str]=None) -> List[Spreadsheet]

Opens all available spreadsheets.

methodgspread.client.Client.remove_permission(file_id:str, permission_id:str) -> None

Deletes a permission from a file.

classgspread.exceptions.GSpreadException

A base class for gspread's exceptions.

classgspread.exceptions.IncorrectCellLabel

The cell label is incorrect.

classgspread.exceptions.InvalidInputValue

The provided values is incorrect.

classgspread.exceptions.NoValidUrlKeyFound

No valid key found in URL.

classgspread.exceptions.SpreadsheetNotFound

Trying to open non-existent or inaccessible spreadsheet.

classgspread.exceptions.UnSupportedExportFormat

Raised when export format is not supported.

classgspread.exceptions.WorksheetNotFound

Trying to open non-existent or inaccessible worksheet.

classgspread.http_client.HTTPClient

An instance of this class communicates with Google API.

methodgspread.http_client.HTTPClient.export(file_id:str, format:str=ExportFormat.PDF) -> bytes

Export the spreadsheet in the given format.

methodgspread.http_client.HTTPClient.import_csv(file_id:str, data:Union[str, bytes]) -> Any

Imports data into the first page of the spreadsheet.

methodgspread.http_client.HTTPClient.list_permissions(file_id:str) -> List[Dict[str, Union[str, bool]]]

Retrieve a list of permissions for a file.

methodgspread.http_client.HTTPClient.remove_permission(file_id:str, permission_id:str) -> None

Deletes a permission from a file.

classgspread.spreadsheet.Spreadsheet

The class that represents a spreadsheet.

methodgspread.spreadsheet.Spreadsheet.accept_ownership(permission_id:str) -> Response

Accept the pending ownership request on that file.

methodgspread.spreadsheet.Spreadsheet.add_worksheet(title:str, rows:int, cols:int, index:Optional[int]=None) -> Worksheet

Adds a new worksheet to a spreadsheet.

methodgspread.spreadsheet.Spreadsheet.creationTime() -> str

Spreadsheet Creation time.

methodgspread.spreadsheet.Spreadsheet.del_worksheet(worksheet:Worksheet) -> Any

Deletes a worksheet from a spreadsheet.

methodgspread.spreadsheet.Spreadsheet.del_worksheet_by_id(worksheet_id:Union[str, int]) -> Any

Deletes a Worksheet by id

method

gspread.spreadsheet.Spreadsheet.duplicate_sheet(source_sheet_id:int, insert_sheet_index:Optional[int]=None, new_sheet_id:Optional[int]=None, new_sheet_name:Optional[str]=None) -> Worksheet

Duplicates the contents of a sheet.

methodgspread.spreadsheet.Spreadsheet.export(format:ExportFormat=ExportFormat.PDF) -> bytes

Export the spreadsheet in the given format.

methodgspread.spreadsheet.Spreadsheet.get_lastUpdateTime() -> str

Get the lastUpdateTime metadata from the Drive API.

methodgspread.spreadsheet.Spreadsheet.get_worksheet(index:int) -> Worksheet

Returns a worksheet with specified `index`.

methodgspread.spreadsheet.Spreadsheet.get_worksheet_by_id(id:Union[str, int]) -> Worksheet

Returns a worksheet with specified `worksheet id`.

methodgspread.spreadsheet.Spreadsheet.id() -> str

Spreadsheet ID.

methodgspread.spreadsheet.Spreadsheet.lastUpdateTime() -> str

Spreadsheet last updated time.

methodgspread.spreadsheet.Spreadsheet.list_named_ranges() -> List[Any]

Lists the spreadsheet's named ranges.

methodgspread.spreadsheet.Spreadsheet.list_permissions() -> List[Dict[str, Union[str, bool]]]

Lists the spreadsheet's permissions.

methodgspread.spreadsheet.Spreadsheet.list_protected_ranges(sheetid:int) -> List[Any]

Lists the spreadsheet's protected named ranges

methodgspread.spreadsheet.Spreadsheet.locale() -> str

Spreadsheet locale

methodgspread.spreadsheet.Spreadsheet.remove_permissions(value:str, role:str='any') -> List[str]

Remove permissions from a user or domain.

method

gspread.spreadsheet.Spreadsheet.share(email_address:str, perm_type:str, role:str, notify:bool=True, email_message:Optional[str]=None, with_link:bool=False) -> Response

Share the spreadsheet with other accounts.

methodgspread.spreadsheet.Spreadsheet.sheet1() -> Worksheet

Shortcut property for getting the first worksheet.

methodgspread.spreadsheet.Spreadsheet.timezone() -> str

Spreadsheet timeZone

methodgspread.spreadsheet.Spreadsheet.title() -> str

Spreadsheet title.

methodgspread.spreadsheet.Spreadsheet.transfer_ownership(permission_id:str) -> Response

Transfer the ownership of this file to a new user.

methodgspread.spreadsheet.Spreadsheet.update_locale(locale:str) -> Any

Update the locale of the spreadsheet.

methodgspread.spreadsheet.Spreadsheet.update_timezone(timezone:str) -> Any

Updates the current spreadsheet timezone.

methodgspread.spreadsheet.Spreadsheet.update_title(title:str) -> Any

Renames the spreadsheet.

methodgspread.spreadsheet.Spreadsheet.url() -> str

Spreadsheet URL.

methodgspread.spreadsheet.Spreadsheet.worksheet(title:str) -> Worksheet

Returns a worksheet with specified `title`.

funcgspread.utils.a1_range_to_grid_range(name:str, sheet_id:Optional[int]=None) -> Dict[str, int]

Converts a range defined in A1 notation to a dict representing a `GridRange`_.

funcgspread.utils.a1_to_rowcol(label:str) -> Tuple[int, int]

Translates a cell's address in A1 notation to a tuple of integers.

funcgspread.utils.absolute_range_name(sheet_name:str, range_name:Optional[str]=None) -> str

Return an absolutized path of a range.

funcgspread.utils.column_letter_to_index(column:str) -> int

Converts a column letter to its numerical index.

funcgspread.utils.convert_colors_to_hex_value(red:float=0.0, green:float=0.0, blue:float=0.0) -> str

Convert RGB color values to a hex color code.

funcgspread.utils.convert_hex_to_colors_dict(hex_color:str) -> Mapping[str, float]

Convert a hex color code to RGB color values.

funcgspread.utils.extract_title_from_range(range_string:str) -> str

Extracts the worksheet title from a range string.

func

gspread.utils.fill_gaps(L:List[List[Any]], rows:Optional[int]=None, cols:Optional[int]=None, padding_value:Any='') -> List[List[Any]]

Fill gaps in a list of lists.

funcgspread.utils.finditem(func:Callable[[T], bool], seq:Iterable[T]) -> T

Finds and returns first item in iterable for which func(item) is True.

funcgspread.utils.get_a1_from_absolute_range(range_name:str) -> str

Get the A1 notation from an absolute range name.

funcgspread.utils.is_full_a1_notation(range_name:str) -> bool

Check if the range name is a full A1 notation.

funcgspread.utils.is_scalar(x:Any) -> bool

Return True if the value is scalar.

funcgspread.utils.rowcol_to_a1(row:int, col:int) -> str

Translates a row and column cell address to A1 notation.

funcgspread.utils.to_hex(value:float) -> str

Convert an integer to a 2-digit uppercase hex string.

funcgspread.utils.wid_to_gid(wid:str) -> str

Calculate gid of a worksheet from its wid.

classgspread.worksheet.ValueRange

The class holds the returned values.

methodgspread.worksheet.ValueRange.first(default:Optional[str]=None) -> Optional[str]

Returns the value of a first cell in a range.

methodgspread.worksheet.ValueRange.range() -> str

The range of the values

methodgspread.worksheet.Worksheet.acell(label:str, value_render_option:ValueRenderOption=ValueRenderOption.formatted) -> Cell

Returns an instance of a :class:`gspread.cell.Cell`.

methodgspread.worksheet.Worksheet.add_cols(cols:int) -> None

Adds columns to worksheet.

methodgspread.worksheet.Worksheet.add_dimension_group_columns(start:int, end:int) -> JSONResponse

Group columns in order to hide them in the UI.

methodgspread.worksheet.Worksheet.add_dimension_group_rows(start:int, end:int) -> JSONResponse

Group rows in order to hide them in the UI.

methodgspread.worksheet.Worksheet.add_rows(rows:int) -> None

Adds rows to worksheet.

methodgspread.worksheet.Worksheet.batch_clear(ranges:Sequence[str]) -> JSONResponse

Clears multiple ranges of cells with 1 API call.

methodgspread.worksheet.Worksheet.batch_format(formats:List[CellFormat]) -> JSONResponse

Formats cells in batch.

method

gspread.worksheet.Worksheet.batch_merge(merges:List[Dict[Literal['range', 'mergeType'], Union[str, MergeType]]], merge_type:MergeType=MergeType.merge_all) -> Any

Merge multiple ranges at the same time.

methodgspread.worksheet.Worksheet.clear() -> JSONResponse

Clears all cells in the worksheet.

methodgspread.worksheet.Worksheet.clear_basic_filter() -> JSONResponse

Remove the basic filter from a worksheet.

methodgspread.worksheet.Worksheet.clear_note(cell:str) -> None

Clear a note.

methodgspread.worksheet.Worksheet.clear_tab_color() -> JSONResponse

Clears the worksheet's tab color.

methodgspread.worksheet.Worksheet.col_count() -> int

Number of columns.

methodgspread.worksheet.Worksheet.column_count() -> int

Number of columns

methodgspread.worksheet.Worksheet.columns_auto_resize(start_column_index:int, end_column_index:int) -> JSONResponse

Updates the size of rows or columns in the worksheet.

methodgspread.worksheet.Worksheet.copy_to(destination_spreadsheet_id:str) -> JSONResponse

Copies this sheet to another spreadsheet.

methodgspread.worksheet.Worksheet.cut_range(source:str, dest:str, paste_type:PasteType=PasteType.normal) -> JSONResponse

Moves a range of data form source to dest ..

methodgspread.worksheet.Worksheet.delete_dimension_group_columns(start:int, end:int) -> JSONResponse

Remove the grouping of a set of columns.

methodgspread.worksheet.Worksheet.delete_dimension_group_rows(start:int, end:int) -> JSONResponse

Remove the grouping of a set of rows.

methodgspread.worksheet.Worksheet.delete_protected_range(id:str) -> JSONResponse

Delete protected range identified by the ID ``id``.

method

gspread.worksheet.Worksheet.duplicate(insert_sheet_index:Optional[int]=None, new_sheet_id:Optional[int]=None, new_sheet_name:Optional[str]=None) -> 'Worksheet'

Duplicate the sheet.

method

gspread.worksheet.Worksheet.find(query:Union[str, re.Pattern], in_row:Optional[int]=None, in_column:Optional[int]=None, case_sensitive:bool=True) -> Optional[Cell]

Finds the first cell matching the query.

method

gspread.worksheet.Worksheet.findall(query:Union[str, re.Pattern], in_row:Optional[int]=None, in_column:Optional[int]=None, case_sensitive:bool=True) -> List[Cell]

Finds all cells matching the query.

methodgspread.worksheet.Worksheet.format(ranges:Union[List[str], str], format:JSONResponse) -> JSONResponse

Format a list of ranges with the given format.

methodgspread.worksheet.Worksheet.freeze(rows:Optional[int]=None, cols:Optional[int]=None) -> JSONResponse

Freeze rows and/or columns on the worksheet.

methodgspread.worksheet.Worksheet.frozen_col_count() -> int

Number of frozen columns.

methodgspread.worksheet.Worksheet.frozen_row_count() -> int

Number of frozen rows.

methodgspread.worksheet.Worksheet.get_all_cells() -> List[Cell]

Returns a list of all `Cell` of the current sheet.

methodgspread.worksheet.Worksheet.get_tab_color() -> Optional[str]

Tab color style in hex format.

methodgspread.worksheet.Worksheet.hide() -> JSONResponse

Hides the current worksheet from the UI.

methodgspread.worksheet.Worksheet.hide_columns(start:int, end:int) -> JSONResponse

Explicitly hide the given column index range.

methodgspread.worksheet.Worksheet.hide_gridlines() -> JSONResponse

Hide gridlines on the current worksheet

methodgspread.worksheet.Worksheet.hide_rows(start:int, end:int) -> JSONResponse

Explicitly hide the given row index range.

methodgspread.worksheet.Worksheet.id() -> int

Worksheet ID.

methodgspread.worksheet.Worksheet.index() -> int

Worksheet index.

methodgspread.worksheet.Worksheet.insert_note(cell:str, content:str) -> None

Insert a note.

methodgspread.worksheet.Worksheet.insert_notes(notes:Mapping[str, str]) -> None

insert multiple notes.

methodgspread.worksheet.Worksheet.isSheetHidden() -> bool

Worksheet hidden status.

methodgspread.worksheet.Worksheet.is_gridlines_hidden() -> bool

Whether or not gridlines hidden.

methodgspread.worksheet.Worksheet.list_dimension_group_columns() -> List[JSONResponse]

List all the grouped columns in this worksheet.

methodgspread.worksheet.Worksheet.list_dimension_group_rows() -> List[JSONResponse]

List all the grouped rows in this worksheet.

methodgspread.worksheet.Worksheet.merge_cells(name:str, merge_type:str=MergeType.merge_all) -> Any

Merge cells.

methodgspread.worksheet.Worksheet.resize(rows:Optional[int]=None, cols:Optional[int]=None) -> JSONResponse

Resizes the worksheet.

methodgspread.worksheet.Worksheet.row_count() -> int

Number of rows.

methodgspread.worksheet.Worksheet.rows_auto_resize(start_row_index:int, end_row_index:int) -> JSONResponse

Updates the size of rows or columns in the worksheet.

methodgspread.worksheet.Worksheet.set_basic_filter(name:Optional[str]=None) -> Any

Add a basic filter to the worksheet.

methodgspread.worksheet.Worksheet.show() -> JSONResponse

Show the current worksheet in the UI.

methodgspread.worksheet.Worksheet.show_gridlines() -> JSONResponse

Show gridlines on the current worksheet

methodgspread.worksheet.Worksheet.sort(*range:Optional[str]=None, *specs:Tuple[int, Literal['asc', 'des']]) -> JSONResponse

Sorts worksheet using given sort orders.

methodgspread.worksheet.Worksheet.spreadsheet() -> 'Spreadsheet'

Parent spreadsheet

methodgspread.worksheet.Worksheet.tab_color() -> Optional[str]

Tab color style.

methodgspread.worksheet.Worksheet.title() -> str

Worksheet title.

methodgspread.worksheet.Worksheet.unhide_columns(start:int, end:int) -> JSONResponse

Explicitly unhide the given column index range.

methodgspread.worksheet.Worksheet.unhide_rows(start:int, end:int) -> JSONResponse

Explicitly unhide the given row index range.

methodgspread.worksheet.Worksheet.unmerge_cells(name:str) -> JSONResponse

Unmerge cells.

methodgspread.worksheet.Worksheet.update_acell(label:str, value:Union[int, float, str]) -> JSONResponse

Updates the value of a cell.

methodgspread.worksheet.Worksheet.update_cell(row:int, col:int, value:Union[int, float, str]) -> JSONResponse

Updates the value of a cell.

method

gspread.worksheet.Worksheet.update_cells(cell_list:List[Cell], value_input_option:ValueInputOption=ValueInputOption.raw) -> Mapping[str, Any]

Updates many cells at once.

methodgspread.worksheet.Worksheet.update_index(index:int) -> JSONResponse

Updates the ``index`` property for the worksheet.

methodgspread.worksheet.Worksheet.update_note(cell:str, content:str) -> None

Update the content of the note located at `cell`.

methodgspread.worksheet.Worksheet.update_notes(notes:Mapping[str, str]) -> None

update multiple notes.

methodgspread.worksheet.Worksheet.update_tab_color(color:str) -> JSONResponse

Changes the worksheet's tab color.

methodgspread.worksheet.Worksheet.update_title(title:str) -> JSONResponse

Renames the worksheet.

methodgspread.worksheet.Worksheet.url() -> str

Worksheet URL.

この情報について

掲載しているシグネチャは burnash/gspread の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る