### Step 2: Select a Service and Connector
From the service type dropdown, select **Drive Services**, then click the **Google Drive** connector tile.
### Step 3: Add Service Name and Description
* Enter a unique, descriptive **Service Name**. Collate identifies services by their service name. Enter a name that distinguishes this deployment from other Google Drive services you are ingesting metadata from.
* Optional: Enter a **Description** for the service.
#### Enter Connection Details
Enter the connection details for Google Drive. The right-hand panel in the UI displays inline help for each field.
* **GCP Credentials**: Provide the GCP credentials to access Google Drive API. You can provide the credentials in one of the following ways:
* **GCP Credentials Path**: Path to the GCP service account credentials JSON file
* **GCP Credentials Values**: Paste the content of the GCP service account credentials JSON file directly
* **Delegated Email (Optional)**: Email address to impersonate using domain-wide delegation. This is required if you want to access files owned by other users in your organization using domain-wide delegation.
* **Drive ID (Optional)**: Specific shared drive ID to connect to. If provided, only this shared drive will be processed. Leave empty to process all accessible drives.
* **Include Team Drives**: Enable to include shared/team drives in metadata extraction. Default is `true`.
* **Include Google Sheets**: Enable to extract metadata only for Google Sheets files. When enabled, only Google Sheets will be processed. Default is `false`.
* **Directory Filter Pattern (Optional)**: Regex pattern to include or exclude directories from metadata extraction.
* **File Filter Pattern (Optional)**: Regex pattern to include or exclude files from metadata extraction.
* **Spreadsheet Filter Pattern (Optional)**: Regex pattern to include or exclude spreadsheets from metadata extraction (only applies when Include Google Sheets is enabled).
* **Worksheet Filter Pattern (Optional)**: Regex pattern to include or exclude worksheets within spreadsheets from metadata extraction (only applies when Include Google Sheets is enabled).
#### Advanced Configuration
Drive Services have an Advanced Configuration section, where you can pass extra arguments to the connector and, if needed, change the connection Scheme. This would only be required to handle advanced connectivity scenarios or customizations.
* **Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to the source during the connection. These details must be added as Key-Value pairs.
* **Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent during the connection. These details must be added as Key-Value pairs.
### Step 5: Configure Ingestion Options
In the **What to Ingest** step, use filter patterns to control which assets Collate ingests from your drive service. Filter patterns use regular expressions applied to asset names.
#### How Filter Patterns Work
* **Include**: Add one or more comma-separated regular expressions. Collate ingests only assets whose names match at least one expression. Leave blank to include all assets.
* **Exclude**: Add one or more comma-separated regular expressions. Collate skips any asset whose name matches an expression. Leave blank to exclude nothing.
Rules match asset names using one of five expressions:
* **contains**: matches any name containing the value. For example, `sales` matches `my_sales_data` and `sales_2024`.
* **starts with**: matches names beginning with the value. For example, `prod_` matches `prod_db` and `prod_schema`.
* **ends with**: matches names ending with the value. For example, `_raw` matches `events_raw` and `logs_raw`.
* **is exactly**: matches the exact name only. For example, `analytics` matches only `analytics`.
* **matches regex**: matches names using a regular expression. For example, `^prod_.*_v\d+$` matches `prod_events_v1`.
When both Include and Exclude are set, Exclude takes priority.
For some services, the dropdown is not available and clicking **Add Agent** takes you directly to the agent configuration page.
4. On the **Configure Ingestion** page, do the following and click **Next**.
* **Name this Ingestion**: Enter a unique recognizable name for this ingestion pipeline.
* **Agent Setup**: Configure the core parameters for this agent. The following fields are available:
| Field | Default | Description |
| ------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Number of Threads | 1 | Number of threads to use for parallel drive ingestion. |
| Mark Deleted Directories | On | Soft-delete directories in Collate when they are removed from the source. Associated entities like files, spreadsheets, worksheets, and lineage are also deleted. |
| Mark Deleted Files | On | Soft-delete files in Collate when they are removed from the source. Associated entities like lineage are also deleted. |
| Mark Deleted Spreadsheets | On | Soft-delete spreadsheets in Collate when they are removed from the source. Associated entities like worksheets and lineage are also deleted. |
| Mark Deleted Worksheets | On | Soft-delete worksheets in Collate when they are removed from the source. Associated entities like lineage are also deleted. |
| Include Directories | On | Fetch directory metadata. Turn off to skip directories entirely. |
| Include Files | On | Fetch file metadata. Turn off to skip files entirely. |
| Include Spreadsheets | On | Fetch spreadsheet metadata. Turn off to skip spreadsheets entirely. |
| Include Worksheets | On | Fetch worksheet metadata. Turn off to skip worksheets entirely. |
* **Filter Patterns**: Apply include or exclude rules to scope which directories, files, spreadsheets, and worksheets this agent ingests. Use FQN for filtering to apply regex on fully qualified names (e.g. `service_name.directory_name.file_name`) instead of raw names. These follow the same filter options described in **Step 5**.
* **Scope & Behaviour**: Control what metadata to include and how to handle deletions. Toggle each option on or off based on your needs:
| Toggle | Default | Description |
| ----------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Enable Debug Log | Off | Sets the ingestion log level to DEBUG. Useful for troubleshooting. |
| Include Tags | On | Ingest tags from the source. |
| Include Owners | Off | Assign owners from the source when the owner email matches a Collate user. Does not overwrite an existing owner. |
| Override Metadata | Off | When on, source values overwrite existing descriptions, tags, owners, and display names in Collate. When off, Collate only updates fields that have no existing value. |
5. On the **Schedule Interval** page, set when the agent runs:
* **Schedule**: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression.
* **On-Demand**: No automatic schedule; trigger the agent manually when needed.
6. Click **Add** to deploy the agent.
## Troubleshooting