Add or Edit a Source
- Amazon S3 Source
- Box (Personal) Source
- Box Business V2 Source
- Box Business Legacy Source
- Confluence Cloud Source
- Confluence Legacy Source
- Confluence Self-Hosted Source
- Database Source
- Dropbox (Personal) Source
- Dropbox Business Source
- Exchange Enterprise Source
- Exchange Online (Personal) Source
- File System Source
- Generic REST API Source
- Gmail for Work Source
- Gmail (Personal) Source
- Google Drive (Personal) Source
- Google Drive for Work Source
- Jira Software Cloud Source
- Jira Software Self-Hosted Source
- Jive Cloud Source
- Jive Server Source
- Lithium Source
- Microsoft Dynamics Source
- OneDrive for Business Source
- Push Source
- RSS Source
- Salesforce Source
- SharePoint Online Source
- SharePoint Online Legacy Source
- SharePoint Server Source
- Sitecore Source
- Sitemap Source
- Twitter Source
- Web Source
- YouTube Source
- Zendesk Source
Add or Edit a Google Drive for Work Source
When you have the required privileges and a Google account with administrator credentials, you can add the content of your users Google Drive to your Coveo organization. This source can be shared or secured (see Source Permission Types). By default, your Google Drive for Work source starts a refresh every 15 minutes to index Google Drive file changes (additions, modifications, or deletions).
When you create the source, you authorize the Coveo Cloud organization to read your Google account using OAuth 2.0, a protocol that authorizes access without giving your password.
Source Features Summary
|Google Drive for Work version||Latest cloud version||Following available Google Drive for Work releases|
|Searchable content types1||Files, folders, comments and replies2, and user profiles|
Note 1: By default the Google Drive for Work source includes files of the My Drive folder for each user. Shared items are included with the associated permissions, so that who ever is authorized to see the items can find them in Coveo search results.
Note 2: The comments and replies are included in the
coveo.comments.authors metadata of their parent item rather than as separate items. This way, users can search for the content of a comment or reply and find the parent item.
Before configuring your source, you must ensure that your Google Drive instance is ready to work with Coveo Cloud.
Authorize Your Coveo Cloud organization to Access the Google Drive of Your Users
Create a Google API Console project (see Authorizing the Coveo Connector to Access Your Google Drive).
Modify security parameters in your Google Apps account (see Authorizing the Coveo Connector to Access Your Google Apps for Work).
Add or Edit a Google Drive for Work Source
Ensure your Google Drive for Work server instance meets the source requirements (see Requirements).
If not already in the Add/Edit a Google Drive for Work Source panel, go to the panel:
To add a source, in the main menu, under Content, select Sources > Add Source button > Google Drive > Google Drive for Work.
To edit a source, in the main menu, under Content, select Sources > source row > Edit in the Action bar.
In the Configuration tab, enter appropriate values for the available parameters:
A descriptive name for your source under 255 characters (not already in use for another source in this organization).
Google Apps domain
The Google Drive domain that you want to index.
Google Apps administrator account email
The email of a Google Apps administrator account in the
The email does NOT end in
Google Service account email
The Google service account email address previously obtained (see Authorizing the Coveo Connector to Access Your Google Drive).
Private key file
Click Choose File, and select the private key file that you previously created (see Authorizing the Coveo Connector to Access Your Google Drive).
Users to include
The email of users whose Google Drive content you want to include, separated by a semicolon. By default, the Google Drive content of all your domain users is included.
When you want users to be included as separate items, add the
IndexUsershidden parameter and set it to
truein the source JSON configuration (see Source JSON Modification Examples). The default value is
Select who can see any Google Drive item from this source in the returned search results (see Source Permission Types):
Secured - Only the identity with the right permissions on the source content
Shared - Everyone
Select this option checkbox when you want to include the items in the chosen Google Drive for Work trash.
Select this option checkbox when you want to include custom properties that Google applications or your custom applications added on items.
Including custom properties significantly increases communication traffic between the source and the Google Drive. This, in turn, significantly increases crawling time.
- In the Access tab, determine whether each group and API key can view or edit the source configuration:
- In the Access Level column, select View or Edit for each available group.
- On the left-hand side of the tab, if available, click Groups or API Keys to switch lists.
If you remove the Edit access level from all the groups of which you are a member, you will not be able to edit the source again after saving. Only administrators and members of other groups that have Edit access on this resource will be able to do so. To keep your ability to edit this resource, you must grant the Edit access level to at least one of your groups.
Optionally, consider editing or adding mappings (see Manage Source Mappings).
You can only manage mapping rules once you build the source (see Add or Edit a Source).
Complete your source addition or edition:
Click Add Source/Save when you want to save your source configuration changes without starting a build/rebuild, such as when you know you want to do other changes soon.
In the Sources page, you must click Start initial build or Start required rebuild in the source Status column to add the source content or make your changes effective, respectively.
Click Add and Build Source/Save and Rebuild Source when you are done editing the source and want to make changes effective.
Back in the Coveo Cloud administration console Sources page, you can review the progress of your Google Drive for Work source addition or modification (see Manage Sources).
Once the source is built or rebuilt, you can review its content in the content browser (see Inspect Items With the Content Browser).
Review the default refresh schedule in which a source refresh starts every 15 minutes (see Edit a Source Schedule).