Google_Drive

Handle Initialize Authorization

post

Handle integration initialization request.

Body
or
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/connectors/google_drive/integrations

No content

Handle Get Integration

get

Handle get integration request.

Path parameters
user_identifierstringRequired
Responses
chevron-right
200

Successful Response

application/json
Responseany
get
/connectors/google_drive/integrations/{user_identifier}

No content

Handle Select Integration

post

Handle integration selection request.

Path parameters
user_identifierstringRequired
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/connectors/google_drive/integrations/{user_identifier}

No content

Handle Remove Integration

delete

Handle integration removal request.

Path parameters
user_identifierstringRequired
Responses
chevron-right
200

Successful Response

application/json
Responseany
delete
/connectors/google_drive/integrations/{user_identifier}

No content

Handle User Has Integration

get

Handle user integration existence check.

Responses
chevron-right
200

Successful Response

application/json
Responseany
get
/connectors/google_drive/integration-exists
200

Successful Response

No content

Auth Schema

get

Handle authentication schema request.

Responses
chevron-right
200

Successful Response

application/json
Responseany
get
/connectors/google_drive/auth-schema
200

Successful Response

No content

Success Authorize Callback

get

Handle successful authorization callback.

Responses
chevron-right
200

Successful Response

application/json
Responseany
get
/connectors/google_drive/success-authorize-callback
200

Successful Response

No content

Search Files

post

Search for files in Google Drive.

Args: request: The request object. http_headers: The HTTP headers.

Body

Search file request model.

response_fieldsany ofOptional

List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.

Example: ["id","name","status"]
string[]Optional
or
nullOptional
response_filtersany ofOptional

Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use:

  • field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When using root, this filters elements within the array at the root path.
  • root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: The root path must target an array of dictionaries (the last array before filtering by field_name value), and field_name should be a field within those dictionary elements. In nested array structures, root should point to the final array of dictionaries that contain the field_name field. Otherwise no filtering will occur.
Example: [{"field_name":"status","type":"string_list","values":["open","in_progress"]}]
or
nullOptional
page_sizeany ofOptional

The maximum number of files to return per page. Acceptable values are 1 to 1000, inclusive.

Default: 100
integer · min: 1 · max: 1000Optional
or
nullOptional
page_tokenany ofOptional

The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.

stringOptional
or
nullOptional
queryany ofOptional

A query for filtering the file results. See the 'Search for files and folders' guide for supported syntax: https://developers.google.com/drive/api/v3/search-files

stringOptional
or
nullOptional
order_byany ofOptional

A comma-separated list of sort keys. Valid keys are: * createdTime: When the file was created. * folder: The folder ID. This field is sorted using alphabetical ordering. * modifiedByMeTime: The last time the file was modified by the user. * modifiedTime: The last time the file was modified by anyone. * name: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * name_natural: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * quotaBytesUsed: The number of storage quota bytes used by the file. * recency: The most recent timestamp from the file's date-time fields. * sharedWithMeTime: When the file was shared with the user, if applicable. * starred: Whether the user has starred the file. * viewedByMeTime: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name.

stringOptional
or
nullOptional
corporaany ofOptional

Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive', and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency. By default, corpora is set to 'user'. However, this can change depending on the filter set through the 'q' parameter.

string · enumOptional

Enum for corpora.

Possible values:
or
nullOptional
drive_idany ofOptional

ID of the shared drive to search.

stringOptional
or
nullOptional
include_items_from_all_drivesany ofOptional

Whether both My Drive and shared drive items should be included in results.

booleanOptional
or
nullOptional
spacesany ofOptional

A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.

stringOptional
or
nullOptional
supports_all_drivesany ofOptional

Whether the requesting application supports both My Drives and shared drives.

booleanOptional
or
nullOptional
include_permissions_for_viewany ofOptional

Specifies which additional view's permissions to include in the response.

stringOptional
or
nullOptional
include_labelsany ofOptional

A comma-separated list of IDs of labels to include in the labelInfo part of the response.

stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/connectors/google_drive/search_files

No content

Get File

post

Get a file from Google Drive by ID.

Args: request: The request object. http_headers: The HTTP headers.

