universal-mcp-applications 0.1.21__py3-none-any.whl → 0.1.23__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of universal-mcp-applications might be problematic. Click here for more details.
- universal_mcp/applications/BEST_PRACTICES.md +166 -0
- universal_mcp/applications/airtable/app.py +0 -1
- universal_mcp/applications/apollo/app.py +0 -1
- universal_mcp/applications/aws_s3/app.py +40 -39
- universal_mcp/applications/browser_use/README.md +1 -0
- universal_mcp/applications/browser_use/__init__.py +0 -0
- universal_mcp/applications/browser_use/app.py +71 -0
- universal_mcp/applications/calendly/app.py +125 -125
- universal_mcp/applications/canva/app.py +95 -99
- universal_mcp/applications/confluence/app.py +0 -1
- universal_mcp/applications/contentful/app.py +4 -5
- universal_mcp/applications/domain_checker/app.py +11 -15
- universal_mcp/applications/e2b/app.py +4 -4
- universal_mcp/applications/elevenlabs/app.py +18 -15
- universal_mcp/applications/exa/app.py +17 -17
- universal_mcp/applications/falai/app.py +28 -29
- universal_mcp/applications/file_system/app.py +9 -9
- universal_mcp/applications/firecrawl/app.py +36 -36
- universal_mcp/applications/fireflies/app.py +55 -56
- universal_mcp/applications/fpl/app.py +49 -50
- universal_mcp/applications/ghost_content/app.py +0 -1
- universal_mcp/applications/github/app.py +41 -43
- universal_mcp/applications/google_calendar/app.py +40 -39
- universal_mcp/applications/google_docs/app.py +168 -232
- universal_mcp/applications/google_drive/app.py +212 -215
- universal_mcp/applications/google_gemini/app.py +1 -5
- universal_mcp/applications/google_mail/app.py +91 -90
- universal_mcp/applications/google_searchconsole/app.py +29 -29
- universal_mcp/applications/google_sheet/app.py +115 -115
- universal_mcp/applications/hashnode/README.md +6 -3
- universal_mcp/applications/hashnode/app.py +174 -25
- universal_mcp/applications/http_tools/app.py +10 -11
- universal_mcp/applications/hubspot/__init__.py +1 -1
- universal_mcp/applications/hubspot/api_segments/api_segment_base.py +36 -7
- universal_mcp/applications/hubspot/api_segments/crm_api.py +368 -368
- universal_mcp/applications/hubspot/api_segments/marketing_api.py +115 -115
- universal_mcp/applications/hubspot/app.py +131 -72
- universal_mcp/applications/jira/app.py +0 -1
- universal_mcp/applications/linkedin/app.py +20 -20
- universal_mcp/applications/markitdown/app.py +10 -5
- universal_mcp/applications/ms_teams/app.py +123 -123
- universal_mcp/applications/openai/app.py +40 -39
- universal_mcp/applications/outlook/app.py +32 -32
- universal_mcp/applications/perplexity/app.py +4 -4
- universal_mcp/applications/reddit/app.py +69 -70
- universal_mcp/applications/resend/app.py +116 -117
- universal_mcp/applications/rocketlane/app.py +0 -1
- universal_mcp/applications/scraper/__init__.py +1 -1
- universal_mcp/applications/scraper/app.py +80 -81
- universal_mcp/applications/serpapi/app.py +14 -14
- universal_mcp/applications/sharepoint/app.py +19 -20
- universal_mcp/applications/shopify/app.py +0 -1
- universal_mcp/applications/slack/app.py +48 -48
- universal_mcp/applications/tavily/app.py +4 -4
- universal_mcp/applications/twitter/api_segments/compliance_api.py +13 -15
- universal_mcp/applications/twitter/api_segments/dm_conversations_api.py +20 -20
- universal_mcp/applications/twitter/api_segments/dm_events_api.py +12 -12
- universal_mcp/applications/twitter/api_segments/likes_api.py +12 -12
- universal_mcp/applications/twitter/api_segments/lists_api.py +37 -39
- universal_mcp/applications/twitter/api_segments/spaces_api.py +24 -24
- universal_mcp/applications/twitter/api_segments/trends_api.py +4 -4
- universal_mcp/applications/twitter/api_segments/tweets_api.py +105 -105
- universal_mcp/applications/twitter/api_segments/usage_api.py +4 -4
- universal_mcp/applications/twitter/api_segments/users_api.py +136 -136
- universal_mcp/applications/twitter/app.py +6 -2
- universal_mcp/applications/unipile/app.py +90 -97
- universal_mcp/applications/whatsapp/app.py +53 -54
- universal_mcp/applications/whatsapp/audio.py +39 -35
- universal_mcp/applications/whatsapp/whatsapp.py +176 -154
- universal_mcp/applications/whatsapp_business/app.py +92 -92
- universal_mcp/applications/yahoo_finance/app.py +105 -63
- universal_mcp/applications/youtube/app.py +193 -196
- universal_mcp/applications/zenquotes/__init__.py +2 -0
- universal_mcp/applications/zenquotes/app.py +5 -5
- {universal_mcp_applications-0.1.21.dist-info → universal_mcp_applications-0.1.23.dist-info}/METADATA +2 -1
- {universal_mcp_applications-0.1.21.dist-info → universal_mcp_applications-0.1.23.dist-info}/RECORD +78 -74
- {universal_mcp_applications-0.1.21.dist-info → universal_mcp_applications-0.1.23.dist-info}/WHEEL +0 -0
- {universal_mcp_applications-0.1.21.dist-info → universal_mcp_applications-0.1.23.dist-info}/licenses/LICENSE +0 -0
|
@@ -2,7 +2,6 @@ from typing import Any
|
|
|
2
2
|
|
|
3
3
|
import httpx
|
|
4
4
|
from loguru import logger
|
|
5
|
-
|
|
6
5
|
from universal_mcp.applications.application import APIApplication
|
|
7
6
|
from universal_mcp.integrations import Integration
|
|
8
7
|
|
|
@@ -22,20 +21,20 @@ class GoogleDriveApp(APIApplication):
|
|
|
22
21
|
) -> dict[str, Any]:
|
|
23
22
|
"""
|
|
24
23
|
Moves a file to a new folder by updating its parent references. This function adds the file to a destination folder (`add_parents`) and removes it from the source (`remove_parents`), offering a focused alternative to the more comprehensive `update_file_metadata` function.
|
|
25
|
-
|
|
24
|
+
|
|
26
25
|
Args:
|
|
27
26
|
file_id: The ID of the file to move
|
|
28
27
|
add_parents: The ID of the destination folder (new parent)
|
|
29
28
|
remove_parents: The ID of the source folder (old parent to remove)
|
|
30
|
-
|
|
29
|
+
|
|
31
30
|
Returns:
|
|
32
31
|
A dictionary containing the updated file information
|
|
33
|
-
|
|
32
|
+
|
|
34
33
|
Raises:
|
|
35
34
|
HTTPError: If the API request fails or returns an error status code
|
|
36
35
|
ConnectionError: If there are network connectivity issues
|
|
37
36
|
AuthenticationError: If the authentication credentials are invalid or expired
|
|
38
|
-
|
|
37
|
+
|
|
39
38
|
Tags:
|
|
40
39
|
move, file, folder, parent, patch, api, important
|
|
41
40
|
"""
|
|
@@ -49,15 +48,15 @@ class GoogleDriveApp(APIApplication):
|
|
|
49
48
|
def get_drive_info(self) -> dict[str, Any]:
|
|
50
49
|
"""
|
|
51
50
|
Fetches key user and storage quota information for the authenticated Google Drive account. This streamlined function offers a focused alternative to `get_about_info`, which queries the same endpoint but exposes all available API parameters, providing a simpler way to get essential account details.
|
|
52
|
-
|
|
51
|
+
|
|
53
52
|
Returns:
|
|
54
53
|
A dictionary containing Drive information including storage quota (usage, limit) and user details (name, email, etc.).
|
|
55
|
-
|
|
54
|
+
|
|
56
55
|
Raises:
|
|
57
56
|
HTTPError: If the API request fails or returns an error status code
|
|
58
57
|
ConnectionError: If there are network connectivity issues
|
|
59
58
|
AuthenticationError: If the authentication credentials are invalid or expired
|
|
60
|
-
|
|
59
|
+
|
|
61
60
|
Tags:
|
|
62
61
|
get, info, storage, drive, quota, user, api, important
|
|
63
62
|
"""
|
|
@@ -80,7 +79,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
80
79
|
- Supported operators: `=`, `!=`, `<`, `<=`, `>`, `>=`, `contains`, `in`
|
|
81
80
|
- Combine conditions with `and` / `or`
|
|
82
81
|
- String values must be in single quotes `'...'`
|
|
83
|
-
|
|
82
|
+
|
|
84
83
|
Examples:
|
|
85
84
|
- "mimeType='application/pdf'"
|
|
86
85
|
- "name contains 'contract' or name contains 'agreement'"
|
|
@@ -114,17 +113,17 @@ class GoogleDriveApp(APIApplication):
|
|
|
114
113
|
def get_file_details(self, file_id: str) -> dict[str, Any]:
|
|
115
114
|
"""
|
|
116
115
|
Fetches all default metadata for a specific file by its unique ID. This function provides a simple, direct retrieval of a single file's complete attributes, differing from `search_files` which performs broad queries for multiple files based on various criteria.
|
|
117
|
-
|
|
116
|
+
|
|
118
117
|
Args:
|
|
119
118
|
file_id: String identifier of the file whose metadata should be retrieved
|
|
120
|
-
|
|
119
|
+
|
|
121
120
|
Returns:
|
|
122
121
|
Dictionary containing the file's metadata including properties such as name, size, type, and other attributes
|
|
123
|
-
|
|
122
|
+
|
|
124
123
|
Raises:
|
|
125
124
|
HTTPError: When the API request fails due to invalid file_id or network issues
|
|
126
125
|
JSONDecodeError: When the API response cannot be parsed as JSON
|
|
127
|
-
|
|
126
|
+
|
|
128
127
|
Tags:
|
|
129
128
|
retrieve, file, metadata, get, api, important
|
|
130
129
|
"""
|
|
@@ -135,16 +134,16 @@ class GoogleDriveApp(APIApplication):
|
|
|
135
134
|
def trash_file(self, file_id: str) -> dict[str, Any]:
|
|
136
135
|
"""
|
|
137
136
|
Moves a specified file to the trash using its ID. It provides simplified error handling by returning a dictionary with a success or error message, unlike the `permanently_delete_file` function which raises an exception on failure.
|
|
138
|
-
|
|
137
|
+
|
|
139
138
|
Args:
|
|
140
139
|
file_id: The unique identifier string of the file to be deleted from Google Drive
|
|
141
|
-
|
|
140
|
+
|
|
142
141
|
Returns:
|
|
143
142
|
A dictionary containing either a success message {'message': 'File deleted successfully'} or an error message {'error': 'error description'}
|
|
144
|
-
|
|
143
|
+
|
|
145
144
|
Raises:
|
|
146
145
|
Exception: When the DELETE request fails due to network issues, invalid file_id, insufficient permissions, or other API errors
|
|
147
|
-
|
|
146
|
+
|
|
148
147
|
Tags:
|
|
149
148
|
delete, file-management, google-drive, api, important
|
|
150
149
|
"""
|
|
@@ -164,20 +163,20 @@ class GoogleDriveApp(APIApplication):
|
|
|
164
163
|
) -> dict[str, Any]:
|
|
165
164
|
"""
|
|
166
165
|
Creates a file in Google Drive using an in-memory text string. Unlike `upload_file_from_path`, which reads from a local file, this function first creates the file's metadata (name, parent) and then uploads the provided string content, returning the new file's complete metadata upon completion.
|
|
167
|
-
|
|
166
|
+
|
|
168
167
|
Args:
|
|
169
168
|
file_name: Name of the file to create on Google Drive
|
|
170
169
|
text_content: Plain text content to be written to the file
|
|
171
170
|
parent_id: Optional ID of the parent folder where the file will be created
|
|
172
171
|
mime_type: MIME type of the file (defaults to 'text/plain')
|
|
173
|
-
|
|
172
|
+
|
|
174
173
|
Returns:
|
|
175
174
|
Dictionary containing metadata of the created file including ID, name, and other Google Drive file properties
|
|
176
|
-
|
|
175
|
+
|
|
177
176
|
Raises:
|
|
178
177
|
HTTPStatusError: Raised when the API request fails during file creation or content upload
|
|
179
178
|
UnicodeEncodeError: Raised when the text_content cannot be encoded in UTF-8
|
|
180
|
-
|
|
179
|
+
|
|
181
180
|
Tags:
|
|
182
181
|
create, file, upload, drive, text, important, storage, document
|
|
183
182
|
"""
|
|
@@ -201,16 +200,16 @@ class GoogleDriveApp(APIApplication):
|
|
|
201
200
|
def find_folder_id_by_name(self, folder_name: str) -> str | None:
|
|
202
201
|
"""
|
|
203
202
|
Searches for a non-trashed folder by its exact name, returning the ID of the first match. As a utility for `create_folder`, it resolves parent names to IDs and returns None if the folder isn't found or an API error occurs, logging the failure internally.
|
|
204
|
-
|
|
203
|
+
|
|
205
204
|
Args:
|
|
206
205
|
folder_name: The name of the folder to search for in Google Drive
|
|
207
|
-
|
|
206
|
+
|
|
208
207
|
Returns:
|
|
209
208
|
str | None: The folder's ID if a matching folder is found, None if no folder is found or if an error occurs
|
|
210
|
-
|
|
209
|
+
|
|
211
210
|
Raises:
|
|
212
211
|
Exception: Caught internally and logged when API requests fail or response parsing errors occur
|
|
213
|
-
|
|
212
|
+
|
|
214
213
|
Tags:
|
|
215
214
|
search, find, google-drive, folder, query, api, utility
|
|
216
215
|
"""
|
|
@@ -229,17 +228,17 @@ class GoogleDriveApp(APIApplication):
|
|
|
229
228
|
def create_folder(self, folder_name: str, parent_id: str = None) -> dict[str, Any]:
|
|
230
229
|
"""
|
|
231
230
|
Creates a new folder in Google Drive, optionally within a parent specified by name or ID. If a parent name is given, it internally resolves it to an ID using the `find_folder_id_by_name` function. Returns the metadata for the newly created folder upon successful creation.
|
|
232
|
-
|
|
231
|
+
|
|
233
232
|
Args:
|
|
234
233
|
folder_name: Name of the folder to create
|
|
235
234
|
parent_id: ID or name of the parent folder. Can be either a folder ID string or a folder name that will be automatically looked up
|
|
236
|
-
|
|
235
|
+
|
|
237
236
|
Returns:
|
|
238
237
|
Dictionary containing the created folder's metadata including its ID, name, and other Drive-specific information
|
|
239
|
-
|
|
238
|
+
|
|
240
239
|
Raises:
|
|
241
240
|
ValueError: Raised when a parent folder name is provided but cannot be found in Google Drive
|
|
242
|
-
|
|
241
|
+
|
|
243
242
|
Tags:
|
|
244
243
|
create, folder, drive, storage, important, management
|
|
245
244
|
"""
|
|
@@ -274,21 +273,21 @@ class GoogleDriveApp(APIApplication):
|
|
|
274
273
|
) -> dict[str, Any]:
|
|
275
274
|
"""
|
|
276
275
|
Uploads a local file to Google Drive by reading its binary content from a path. It creates the file's metadata, uploads the content, and returns the new file's metadata. This differs from `create_text_file` which uses in-memory string content instead of a local file path.
|
|
277
|
-
|
|
276
|
+
|
|
278
277
|
Args:
|
|
279
278
|
file_name: Name to give the file on Google Drive
|
|
280
279
|
file_path: Path to the local file to upload
|
|
281
280
|
parent_id: Optional ID of the parent folder to create the file in
|
|
282
281
|
mime_type: MIME type of the file (e.g., 'image/jpeg', 'image/png', 'application/pdf')
|
|
283
|
-
|
|
282
|
+
|
|
284
283
|
Returns:
|
|
285
284
|
Dictionary containing the uploaded file's metadata from Google Drive
|
|
286
|
-
|
|
285
|
+
|
|
287
286
|
Raises:
|
|
288
287
|
FileNotFoundError: When the specified file_path does not exist or is not accessible
|
|
289
288
|
HTTPError: When the API request fails or returns an error status code
|
|
290
289
|
IOError: When there are issues reading the file content
|
|
291
|
-
|
|
290
|
+
|
|
292
291
|
Tags:
|
|
293
292
|
upload, file-handling, google-drive, api, important, binary, storage
|
|
294
293
|
"""
|
|
@@ -332,7 +331,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
332
331
|
) -> dict[str, Any]:
|
|
333
332
|
"""
|
|
334
333
|
Retrieves a list of the user's installed Google Drive applications. Allows optional filtering by file extensions or MIME types to find apps capable of opening specific file formats, returning a detailed list of matching applications.
|
|
335
|
-
|
|
334
|
+
|
|
336
335
|
Args:
|
|
337
336
|
appFilterExtensions (string): A query parameter to filter applications based on extensions, allowing string values to be specified in the URL. Example: '<string>'.
|
|
338
337
|
appFilterMimeTypes (string): Filters the results to include only apps that can open any of the provided comma-separated list of MIME types[4][1]. Example: '<string>'.
|
|
@@ -348,14 +347,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
348
347
|
upload_protocol (string): Upload protocol for media (e.g. "raw", "multipart"). Example: '<string>'.
|
|
349
348
|
uploadType (string): Legacy upload protocol for media (e.g. "media", "multipart"). Example: '<string>'.
|
|
350
349
|
xgafv (string): V1 error format. Example: '<string>'.
|
|
351
|
-
|
|
350
|
+
|
|
352
351
|
Returns:
|
|
353
352
|
dict[str, Any]: Successful response
|
|
354
|
-
|
|
353
|
+
|
|
355
354
|
Raises:
|
|
356
355
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
357
356
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
358
|
-
|
|
357
|
+
|
|
359
358
|
Tags:
|
|
360
359
|
Apps
|
|
361
360
|
"""
|
|
@@ -410,7 +409,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
410
409
|
) -> dict[str, Any]:
|
|
411
410
|
"""
|
|
412
411
|
Retrieves detailed information for a single installed Google Drive application using its unique ID. This provides a targeted alternative to `list_installed_apps`, which returns a complete list, allowing for focused data retrieval about a specific application.
|
|
413
|
-
|
|
412
|
+
|
|
414
413
|
Args:
|
|
415
414
|
appId (string): appId
|
|
416
415
|
access_token (string): OAuth access token. Example: '{{accessToken}}'.
|
|
@@ -424,14 +423,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
424
423
|
upload_protocol (string): Upload protocol for media (e.g. "raw", "multipart"). Example: '<string>'.
|
|
425
424
|
uploadType (string): Legacy upload protocol for media (e.g. "media", "multipart"). Example: '<string>'.
|
|
426
425
|
xgafv (string): V1 error format. Example: '<string>'.
|
|
427
|
-
|
|
426
|
+
|
|
428
427
|
Returns:
|
|
429
428
|
dict[str, Any]: Successful response
|
|
430
|
-
|
|
429
|
+
|
|
431
430
|
Raises:
|
|
432
431
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
433
432
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
434
|
-
|
|
433
|
+
|
|
435
434
|
Tags:
|
|
436
435
|
Apps
|
|
437
436
|
"""
|
|
@@ -480,7 +479,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
480
479
|
) -> dict[str, Any]:
|
|
481
480
|
"""
|
|
482
481
|
Retrieves user account and Drive settings from the `/about` endpoint. This generic function provides full parameter control, offering a flexible alternative to the `get_drive_info` method, which requests specific, predefined fields like storage quota and user details.
|
|
483
|
-
|
|
482
|
+
|
|
484
483
|
Args:
|
|
485
484
|
alt (string): Data format for the response. Example: 'json'.
|
|
486
485
|
fields (string): Selector specifying which fields to include in a partial response. Example: '<string>'.
|
|
@@ -489,14 +488,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
489
488
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
490
489
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
491
490
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
492
|
-
|
|
491
|
+
|
|
493
492
|
Returns:
|
|
494
493
|
dict[str, Any]: Successful response
|
|
495
|
-
|
|
494
|
+
|
|
496
495
|
Raises:
|
|
497
496
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
498
497
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
499
|
-
|
|
498
|
+
|
|
500
499
|
Tags:
|
|
501
500
|
Information
|
|
502
501
|
"""
|
|
@@ -553,7 +552,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
553
552
|
) -> dict[str, Any]:
|
|
554
553
|
"""
|
|
555
554
|
Fetches a paginated list of file changes for a user's account or a specific shared drive, using a required page token. Supports various filters to customize the change log, enabling tracking of file activity for synchronization or auditing.
|
|
556
|
-
|
|
555
|
+
|
|
557
556
|
Args:
|
|
558
557
|
pageToken (string): (Required) 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 or to the response from the getStartPageToken method. Example: '{{pageToken}}'.
|
|
559
558
|
driveId (string): The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. Example: '{{driveId}}'.
|
|
@@ -576,14 +575,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
576
575
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
577
576
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
578
577
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
579
|
-
|
|
578
|
+
|
|
580
579
|
Returns:
|
|
581
580
|
dict[str, Any]: Successful response
|
|
582
|
-
|
|
581
|
+
|
|
583
582
|
Raises:
|
|
584
583
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
585
584
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
586
|
-
|
|
585
|
+
|
|
587
586
|
Tags:
|
|
588
587
|
Changes
|
|
589
588
|
"""
|
|
@@ -644,7 +643,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
644
643
|
) -> dict[str, Any]:
|
|
645
644
|
"""
|
|
646
645
|
Retrieves a starting page token representing the current state of a user's Drive or a shared drive. This token serves as a baseline for subsequent calls to list future file and folder changes, enabling efficient, incremental change tracking.
|
|
647
|
-
|
|
646
|
+
|
|
648
647
|
Args:
|
|
649
648
|
driveId (string): The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive is returned. Example: '{{driveId}}'.
|
|
650
649
|
supportsAllDrives (string): Whether the requesting application supports both My Drives and shared drives. Example: '<boolean>'.
|
|
@@ -657,14 +656,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
657
656
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
658
657
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
659
658
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
660
|
-
|
|
659
|
+
|
|
661
660
|
Returns:
|
|
662
661
|
dict[str, Any]: Successful response
|
|
663
|
-
|
|
662
|
+
|
|
664
663
|
Raises:
|
|
665
664
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
666
665
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
667
|
-
|
|
666
|
+
|
|
668
667
|
Tags:
|
|
669
668
|
Changes
|
|
670
669
|
"""
|
|
@@ -735,7 +734,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
735
734
|
) -> dict[str, Any]:
|
|
736
735
|
"""
|
|
737
736
|
Sets up a push notification channel to monitor changes across a user's Google Drive or a specific shared drive. This allows an external service to receive updates when files are modified, added, or deleted, based on specified filters.
|
|
738
|
-
|
|
737
|
+
|
|
739
738
|
Args:
|
|
740
739
|
pageToken (string): (Required) 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 or to the response from the getStartPageToken method. Example: '{{pageToken}}'.
|
|
741
740
|
driveId (string): The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. Example: '{{driveId}}'.
|
|
@@ -768,14 +767,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
768
767
|
resourceUri (string): resourceUri Example: '<string>'.
|
|
769
768
|
token (string): token Example: '<string>'.
|
|
770
769
|
type (string): type Example: '<string>'.
|
|
771
|
-
|
|
770
|
+
|
|
772
771
|
Returns:
|
|
773
772
|
dict[str, Any]: Successful response
|
|
774
|
-
|
|
773
|
+
|
|
775
774
|
Raises:
|
|
776
775
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
777
776
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
778
|
-
|
|
777
|
+
|
|
779
778
|
Tags:
|
|
780
779
|
Changes
|
|
781
780
|
"""
|
|
@@ -863,7 +862,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
863
862
|
) -> Any:
|
|
864
863
|
"""
|
|
865
864
|
Terminates an active push notification channel, ceasing the delivery of updates for a watched Google Drive resource. This requires the channel's ID and resource ID to identify and close the specific notification stream, effectively unsubscribing from real-time changes.
|
|
866
|
-
|
|
865
|
+
|
|
867
866
|
Args:
|
|
868
867
|
alt (string): Data format for the response. Example: 'json'.
|
|
869
868
|
fields (string): Selector specifying which fields to include in a partial response. Example: '<string>'.
|
|
@@ -882,14 +881,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
882
881
|
resourceUri (string): resourceUri Example: '<string>'.
|
|
883
882
|
token (string): token Example: '<string>'.
|
|
884
883
|
type (string): type Example: '<string>'.
|
|
885
|
-
|
|
884
|
+
|
|
886
885
|
Returns:
|
|
887
886
|
Any: Successful response
|
|
888
|
-
|
|
887
|
+
|
|
889
888
|
Raises:
|
|
890
889
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
891
890
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
892
|
-
|
|
891
|
+
|
|
893
892
|
Tags:
|
|
894
893
|
Channels
|
|
895
894
|
"""
|
|
@@ -958,7 +957,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
958
957
|
) -> dict[str, Any]:
|
|
959
958
|
"""
|
|
960
959
|
Retrieves a paginated list of all top-level comments for a specified Google Drive file. It supports filtering by modification time and including deleted comments, fetching parent comments rather than replies, unlike `list_comment_replies`.
|
|
961
|
-
|
|
960
|
+
|
|
962
961
|
Args:
|
|
963
962
|
fileId (string): fileId
|
|
964
963
|
includeDeleted (string): Whether to include deleted comments. Deleted comments will not include their original content. Example: '<boolean>'.
|
|
@@ -972,14 +971,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
972
971
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
973
972
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
974
973
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
975
|
-
|
|
974
|
+
|
|
976
975
|
Returns:
|
|
977
976
|
dict[str, Any]: Successful response
|
|
978
|
-
|
|
977
|
+
|
|
979
978
|
Raises:
|
|
980
979
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
981
980
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
982
|
-
|
|
981
|
+
|
|
983
982
|
Tags:
|
|
984
983
|
Comments
|
|
985
984
|
"""
|
|
@@ -1041,7 +1040,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
1041
1040
|
) -> dict[str, Any]:
|
|
1042
1041
|
"""
|
|
1043
1042
|
Creates a new comment on a specified Google Drive file. It requires a file ID and the comment's content, returning the new comment's metadata. This adds top-level comments, distinct from `create_comment_reply` which replies to existing comments.
|
|
1044
|
-
|
|
1043
|
+
|
|
1045
1044
|
Args:
|
|
1046
1045
|
fileId (string): fileId
|
|
1047
1046
|
alt (string): Data format for the response. Example: 'json'.
|
|
@@ -1063,14 +1062,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
1063
1062
|
quotedFileContent (object): quotedFileContent Example: {'mimeType': '<string>', 'value': '<string>'}.
|
|
1064
1063
|
replies (array): replies Example: "[{'action': '<string>', 'author': {'displayName': '<string>', 'emailAddress': '<string>', 'kind': 'drive#user', 'me': '<boolean>', 'permissionId': '<string>', 'photoLink': '<string>'}, 'content': '<string>', 'createdTime': '<dateTime>', 'deleted': '<boolean>', 'htmlContent': '<string>', 'id': '<string>', 'kind': 'drive#reply', 'modifiedTime': '<dateTime>'}, {'action': '<string>', 'author': {'displayName': '<string>', 'emailAddress': '<string>', 'kind': 'drive#user', 'me': '<boolean>', 'permissionId': '<string>', 'photoLink': '<string>'}, 'content': '<string>', 'createdTime': '<dateTime>', 'deleted': '<boolean>', 'htmlContent': '<string>', 'id': '<string>', 'kind': 'drive#reply', 'modifiedTime': '<dateTime>'}]".
|
|
1065
1064
|
resolved (string): resolved Example: '<boolean>'.
|
|
1066
|
-
|
|
1065
|
+
|
|
1067
1066
|
Returns:
|
|
1068
1067
|
dict[str, Any]: Successful response
|
|
1069
|
-
|
|
1068
|
+
|
|
1070
1069
|
Raises:
|
|
1071
1070
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
1072
1071
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
1073
|
-
|
|
1072
|
+
|
|
1074
1073
|
Tags:
|
|
1075
1074
|
Comments
|
|
1076
1075
|
"""
|
|
@@ -1141,7 +1140,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
1141
1140
|
) -> dict[str, Any]:
|
|
1142
1141
|
"""
|
|
1143
1142
|
Retrieves a single comment's metadata using its unique comment and file IDs. This provides targeted access to one comment, unlike `list_file_comments` which lists all comments for a file. It can optionally include deleted comments in the returned data.
|
|
1144
|
-
|
|
1143
|
+
|
|
1145
1144
|
Args:
|
|
1146
1145
|
fileId (string): fileId
|
|
1147
1146
|
commentId (string): commentId
|
|
@@ -1153,14 +1152,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
1153
1152
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
1154
1153
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
1155
1154
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
1156
|
-
|
|
1155
|
+
|
|
1157
1156
|
Returns:
|
|
1158
1157
|
dict[str, Any]: Successful response
|
|
1159
|
-
|
|
1158
|
+
|
|
1160
1159
|
Raises:
|
|
1161
1160
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
1162
1161
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
1163
|
-
|
|
1162
|
+
|
|
1164
1163
|
Tags:
|
|
1165
1164
|
Comments
|
|
1166
1165
|
"""
|
|
@@ -1210,7 +1209,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
1210
1209
|
) -> Any:
|
|
1211
1210
|
"""
|
|
1212
1211
|
Permanently deletes a specific comment from a Google Drive file, identified by both the file and comment IDs. This irreversible action removes the top-level comment and its replies, distinguishing it from the `delete_reply` function which targets only individual replies within a comment thread.
|
|
1213
|
-
|
|
1212
|
+
|
|
1214
1213
|
Args:
|
|
1215
1214
|
fileId (string): fileId
|
|
1216
1215
|
commentId (string): commentId
|
|
@@ -1221,14 +1220,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
1221
1220
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
1222
1221
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
1223
1222
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
1224
|
-
|
|
1223
|
+
|
|
1225
1224
|
Returns:
|
|
1226
1225
|
Any: Successful response
|
|
1227
|
-
|
|
1226
|
+
|
|
1228
1227
|
Raises:
|
|
1229
1228
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
1230
1229
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
1231
|
-
|
|
1230
|
+
|
|
1232
1231
|
Tags:
|
|
1233
1232
|
Comments
|
|
1234
1233
|
"""
|
|
@@ -1289,7 +1288,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
1289
1288
|
) -> dict[str, Any]:
|
|
1290
1289
|
"""
|
|
1291
1290
|
Updates an existing comment on a specified file using its unique ID. This function allows for partial modification of the comment's properties, such as its content or resolved status, and returns the updated comment's metadata.
|
|
1292
|
-
|
|
1291
|
+
|
|
1293
1292
|
Args:
|
|
1294
1293
|
fileId (string): fileId
|
|
1295
1294
|
commentId (string): commentId
|
|
@@ -1312,14 +1311,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
1312
1311
|
quotedFileContent (object): quotedFileContent Example: {'mimeType': '<string>', 'value': '<string>'}.
|
|
1313
1312
|
replies (array): replies Example: "[{'action': '<string>', 'author': {'displayName': '<string>', 'emailAddress': '<string>', 'kind': 'drive#user', 'me': '<boolean>', 'permissionId': '<string>', 'photoLink': '<string>'}, 'content': '<string>', 'createdTime': '<dateTime>', 'deleted': '<boolean>', 'htmlContent': '<string>', 'id': '<string>', 'kind': 'drive#reply', 'modifiedTime': '<dateTime>'}, {'action': '<string>', 'author': {'displayName': '<string>', 'emailAddress': '<string>', 'kind': 'drive#user', 'me': '<boolean>', 'permissionId': '<string>', 'photoLink': '<string>'}, 'content': '<string>', 'createdTime': '<dateTime>', 'deleted': '<boolean>', 'htmlContent': '<string>', 'id': '<string>', 'kind': 'drive#reply', 'modifiedTime': '<dateTime>'}]".
|
|
1314
1313
|
resolved (string): resolved Example: '<boolean>'.
|
|
1315
|
-
|
|
1314
|
+
|
|
1316
1315
|
Returns:
|
|
1317
1316
|
dict[str, Any]: Successful response
|
|
1318
|
-
|
|
1317
|
+
|
|
1319
1318
|
Raises:
|
|
1320
1319
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
1321
1320
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
1322
|
-
|
|
1321
|
+
|
|
1323
1322
|
Tags:
|
|
1324
1323
|
Comments
|
|
1325
1324
|
"""
|
|
@@ -1388,7 +1387,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
1388
1387
|
) -> dict[str, Any]:
|
|
1389
1388
|
"""
|
|
1390
1389
|
Retrieves a paginated list of shared drives accessible to the user. Supports optional query-based filtering and can be executed with domain administrator privileges to list all shared drives within the domain, returning a dictionary containing the list of drives and pagination details.
|
|
1391
|
-
|
|
1390
|
+
|
|
1392
1391
|
Args:
|
|
1393
1392
|
pageSize (string): Maximum number of shared drives to return per page. Example: '<integer>'.
|
|
1394
1393
|
pageToken (string): Page token for shared drives. Example: '{{pageToken}}'.
|
|
@@ -1401,14 +1400,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
1401
1400
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
1402
1401
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
1403
1402
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
1404
|
-
|
|
1403
|
+
|
|
1405
1404
|
Returns:
|
|
1406
1405
|
dict[str, Any]: Successful response
|
|
1407
|
-
|
|
1406
|
+
|
|
1408
1407
|
Raises:
|
|
1409
1408
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
1410
1409
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
1411
|
-
|
|
1410
|
+
|
|
1412
1411
|
Tags:
|
|
1413
1412
|
Shared Drive
|
|
1414
1413
|
"""
|
|
@@ -1468,7 +1467,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
1468
1467
|
) -> dict[str, Any]:
|
|
1469
1468
|
"""
|
|
1470
1469
|
Creates a new shared drive using a unique `requestId` for idempotency. This function allows specifying initial properties such as its name, background image, and access restrictions, returning the created drive's metadata on success.
|
|
1471
|
-
|
|
1470
|
+
|
|
1472
1471
|
Args:
|
|
1473
1472
|
requestId (string): (Required) An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned. Example: 'requestId'.
|
|
1474
1473
|
alt (string): Data format for the response. Example: 'json'.
|
|
@@ -1490,14 +1489,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
1490
1489
|
orgUnitId (string): orgUnitId Example: '<string>'.
|
|
1491
1490
|
restrictions (object): restrictions Example: {'adminManagedRestrictions': '<boolean>', 'copyRequiresWriterPermission': '<boolean>', 'domainUsersOnly': '<boolean>', 'driveMembersOnly': '<boolean>', 'sharingFoldersRequiresOrganizerPermission': '<boolean>'}.
|
|
1492
1491
|
themeId (string): themeId Example: '<string>'.
|
|
1493
|
-
|
|
1492
|
+
|
|
1494
1493
|
Returns:
|
|
1495
1494
|
dict[str, Any]: Successful response
|
|
1496
|
-
|
|
1495
|
+
|
|
1497
1496
|
Raises:
|
|
1498
1497
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
1499
1498
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
1500
|
-
|
|
1499
|
+
|
|
1501
1500
|
Tags:
|
|
1502
1501
|
Shared Drive
|
|
1503
1502
|
"""
|
|
@@ -1566,7 +1565,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
1566
1565
|
) -> dict[str, Any]:
|
|
1567
1566
|
"""
|
|
1568
1567
|
Retrieves metadata for a specific shared drive using its ID. Unlike `get_drive_info`, which gets user account data, this function targets a single drive's properties. It supports domain administrator access and allows specifying fields to customize the response, returning the drive's detailed information.
|
|
1569
|
-
|
|
1568
|
+
|
|
1570
1569
|
Args:
|
|
1571
1570
|
driveId (string): driveId
|
|
1572
1571
|
useDomainAdminAccess (string): Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs. Example: '<boolean>'.
|
|
@@ -1577,14 +1576,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
1577
1576
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
1578
1577
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
1579
1578
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
1580
|
-
|
|
1579
|
+
|
|
1581
1580
|
Returns:
|
|
1582
1581
|
dict[str, Any]: Successful response
|
|
1583
|
-
|
|
1582
|
+
|
|
1584
1583
|
Raises:
|
|
1585
1584
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
1586
1585
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
1587
|
-
|
|
1586
|
+
|
|
1588
1587
|
Tags:
|
|
1589
1588
|
Shared Drive
|
|
1590
1589
|
"""
|
|
@@ -1633,7 +1632,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
1633
1632
|
) -> Any:
|
|
1634
1633
|
"""
|
|
1635
1634
|
Permanently deletes a shared drive by its ID. This irreversible action removes the entire drive and, unlike `trash_file`, can optionally delete all its contents for domain administrators, providing a complete removal solution for a shared workspace.
|
|
1636
|
-
|
|
1635
|
+
|
|
1637
1636
|
Args:
|
|
1638
1637
|
driveId (string): driveId
|
|
1639
1638
|
allowItemDeletion (string): Whether any items inside the shared drive should also be deleted. This option is only supported when useDomainAdminAccess is also set to true. Example: '<boolean>'.
|
|
@@ -1645,14 +1644,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
1645
1644
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
1646
1645
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
1647
1646
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
1648
|
-
|
|
1647
|
+
|
|
1649
1648
|
Returns:
|
|
1650
1649
|
Any: Successful response
|
|
1651
|
-
|
|
1650
|
+
|
|
1652
1651
|
Raises:
|
|
1653
1652
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
1654
1653
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
1655
|
-
|
|
1654
|
+
|
|
1656
1655
|
Tags:
|
|
1657
1656
|
Shared Drive
|
|
1658
1657
|
"""
|
|
@@ -1713,7 +1712,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
1713
1712
|
) -> dict[str, Any]:
|
|
1714
1713
|
"""
|
|
1715
1714
|
Updates a shared drive's metadata properties, such as its name, theme, or color, using its ID. This function sends a PATCH request to modify the drive and returns a dictionary containing the complete, updated metadata for the shared drive upon success.
|
|
1716
|
-
|
|
1715
|
+
|
|
1717
1716
|
Args:
|
|
1718
1717
|
driveId (string): driveId
|
|
1719
1718
|
useDomainAdminAccess (string): Issue the request as a domain administrator. If set to true, then the requester is granted access if they're an administrator of the domain to which the shared drive belongs. Example: '<boolean>'.
|
|
@@ -1736,14 +1735,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
1736
1735
|
orgUnitId (string): orgUnitId Example: '<string>'.
|
|
1737
1736
|
restrictions (object): restrictions Example: {'adminManagedRestrictions': '<boolean>', 'copyRequiresWriterPermission': '<boolean>', 'domainUsersOnly': '<boolean>', 'driveMembersOnly': '<boolean>', 'sharingFoldersRequiresOrganizerPermission': '<boolean>'}.
|
|
1738
1737
|
themeId (string): themeId Example: '<string>'.
|
|
1739
|
-
|
|
1738
|
+
|
|
1740
1739
|
Returns:
|
|
1741
1740
|
dict[str, Any]: Successful response
|
|
1742
|
-
|
|
1741
|
+
|
|
1743
1742
|
Raises:
|
|
1744
1743
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
1745
1744
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
1746
|
-
|
|
1745
|
+
|
|
1747
1746
|
Tags:
|
|
1748
1747
|
Shared Drive
|
|
1749
1748
|
"""
|
|
@@ -1808,7 +1807,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
1808
1807
|
) -> dict[str, Any]:
|
|
1809
1808
|
"""
|
|
1810
1809
|
Hides a specified shared drive from the user's default view using its ID. This function sends a POST request to the API's hide endpoint, returning updated drive metadata. It is the direct counterpart to the `unhide_drive` function, which restores visibility.
|
|
1811
|
-
|
|
1810
|
+
|
|
1812
1811
|
Args:
|
|
1813
1812
|
driveId (string): driveId
|
|
1814
1813
|
alt (string): Data format for the response. Example: 'json'.
|
|
@@ -1818,14 +1817,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
1818
1817
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
1819
1818
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
1820
1819
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
1821
|
-
|
|
1820
|
+
|
|
1822
1821
|
Returns:
|
|
1823
1822
|
dict[str, Any]: Successful response
|
|
1824
|
-
|
|
1823
|
+
|
|
1825
1824
|
Raises:
|
|
1826
1825
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
1827
1826
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
1828
|
-
|
|
1827
|
+
|
|
1829
1828
|
Tags:
|
|
1830
1829
|
Shared Drive
|
|
1831
1830
|
"""
|
|
@@ -1877,7 +1876,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
1877
1876
|
) -> dict[str, Any]:
|
|
1878
1877
|
"""
|
|
1879
1878
|
Makes a hidden shared drive visible again in the user's default view by its ID. This function sends a POST request to the Google Drive API's `/unhide` endpoint, effectively reversing the action of the `hide_drive` function, and returns the updated drive metadata.
|
|
1880
|
-
|
|
1879
|
+
|
|
1881
1880
|
Args:
|
|
1882
1881
|
driveId (string): driveId
|
|
1883
1882
|
alt (string): Data format for the response. Example: 'json'.
|
|
@@ -1887,14 +1886,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
1887
1886
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
1888
1887
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
1889
1888
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
1890
|
-
|
|
1889
|
+
|
|
1891
1890
|
Returns:
|
|
1892
1891
|
dict[str, Any]: Successful response
|
|
1893
|
-
|
|
1892
|
+
|
|
1894
1893
|
Raises:
|
|
1895
1894
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
1896
1895
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
1897
|
-
|
|
1896
|
+
|
|
1898
1897
|
Tags:
|
|
1899
1898
|
Shared Drive
|
|
1900
1899
|
"""
|
|
@@ -1959,7 +1958,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
1959
1958
|
) -> dict[str, Any]:
|
|
1960
1959
|
"""
|
|
1961
1960
|
Exhaustively lists or searches files using advanced parameters for filtering, sorting, and pagination. As a low-level alternative to the simplified `search_files` function, it provides granular control by exposing the full range of Google Drive API query options for complex retrieval.
|
|
1962
|
-
|
|
1961
|
+
|
|
1963
1962
|
Args:
|
|
1964
1963
|
corpora (string): Groupings of files to which the query applies. Supported groupings are: 'user' (files created by, opened by, or shared directly with the user), 'drive' (files in the specified shared drive as indicated by the 'driveId'), 'domain' (files shared to the user's domain), and 'allDrives' (A combination of 'user' and 'drive' for all drives where the user is a member). When able, use 'user' or 'drive', instead of 'allDrives', for efficiency. Example: '<string>'.
|
|
1965
1964
|
driveId (string): ID of the shared drive to search. Example: '{{driveId}}'.
|
|
@@ -1982,14 +1981,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
1982
1981
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
1983
1982
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
1984
1983
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
1985
|
-
|
|
1984
|
+
|
|
1986
1985
|
Returns:
|
|
1987
1986
|
dict[str, Any]: Successful response
|
|
1988
|
-
|
|
1987
|
+
|
|
1989
1988
|
Raises:
|
|
1990
1989
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
1991
1990
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
1992
|
-
|
|
1991
|
+
|
|
1993
1992
|
Tags:
|
|
1994
1993
|
Files
|
|
1995
1994
|
"""
|
|
@@ -2117,7 +2116,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
2117
2116
|
) -> dict[str, Any]:
|
|
2118
2117
|
"""
|
|
2119
2118
|
Creates a new file's metadata resource in Google Drive, allowing detailed configuration of properties like name, MIME type, and parent folders. Unlike `upload_file_from_path` or `create_text_file`, this function only creates the metadata entry without uploading any file content.
|
|
2120
|
-
|
|
2119
|
+
|
|
2121
2120
|
Args:
|
|
2122
2121
|
enforceSingleParent (string): Deprecated. Creating files in multiple folders is no longer supported. Example: '<boolean>'.
|
|
2123
2122
|
ignoreDefaultVisibility (string): 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. Example: '<boolean>'.
|
|
@@ -2197,14 +2196,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
2197
2196
|
webContentLink (string): webContentLink Example: '<string>'.
|
|
2198
2197
|
webViewLink (string): webViewLink Example: '<string>'.
|
|
2199
2198
|
writersCanShare (string): writersCanShare Example: '<boolean>'.
|
|
2200
|
-
|
|
2199
|
+
|
|
2201
2200
|
Returns:
|
|
2202
2201
|
dict[str, Any]: Successful response
|
|
2203
|
-
|
|
2202
|
+
|
|
2204
2203
|
Raises:
|
|
2205
2204
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
2206
2205
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
2207
|
-
|
|
2206
|
+
|
|
2208
2207
|
Tags:
|
|
2209
2208
|
Files
|
|
2210
2209
|
"""
|
|
@@ -2332,7 +2331,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
2332
2331
|
) -> dict[str, Any]:
|
|
2333
2332
|
"""
|
|
2334
2333
|
Generates a batch of unique IDs for future Google Drive files or shortcuts. This utility optimizes creation workflows by allowing identifiers to be fetched in advance, specifying quantity, storage space (e.g., 'drive'), and item type (e.g., 'files').
|
|
2335
|
-
|
|
2334
|
+
|
|
2336
2335
|
Args:
|
|
2337
2336
|
count (string): The number of IDs to return. Example: '<integer>'.
|
|
2338
2337
|
space (string): The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'. (Default: 'drive') Example: '<string>'.
|
|
@@ -2344,14 +2343,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
2344
2343
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
2345
2344
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
2346
2345
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
2347
|
-
|
|
2346
|
+
|
|
2348
2347
|
Returns:
|
|
2349
2348
|
dict[str, Any]: Successful response
|
|
2350
|
-
|
|
2349
|
+
|
|
2351
2350
|
Raises:
|
|
2352
2351
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
2353
2352
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
2354
|
-
|
|
2353
|
+
|
|
2355
2354
|
Tags:
|
|
2356
2355
|
Files
|
|
2357
2356
|
"""
|
|
@@ -2399,7 +2398,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
2399
2398
|
) -> Any:
|
|
2400
2399
|
"""
|
|
2401
2400
|
Permanently deletes all files and folders from the trash. This irreversible action can target the user's main trash or a specific shared drive's trash via its `driveId`, distinguishing it from `trash_file` which only moves a single item to the trash.
|
|
2402
|
-
|
|
2401
|
+
|
|
2403
2402
|
Args:
|
|
2404
2403
|
driveId (string): If set, empties the trash of the provided shared drive. Example: '{{driveId}}'.
|
|
2405
2404
|
enforceSingleParent (string): Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root. Example: '<boolean>'.
|
|
@@ -2410,14 +2409,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
2410
2409
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
2411
2410
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
2412
2411
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
2413
|
-
|
|
2412
|
+
|
|
2414
2413
|
Returns:
|
|
2415
2414
|
Any: Successful response
|
|
2416
|
-
|
|
2415
|
+
|
|
2417
2416
|
Raises:
|
|
2418
2417
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
2419
2418
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
2420
|
-
|
|
2419
|
+
|
|
2421
2420
|
Tags:
|
|
2422
2421
|
Files
|
|
2423
2422
|
"""
|
|
@@ -2466,7 +2465,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
2466
2465
|
) -> Any:
|
|
2467
2466
|
"""
|
|
2468
2467
|
Permanently deletes a file by its ID, bypassing the trash for irreversible removal. Unlike the simpler `trash_file` function, this method offers advanced control through numerous optional API parameters, such as handling files located in shared drives.
|
|
2469
|
-
|
|
2468
|
+
|
|
2470
2469
|
Args:
|
|
2471
2470
|
fileId (string): fileId
|
|
2472
2471
|
enforceSingleParent (string): Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root. Example: '<boolean>'.
|
|
@@ -2479,14 +2478,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
2479
2478
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
2480
2479
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
2481
2480
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
2482
|
-
|
|
2481
|
+
|
|
2483
2482
|
Returns:
|
|
2484
2483
|
Any: Successful response
|
|
2485
|
-
|
|
2484
|
+
|
|
2486
2485
|
Raises:
|
|
2487
2486
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
2488
2487
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
2489
|
-
|
|
2488
|
+
|
|
2490
2489
|
Tags:
|
|
2491
2490
|
Files
|
|
2492
2491
|
"""
|
|
@@ -2607,7 +2606,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
2607
2606
|
) -> dict[str, Any]:
|
|
2608
2607
|
"""
|
|
2609
2608
|
Modifies a file's metadata properties, such as name, description, or trashed status, using its unique ID. It also moves files by changing parent attributes, acting as a comprehensive alternative to the more specialized `move_file` function.
|
|
2610
|
-
|
|
2609
|
+
|
|
2611
2610
|
Args:
|
|
2612
2611
|
fileId (string): fileId
|
|
2613
2612
|
addParents (string): A comma-separated list of parent IDs to add. Example: '<string>'.
|
|
@@ -2689,14 +2688,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
2689
2688
|
webContentLink (string): webContentLink Example: '<string>'.
|
|
2690
2689
|
webViewLink (string): webViewLink Example: '<string>'.
|
|
2691
2690
|
writersCanShare (string): writersCanShare Example: '<boolean>'.
|
|
2692
|
-
|
|
2691
|
+
|
|
2693
2692
|
Returns:
|
|
2694
2693
|
dict[str, Any]: Successful response
|
|
2695
|
-
|
|
2694
|
+
|
|
2696
2695
|
Raises:
|
|
2697
2696
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
2698
2697
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
2699
|
-
|
|
2698
|
+
|
|
2700
2699
|
Tags:
|
|
2701
2700
|
Files
|
|
2702
2701
|
"""
|
|
@@ -2890,7 +2889,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
2890
2889
|
) -> dict[str, Any]:
|
|
2891
2890
|
"""
|
|
2892
2891
|
Creates a copy of a file using its ID. This function can simultaneously apply metadata updates, such as a new name or parent folder, to the duplicate upon creation and returns the new file's metadata.
|
|
2893
|
-
|
|
2892
|
+
|
|
2894
2893
|
Args:
|
|
2895
2894
|
fileId (string): fileId
|
|
2896
2895
|
enforceSingleParent (string): Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead. Example: '<boolean>'.
|
|
@@ -2970,14 +2969,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
2970
2969
|
webContentLink (string): webContentLink Example: '<string>'.
|
|
2971
2970
|
webViewLink (string): webViewLink Example: '<string>'.
|
|
2972
2971
|
writersCanShare (string): writersCanShare Example: '<boolean>'.
|
|
2973
|
-
|
|
2972
|
+
|
|
2974
2973
|
Returns:
|
|
2975
2974
|
dict[str, Any]: Successful response
|
|
2976
|
-
|
|
2975
|
+
|
|
2977
2976
|
Raises:
|
|
2978
2977
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
2979
2978
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
2980
|
-
|
|
2979
|
+
|
|
2981
2980
|
Tags:
|
|
2982
2981
|
Files
|
|
2983
2982
|
"""
|
|
@@ -3105,7 +3104,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
3105
3104
|
) -> Any:
|
|
3106
3105
|
"""
|
|
3107
3106
|
Exports a Google Workspace document (e.g., Google Doc) by its ID, converting it to a specified format like PDF using the `mimeType` argument. This function returns the raw, converted file content for download, differentiating it from methods that retrieve metadata.
|
|
3108
|
-
|
|
3107
|
+
|
|
3109
3108
|
Args:
|
|
3110
3109
|
fileId (string): fileId
|
|
3111
3110
|
mimeType (string): (Required) The MIME type of the format requested for this export. Example: 'mimeType'.
|
|
@@ -3116,14 +3115,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
3116
3115
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
3117
3116
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
3118
3117
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
3119
|
-
|
|
3118
|
+
|
|
3120
3119
|
Returns:
|
|
3121
3120
|
Any: Successful response
|
|
3122
|
-
|
|
3121
|
+
|
|
3123
3122
|
Raises:
|
|
3124
3123
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
3125
3124
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
3126
|
-
|
|
3125
|
+
|
|
3127
3126
|
Tags:
|
|
3128
3127
|
Files
|
|
3129
3128
|
"""
|
|
@@ -3172,7 +3171,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
3172
3171
|
) -> dict[str, Any]:
|
|
3173
3172
|
"""
|
|
3174
3173
|
Retrieves a paginated list of all labels applied to a specific file in Google Drive, identified by its unique ID. It allows controlling the number of results per page and navigating through pages of labels, differing from `modify_file_labels` which alters them.
|
|
3175
|
-
|
|
3174
|
+
|
|
3176
3175
|
Args:
|
|
3177
3176
|
fileId (string): fileId
|
|
3178
3177
|
maxResults (string): The maximum number of labels to return per page. When not set, this defaults to 100. Example: '<integer>'.
|
|
@@ -3184,14 +3183,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
3184
3183
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
3185
3184
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
3186
3185
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
3187
|
-
|
|
3186
|
+
|
|
3188
3187
|
Returns:
|
|
3189
3188
|
dict[str, Any]: Successful response
|
|
3190
|
-
|
|
3189
|
+
|
|
3191
3190
|
Raises:
|
|
3192
3191
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
3193
3192
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
3194
|
-
|
|
3193
|
+
|
|
3195
3194
|
Tags:
|
|
3196
3195
|
Files
|
|
3197
3196
|
"""
|
|
@@ -3241,7 +3240,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
3241
3240
|
) -> dict[str, Any]:
|
|
3242
3241
|
"""
|
|
3243
3242
|
Atomically modifies the set of labels on a specified file in Google Drive. It can add, update, or remove labels based on the provided list of modifications, returning the updated label metadata for the file.
|
|
3244
|
-
|
|
3243
|
+
|
|
3245
3244
|
Args:
|
|
3246
3245
|
fileId (string): fileId
|
|
3247
3246
|
alt (string): Data format for the response. Example: 'json'.
|
|
@@ -3253,14 +3252,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
3253
3252
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
3254
3253
|
kind (string): kind Example: 'drive#modifyLabelsRequest'.
|
|
3255
3254
|
labelModifications (array): labelModifications Example: "[{'fieldModifications': [{'fieldId': '<string>', 'kind': 'drive#labelFieldModification', 'setDateValues': ['<date>', '<date>'], 'setIntegerValues': ['<int64>', '<int64>'], 'setSelectionValues': ['<string>', '<string>'], 'setTextValues': ['<string>', '<string>'], 'setUserValues': ['<string>', '<string>'], 'unsetValues': '<boolean>'}, {'fieldId': '<string>', 'kind': 'drive#labelFieldModification', 'setDateValues': ['<date>', '<date>'], 'setIntegerValues': ['<int64>', '<int64>'], 'setSelectionValues': ['<string>', '<string>'], 'setTextValues': ['<string>', '<string>'], 'setUserValues': ['<string>', '<string>'], 'unsetValues': '<boolean>'}], 'kind': 'drive#labelModification', 'labelId': '<string>', 'removeLabel': '<boolean>'}, {'fieldModifications': [{'fieldId': '<string>', 'kind': 'drive#labelFieldModification', 'setDateValues': ['<date>', '<date>'], 'setIntegerValues': ['<int64>', '<int64>'], 'setSelectionValues': ['<string>', '<string>'], 'setTextValues': ['<string>', '<string>'], 'setUserValues': ['<string>', '<string>'], 'unsetValues': '<boolean>'}, {'fieldId': '<string>', 'kind': 'drive#labelFieldModification', 'setDateValues': ['<date>', '<date>'], 'setIntegerValues': ['<int64>', '<int64>'], 'setSelectionValues': ['<string>', '<string>'], 'setTextValues': ['<string>', '<string>'], 'setUserValues': ['<string>', '<string>'], 'unsetValues': '<boolean>'}], 'kind': 'drive#labelModification', 'labelId': '<string>', 'removeLabel': '<boolean>'}]".
|
|
3256
|
-
|
|
3255
|
+
|
|
3257
3256
|
Returns:
|
|
3258
3257
|
dict[str, Any]: Successful response
|
|
3259
|
-
|
|
3258
|
+
|
|
3260
3259
|
Raises:
|
|
3261
3260
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
3262
3261
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
3263
|
-
|
|
3262
|
+
|
|
3264
3263
|
Tags:
|
|
3265
3264
|
Files
|
|
3266
3265
|
"""
|
|
@@ -3334,7 +3333,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
3334
3333
|
) -> dict[str, Any]:
|
|
3335
3334
|
"""
|
|
3336
3335
|
Establishes a push notification channel for a specific file, enabling real-time updates via webhook. Unlike `watch_drive_changes`, which monitors an entire drive, this function provides targeted notifications for content or metadata updates to a single file identified by its ID.
|
|
3337
|
-
|
|
3336
|
+
|
|
3338
3337
|
Args:
|
|
3339
3338
|
fileId (string): fileId
|
|
3340
3339
|
acknowledgeAbuse (string): Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. Example: '<boolean>'.
|
|
@@ -3359,14 +3358,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
3359
3358
|
resourceUri (string): resourceUri Example: '<string>'.
|
|
3360
3359
|
token (string): token Example: '<string>'.
|
|
3361
3360
|
type (string): type Example: '<string>'.
|
|
3362
|
-
|
|
3361
|
+
|
|
3363
3362
|
Returns:
|
|
3364
3363
|
dict[str, Any]: Successful response
|
|
3365
|
-
|
|
3364
|
+
|
|
3366
3365
|
Raises:
|
|
3367
3366
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
3368
3367
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
3369
|
-
|
|
3368
|
+
|
|
3370
3369
|
Tags:
|
|
3371
3370
|
Files
|
|
3372
3371
|
"""
|
|
@@ -3444,7 +3443,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
3444
3443
|
) -> dict[str, Any]:
|
|
3445
3444
|
"""
|
|
3446
3445
|
Retrieves the list of permissions for a specified file or shared drive. This function supports pagination and various query parameters to customize results for different access levels, such as domain administration, unlike `get_permission_by_id` which fetches a single permission.
|
|
3447
|
-
|
|
3446
|
+
|
|
3448
3447
|
Args:
|
|
3449
3448
|
fileId (string): fileId
|
|
3450
3449
|
includePermissionsForView (string): Specifies which additional view's permissions to include in the response. Only 'published' is supported. Example: '<string>'.
|
|
@@ -3460,14 +3459,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
3460
3459
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
3461
3460
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
3462
3461
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
3463
|
-
|
|
3462
|
+
|
|
3464
3463
|
Returns:
|
|
3465
3464
|
dict[str, Any]: Successful response
|
|
3466
|
-
|
|
3465
|
+
|
|
3467
3466
|
Raises:
|
|
3468
3467
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
3469
3468
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
3470
|
-
|
|
3469
|
+
|
|
3471
3470
|
Tags:
|
|
3472
3471
|
Permissions
|
|
3473
3472
|
"""
|
|
@@ -3542,7 +3541,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
3542
3541
|
) -> dict[str, Any]:
|
|
3543
3542
|
"""
|
|
3544
3543
|
Creates a permission for a file or shared drive, assigning roles like 'reader' to a user, group, or domain. This comprehensive method supports advanced options like notification emails and ownership transfer, distinguishing it from the simplified `create_permission` function which offers fewer parameters.
|
|
3545
|
-
|
|
3544
|
+
|
|
3546
3545
|
Args:
|
|
3547
3546
|
fileId (string): fileId
|
|
3548
3547
|
emailMessage (string): A plain text custom message to include in the notification email. Example: '<string>'.
|
|
@@ -3575,14 +3574,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
3575
3574
|
teamDrivePermissionDetails (array): teamDrivePermissionDetails Example: "[{'inherited': '<boolean>', 'inheritedFrom': '<string>', 'role': '<string>', 'teamDrivePermissionType': '<string>'}, {'inherited': '<boolean>', 'inheritedFrom': '<string>', 'role': '<string>', 'teamDrivePermissionType': '<string>'}]".
|
|
3576
3575
|
type (string): type Example: '<string>'.
|
|
3577
3576
|
view (string): view Example: '<string>'.
|
|
3578
|
-
|
|
3577
|
+
|
|
3579
3578
|
Returns:
|
|
3580
3579
|
dict[str, Any]: Successful response
|
|
3581
|
-
|
|
3580
|
+
|
|
3582
3581
|
Raises:
|
|
3583
3582
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
3584
3583
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
3585
|
-
|
|
3584
|
+
|
|
3586
3585
|
Tags:
|
|
3587
3586
|
Permissions
|
|
3588
3587
|
"""
|
|
@@ -3666,7 +3665,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
3666
3665
|
) -> dict[str, Any]:
|
|
3667
3666
|
"""
|
|
3668
3667
|
Retrieves metadata for a specific permission on a file or shared drive, identified by its unique ID. This provides targeted access information, unlike `list_file_permissions` which fetches all permissions for a file.
|
|
3669
|
-
|
|
3668
|
+
|
|
3670
3669
|
Args:
|
|
3671
3670
|
fileId (string): fileId
|
|
3672
3671
|
permissionId (string): permissionId
|
|
@@ -3680,14 +3679,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
3680
3679
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
3681
3680
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
3682
3681
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
3683
|
-
|
|
3682
|
+
|
|
3684
3683
|
Returns:
|
|
3685
3684
|
dict[str, Any]: Successful response
|
|
3686
|
-
|
|
3685
|
+
|
|
3687
3686
|
Raises:
|
|
3688
3687
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
3689
3688
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
3690
|
-
|
|
3689
|
+
|
|
3691
3690
|
Tags:
|
|
3692
3691
|
Permissions
|
|
3693
3692
|
"""
|
|
@@ -3742,7 +3741,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
3742
3741
|
) -> Any:
|
|
3743
3742
|
"""
|
|
3744
3743
|
Deletes a specific permission from a Google Drive file or shared drive, identified by their respective IDs. This action permanently revokes the access associated with that permission, with optional parameters for shared drives and domain administrator access.
|
|
3745
|
-
|
|
3744
|
+
|
|
3746
3745
|
Args:
|
|
3747
3746
|
fileId (string): fileId
|
|
3748
3747
|
permissionId (string): permissionId
|
|
@@ -3756,14 +3755,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
3756
3755
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
3757
3756
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
3758
3757
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
3759
|
-
|
|
3758
|
+
|
|
3760
3759
|
Returns:
|
|
3761
3760
|
Any: Successful response
|
|
3762
|
-
|
|
3761
|
+
|
|
3763
3762
|
Raises:
|
|
3764
3763
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
3765
3764
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
3766
|
-
|
|
3765
|
+
|
|
3767
3766
|
Tags:
|
|
3768
3767
|
Permissions
|
|
3769
3768
|
"""
|
|
@@ -3835,7 +3834,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
3835
3834
|
) -> dict[str, Any]:
|
|
3836
3835
|
"""
|
|
3837
3836
|
Updates an existing permission for a file or shared drive using its permission ID. This function can modify a user's role (e.g., from reader to writer), transfer ownership, or change expiration settings, returning the updated permission object upon success.
|
|
3838
|
-
|
|
3837
|
+
|
|
3839
3838
|
Args:
|
|
3840
3839
|
fileId (string): fileId
|
|
3841
3840
|
permissionId (string): permissionId
|
|
@@ -3866,14 +3865,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
3866
3865
|
teamDrivePermissionDetails (array): teamDrivePermissionDetails Example: "[{'inherited': '<boolean>', 'inheritedFrom': '<string>', 'role': '<string>', 'teamDrivePermissionType': '<string>'}, {'inherited': '<boolean>', 'inheritedFrom': '<string>', 'role': '<string>', 'teamDrivePermissionType': '<string>'}]".
|
|
3867
3866
|
type (string): type Example: '<string>'.
|
|
3868
3867
|
view (string): view Example: '<string>'.
|
|
3869
|
-
|
|
3868
|
+
|
|
3870
3869
|
Returns:
|
|
3871
3870
|
dict[str, Any]: Successful response
|
|
3872
|
-
|
|
3871
|
+
|
|
3873
3872
|
Raises:
|
|
3874
3873
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
3875
3874
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
3876
|
-
|
|
3875
|
+
|
|
3877
3876
|
Tags:
|
|
3878
3877
|
Permissions
|
|
3879
3878
|
"""
|
|
@@ -3951,7 +3950,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
3951
3950
|
) -> dict[str, Any]:
|
|
3952
3951
|
"""
|
|
3953
3952
|
Fetches a paginated list of replies for a specific comment, requiring both file and comment IDs. It can optionally include deleted replies. Unlike `list_file_comments`, which retrieves all top-level comments, this function targets replies within a single comment's thread.
|
|
3954
|
-
|
|
3953
|
+
|
|
3955
3954
|
Args:
|
|
3956
3955
|
fileId (string): fileId
|
|
3957
3956
|
commentId (string): commentId
|
|
@@ -3965,14 +3964,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
3965
3964
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
3966
3965
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
3967
3966
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
3968
|
-
|
|
3967
|
+
|
|
3969
3968
|
Returns:
|
|
3970
3969
|
dict[str, Any]: Successful response
|
|
3971
|
-
|
|
3970
|
+
|
|
3972
3971
|
Raises:
|
|
3973
3972
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
3974
3973
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
3975
|
-
|
|
3974
|
+
|
|
3976
3975
|
Tags:
|
|
3977
3976
|
Replies
|
|
3978
3977
|
"""
|
|
@@ -4033,7 +4032,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
4033
4032
|
) -> dict[str, Any]:
|
|
4034
4033
|
"""
|
|
4035
4034
|
Creates a reply to a specific comment on a Google Drive file. It requires the file ID and the parent comment ID, posting the new reply's content to the correct comment thread.
|
|
4036
|
-
|
|
4035
|
+
|
|
4037
4036
|
Args:
|
|
4038
4037
|
fileId (string): fileId
|
|
4039
4038
|
commentId (string): commentId
|
|
@@ -4053,14 +4052,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
4053
4052
|
id (string): id Example: '<string>'.
|
|
4054
4053
|
kind (string): kind Example: 'drive#reply'.
|
|
4055
4054
|
modifiedTime (string): modifiedTime Example: '<dateTime>'.
|
|
4056
|
-
|
|
4055
|
+
|
|
4057
4056
|
Returns:
|
|
4058
4057
|
dict[str, Any]: Successful response
|
|
4059
|
-
|
|
4058
|
+
|
|
4060
4059
|
Raises:
|
|
4061
4060
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
4062
4061
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
4063
|
-
|
|
4062
|
+
|
|
4064
4063
|
Tags:
|
|
4065
4064
|
Replies
|
|
4066
4065
|
"""
|
|
@@ -4131,7 +4130,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
4131
4130
|
) -> dict[str, Any]:
|
|
4132
4131
|
"""
|
|
4133
4132
|
Retrieves a specific reply's metadata from a comment thread using file, comment, and reply IDs. Unlike `list_comment_replies`, which fetches all replies for a comment, this function targets a single one and can optionally include deleted replies in the result.
|
|
4134
|
-
|
|
4133
|
+
|
|
4135
4134
|
Args:
|
|
4136
4135
|
fileId (string): fileId
|
|
4137
4136
|
commentId (string): commentId
|
|
@@ -4144,14 +4143,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
4144
4143
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
4145
4144
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
4146
4145
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
4147
|
-
|
|
4146
|
+
|
|
4148
4147
|
Returns:
|
|
4149
4148
|
dict[str, Any]: Successful response
|
|
4150
|
-
|
|
4149
|
+
|
|
4151
4150
|
Raises:
|
|
4152
4151
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
4153
4152
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
4154
|
-
|
|
4153
|
+
|
|
4155
4154
|
Tags:
|
|
4156
4155
|
Replies
|
|
4157
4156
|
"""
|
|
@@ -4204,7 +4203,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
4204
4203
|
) -> Any:
|
|
4205
4204
|
"""
|
|
4206
4205
|
Permanently deletes a specific reply from a comment on a Google Drive file. This targeted operation requires file, comment, and reply IDs to remove a single nested reply, distinguishing it from `delete_comment` which removes an entire top-level comment.
|
|
4207
|
-
|
|
4206
|
+
|
|
4208
4207
|
Args:
|
|
4209
4208
|
fileId (string): fileId
|
|
4210
4209
|
commentId (string): commentId
|
|
@@ -4216,14 +4215,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
4216
4215
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
4217
4216
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
4218
4217
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
4219
|
-
|
|
4218
|
+
|
|
4220
4219
|
Returns:
|
|
4221
4220
|
Any: Successful response
|
|
4222
|
-
|
|
4221
|
+
|
|
4223
4222
|
Raises:
|
|
4224
4223
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
4225
4224
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
4226
|
-
|
|
4225
|
+
|
|
4227
4226
|
Tags:
|
|
4228
4227
|
Replies
|
|
4229
4228
|
"""
|
|
@@ -4284,7 +4283,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
4284
4283
|
) -> dict[str, Any]:
|
|
4285
4284
|
"""
|
|
4286
4285
|
Updates a specific reply to a comment on a file in Google Drive. It uses file, comment, and reply IDs to locate the reply, allowing modification of its properties like content. The function then returns the updated reply's metadata.
|
|
4287
|
-
|
|
4286
|
+
|
|
4288
4287
|
Args:
|
|
4289
4288
|
fileId (string): fileId
|
|
4290
4289
|
commentId (string): commentId
|
|
@@ -4305,14 +4304,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
4305
4304
|
id (string): id Example: '<string>'.
|
|
4306
4305
|
kind (string): kind Example: 'drive#reply'.
|
|
4307
4306
|
modifiedTime (string): modifiedTime Example: '<dateTime>'.
|
|
4308
|
-
|
|
4307
|
+
|
|
4309
4308
|
Returns:
|
|
4310
4309
|
dict[str, Any]: Successful response
|
|
4311
|
-
|
|
4310
|
+
|
|
4312
4311
|
Raises:
|
|
4313
4312
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
4314
4313
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
4315
|
-
|
|
4314
|
+
|
|
4316
4315
|
Tags:
|
|
4317
4316
|
Replies
|
|
4318
4317
|
"""
|
|
@@ -4379,7 +4378,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
4379
4378
|
) -> dict[str, Any]:
|
|
4380
4379
|
"""
|
|
4381
4380
|
Retrieves a paginated list of all historical versions (revisions) for a specific file in Google Drive. Supports page size and token parameters to navigate a file's change history, differentiating it from functions that get, update, or delete a single revision.
|
|
4382
|
-
|
|
4381
|
+
|
|
4383
4382
|
Args:
|
|
4384
4383
|
fileId (string): fileId
|
|
4385
4384
|
pageSize (string): The maximum number of revisions to return per page. Example: '<integer>'.
|
|
@@ -4391,14 +4390,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
4391
4390
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
4392
4391
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
4393
4392
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
4394
|
-
|
|
4393
|
+
|
|
4395
4394
|
Returns:
|
|
4396
4395
|
dict[str, Any]: Successful response
|
|
4397
|
-
|
|
4396
|
+
|
|
4398
4397
|
Raises:
|
|
4399
4398
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
4400
4399
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
4401
|
-
|
|
4400
|
+
|
|
4402
4401
|
Tags:
|
|
4403
4402
|
Revisions
|
|
4404
4403
|
"""
|
|
@@ -4448,7 +4447,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
4448
4447
|
) -> dict[str, Any]:
|
|
4449
4448
|
"""
|
|
4450
4449
|
Fetches metadata for a single, specific file revision using its file and revision IDs. Unlike `list_file_revisions` which lists a file's complete version history, this function targets one historical version to retrieve its unique metadata.
|
|
4451
|
-
|
|
4450
|
+
|
|
4452
4451
|
Args:
|
|
4453
4452
|
fileId (string): fileId
|
|
4454
4453
|
revisionId (string): revisionId
|
|
@@ -4460,14 +4459,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
4460
4459
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
4461
4460
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
4462
4461
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
4463
|
-
|
|
4462
|
+
|
|
4464
4463
|
Returns:
|
|
4465
4464
|
dict[str, Any]: Successful response
|
|
4466
|
-
|
|
4465
|
+
|
|
4467
4466
|
Raises:
|
|
4468
4467
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
4469
4468
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
4470
|
-
|
|
4469
|
+
|
|
4471
4470
|
Tags:
|
|
4472
4471
|
Revisions
|
|
4473
4472
|
"""
|
|
@@ -4517,7 +4516,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
4517
4516
|
) -> Any:
|
|
4518
4517
|
"""
|
|
4519
4518
|
Permanently deletes a specific revision of a file, identified by its file and revision IDs. This irreversible action removes a single historical version, distinguishing it from functions like `permanently_delete_file`, which deletes the entire file, or `trash_file`, which moves it to the trash.
|
|
4520
|
-
|
|
4519
|
+
|
|
4521
4520
|
Args:
|
|
4522
4521
|
fileId (string): fileId
|
|
4523
4522
|
revisionId (string): revisionId
|
|
@@ -4528,14 +4527,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
4528
4527
|
prettyPrint (string): Returns response with indentations and line breaks. Example: '<boolean>'.
|
|
4529
4528
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: '<string>'.
|
|
4530
4529
|
userIp (string): Deprecated. Please use quotaUser instead. Example: '<string>'.
|
|
4531
|
-
|
|
4530
|
+
|
|
4532
4531
|
Returns:
|
|
4533
4532
|
Any: Successful response
|
|
4534
|
-
|
|
4533
|
+
|
|
4535
4534
|
Raises:
|
|
4536
4535
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
4537
4536
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
4538
|
-
|
|
4537
|
+
|
|
4539
4538
|
Tags:
|
|
4540
4539
|
Revisions
|
|
4541
4540
|
"""
|
|
@@ -4598,7 +4597,7 @@ class GoogleDriveApp(APIApplication):
|
|
|
4598
4597
|
) -> dict[str, Any]:
|
|
4599
4598
|
"""
|
|
4600
4599
|
Updates the metadata for a specific file revision using its file and revision IDs. It modifies properties such as pinning the revision (`keepForever`) or its publication status, and returns the updated revision metadata upon success.
|
|
4601
|
-
|
|
4600
|
+
|
|
4602
4601
|
Args:
|
|
4603
4602
|
fileId (string): fileId
|
|
4604
4603
|
revisionId (string): revisionId
|
|
@@ -4623,14 +4622,14 @@ class GoogleDriveApp(APIApplication):
|
|
|
4623
4622
|
publishedLink (string): publishedLink Example: '<string>'.
|
|
4624
4623
|
publishedOutsideDomain (string): publishedOutsideDomain Example: '<boolean>'.
|
|
4625
4624
|
size (string): size Example: '<int64>'.
|
|
4626
|
-
|
|
4625
|
+
|
|
4627
4626
|
Returns:
|
|
4628
4627
|
dict[str, Any]: Successful response
|
|
4629
|
-
|
|
4628
|
+
|
|
4630
4629
|
Raises:
|
|
4631
4630
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
4632
4631
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
4633
|
-
|
|
4632
|
+
|
|
4634
4633
|
Tags:
|
|
4635
4634
|
Revisions
|
|
4636
4635
|
"""
|
|
@@ -4685,8 +4684,6 @@ class GoogleDriveApp(APIApplication):
|
|
|
4685
4684
|
except ValueError:
|
|
4686
4685
|
return None
|
|
4687
4686
|
|
|
4688
|
-
|
|
4689
|
-
|
|
4690
4687
|
def create_permission(
|
|
4691
4688
|
self,
|
|
4692
4689
|
fileId: str,
|
|
@@ -4696,20 +4693,20 @@ class GoogleDriveApp(APIApplication):
|
|
|
4696
4693
|
) -> dict[str, Any]:
|
|
4697
4694
|
"""
|
|
4698
4695
|
Grants a specified role (e.g., 'reader') to a user or group for a file. This is a simplified alternative to the comprehensive `create_file_permission` function, focusing only on the core arguments required for basic sharing operations and omitting advanced options like notification settings or ownership transfer.
|
|
4699
|
-
|
|
4696
|
+
|
|
4700
4697
|
Args:
|
|
4701
4698
|
fileId (string): fileId
|
|
4702
4699
|
emailAddress (string): emailAddress Example: '{{currentEmailId}}'.
|
|
4703
4700
|
role (string): role Example: 'reader'.
|
|
4704
4701
|
type (string): type Example: 'user'.
|
|
4705
|
-
|
|
4702
|
+
|
|
4706
4703
|
Returns:
|
|
4707
4704
|
dict[str, Any]: Grant Google Drive Access
|
|
4708
|
-
|
|
4705
|
+
|
|
4709
4706
|
Raises:
|
|
4710
4707
|
HTTPError: Raised when the API request fails (e.g., non-2XX status code).
|
|
4711
4708
|
JSONDecodeError: Raised if the response body cannot be parsed as JSON.
|
|
4712
|
-
|
|
4709
|
+
|
|
4713
4710
|
Tags:
|
|
4714
4711
|
Google Drive API Use Cases, Share file access to a slack channel
|
|
4715
4712
|
"""
|