Google Drive search docs (#398)

evantahler · web-flow · commit c3083e3f72c0 · 2025-08-06T18:41:20.000-07:00
* Google Drive search docs

* remove dupe page

* delete old examples

* fix links
diff --git a/pages/toolkits/productivity/google_drive.mdx b/pages/toolkits/productivity/google_drive.mdx
@@ -1,4 +1,4 @@
-# Google Drive
+# GoogleDrive
 
 import ToolInfo from "@/components/ToolInfo";
 import Badges from "@/components/Badges";
@@ -7,39 +7,37 @@ import TableOfContents from "@/components/TableOfContents";
 import ToolFooter from "@/components/ToolFooter";
 
 <ToolInfo
-  description="Enable agents to interact with Google Drive."
+  description="Enable agents to interact with GoogleDrive"
   author="Arcade"
-  codeLink="https://github.com/ArcadeAI/arcade-ai/tree/main/toolkits/google_drive"
-  authType="oauth2"
-  authProviderName="Google"
-  versions={["0.1.0"]}
+  authType="OAuth2"
+  versions={["3.0.0"]}
 />
 
-
 <Badges repo="arcadeai/arcade_google_drive" />
 
-The Arcade Google Drive toolkit provides a pre-built set of tools for interacting with Google Drive. These tools make it easy to build agents and AI apps that can:
+The GoogleDrive toolkit provides a set of tools for interacting with Google Drive, enabling users to efficiently manage and access their files. With this toolkit, users can:
 
-- Search Google documents in the user's Google Drive
-- Search and retrieve the contents of Google documents in the user's Google Drive
+- Retrieve the file and folder structure of their Google Drive.
+- Generate a Google File Picker URL for user-driven file selection and authorization, allowing secure access to files.
+- Search for specific files within Google Drive.
 
 ## Available Tools
 
-These tools are currently available in the Arcade Google Drive toolkit.
-
 <TableOfContents
   headers={["Tool Name", "Description"]}
-  data={[
-    ["GoogleDrive.GetFileTreeStructure", "Get the file/folder tree structure of the user's Google Drive."],
-    ["GoogleDrive.GenerateGoogleFilePickerUrl", "Generate a Google File Picker URL for user-driven file selection and authorization"],
-  ]}
+  data={
+    [
+      ["GoogleDrive.GetFileTreeStructure", "Get the file/folder tree structure of the user's Google Drive."],
+      ["GoogleDrive.GenerateGoogleFilePickerUrl", "Generate a Google File Picker URL for user-driven file selection and authorization."],
+      ["GoogleDrive.SearchFiles", "Search for files in Google Drive"],
+    ]
+  }
 />
 
 <Tip>
   If you need to perform an action that's not listed here, you can [get in touch
   with us](mailto:contact@arcade.dev) to request a new tool, or [create your
-  own tools](/home/build-tools/create-a-toolkit) with the [Google auth
-  provider](/home/auth-providers/google#using-google-auth-in-custom-tools).
+  own tools](/home/build-tools/create-a-toolkit).
 </Tip>
 
 ## GoogleDrive.GetFileTreeStructure
@@ -50,24 +48,23 @@ These tools are currently available in the Arcade Google Drive toolkit.
     {
       label: "Call the Tool with User Authorization",
       content: {
-        Python: [
-          "/examples/integrations/toolkits/google/drive/get_file_tree_structure_example_call_tool.py",
-        ],
-        JavaScript: ["/examples/integrations/toolkits/google/drive/get_file_tree_structure_example_call_tool.js"],
+        Python: ["/examples/integrations/toolkits/google_drive/get_file_tree_structure_example_call_tool.py"],
+        JavaScript: ["/examples/integrations/toolkits/google_drive/get_file_tree_structure_example_call_tool.js"],
       },
-    }
+    },
   ]}
 />
 
 Get the file/folder tree structure of the user's Google Drive.
 
 **Parameters**
 