Body

Get file request model.

response_fieldsany ofOptional

List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.

Example: ["id","name","status"]
string[]Optional
or
nullOptional
response_filtersany ofOptional

Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use:

  • field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When using root, this filters elements within the array at the root path.
  • root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: The root path must target an array of dictionaries (the last array before filtering by field_name value), and field_name should be a field within those dictionary elements. In nested array structures, root should point to the final array of dictionaries that contain the field_name field. Otherwise no filtering will occur.
Example: [{"field_name":"status","type":"string_list","values":["open","in_progress"]}]
or
nullOptional
idstringRequired

ID of the file to retrieve.

supports_all_drivesany ofOptional

Whether the requesting application supports both My Drives and shared drives.

booleanOptional
or
nullOptional
include_permissions_for_viewany ofOptional

Specifies which additional view's permissions to include in the response. Only 'published' is supported.

stringOptional
or
nullOptional
include_labelsany ofOptional

A comma-separated list of IDs of labels to include in the labelInfo part of the response.

stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/connectors/google_drive/get_file

No content

Create File

post

Upload a file to Google Drive.

Please use multipart/form-data for the request body.

Args: request: The request object. http_headers: The HTTP headers.

Body

Create file request model from multipart/form-data.

response_fieldsany ofOptional

List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.

Example: ["id","name","status"]
string[]Optional
or
nullOptional
response_filtersany ofOptional

Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use:

  • field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When using root, this filters elements within the array at the root path.
  • root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: The root path must target an array of dictionaries (the last array before filtering by field_name value), and field_name should be a field within those dictionary elements. In nested array structures, root should point to the final array of dictionaries that contain the field_name field. Otherwise no filtering will occur.
Example: [{"field_name":"status","type":"string_list","values":["open","in_progress"]}]
or
nullOptional
filestring · binaryRequired

The file to upload.

resumeableany ofOptional

Whether to use resumable upload. Defaults to False.

Default: false
booleanOptional
or
nullOptional
parent_folder_idany ofOptional

The ID of the parent folder where the file will be created.

stringOptional
or
nullOptional
descriptionany ofOptional

A description of the file.

stringOptional
or
nullOptional
use_content_as_indexable_textany ofOptional

Whether to use the uploaded content as indexable text.

Default: false
booleanOptional
or
nullOptional
ignore_default_visibilityany ofOptional

Indicates whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.

booleanOptional
or
nullOptional
keep_revision_foreverany ofOptional

Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.

booleanOptional
or
nullOptional
ocr_languageany ofOptional

A language hint for OCR processing during image import (ISO 639-1 code).

stringOptional
or
nullOptional
supports_all_drivesany ofOptional

Indicates whether the requesting application supports both My Drives and shared drives.

booleanOptional
or
nullOptional
include_permissions_for_viewany ofOptional

Specifies which additional view's permissions to include in the response. Only 'published' is supported.

stringOptional
or
nullOptional
include_labelsany ofOptional

A comma-separated list of IDs of labels to include in the labelInfo part of the response.

stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/connectors/google_drive/create_file

No content

Create Folder

post

Create a folder in Google Drive.

Args: request: The request object. http_headers: The HTTP headers.

Body

Create folder request model.

response_fieldsany ofOptional

List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.

Example: ["id","name","status"]
string[]Optional
or
nullOptional
response_filtersany ofOptional

Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use:

  • field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When using root, this filters elements within the array at the root path.
  • root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: The root path must target an array of dictionaries (the last array before filtering by field_name value), and field_name should be a field within those dictionary elements. In nested array structures, root should point to the final array of dictionaries that contain the field_name field. Otherwise no filtering will occur.
Example: [{"field_name":"status","type":"string_list","values":["open","in_progress"]}]
or
nullOptional
namestringRequired

The name of the folder.

parent_folder_idany ofOptional

The ID of the parent folder where the folder will be created.

stringOptional
or
nullOptional
descriptionany ofOptional

A description of the folder.

stringOptional
or
nullOptional
supports_all_drivesany ofOptional

Indicates whether the requesting application supports both My Drives and shared drives.

booleanOptional
or
nullOptional
include_permissions_for_viewany ofOptional

