Google Drive

Node: googleDrive · Full type: n8n-nodes-base.googleDrive · Version: 3

Ergonomic keyword available: GDRIVE — see NFLOW.md for shorter syntax.

Credentials

googleApi (alias: @google) / googleDriveOAuth2Api (alias: @google)

CREDENTIAL @google = googleApi "My Google Drive"

Operations

Resource: file

copy

Parameter	Type	Default	Details
fileId	resourceLocator	{...}	required; modes: list, url, id
name	string	""
sameFolder	boolean	true
driveId	resourceLocator	{...}	required; modes: list, url, id
folderId	resourceLocator	{...}	required; modes: list, url, id
options	collection	{}	keys: copyRequiresWriterPermission, description

createFromText

Parameter	Type	Default	Details
content	string	""
name	string	""
driveId	resourceLocator	{...}	modes: list, url, id
folderId	resourceLocator	{...}	modes: list, url, id
options	collection	{}	keys: appPropertiesUi, propertiesUi, keepRevisionForever, ocrLanguage, useContentAsIndexableText, convertToGoogleDocument

deleteFile

Parameter	Type	Default	Details
fileId	resourceLocator	{...}	required; modes: list, url, id
options	collection	{}	keys: deletePermanently

download

Parameter	Type	Default	Details
fileId	resourceLocator	{...}	required; modes: list, url, id
options	collection	{}	keys: binaryPropertyName, googleFileConversion, fileName

move

Parameter	Type	Default	Details
fileId	resourceLocator	{...}	required; modes: list, url, id
driveId	resourceLocator	{...}	required; modes: list, url, id
folderId	resourceLocator	{...}	required; modes: list, url, id

share

Parameter	Type	Default	Details
fileId	resourceLocator	{...}	required; modes: list, url, id
permissionsUi	fixedCollection	{}	groups: permissionsValues
options	collection	{}	keys: emailMessage, moveToNewOwnersRoot, sendNotificationEmail, transferOwnership, useDomainAdminAccess

update

Parameter	Type	Default	Details
fileId	resourceLocator	{...}	required; modes: list, url, id
changeFileContent	boolean	false
inputDataFieldName	string	"data"
newUpdatedFileName	string	""
options	collection	{}	keys: appPropertiesUi, propertiesUi, keepRevisionForever, ocrLanguage, useContentAsIndexableText, trashed, ...

upload

Parameter	Type	Default	Details
inputDataFieldName	string	"data"	required
name	string	""
driveId	resourceLocator	{...}	required; modes: list, url, id
folderId	resourceLocator	{...}	required; modes: list, url, id
options	collection	{}	keys: appPropertiesUi, propertiesUi, keepRevisionForever, ocrLanguage, useContentAsIndexableText, simplifyOutput

Resource: fileFolder

search

Parameter	Type	Default	Details
searchMethod	options	"name"	name, query
queryString	string	""
queryString	string	""
returnAll	boolean	false
limit	number	50
filter	collection	{}	keys: driveId, folderId, whatToSearch, fileTypes, fileTypes, includeTrashed
options	collection	{}	keys: fields

Resource: folder

create

Parameter	Type	Default	Details
name	string	""
driveId	resourceLocator	{...}	required; modes: list, url, id
folderId	resourceLocator	{...}	required; modes: list, url, id
options	collection	{}	keys: simplifyOutput, folderColorRgb

deleteFolder

Parameter	Type	Default	Details
folderNoRootId	resourceLocator	{...}	required; modes: list, url, id
options	collection	{}	keys: deletePermanently

share

Parameter	Type	Default	Details
folderNoRootId	resourceLocator	{...}	required; modes: list, url, id
permissionsUi	fixedCollection	{}	groups: permissionsValues
options	collection	{}	keys: emailMessage, moveToNewOwnersRoot, sendNotificationEmail, transferOwnership, useDomainAdminAccess

Resource: drive

create

Parameter	Type	Default	Details
name	string	""
options	collection	{}	keys: capabilities, colorRgb, hidden, restrictions

deleteDrive

Parameter	Type	Default	Details
driveId	resourceLocator	{...}	required; modes: list, url, id

get

Parameter	Type	Default	Details
driveId	resourceLocator	{...}	required; modes: list, url, id
options	collection	{}	keys: useDomainAdminAccess

list

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	100
options	collection	{}	keys: q, useDomainAdminAccess

update

Parameter	Type	Default	Details
driveId	resourceLocator	{...}	required; modes: list, url, id
options	collection	{}	keys: colorRgb, name, restrictions

Common Parameters

Parameter	Type	Default	Details
authentication	options	"oAuth2"	oAuth2, serviceAccount

Parameter Details

options children:

Parameter	Type	Default	Details
capabilities	collection	{}	keys: canAddChildren, canChangeCopyRequiresWriterPermissionRestriction, canChangeDomainUsersOnlyRestriction, canChangeDriveBackground, canChangeDriveMembersOnlyRestriction, canComment, ...
colorRgb	color	""
hidden	boolean	false
restrictions	collection	{}	keys: adminManagedRestrictions, copyRequiresWriterPermission, domainUsersOnly, driveMembersOnly

permissionsUi children:

permissionsValues group:

Parameter	Type	Default	Details
role	options	""	commenter, fileOrganizer, organizer, owner, reader, writer
type	options	""	user, group, domain, anyone
emailAddress	string	""
domain	string	""
allowFileDiscovery	boolean	false

filter children:

Parameter	Type	Default	Details
driveId	resourceLocator	{...}	modes: list, url, id
folderId	resourceLocator	{...}	modes: list, url, id
whatToSearch	options	"all"	all, files, folders
fileTypes	multiOptions	[]	multi: *, application/vnd.google-apps.drive-sdk, application/vnd.google-apps.audio, application/vnd.google-apps.folder, application/vnd.google-apps.script, application/vnd.google-apps.document, application/vnd.google-apps.drawing, application/vnd.google-apps.form, ... (16 total)
fileTypes	multiOptions	[]	multi: *, application/vnd.google-apps.drive-sdk, application/vnd.google-apps.audio, application/vnd.google-apps.script, application/vnd.google-apps.document, application/vnd.google-apps.drawing, application/vnd.google-apps.form, application/vnd.google-apps.fusiontable, ... (15 total)
includeTrashed	boolean	false

Example

NODE "googleDrive" @google AS "Google Drive" {
  resource: "file",
  operation: "get"
}