Google Drive Integration with Orkes Conductor

Available since

• v5.3.0 and later

Integrating Google Drive with Orkes Conductor lets you build workflows that interact with your Drive files and folders using the following operations:

• Create Folder
• Delete Folder
• Share Folder
• Upload File from Base64
• Download File Base64
• Create File from Text
• Create Google Doc
• Copy File
• Update File
• Move File
• Share File
• List Files
• Delete File
• Search Files and Folders
• Create Shared Drive
• Update Shared Drive
• Get Shared Drive
• Get Many Shared Drives
• Delete Shared Drive

This guide explains how to set up and use the integration. Here’s an overview:

1. Get the required credentials from Google Console.
2. Configure a new Google Drive integration in Orkes Conductor.
3. Use Google Drive integration in workflows.

Step 1: Get the Google Console credentials

To integrate Google Drive with Orkes Conductor, retrieve the OAuth client ID and secret from the Google console, and enable the Google Drive API.

Get OAuth Client credentials

To get the credentials:

1. Go to the Google Cloud Console.
2. Select your project or create a new one.
3. In the left navigation menu, go to APIs & Services > Credentials
4. Select + Create credentials > OAuth client ID.

5. Choose your application type as Web application, and enter a Name.
6. In Authorized redirect URIs, select +Add URI and enter your redirect URI in the format https://<YOUR-CONDUCTOR-CLUSTER-NAME>/integrations/oauth/callback.
7. Select + Create.
8. Note the generated OAuth Client ID and secret, or download and save the JSON.

Enable Google Drive API

To enable Google Drive API access:

1. Go to APIs & Services > Enabled APIs & services.
2. Select + Enable APIs and services.
3. Search for Google Drive API and enable it.

Step 2: Add an integration for Google Drive

After obtaining the credentials, add a Google Drive integration to your Conductor cluster.

To create an integration:

1. Go to Integrations > Connected Apps from the left navigation menu on your Conductor cluster.
2. Select + New integration.
3. In the Productivity section, choose Google Drive.
4. Select + Add and enter the following parameters:

Parameter	Description	Required/Optional
Integration name	A name for the integration.	Required.
Scope	The OAuth2 scope for Google Drive API access. The scope you select determines the level of access Google grants to the integration. Supported values: Read Only: Grants read-only access to files and metadata in Google Drive. File Access: Grants access to files created or opened by the integration. Full Access: Grants full access to all files in Google Drive.	Required.
OAuth Client ID	The OAuth client ID generated from Step 1.	Required.
OAuth Client Secret	The OAuth client secret generated from Step 1.	Required.
Parent Folder Id	The default parent folder ID to use within the integration. To get the folder ID, open the folder in Google Drive. The ID is the string of characters at the end of the URL: https://drive.google.com/drive/u/0/folders/<FOLDER-ID>?ths=true.	Optional.
Description	A description of the integration.	Required.

5. (Optional) Toggle the Active button off if you don’t want to activate the integration instantly.
6. Select Authorize.

This takes you to the Google sign-in page, where you can authorize the connection with your Google account. Once authorized, the integration is created successfully.

Step 3: Use Google Drive integration in workflows

Once the integration is ready, this can be used directly within the workflows.

To use Google Drive integration in a workflow:

1. Go to Definitions > Workflow from the left navigation menu on your Conductor cluster.
2. Select + Define workflow.
3. In your workflow, select the (+) icon and select Connected Apps.

4. In Add Task panel on the right, search for Google Drive, and select the integration created in Step 2.

The following operations are available for use with this integration.

Operation	Description	Supported Integration Scopes
Create Folder	Create a folder in Google Drive, optionally under a parent folder.	Full Access File Access
Delete Folder	Delete a folder by ID.	Full Access File Access
Share Folder	Share a folder with a user.	Full Access File Access
Upload File From Base64	Upload a file from base64-encoded content into Google Drive.	Full Access File Access
Download File Base64	Download a file's content as base64 by file ID.	Full Access File Access Read Only
Create File From Text	Create a new file in Drive from plain text content.	Full Access File Access
Create Google Doc	Create a Google Doc with a title and plain text content.	Full Access File Access
Copy File	Copy a file in Google Drive.	Full Access File Access
Update File	Update a file's metadata or content.	Full Access File Access
Move File	Move a file to another folder.	Full Access File Access
Share File	Share a file with a user.	Full Access File Access
List Files	Lists files from Google Drive matching the query.	Full Access File Access Read Only
Delete File	Delete a file by file ID.	Full Access File Access
Search Files and Folders	Search files and folders in Google Drive.	Full Access File Access Read Only
Create Shared Drive	Create a shared drive.	Full Access
Update Shared Drive	Update shared drive metadata.	Full Access
Get Shared Drive	Retrieve a shared drive by ID.	Full Access Read Only
Get Many Shared Drives	List shared drives available to the user.	Full Access Read Only
Delete Shared Drive	Delete a shared drive.	Full Access

5. Select the required operation, configure the parameters, and select Save > Confirm.
6. Select Execute to run the workflow.

For the complete operations parameters and output reference, see Google Drive Operations Reference.