Specifies which additional view's permissions to include in the response. Only 'published' is supported.

stringOptional
or
nullOptional
include_labelsany ofOptional

A comma-separated list of IDs of labels to include in the labelInfo part of the response.

stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/connectors/google_drive/create_folder

No content

Update File

post

Update a file in Google Drive.

Please use multipart/form-data for the request body.

Args: request: The request object. http_headers: The HTTP headers.

Body

Update file request model from multipart/form-data.

response_fieldsany ofOptional

List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.

Example: ["id","name","status"]
string[]Optional
or
nullOptional
response_filtersany ofOptional

Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use:

  • field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When using root, this filters elements within the array at the root path.
  • root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: The root path must target an array of dictionaries (the last array before filtering by field_name value), and field_name should be a field within those dictionary elements. In nested array structures, root should point to the final array of dictionaries that contain the field_name field. Otherwise no filtering will occur.
Example: [{"field_name":"status","type":"string_list","values":["open","in_progress"]}]
or
nullOptional
idstringRequired

The ID of the file to update.

fileany ofOptional

The file to upload. If not provided, only metadata will be updated.

string · binaryOptional
or
nullOptional
resumableany ofOptional

Whether to use resumable upload. Defaults to False.

Default: false
booleanOptional
or
nullOptional
nameany ofOptional

The new name for the file.

stringOptional
or
nullOptional
descriptionany ofOptional

The new description for the file.

stringOptional
or
nullOptional
add_parentsany ofOptional

A comma-separated list of parent IDs to add.

stringOptional
or
nullOptional
remove_parentsany ofOptional

A comma-separated list of parent IDs to remove.

stringOptional
or
nullOptional
keep_revision_foreverany ofOptional

Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.

booleanOptional
or
nullOptional
ocr_languageany ofOptional

A language hint for OCR processing during image import (ISO 639-1 code).

stringOptional
or
nullOptional
use_content_as_indexable_textany ofOptional

Indicates whether to use the content of the file as indexable text.

booleanOptional
or
nullOptional
supports_all_drivesany ofOptional

Indicates whether the requesting application supports both My Drives and shared drives.

booleanOptional
or
nullOptional
include_permissions_for_viewany ofOptional

Specifies which additional view's permissions to include in the response. Only 'published' is supported.

stringOptional
or
nullOptional
include_labelsany ofOptional

A comma-separated list of IDs of labels to include in the labelInfo part of the response.

stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/connectors/google_drive/update_file

No content

Update Folder

post

Update a folder in Google Drive.

Args: request: The request object. http_headers: The HTTP headers.

Body

Update folder request model.

response_fieldsany ofOptional

List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.

Example: ["id","name","status"]
string[]Optional
or
nullOptional
response_filtersany ofOptional

Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use:

  • field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When using root, this filters elements within the array at the root path.
  • root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: The root path must target an array of dictionaries (the last array before filtering by field_name value), and field_name should be a field within those dictionary elements. In nested array structures, root should point to the final array of dictionaries that contain the field_name field. Otherwise no filtering will occur.
Example: [{"field_name":"status","type":"string_list","values":["open","in_progress"]}]
or
nullOptional
idstringRequired

The ID of the folder to update.

nameany ofOptional

The new name for the folder.

stringOptional
or
nullOptional
descriptionany ofOptional

The new description for the folder.

stringOptional
or
nullOptional
add_parentsany ofOptional

A comma-separated list of parent IDs to add.

stringOptional
or
nullOptional
remove_parentsany ofOptional

A comma-separated list of parent IDs to remove.

stringOptional
or
nullOptional
supports_all_drivesany ofOptional

Indicates whether the requesting application supports both My Drives and shared drives.

booleanOptional
or
nullOptional
include_permissions_for_viewany ofOptional

Specifies which additional view's permissions to include in the response. Only 'published' is supported.

stringOptional
or
nullOptional
include_labelsany ofOptional

A comma-separated list of IDs of labels to include in the labelInfo part of the response.

stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/connectors/google_drive/update_folder

No content

Copy File

post

Copy a file in Google Drive.

Args: request: The request object. http_headers: The HTTP headers.

