Prerequisites
- Drive folder link - The link to the Google Drive folder you want to sync files from (includes files located in subfolders)
- A GCP project
- Enable the Google Drive API in your GCP project
- Service Account Key with access to the Google Drive folder you want to synchronize
Setup guide
The Google Drive source connector supports authentication Service Account Key Authentication.Set up the service account key
Create a service account
- Open the Service Accounts page in your Google Cloud console.
- Select an existing project, or create a new project.
- At the top of the page, click + Create service account.
- Enter a name and description for the service account, then click Create and Continue.
- Under Service account permissions, select the roles to grant to the service account, then click Continue. We recommend the Viewer role.
Generate a key
- Go to the API Console/Credentials page and click on the email address of the service account you just created.
- In the Keys tab, click + Add key, then click Create new key.
- Select JSON as the Key type. This will generate and download the JSON key file that you’ll use for authentication. Click Continue.
Enable the Google Drive API
- Go to the API Console/Library page.
- Make sure you have selected the correct project from the top.
- Find and select the Google Drive API.
- Click ENABLE.
If your folder is viewable by anyone with its link, no further action is needed. If not, give your Service account access to your folder. Check out this video for how to do this.
In the Paradigm admin
Datasource Configuration
- Navigate to the DATASOURCES section in your Paradigm admin interface
- Create a new Datasource with Datasource type = Google Drive
- Add your Google Cloud service account key in JSON format:
- For Folder Link, enter the link to the Google Drive folder. To get the link, navigate to the folder you want to sync in the Google Drive UI, and copy the current URL.
-
Configure the optional Start Date parameter that marks a starting date and time in UTC for data replication. Any files that have not been modified since this specified date/time will not be replicated. Use the provided datepicker (recommended) or enter the desired date programmatically in the format
YYYY-MM-DDTHH:mm:ssZ
. Leaving this field blank will replicate data from all files that have not been excluded by the Path Pattern and Path Prefix. - Click Set up source and wait for the tests to complete.
Authentication Method
Service Account Key Authentication
- Uses JSON key file generated from Google Cloud Console
- Provides secure access to Google Drive folders
- Requires proper role assignment (Viewer role recommended)
- Service account must have access to the target Google Drive folder
File Synchronization Details
Included Content
- All files in the specified folder
- Files in all subfolders (recursive sync)
- Only supported file types are processed
- Files within size limits are included
Excluded Content
- Unsupported file types are automatically excluded
- Files that exceed size limits are skipped
- Files can be filtered using Path Pattern and Path Prefix settings
Troubleshooting
Common Issues
Authentication Errors- Verify the service account JSON key is correctly formatted
- Ensure the service account has the necessary permissions
- Check that the Google Drive API is enabled for your project
- Confirm the service account has access to the target folder
- For private folders, explicitly share the folder with the service account email
- Verify folder permissions and sharing settings
- Check the folder link format is correct
- Verify the Start Date parameter if used
- Review file type and size limitations