Google Drive

The Arcade Google Drive toolkit provides a pre-built set of tools for interacting with Google Drive. These tools make it easy to build agents and AI apps that can:

• Search Google documents in the user’s Google Drive
• Search and retrieve the contents of Google documents in the user’s Google Drive

Available Tools

These tools are currently available in the Arcade Google Drive toolkit.

GoogleDrive.GetFileTreeStructure

Get the file/folder tree structure of the user’s Google Drive.

Parameters

• include_shared_drives (bool, optional) Whether to include shared drives in the file tree structure. Defaults to False.
• restrict_to_shared_drive_id (str, optional) If provided, only include files from this shared drive in the file tree structure. Defaults to None, which will include files and folders from all drives.
• include_organization_domain_documents (bool, optional) Whether to include documents from the organization’s domain. This is applicable to admin users who have permissions to view organization-wide documents in a Google Workspace account. Defaults to False.
• order_by (enum (OrderBy), optional) Sort order. Defaults to listing the most recently modified documents first.
• limit (int, optional) The number of files and folders to list. Defaults to None, which will list all files and folders.

GoogleDrive.GenerateGoogleFilePickerUrl

Generate a Google File Picker URL for user-driven file selection and authorization.

This tool generates a URL that directs the end-user to a Google File Picker interface where where they can select or upload Google Drive files. Users can grant permission to access their Drive files, providing a secure and authorized way to interact with their files.

This is particularly useful when prior tools (e.g., those accessing or modifying Google Docs, Google Sheets, etc.) encountered failures due to file non-existence (Requested entity was not found) or permission errors. Once the user completes the file picker flow, the prior tool can be retried.

Auth

The Arcade Google Drive toolkit uses the Google auth provider to connect to users’ Google accounts.

With the hosted Arcade Engine, there’s nothing to configure. Your users will see Arcade as the name of the application that’s requesting permission.

With a self-hosted installation of Arcade, you need to configure the Google auth provider with your own Google app credentials.

Reference

OrderBy

Sort keys for ordering files in Google Drive. Each key has both ascending and descending options.

• CREATED_TIME: When the file was created (ascending).
• CREATED_TIME_DESC: When the file was created (descending).
• FOLDER: The folder ID, sorted using alphabetical ordering (ascending).
• FOLDER_DESC: The folder ID, sorted using alphabetical ordering (descending).
• MODIFIED_BY_ME_TIME: The last time the file was modified by the user (ascending).
• MODIFIED_BY_ME_TIME_DESC: The last time the file was modified by the user (descending).
• MODIFIED_TIME: The last time the file was modified by anyone (ascending).
• MODIFIED_TIME_DESC: The last time the file was modified by anyone (descending).
• NAME: The name of the file, sorted using alphabetical ordering (ascending).
• NAME_DESC: The name of the file, sorted using alphabetical ordering (descending).
• NAME_NATURAL: The name of the file, sorted using natural sort ordering (ascending).
• NAME_NATURAL_DESC: The name of the file, sorted using natural sort ordering (descending).
• QUOTA_BYTES_USED: The number of storage quota bytes used by the file (ascending).
• QUOTA_BYTES_USED_DESC: The number of storage quota bytes used by the file (descending).
• RECENCY: The most recent timestamp from the file’s date-time fields (ascending).
• RECENCY_DESC: The most recent timestamp from the file’s date-time fields (descending).
• SHARED_WITH_ME_TIME: When the file was shared with the user, if applicable (ascending).
• SHARED_WITH_ME_TIME_DESC: When the file was shared with the user, if applicable (descending).
• STARRED: Whether the user has starred the file (ascending).
• STARRED_DESC: Whether the user has starred the file (descending).
• VIEWED_BY_ME_TIME: The last time the file was viewed by the user (ascending).
• VIEWED_BY_ME_TIME_DESC: The last time the file was viewed by the user (descending).

pip install arcade_google_drive