Body

Copy file request model.

response_fieldsany ofOptional

List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.

Example: ["id","name","status"]
string[]Optional
or
nullOptional
response_filtersany ofOptional

Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use:

  • field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When using root, this filters elements within the array at the root path.
  • root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: The root path must target an array of dictionaries (the last array before filtering by field_name value), and field_name should be a field within those dictionary elements. In nested array structures, root should point to the final array of dictionaries that contain the field_name field. Otherwise no filtering will occur.
Example: [{"field_name":"status","type":"string_list","values":["open","in_progress"]}]
or
nullOptional
idstringRequired

The ID of the file to copy.

nameany ofOptional

The name of the new file that will be created as a result of the copy operation.

stringOptional
or
nullOptional
descriptionany ofOptional

The description of the new file that will be copied from the source file.

stringOptional
or
nullOptional
parent_folder_idany ofOptional

The ID of the parent folder that will be copied from the source file.

stringOptional
or
nullOptional
keep_revision_foreverany ofOptional

Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.

booleanOptional
or
nullOptional
ignore_default_visibilityany ofOptional

Indicates whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.

booleanOptional
or
nullOptional
ocr_languageany ofOptional

A language hint for OCR processing during image import (ISO 639-1 code).

stringOptional
or
nullOptional
supports_all_drivesany ofOptional

Indicates whether the requesting application supports both My Drives and shared drives.

booleanOptional
or
nullOptional
include_permissions_for_viewany ofOptional

Specifies which additional view's permissions to include in the response. Only 'published' is supported.

stringOptional
or
nullOptional
include_labelsany ofOptional

A comma-separated list of IDs of labels to include in the labelInfo part of the response.

stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/connectors/google_drive/copy_file

No content

Delete File

post

Delete a file or folder from Google Drive.

Args: request: The request object. http_headers: The HTTP headers.

Body

Delete file request model.

idstringRequired

The ID of the file to delete.

supports_all_drivesany ofOptional

Indicates whether the requesting application supports both My Drives and shared drives.

booleanOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/connectors/google_drive/delete_file

No content

Summarize Folder Files By Type

post

Summarize files by type in a folder in Google Drive.

Args: request: The request object. http_headers: The HTTP headers.

Body

Get total file by type summary request model.

response_fieldsany ofOptional

List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.

Example: ["id","name","status"]
string[]Optional
or
nullOptional
response_filtersany ofOptional

Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use:

  • field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When using root, this filters elements within the array at the root path.
  • root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: The root path must target an array of dictionaries (the last array before filtering by field_name value), and field_name should be a field within those dictionary elements. In nested array structures, root should point to the final array of dictionaries that contain the field_name field. Otherwise no filtering will occur.
Example: [{"field_name":"status","type":"string_list","values":["open","in_progress"]}]
or
nullOptional
folder_idstringRequired

The ID of the folder to get the summary for.

callback_urlsany ofOptional

Optional list of URLs to be called back upon completion.

string[]Optional
or
nullOptional
waitingany ofOptional

Waiting mode. If True, wait for completion and return actual data (sync mode). If False or None, process in background and return immediately (background mode).

booleanOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/connectors/google_drive/summarize_folder_files_by_type

No content

Summarize Total Files By Type

post

Summarize total files by type in Google Drive.

Args: request: The request object. http_headers: The HTTP headers.

Body

Get all files total by type summary request model.

response_fieldsany ofOptional

List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.

Example: ["id","name","status"]
string[]Optional
or
nullOptional
response_filtersany ofOptional

Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use:

  • field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When using root, this filters elements within the array at the root path.
  • root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: The root path must target an array of dictionaries (the last array before filtering by field_name value), and field_name should be a field within those dictionary elements. In nested array structures, root should point to the final array of dictionaries that contain the field_name field. Otherwise no filtering will occur.
Example: [{"field_name":"status","type":"string_list","values":["open","in_progress"]}]
or
nullOptional
waitingany ofOptional

Waiting mode. If True, wait for completion and return actual data (sync mode). If False or None, process in background and return immediately (background mode).

booleanOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/connectors/google_drive/summarize_total_files_by_type

No content

Recent Files

post