-- **`include_shared_drives`** _(bool, optional)_ Whether to include shared drives in the file tree structure. Defaults to False.
-- **`restrict_to_shared_drive_id`** _(str, optional)_ If provided, only include files from this shared drive in the file tree structure. Defaults to None, which will include files and folders from all drives.
-- **`include_organization_domain_documents`** _(bool, optional)_ Whether to include documents from the organization's domain. This is applicable to admin users who have permissions to view organization-wide documents in a Google Workspace account. Defaults to False.
-- **`order_by`** _(enum ([OrderBy](#orderby)), optional)_ Sort order. Defaults to listing the most recently modified documents first.
-- **`limit`** _(int, optional)_ The number of files and folders to list. Defaults to None, which will list all files and folders.
+- **include_shared_drives** (`boolean`, optional) Whether to include shared drives in the file tree structure. Defaults to False.
+- **restrict_to_shared_drive_id** (`string`, optional) If provided, only include files from this shared drive in the file tree structure. Defaults to None, which will include files and folders from all drives.
+- **include_organization_domain_documents** (`boolean`, optional) Whether to include documents from the organization's domain. This is applicable to admin users who have permissions to view organization-wide documents in a Google Workspace account. Defaults to False.
+- **order_by** (`Enum` [OrderBy](/toolkits/productivity/google_drive/reference#OrderBy), optional) Sort order. Defaults to listing the most recently modified documents first
+- **limit** (`integer`, optional) The number of files and folders to list. Defaults to None, which will list all files and folders.
+
 
 ## GoogleDrive.GenerateGoogleFilePickerUrl
 
@@ -77,63 +74,52 @@ Get the file/folder tree structure of the user's Google Drive.
     {
       label: "Call the Tool with User Authorization",
       content: {
-        Python: [
-          "/examples/integrations/toolkits/google/drive/generate_google_file_picker_url_example_call_tool.py",
-        ],
-        JavaScript: ["/examples/integrations/toolkits/google/drive/generate_google_file_picker_url_example_call_tool.js"],
+        Python: ["/examples/integrations/toolkits/google_drive/generate_google_file_picker_url_example_call_tool.py"],
+        JavaScript: ["/examples/integrations/toolkits/google_drive/generate_google_file_picker_url_example_call_tool.js"],
       },
-    }
+    },
   ]}
 />
 
 Generate a Google File Picker URL for user-driven file selection and authorization.
 
-This tool generates a URL that directs the end-user to a Google File Picker interface where
-where they can select or upload Google Drive files. Users can grant permission to access their
-Drive files, providing a secure and authorized way to interact with their files.
+**Parameters**
 
-This is particularly useful when prior tools (e.g., those accessing or modifying
-Google Docs, Google Sheets, etc.) encountered failures due to file non-existence
-(Requested entity was not found) or permission errors. Once the user completes the file
-picker flow, the prior tool can be retried.
+This tool does not take any parameters.
 
-## Auth
+## GoogleDrive.SearchFiles
 
-The Arcade Google Drive toolkit uses the [Google auth provider](/home/auth-providers/google) to connect to users' Google accounts.
+<br />
+<TabbedCodeBlock
+  tabs={[
+    {
+      label: "Call the Tool with User Authorization",
+      content: {
+        Python: ["/examples/integrations/toolkits/google_drive/search_files_example_call_tool.py"],
+        JavaScript: ["/examples/integrations/toolkits/google_drive/search_files_example_call_tool.js"],
+      },
+    },
+  ]}
+/>
 
-With the hosted Arcade Engine, there's nothing to configure. Your users will see `Arcade` as the name of the application that's requesting permission.
+Search for files in Google Drive
 
-With a self-hosted installation of Arcade, you need to [configure the Google auth provider](/home/auth-providers/google#configuring-google-auth) with your own Google app credentials.
+**Parameters**
+
+- **query** (`string`, required) The search query to use to find files in Google DriveThis can include document titles or body content.
+- **include_shared_drives** (`boolean`, optional) Whether to include shared drives in the search. Defaults to False.
+- **restrict_to_shared_drive_id** (`string`, optional) If provided, only search files from this shared drive. Defaults to None, which will search files from all drives.
+- **include_organization_domain_documents** (`boolean`, optional) Whether to include documents from the organization's domain. This is applicable to admin users who have permissions to view organization-wide documents in a Google Workspace account. Defaults to False.
+- **order_by** (`Enum` [OrderBy](/toolkits/productivity/google_drive/reference#OrderBy), optional) Sort order for search results. Defaults to listing the most recently modified documents first
+- **limit** (`integer`, optional) The maximum number of search results to return. Defaults to 50.
+- **file_types** (`Enum` [GoogleDriveFileType](/toolkits/productivity/google_drive/reference#GoogleDriveFileType), optional) Filter by specific file types. Defaults to None, which includes all file types.
 
----
 
-## Reference
 
-## OrderBy
 
-Sort keys for ordering files in Google Drive. Each key has both ascending and descending options.
+## Auth
 
-- **`CREATED_TIME`**: When the file was created (ascending).
-- **`CREATED_TIME_DESC`**: When the file was created (descending).
-- **`FOLDER`**: The folder ID, sorted using alphabetical ordering (ascending).
-- **`FOLDER_DESC`**: The folder ID, sorted using alphabetical ordering (descending).
-- **`MODIFIED_BY_ME_TIME`**: The last time the file was modified by the user (ascending).
-- **`MODIFIED_BY_ME_TIME_DESC`**: The last time the file was modified by the user (descending).
-- **`MODIFIED_TIME`**: The last time the file was modified by anyone (ascending).
-- **`MODIFIED_TIME_DESC`**: The last time the file was modified by anyone (descending).
-- **`NAME`**: The name of the file, sorted using alphabetical ordering (ascending).
-- **`NAME_DESC`**: The name of the file, sorted using alphabetical ordering (descending).
-- **`NAME_NATURAL`**: The name of the file, sorted using natural sort ordering (ascending).
-- **`NAME_NATURAL_DESC`**: The name of the file, sorted using natural sort ordering (descending).
-- **`QUOTA_BYTES_USED`**: The number of storage quota bytes used by the file (ascending).
-- **`QUOTA_BYTES_USED_DESC`**: The number of storage quota bytes used by the file (descending).
-- **`RECENCY`**: The most recent timestamp from the file's date-time fields (ascending).
-- **`RECENCY_DESC`**: The most recent timestamp from the file's date-time fields (descending).
-- **`SHARED_WITH_ME_TIME`**: When the file was shared with the user, if applicable (ascending).
-- **`SHARED_WITH_ME_TIME_DESC`**: When the file was shared with the user, if applicable (descending).
-- **`STARRED`**: Whether the user has starred the file (ascending).
-- **`STARRED_DESC`**: Whether the user has starred the file (descending).
-- **`VIEWED_BY_ME_TIME`**: The last time the file was viewed by the user (ascending).
-- **`VIEWED_BY_ME_TIME_DESC`**: The last time the file was viewed by the user (descending).
+The Arcade GoogleDrive toolkit uses the [Google auth provider](/home/auth-providers/google) to connect to users' GoogleDrive accounts. Please refer to the [Google auth provider](/home/auth-providers/google) documentation to learn how to configure auth.
 
 <ToolFooter pipPackageName="arcade_google_drive" />
+
diff --git a/pages/toolkits/productivity/google_drive/reference.mdx b/pages/toolkits/productivity/google_drive/reference.mdx
@@ -0,0 +1,45 @@
+# GoogleDrive Reference
+
+Below is a reference of enumerations used by some tools in the GoogleDrive toolkit:
+
+## OrderBy
+
+- **CREATED_TIME**: `createdTime`
+- **CREATED_TIME_DESC**: `createdTime desc`
+- **FOLDER**: `folder`
+- **FOLDER_DESC**: `folder desc`
+- **MODIFIED_BY_ME_TIME**: `modifiedByMeTime`
+- **MODIFIED_BY_ME_TIME_DESC**: `modifiedByMeTime desc`
+- **MODIFIED_TIME**: `modifiedTime`
+- **MODIFIED_TIME_DESC**: `modifiedTime desc`
+- **NAME**: `name`
+- **NAME_DESC**: `name desc`
+- **NAME_NATURAL**: `name_natural`
+- **NAME_NATURAL_DESC**: `name_natural desc`
+- **QUOTA_BYTES_USED**: `quotaBytesUsed`
+- **QUOTA_BYTES_USED_DESC**: `quotaBytesUsed desc`
+- **RECENCY**: `recency`
+- **RECENCY_DESC**: `recency desc`
+- **SHARED_WITH_ME_TIME**: `sharedWithMeTime`
+- **SHARED_WITH_ME_TIME_DESC**: `sharedWithMeTime desc`
+- **STARRED**: `starred`
+- **STARRED_DESC**: `starred desc`
+- **VIEWED_BY_ME_TIME**: `viewedByMeTime`
+- **VIEWED_BY_ME_TIME_DESC**: `viewedByMeTime desc`
+
+## GoogleDriveFileType
+
+- **SPREADSHEET**: `spreadsheet`
+- **SLIDES**: `slides`
+- **DOCUMENT**: `document`
+- **DRAWING**: `drawing`
+- **FORM**: `form`
+- **FOLDER**: `folder`
+- **IMAGE**: `image`
+- **VIDEO**: `video`
+- **AUDIO**: `audio`
+- **SCRIPT**: `script`
+- **SITES**: `sites`
+- **PDF**: `pdf`
+
+
diff --git a/public/examples/integrations/toolkits/google_drive/generate_google_file_picker_url_example_call_tool.js b/public/examples/integrations/toolkits/google_drive/generate_google_file_picker_url_example_call_tool.js
@@ -6,10 +6,7 @@ const USER_ID = "{arcade_user_id}";
 const TOOL_NAME = "GoogleDrive.GenerateGoogleFilePickerUrl";
 
 // Start the authorization process
-const authResponse = await client.tools.authorize({
-  tool_name: TOOL_NAME,
-  user_id: USER_ID,
-});
+const authResponse = await client.tools.authorize({tool_name: TOOL_NAME});
 
 if (authResponse.status !== "completed") {
   console.log(`Click this link to authorize: ${authResponse.url}`);
@@ -26,4 +23,4 @@ const response = await client.tools.execute({
   user_id: USER_ID,
 });
 
-console.log(response);
+console.log(JSON.stringify(response.output.value, null, 2));
diff --git a/public/examples/integrations/toolkits/google_drive/generate_google_file_picker_url_example_call_tool.py b/public/examples/integrations/toolkits/google_drive/generate_google_file_picker_url_example_call_tool.py
@@ -1,26 +1,26 @@
+import json
 from arcadepy import Arcade
 
 client = Arcade()  # Automatically finds the `ARCADE_API_KEY` env variable
 
 USER_ID = "{arcade_user_id}"
 TOOL_NAME = "GoogleDrive.GenerateGoogleFilePickerUrl"
 
-auth_response = client.tools.authorize(
-    tool_name=TOOL_NAME,
-    user_id=USER_ID,
-)
+auth_response = client.tools.authorize(tool_name=TOOL_NAME)
 
 if auth_response.status != "completed":
     print(f"Click this link to authorize: {auth_response.url}")
 
 # Wait for the authorization to complete
 client.auth.wait_for_completion(auth_response)
 
-tool_input = {}
+tool_input = {
+    
+}
 
 response = client.tools.execute(
     tool_name=TOOL_NAME,
     input=tool_input,
     user_id=USER_ID,
 )
-print(response)
+print(json.dumps(response.output.value, indent=2))
diff --git a/public/examples/integrations/toolkits/google_drive/get_file_tree_structure_example_call_tool.js b/public/examples/integrations/toolkits/google_drive/get_file_tree_structure_example_call_tool.js
@@ -6,10 +6,7 @@ const USER_ID = "{arcade_user_id}";
 const TOOL_NAME = "GoogleDrive.GetFileTreeStructure";
 
 // Start the authorization process
-const authResponse = await client.tools.authorize({
-  tool_name: TOOL_NAME,
-  user_id: USER_ID,
-});
+const authResponse = await client.tools.authorize({tool_name: TOOL_NAME});
 
 if (authResponse.status !== "completed") {
   console.log(`Click this link to authorize: ${authResponse.url}`);
@@ -19,8 +16,12 @@ if (authResponse.status !== "completed") {
 await client.auth.waitForCompletion(authResponse);
 
 const toolInput = {
-  include_shared_drives: true,
-  limit: 10,
+  "include_shared_drives": true,
+  "restrict_to_shared_drive_id": "abc123",
+  "order_by": [
+    "name"
+  ],
+  "limit": 10
 };
 
 const response = await client.tools.execute({
@@ -29,4 +30,4 @@ const response = await client.tools.execute({
   user_id: USER_ID,
 });
 
-console.log(response);
+console.log(JSON.stringify(response.output.value, null, 2));
diff --git a/public/examples/integrations/toolkits/google_drive/get_file_tree_structure_example_call_tool.py b/public/examples/integrations/toolkits/google_drive/get_file_tree_structure_example_call_tool.py
@@ -1,14 +1,12 @@
+import json
 from arcadepy import Arcade
 
 client = Arcade()  # Automatically finds the `ARCADE_API_KEY` env variable
 
 USER_ID = "{arcade_user_id}"
 TOOL_NAME = "GoogleDrive.GetFileTreeStructure"
 
-auth_response = client.tools.authorize(
-    tool_name=TOOL_NAME,
-    user_id=USER_ID,
-)
+auth_response = client.tools.authorize(tool_name=TOOL_NAME)
 
 if auth_response.status != "completed":
     print(f"Click this link to authorize: {auth_response.url}")
@@ -17,13 +15,15 @@
 client.auth.wait_for_completion(auth_response)
 
 tool_input = {
-    "include_shared_drives": True,
-    "limit": 10,
+    'include_shared_drives': True,
+    'restrict_to_shared_drive_id': 'abc123',
+    'order_by': ['name'],
+    'limit': 10
 }
 
 response = client.tools.execute(
     tool_name=TOOL_NAME,
     input=tool_input,
     user_id=USER_ID,
 )
-print(response)
+print(json.dumps(response.output.value, indent=2))
diff --git a/public/examples/integrations/toolkits/google_drive/search_files_example_call_tool.js b/public/examples/integrations/toolkits/google_drive/search_files_example_call_tool.js
@@ -0,0 +1,34 @@
+import { Arcade } from "@arcadeai/arcadejs";
+
+const client = new Arcade(); // Automatically finds the `ARCADE_API_KEY` env variable
+
+const USER_ID = "{arcade_user_id}";
+const TOOL_NAME = "GoogleDrive.SearchFiles";
+
+// Start the authorization process
+const authResponse = await client.tools.authorize({tool_name: TOOL_NAME});
+
+if (authResponse.status !== "completed") {
+  console.log(`Click this link to authorize: ${authResponse.url}`);
+}
+
+// Wait for the authorization to complete
+await client.auth.waitForCompletion(authResponse);
+
+const toolInput = {
+  "query": "project report",
+  "include_shared_drives": true,
+  "limit": 10,
+  "file_types": [
+    "document",
+    "spreadsheet"
+  ]
+};
+
+const response = await client.tools.execute({
+  tool_name: TOOL_NAME,
+  input: toolInput,
+  user_id: USER_ID,
+});
+
+console.log(JSON.stringify(response.output.value, null, 2));
diff --git a/public/examples/integrations/toolkits/google_drive/search_files_example_call_tool.py b/public/examples/integrations/toolkits/google_drive/search_files_example_call_tool.py
