GuidesAPI Reference
Guides

Schema

Config

Credentials

The credentials used to access Google Drive API. Once supplied, these values will be encrypted and moved into the EncryptedCredentials property.

EncryptedCredentials

The encrypted credentials that were supplied via the Credentials property

DocumentLevelSecurityEnabled

Set to true to apply permissions to the synchronised content

  • Type: Boolean
  • Default: True

UseDomainWideDelegation

Set to true to indicate that the credentials have Domain Wide Delegation enabled and the service account is able to impersonate users to synchronise users individual drives

  • Type: Boolean
  • Default: True

GoogleWorkspaceAdminImpersonationEmail

Used for impersonation when synchronising users and groups

  • Type: String

GoogleWorkspaceSharedDrivesImpersonationEmail

Used for impersonation when synchronising shared drives

  • Type: String

SynchroniseMyDrives

Set to true to discover users and synchronise each of their my drives

  • Type: Boolean
  • Default: True

MyDriveFilters

Options for choosing which users drives should be synchronised or not

FacetTypeNameMappings

A collection of Google Drive entity facet type name mappings. If none are supplied then the defaults will be used.

TaxonomyTypeNameMappings

A collection of standard taxonomy field mappings for default meta data associated with synchronised entities. If none are supplied then the defaults will be used.

Icons

Can be used to override which icons should be used during indexing for different google drive entity types and file types

UserLookupDomainReplacement

Can be used to replace the domain in the user email address with another domain, which is then used to perform a lookup of the user within the intranet

IsEnabled

Set to true for this connector synchronisation to be performed

  • Type: Boolean
  • Default: True

LogEventLevel

The logging level for log messages to be recorded

  • Type: Enum
  • Values: Verbose, Debug, Information, Warning, Error, Fatal
  • Default: Information

PerformUserAccessControlDigestion

Set to true for this connector to perform user external identities synchronisation for this connector

  • Type: Boolean
  • Default: True

PerformDocsDigestion

Set to true for this connector to perform docs synchronisation for this connector

  • Type: Boolean
  • Default: True

JsonCredentialParameters

type

  • Type: String

project_id

  • Type: String

quota_project_id

  • Type: String

client_id

  • Type: String

client_secret

  • Type: String

client_email

  • Type: String

private_key

  • Type: String

private_key_id

  • Type: String

refresh_token

  • Type: String

ItemFilters

Mode

  • Type: Enum
  • Values: All, Specific
  • Default: Specific

AllModeOptions

SpecificModeOptions

FacetTypeNameMapping

Type

The Google Drive entity type that these settings apply to

  • Type: Enum
  • Values: Drive, Folder, File, Site
  • Default: Drive

Name

The custom name that you want to use for this Google Drive entity type

  • Type: String

TaxonomyTypeNameMapping

Type

The taxonomy type that these settings apply to

  • Type: Enum
  • Values: Drive, DriveFileType, FileExtension, Directory
  • Default: Drive

Name

The custom name for this taxonomy type. I.e. how you want this to appear in your intranet.

  • Type: String

IconSources

Drive

If provided will override the default icon used for Google Drives during indexing

Sheets

If provided will override the default icon used for Google Sheets during indexing

Docs

If provided will override the default icon used for Google Docs during indexing

Slides

If provided will override the default icon used for Google Slides during indexing

Folder

If provided will override the default icon used for Google Drive Folders during indexing

Site

If provided will override the default icon used for Google Drive Sites during indexing

File

If provided will override the default icon used for Google Drive Files during indexing. This is the fallback icon for the file, if it is not a Google Docs, Google Sheets or a Google Slides file, or if an icon is not configured for the file extension.

FileExtensions

Can be configured for each file exif it is not a Google Docs, Google Sheets or a Google Slides file, or if an icon is not configured for the file extension.

UserLookupDomainReplacement

OriginalDomain

The domain to match in the user email address

  • Type: String

ReplacementDomain

What the original domain should be replaced with in the user email address

  • Type: String

AllItemsFilterOptions

Disallowed

  • Type: Array (String)

SpecificItemsFilterOptions

Allowed

  • Type: Array (String)

IconSource

Url

If provided, then this url will be used for the icon. If both the Url and AssetId are provided, then the Url will be used.

  • Type: String

AssetId

If provided, then this asset id will be used for the icon. If both the Url and AssetId are provided, then the Url will be used.

  • Type: String

FileExtensionIconSource

FileExtensions

A comma delimetered list of file extensions that these settings apply to. E.g. '.png,.jpg'

  • Type: String

Url

If provided, then this url will be used for the icon. If both the Url and AssetId are provided, then the Url will be used.

  • Type: String

AssetId

If provided, then this asset id will be used for the icon. If both the Url and AssetId are provided, then the Url will be used.

  • Type: String

Updated 4 months ago