Google Drive

Google Drive logo

Google Drive

Configuration

Google Drive source connector integrates with the Google Drive API to extract files.

Supports both personal Google Drive (My Drive) and shared drives.

It supports downloading and processing files while maintaining proper organization and access permissions.

Authentication

This connector uses OAuth 2.0 with custom credentials. You need to provide your OAuth application’s Client ID and Client Secret, then complete the OAuth consent flow.

OAuth Setup Required
  1. Create an OAuth application in your provider’s developer console
  2. Enter your Client ID and Client Secret when configuring the connection
  3. Complete the OAuth consent flow

Configuration Options

The following configuration options are available for this connector:

Configuration Parameters

Google Drive configuration schema.

include_patterns
list[str]Defaults to []

List of file/folder paths to include in synchronization. Examples: ‘my_folder/*’, ‘my_folder/my_file.pdf’. Separate multiple patterns with commas. If empty, all files are included.

Data Models

The following data models are available for this connector:

Schema for a Drive resource (shared drive).

Reference: https://developers.google.com/drive/api/v3/reference/drives

FieldTypeDescription
drive_idstrUnique identifier for the shared drive.
titlestrDisplay name of the shared drive.
created_timeOptional[datetime]Creation timestamp of the shared drive.
kindOptional[str]Identifies what kind of resource this is; typically “drive#drive”.
color_rgbOptional[str]The color of this shared drive as an RGB hex string.
hiddenboolWhether the shared drive is hidden from default view.
org_unit_idOptional[str]The organizational unit of this shared drive, if applicable.

Schema for a File resource (in a user’s or shared drive).

Reference: https://developers.google.com/drive/api/v3/reference/files

FieldTypeDescription
file_idstrUnique identifier for the file.
titlestrDisplay title of the file.
created_timedatetimeTimestamp when the file was created.
modified_timedatetimeTimestamp when the file was last modified.
descriptionOptional[str]Optional description of the file.
starredboolIndicates whether the user has starred the file.
trashedboolWhether the file is in the trash.
explicitly_trashedboolWhether the file was explicitly trashed by the user.
parentsList[str]IDs of the parent folders containing this file.
ownersList[Any]Owners of the file.
sharedboolWhether the file is shared.
web_view_linkOptional[str]Link for opening the file in a relevant Google editor or viewer.
icon_linkOptional[str]A static, far-reaching URL to the file’s icon.
md5_checksumOptional[str]MD5 checksum for the content of the file.
shared_with_me_timeOptional[datetime]Time when this file was shared with the user.
modified_by_me_timeOptional[datetime]Last time the user modified the file.
viewed_by_me_timeOptional[datetime]Last time the user viewed the file.

Deletion signal for a Google Drive file.

FieldTypeDescription
file_idstrID of the file that was deleted.
labelstrHuman-readable deletion label.
drive_idOptional[str]Drive identifier that contained the file.

Integrate Airweave with Google APIs on localhost

This guide will walk you through connecting Google Workspace APIs to Airweave when running locally. Google provides extensive documentation on setting up your workspace. Below is a streamlined process for connecting Google APIs to Airweave.

  1. Create a Google Cloud project for your Google Workspace (if you don’t already have one)
  2. Enable the Google Workspace APIs for Gmail, Google Calendar, and Google Drive
  3. Configure Google OAuth 2.0 consent screen
  4. Under Audience, select Make external and add test users
  5. Under Data Access, add the following scopes:
https://www.googleapis.com/auth/docs
https://www.googleapis.com/auth/drive.photos.readonly
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive.metadata
https://www.googleapis.com/auth/drive.metadata.readonly
https://www.googleapis.com/auth/gmail.readonly
https://www.googleapis.com/auth/calendar.events.public.readonly
https://www.googleapis.com/auth/calendar.freebusy
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar.calendars.readonly
https://www.googleapis.com/auth/calendar.events.owned.readonly
https://www.googleapis.com/auth/calendar.events.readonly
  1. Create OAuth client ID credentials

  2. Under “Authorized redirect URIs,” click ”+ Add URI” and add the Redirect URI. Use the appropriate URL for your environment: Production (Airweave Cloud):

    https://api.airweave.ai/source-connections/callback

    Local:

    http://localhost:8001/source-connections/callback
  3. Locate the client ID and client secret from your newly created OAuth client. Add these credentials to the dev.integrations.yml file to enable Google API integration.