Get recent files in Google Drive.

Args: request: The request object. http_headers: The HTTP headers.

Body

Base model for all requests that enables response field filtering.

response_fieldsany ofOptional

List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.

Example: ["id","name","status"]
string[]Optional
or
nullOptional
response_filtersany ofOptional

Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use:

  • field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When using root, this filters elements within the array at the root path.
  • root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: The root path must target an array of dictionaries (the last array before filtering by field_name value), and field_name should be a field within those dictionary elements. In nested array structures, root should point to the final array of dictionaries that contain the field_name field. Otherwise no filtering will occur.
Example: [{"field_name":"status","type":"string_list","values":["open","in_progress"]}]
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/connectors/google_drive/list_recent_files_from_yesterday

No content

Create Permission

post

Create a permission for a file or folder in Google Drive.

Args: request: The request object. http_headers: The HTTP headers.

Body

Create permission request model.

response_fieldsany ofOptional

List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.

Example: ["id","name","status"]
string[]Optional
or
nullOptional
response_filtersany ofOptional

Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use:

  • field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When using root, this filters elements within the array at the root path.
  • root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: The root path must target an array of dictionaries (the last array before filtering by field_name value), and field_name should be a field within those dictionary elements. In nested array structures, root should point to the final array of dictionaries that contain the field_name field. Otherwise no filtering will occur.
Example: [{"field_name":"status","type":"string_list","values":["open","in_progress"]}]
or
nullOptional
file_idstringRequired
supports_all_drivesany ofOptional
booleanOptional
or
nullOptional
use_domain_admin_accessany ofOptional
booleanOptional
or
nullOptional
rolestring · enumRequired

The role of the permission. Example: reader | commenter | writer | organizer | fileOrganizer | owner

Possible values:
typestring · enumRequired

The type of the permission. example: user | group | domain | anyone

Possible values:
email_addressany ofOptional

The email address of the user or group to which this permission refers.

stringOptional
or
nullOptional
expiration_timeany ofOptional

The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future.

stringOptional
or
nullOptional
allow_file_discoveryany ofOptional

Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.

booleanOptional
or
nullOptional
viewany ofOptional

Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.

stringOptional
or
nullOptional
email_messageany ofOptional

A plain text custom message to include in the notification email.

stringOptional
or
nullOptional
move_to_new_owners_rootany ofOptional

This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to true, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to false, parents are not changed.

booleanOptional
or
nullOptional
send_notification_emailany ofOptional

Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.

booleanOptional
or
nullOptional
transfer_ownershipany ofOptional

Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.

booleanOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/connectors/google_drive/create_permission

No content

List Permissions

post

List permissions for a file or folder in Google Drive.

Args: request: The request object. http_headers: The HTTP headers.

Body

List permission request model.

response_fieldsany ofOptional

List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.

Example: ["id","name","status"]
string[]Optional
or
nullOptional
response_filtersany ofOptional

Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use:

  • field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When using root, this filters elements within the array at the root path.
  • root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: The root path must target an array of dictionaries (the last array before filtering by field_name value), and field_name should be a field within those dictionary elements. In nested array structures, root should point to the final array of dictionaries that contain the field_name field. Otherwise no filtering will occur.
Example: [{"field_name":"status","type":"string_list","values":["open","in_progress"]}]
or
nullOptional
file_idstringRequired
supports_all_drivesany ofOptional
booleanOptional
or
nullOptional
use_domain_admin_accessany ofOptional
booleanOptional
or
nullOptional
include_permissions_for_viewany ofOptional

Specifies which additional view's permissions to include in the response. Only 'published' is supported.

stringOptional
or
nullOptional
page_sizeany ofOptional

The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned.

integerOptional
or
nullOptional
page_tokenany ofOptional

The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.

stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/connectors/google_drive/list_permissions

No content

Get Permission

post

Get a specific permission for a file or folder in Google Drive.

Args: request: The request object. http_headers: The HTTP headers.

Body

Get permission request model.

response_fieldsany ofOptional

List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.

