Google Drive connector schema

Reference for every field in the Google Drive native connector configuration JSON.

Overview

This page documents each property in the Google Drive connector config. For guidance on how to use these settings, see Google Drive native connector. Full endpoint details live in the API Reference.

Config

Property	Description	Type	Default
`Credentials`	The credentials used to access the Google Drive API. Once supplied, these values are encrypted and moved into the `EncryptedCredentials` property.	Object (JsonCredentialParameters)
`EncryptedCredentials`	The encrypted credentials supplied via the `Credentials` property.	Object (JsonCredentialParameters)
`DocumentLevelSecurityEnabled`	Set to `true` to apply permissions to the synchronised content.	Boolean	`True`
`UseDomainWideDelegation`	Set to `true` to indicate that the credentials have domain-wide delegation enabled and the service account can impersonate users to synchronise their individual drives.	Boolean	`True`
`GoogleWorkspaceAdminImpersonationEmail`	Used for impersonation when synchronising users and groups.	String
`GoogleWorkspaceSharedDrivesImpersonationEmail`	Used for impersonation when synchronising shared drives.	String
`SynchroniseMyDrives`	Set to `true` to discover users and synchronise each of their My Drives.	Boolean	`True`
`MyDriveFilters`	Options for choosing which users' drives are synchronised.	Object (ItemFilters)
`FacetTypeNameMappings`	A collection of Google Drive entity facet type name mappings. If none are supplied, the defaults are used.	Object (FacetTypeNameMapping)
`TaxonomyTypeNameMappings`	A collection of standard taxonomy field mappings for default metadata associated with synchronised entities. If none are supplied, the defaults are used.	Object (TaxonomyTypeNameMapping)
`Icons`	Overrides which icons are used during indexing for different Google Drive entity types and file types.	Object (IconSources)
`UserLookupDomainReplacement`	Replaces the domain in the user email address with another domain, which is then used to look up the user within the intranet.	Object (UserLookupDomainReplacement)
`IsEnabled`	Set to `true` for this connector synchronisation to be performed.	Boolean	`True`
`LogEventLevel`	The logging level for log messages. Values: `Verbose`, `Debug`, `Information`, `Warning`, `Error`.	Enum	`Information`
`PerformUserAccessControlDigestion`	Set to `true` for this connector to perform user external identities synchronisation.	Boolean	`True`
`PerformDocsDigestion`	Set to `true` for this connector to perform docs synchronisation.	Boolean	`True`

JsonCredentialParameters

Property	Type
`type`	String
`project_id`	String
`quota_project_id`	String
`client_id`	String
`client_secret`	String
`client_email`	String
`private_key`	String
`private_key_id`	String
`refresh_token`	String

ItemFilters

Property	Description	Type	Default
`Mode`	Values: `All`, `Specific`.	Enum	`Specific`
`AllModeOptions`		Object (AllItemsFilterOptions)
`SpecificModeOptions`		Object (SpecificItemsFilterOptions)

FacetTypeNameMapping

Property	Description	Type	Default
`Type`	The Google Drive entity type these settings apply to. Values: `Drive`, `Folder`, `File`, `Site`.	Enum	`Drive`
`Name`	The custom name to use for this Google Drive entity type.	String

TaxonomyTypeNameMapping

Property	Description	Type	Default
`Type`	The taxonomy type these settings apply to. Values: `Drive`, `DriveFileType`, `FileExtension`, `Directory`.	Enum	`Drive`
`Name`	The custom name for this taxonomy type, that is, how it appears in your intranet.	String

IconSources

Property	Description	Type
`Drive`	Overrides the default icon used for Google Drives during indexing.	Object (IconSource)
`Sheets`	Overrides the default icon used for Google Sheets during indexing.	Object (IconSource)
`Docs`	Overrides the default icon used for Google Docs during indexing.	Object (IconSource)
`Slides`	Overrides the default icon used for Google Slides during indexing.	Object (IconSource)
`Folder`	Overrides the default icon used for Google Drive folders during indexing.	Object (IconSource)
`Site`	Overrides the default icon used for Google Drive sites during indexing.	Object (IconSource)
`File`	Overrides the default icon used for Google Drive files during indexing. This is the fallback icon for a file that is not a Google Docs, Sheets, or Slides file, or when an icon is not configured for the file extension.	Object (IconSource)
`FileExtensions`	Configures the icon used per file extension, for files that are not Google Docs, Sheets, or Slides.	Object (FileExtensionIconSource)

UserLookupDomainReplacement

Property	Description	Type
`OriginalDomain`	The domain to match in the user email address.	String
`ReplacementDomain`	What the original domain is replaced with in the user email address.	String

AllItemsFilterOptions

Property	Type
`Disallowed`	Array (String)

SpecificItemsFilterOptions

Property	Type
`Allowed`	Array (String)

IconSource

Property	Description	Type
`Url`	If provided, this URL is used for the icon. If both `Url` and `AssetId` are provided, `Url` is used.	String
`AssetId`	If provided, this asset ID is used for the icon. If both `Url` and `AssetId` are provided, `Url` is used.	String

FileExtensionIconSource

Property	Description	Type
`FileExtensions`	A comma-delimited list of file extensions these settings apply to, for example `.png,.jpg`.	String
`Url`	If provided, this URL is used for the icon. If both `Url` and `AssetId` are provided, `Url` is used.	String
`AssetId`	If provided, this asset ID is used for the icon. If both `Url` and `AssetId` are provided, `Url` is used.	String

Section: Workplace Search