Drive API Reference

Complete reference for all Drive service methods and properties.

Drive Class

python
from gspace import GSpace

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

Methods

list_files

List files in Google Drive.

python
def list_files(
    page_size: int = 100,
    fields: str = "nextPageToken, files(id, name, mimeType, size, modifiedTime, parents)",
    q: str | None = None,
    order_by: str = "modifiedTime desc",
    **kwargs
) -> list[dict]

get_file

Get file metadata.

python
def get_file(
    file_id: str,
    fields: str = "*"
) -> dict

upload_file

Upload a file to Google Drive.

python
def upload_file(
    file_path: str | Path,
    name: str | None = None,
    description: str | None = None,
    parents: list[str] | None = None,
    mime_type: str | None = None
) -> dict

download_file

Download a file from Google Drive.

python
def download_file(
    file_id: str,
    output_path: str | Path,
    mime_type: str | None = None
) -> None

create_folder

Create a new folder.

python
def create_folder(
    name: str,
    description: str | None = None,
    parents: list[str] | None = None
) -> dict

update_file

Update file metadata.

python
def update_file(
    file_id: str,
    name: str | None = None,
    description: str | None = None,
    **kwargs
) -> dict

copy_file

Copy a file.

python
def copy_file(
    file_id: str,
    name: str | None = None,
    parents: list[str] | None = None
) -> dict

move_file

Move a file to a different folder.

python
def move_file(
    file_id: str,
    folder_id: str,
    remove_from_previous: bool = True
) -> dict

delete_file

Delete a file.

python
def delete_file(file_id: str) -> None

search_files

Search for files using query syntax.

python
def search_files(
    query: str,
    page_size: int = 100,
    order_by: str = "modifiedTime desc"
) -> list[dict]

share_file

Share a file with users or make it public.

python
def share_file(
    file_id: str,
    email: str | None = None,
    role: str = "reader",
    type: str = "user",
    allow_file_discovery: bool = False
) -> dict

list_permissions

List permissions for a file.

python
def list_permissions(file_id: str) -> list[dict]

delete_permission

Delete a permission.

python
def delete_permission(
    file_id: str,
    permission_id: str
) -> None