Example: ["id","name","status"]
string[]Optional
or
nullOptional
response_filtersany ofOptional

Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use:

  • field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When using root, this filters elements within the array at the root path.
  • root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: The root path must target an array of dictionaries (the last array before filtering by field_name value), and field_name should be a field within those dictionary elements. In nested array structures, root should point to the final array of dictionaries that contain the field_name field. Otherwise no filtering will occur.
Example: [{"field_name":"status","type":"string_list","values":["open","in_progress"]}]
or
nullOptional
file_idstringRequired
supports_all_drivesany ofOptional
booleanOptional
or
nullOptional
use_domain_admin_accessany ofOptional
booleanOptional
or
nullOptional
permission_idstringRequired

The ID of the permission to retrieve.

Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/connectors/google_drive/get_permission

No content

Update Permission

post

Update a permission for a file or folder in Google Drive.

Args: request: The request object. http_headers: The HTTP headers.

Body

Update permission request model.

response_fieldsany ofOptional

List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.

Example: ["id","name","status"]
string[]Optional
or
nullOptional
response_filtersany ofOptional

Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.

How to use:

  • field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When using root, this filters elements within the array at the root path.
  • root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: The root path must target an array of dictionaries (the last array before filtering by field_name value), and field_name should be a field within those dictionary elements. In nested array structures, root should point to the final array of dictionaries that contain the field_name field. Otherwise no filtering will occur.
Example: [{"field_name":"status","type":"string_list","values":["open","in_progress"]}]
or
nullOptional
file_idstringRequired
supports_all_drivesany ofOptional
booleanOptional
or
nullOptional
use_domain_admin_accessany ofOptional
booleanOptional
or
nullOptional
permission_idstringRequired

The ID of the permission to update.

roleany ofOptional

The role granted by this permission. While new values may be supported in the future, the following are currently allowed: - owner - organizer - fileOrganizer - writer - commenter - reader.

string · enumOptional

Enum for permission roles.

Possible values:
or
nullOptional
expiration_timeany ofOptional

The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future.

stringOptional
or
nullOptional
remove_expirationany ofOptional

Indicates whether to remove the expiration time of the permission.

booleanOptional
or
nullOptional
transfer_ownershipany ofOptional

Indicates whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.

booleanOptional
or
nullOptional
enforce_expensive_accessany ofOptional

Indicates whether to enforce expensive access.

booleanOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/connectors/google_drive/update_permission

No content

Delete Permission

post

Delete a permission from a file or folder in Google Drive.

Args: request: The request object. http_headers: The HTTP headers.

Body

Delete permission request model.

file_idstringRequired

The ID of the file to which the permission belongs.

supports_all_drivesany ofOptional
booleanOptional
or
nullOptional
use_domain_admin_accessany ofOptional
booleanOptional
or
nullOptional
permission_idstringRequired

The ID of the permission to delete.

enforce_expensive_accessany ofOptional

Indicates whether the request should enforce expensive access rules.

booleanOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/connectors/google_drive/delete_permission

No content

Download File

post

Download a file from Google Drive.

Args: request: The request object. http_headers: The HTTP headers.

Body

Download file request model.

idstringRequired

ID of the file to download.

export_formatany ofOptional

File export format as a filename extension (without dot .). e.g., pdf, md, rdt, etc.

stringOptional
or
nullOptional
revision_idany ofOptional

The revision ID of the file to download. This field can only be set when downloading blob files, Google Docs, and Google Sheets. Returns INVALID_ARGUMENT if downloading a specific revision on the file is unsupported.

stringOptional
or
nullOptional
acknowledge_abuseany ofOptional

Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the alt parameter is set to media and the user is the owner of the file or an organizer of the shared drive in which the file resides.

booleanOptional
or
nullOptional
supports_all_drivesany ofOptional

Indicates whether the requesting application supports both My Drives and shared drives.

booleanOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/connectors/google_drive/download_file

No content

Get Markdown Content

post

Convert a Google Drive file to Markdown.

Args: request: Request model containing file id and options. http_headers: HTTP headers for auth.

Returns: Dict with filename and markdown content.

Body

Convert file to markdown request model.

idstringRequired

ID of the file to convert to markdown.

Responses
chevron-right
200

Successful Response

application/json
post
/connectors/google_drive/get_markdown_content

Last updated