Google Drive

The Google Drive modules enable you to monitor, search, create, update, delete, and manage your files, folder, or shared drives in your Google Drive.

• See the changelog for the Google Drive App

Getting Started with Google Drive

Prerequisites

• A Google account

In order to use Google Drive with Integromat, it is necessary to have a Google account. If you do not have one, you can create a Google account at accounts.google.com/signup.

Connecting Google Drive to Integromat

To connect your Google Drive account to Integromat as a G Suite user (Business Gmail account) follow the general instructions for Connecting to services.

After you click the Continue button, Integromat will redirect you to the Google website where you will be prompted to grant Integromat access to your account:

Here, allow access by clicking the Allow button. Afterwards, you will be redirected back to the Integromat scenario. Now, you can continue creating your scenario.

 

If you are @gmail.com or @googlemail.com user you need to create an OAuth client on the Google Cloud Platform in order to obtain Client ID and Client Secret.
For step-by-step instructions on how to create the OAuth client (and obtain Client ID and Client Secret) please refer to the Connecting Integromat To Google Services Using a Custom OAuth Client documentation.

To find out whether you are G Suite user or @gmail user please see the Google API restrictions (Do I have a G Suite account? section) article.

File/Folder

Watch Files In a Folder

Retrieves file details when a file is added or modified in the specified folder.

Connection	Establish a connection to your Google Drive.
Watch Files	Select whether you want to watch new files in the folder (By Created Time), or modified files (By Modified Time).
Choose a Drive	Select whether you want to watch files in one of the following locations: My Drive Shared With Me Google Shared Drive (This option is available for G Suite users only! Other users will get the Invalid Value error)
Select the Folder to be Watched	Navigate to the folder you want to watch.
File Types to Watch	Select file type to filter watched files by.
Limit	Set the maximum number of files Integromat will return during one execution cycle.

Watch All Files

Retrieves file details when a file in your Google Drive is added or modified.

Connection	Establish a connection to your Google Drive.
Watch Files	Select whether you want to watch new files in the folder (By Created Time), or modified files (By Modified Time).
Choose a Drive	Select whether you want to watch files in one of the following locations: My Drive Shared With Me Google Shared Drive (This option is available for G Suite users only! Other users will get the Invalid Value error)
File Types to Watch	Select file type to filter watched files by.
Limit	Set the maximum number of files Integromat will return during one execution cycle.

Watch Folder

Retrieves folder details when a new folder is created or the existing one is modified.

Connection	Establish a connection to your Google Drive.
Watch Files	Select whether you want to watch new folders (By Created Time), or modified folders (By Modified Time).
Choose a Drive	Select whether you want to watch folders in one of the following locations: My Drive Shared With Me Google Shared Drive (This option is available for G Suite users only! Other users will get the Invalid Value error)
Choose a Folder	Navigate to the folder you want to watch for the folders.
Limit	Set the maximum number of folders Integromat will return during one execution cycle.

Search for Files/Folders

Searches for files or folders based on search criteria.

Connection	Establish a connection to your Google Drive.
Choose a Drive	Select the location where you want to search for files or folders: My Drive Shared With Me Google Shared Drive (This option is available for G Suite users only! Other users will get the Invalid Value error)
Choose a Folder	Navigate to the folder you want to search for the files or folders.
Retrieve	Select whether you want to search for files, folders, or both.
Search	Select the type of the search you want to perform. Search within file/folder names Fulltext search Enter custom search query
Query	Enter the query (differs based on the search type selected in the Search field above). Search within file/folder names Enter a part of the file name or full file name (including the suffix) you want to search. Select whether you want to search exact term or search the file/folder name that contains the entered term in the Search Options field below. Fulltext search   Enter any search term you want search in your Google Drive. Enter custom search query Enter the custom search query. For more details, please refer to the Search for Files section of this article. Add the folder selected above to the query Searches for the folder n the parents collection. This finds all files and folders located directly in the folder selected above.
Limit	Set the maximum number of files or folders Integromat will return during one execution cycle.

Download a File

Downloads a file from your Google Drive.

Connection	Establish a connection to your Google Drive.
Choose a Drive	Select the location where you want to download a file from: My Drive Shared With Me Google Shared Drive (This option is available for G Suite users only! Other users will get the Invalid Value error)
Enter a File ID	Select whether you want to enter (map) the file ID manually or select the file using the menu.
File ID	Enter (map) the file ID of the file you want to download.
Convert Google Documents/Spreadsheets/Slides/Drawings Files to Format	Select the file type of the file you want to download and target file type you want convert to the file to.

Create a File From Text

Creates a file in the selected Google Drive folder.

Connection	Establish a connection to your Google Drive.
Choose a Drive	Select the location where you want to create the file at: My Drive Shared With Me Google Shared Drive (This option is available for G Suite users only! Other users will get the Invalid Value error)
New Text File Location	Select the target location where you want to create the new file.
File Name	Enter the name for the new file.
File Content	Enter the plain text content of the new file.
Convert the File to Google Docs Document	Enable this to set the file's mimeType to application/vnd.google-apps.document instead of text/plain.

Create a Folder

Creates a folder in the specified location.

Connection	Establish a connection to your Google Drive.
Choose a drive	Select the drive where you want to create the folder: My Drive Shared With Me Google Shared Drive (This option is available for G Suite users only! Other users will get the Invalid Value error)
New Folder Location	Select the target location where you want to create the new folder.
New Folder's Name	Enter the name for the new folder.
Share Folder	If enabled, the folder is shared to anyone with the link of the folder (Web View Link). Otherwise the Web View Link works for the owners only.
Type	Select permission for the folder. A permission grants a user, group, domain, or the world access to a folder hierarchy.
Role	Select the role to define what users can do with a file or folder. For the list of  operations users can perform for each role please refer to the Roles documentation.

Upload a File

Uploads a file to your Google Drive.

Connection	Establish a connection to your Google Drive.
Enter a Folder ID	Select whether you want to enter (map) the folder ID manually or select the folder using the menu.
Folder ID	Enter (map) the folder ID of the folder you want to upload the file to.
New File Name	Enter the new file name if you want to change the name of the file.
Source File	Map the file you want to upload from the previous module (e.g. HTTP > Get a File or Dropbox > Get a file), or enter the file name and file data manually.

Update a File

Updates a file's metadata or content.

Connection	Establish a connection to your Google Drive.
Enter a File ID	Select whether you want to enter (map) the file ID manually or select the file using the menu.
File ID	Enter (map) the File ID of the file you want to update.
New Updated File Name	Enter the new file name if you want to change the name of the file.
File Description	Enter the new file description.
Change File Content	Enable this option to change the file content. The new file must have the same mimeType as the original file.
Source File	Map the file you want to upload from the previous module (e.g. HTTP > Get a File or Dropbox > Get a file), or enter the file name and file data manually.

Move a File/Folder to Trash

Moves a file or folder to the trash.

Connection	Establish a connection to your Google Drive.
Enter a File/Folder ID	Select whether you want to enter (map) the file or folder ID manually or select the file or folder using the menu.
Select File/Folder	Select whether you want to move the file or folder to the trash.
File ID / Folder ID	Enter (map) the File ID (or folder ID) of the file (or folder) you want to move to the trash.

Delete a File/Folder.

Permanently deletes a file or folder.

Connection	Establish a connection to your Google Drive.
Enter a File/Folder ID	Select whether you want to enter (map) the file or folder ID manually or select the file or folder using the menu.
Select File/Folder	Select whether you want to permanently delete a file or folder.
File ID / Folder ID	Enter (map) the File ID (or folder ID) of the file (or folder) you want to permanently delete.

Copy a File

Copies a file to the new location.

Connection	Establish a connection to your Google Drive.
Original File's Drive	Select the drive you want to copy the file from: My Drive Shared With Me Google Shared Drive (This option is available for G Suite users only! Other users will get the Invalid Value error)
Original File ID	Enter (map) the File ID of the original file you want to copy.
New Drive Location	Select the target drive you want to copy the file to: My Drive Shared With Me Google Shared Drive (This option is available for G Suite users only! Other users will get the Invalid Value error)
New Folder Location	Select the target folder you want to copy the file to.
Copied File Name	Enter the new file name if you want to change the name of the file in the target location.

Move a File/Folder

Moves a file or folder to the new target location.

Connection	Establish a connection to your Google Drive.
Choose a Drive	Select the drive you want to move the file or folder from: My Drive Shared With Me Google Shared Drive (This option is available for G Suite users only! Other users will get the Invalid Value error)
Select File/Folder	Select whether you want to move a file or folder.
File ID/ Folder ID	Enter (map) the File ID (or Folder ID) of the file (or folder) you want to move.
New Drive Location	Select the target drive you want to move the file or folder to: My Drive Shared With Me Google Shared Drive (This option is available for G Suite users only! Other users will get the Invalid Value error)
New Folder Location	Select the target folder you want to move the file or folder to.

Get a Share Link

Retrieves and sets up permissions and sends share link for a file or folder.

Connection	Establish a connection to your Google Drive.
Choose a Drive	Select the drive that contains the file or folder you want to share: My Drive Shared With Me Google Shared Drive (This option is available for G Suite users only! Other users will get the Invalid Value error)
Select File/Folder	Select whether you want to share a file or folder.
File ID/ Folder ID	Enter (map) the File ID (or Folder ID) of the file (or folder) you want to share.
Role	Select the role granted by this permission to define what users can do with a file or folder. For the list of  operations users can perform for each role please refer to the Roles documentation.
Type	Select a permission for the file or folder. A permission grants a user, group, domain or the world access to a folder hierarchy or to the file.
Email address / Organization Domain	Enter the email address or organization domain you want to restrict the access to the file or folder to.
Send notification email	The notification email with the link will be sent to the specified email address.
Allow File Discovery	Enable to define whether the permission allows the file to be discovered through search.

Google Shared Drive (FOR G SUITE USERS ONLY)

Watch Shared Drives

Triggers when a shared drive is created.

Connection	Establish a connection to your Google Drive.
Search	Select whether you want to filter returned drives by custom search query or query filter.
Query filter	Set the filter to filter returned shared drives by name, organizer count, or member count. You can also use AND and OR operators to combine the filter.
Query	Enter your custom search query. For example:name contains 'integromat' and memberCount >= 20 For more info, see the documentation.
Limit	Set the maximum number of drives Integromat will return during one execution cycle.

Search for Shared Drives

Searches for the Google shared drive.

Connection	Establish a connection to your Google Drive.
Search	Select whether you want to filter returned drives by custom search query or query filter.
Query filter	Set the filter to filter returned shared drives by name, organizer count, member count, or created time. You can also use AND and OR operators to combine the filter.
Query	Enter your custom search query. For example:name contains 'integromat' and memberCount >= 20 For more info, see the documentation.
Limit	Set the maximum number of drives Integromat will return during one execution cycle.

Create a Shared Drive

Creates a new shared drive.

Connection	Establish a connection to your Google Drive.
New Shared Drive's Name	Enter the name for the new shared drive.

Get a Shared Drive

Retrieves shared drive details.

Connection	Establish a connection to your Google Drive.
Shared Drive ID	Enter (map) the ID or select the drive you want to retrieve details about.

Update a Shared Drive

Updates an existing drive's name and/or restrictions.

Connection	Establish a connection to your Google Drive.
Shared Drive ID	Enter (map) the ID or select the drive you want to update.
Name	Enter the new name for the shared drive.
Restrictions	Enable or disable restrictions that apply to this shared drive or items inside this shared drive. Admin Managed Restrictions Select whether administrative privileges on this shared drive are required to modify restrictions. Copy Requires Writer Permission Select whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is enabled, it will override the similarly named field to true for any file inside this shared drive. Domain Users Only Select whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive. Drive Members Only Select whether access to items inside this shared drive is restricted to its members.

Delete a Shared Drive

Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items. 

Connection	Establish a connection to your Google Drive.
Shared Drive ID	Enter (map) the ID or select the drive you want to delete.

Other

Watch Comments

Triggers when a comment is added or modified on the selected file.

Connection	Establish a connection to your Google Drive.
Watch Comments	Select whether you want to watch new comments (By Created Time), or modified comments (By Modified Time).
Choose a Drive	Select whether you want to watch comments in one of the following locations: My Drive Shared With Me Google Shared Drive (This option is available for G Suite users only! Other users will get the Invalid Value error)
File ID	Navigate to and select the file you want to watch for comments.
Limit	Set the maximum number of comments Integromat will return during one execution cycle.

Make an API Call

Allows you to perform a custom API call.

Connection	Establish a connection to your Google Drive..
URL	Enter a path relative to https://www.googleapis.com/drive. e.g./v3/files For the list of available endpoints, refer to the Google Drive API Documentation.
Method	Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry.
Headers	Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String	Enter the request query string.
Body	Enter the body content for your API call.

Example of Use - List All Files

The following API call returns all files in your Google Drive:

URL:
/v3/files

Method:
GET

The result can be found in the module's Output under Bundle > Body > files. 
In our example, 30 files were returned:

Search For Files

In the module Search for Files/Folders you can use your own query which consists of these parts:

Field - Attribute of the file that is being searched, e.g. the attribute name of the file.

Operator - Test that is performed on the data to provide a match, e.g. contains.

Value - The content of the attribute that is tested, e.g. the name of the file My cool document.

Combine clauses with the conjunctions and or or, and negate the query with not.

Fields

Field	Value Type	Operators	Description
title	string	contains<sup>1</sup>, =, !=	Name of the file.
fullText	string	contains<sup>2</sup>	Full text of the file including name, description, content, and indexable text.
mimeType	string	contains, =, !=	MIME type of the file.
modifiedDate	date<sup>3</sup>	<=, <, =, !=, >, >=	Date of the last modification to the file.
lastViewedByMeDate	date<sup>3</sup>	<=, <, =, !=, >, >=	Date that the user last viewed a file.
trashed	boolean	=, !=	Whether the file is in the trash or not.
starred	boolean	=, !=	Whether the file is starred or not.
parents	collection	in	Whether the parents collection contains the specified ID.
owners	collection	in	Users who own the file.
writers	collection	in	Users who have permission to modify the file.
readers	collection	in	Users who have permission to read the file.
sharedWithMe	boolean	=, !=	Files that are in the user's "Shared with me" collection.
properties	collection	has	Public custom file properties.

[1] The contains operator only performs prefix matching for a title. For example, the title "HelloWorld" would match for title contains 'Hello' but not title contains 'World'.

[2] The contains operator only performs matching on entire string tokens for fullText. For example, if the full text of a doc contains the string "HelloWorld" only the query fullText contains 'HelloWorld' would return a result. Queries such as fullText contains 'Hello' would not return results in this scenario.

[2] The contains operator will match on an exact alphanumeric phrase if it is surrounded by double quotes. For example, if the fullText of a doc contains the string "Hello there world", then the query fullText contains '"Hello there"' will return a result, but the query fullText contains '"Hello world"' would not. Furthermore, since the search is alphanumeric, if the fullText of a doc contains the string "Hello_world", then the query fullText contains '"Hello world"' would return a result.

[3] Fields of type date are currently not comparable to each other, only to constant dates.

Value types

Value Type	Notes
String	Surround with single quotes '. Escape single quotes in queries with \', e.g., 'Valentine\'s Day'.
Boolean	true or false.
Date	RFC 3339 format, default timezone is UTC, e.g., 2012-06-04T12:00:00-08:00.

Operators

Operator	Notes
contains	The content of one string is present in the other.
=	The content of a string or boolean is equal to the other.
!=	The content of a string or boolean is not equal to the other.
<	A date is earlier than another.
<=	A date is earlier than or equal to another.
>	A date is later than another.
>=	A date is later than or equal to another.
in	An element is contained within a collection.
and	Return files that match both clauses.
or	Return files that match either clause.
not	Negates a search clause.
has	A collection contains an element matching the parameters.

For compound clauses, you can use parentheses to group clauses together. For example:
modifiedDate > '2012-06-04T12:00:00' and (mimeType contains 'image/' or mimeType contains 'video/')

This search returns all files with an image or video MIME type that their last modification was after June 4, 2012. Because and and or operators are evaluated from left to right, without parentheses, the above example would return only images modified after June 4, 2012, but would return all videos, even those before June 4, 2012.

Examples

All examples on this page show the unencoded q parameter, where title = 'hello' is encoded as
title+%3d+%27hello%27. Client libraries handle this encoding automatically.

Search for files with the name "hello"
title = 'hello'

Search for folders using the folder-specific MIME type
mimeType = 'application/vnd.google-apps.folder'

Search for files that are not folders
mimeType != 'application/vnd.google-apps.folder'

Search for files with a name containing the words "hello" and "goodbye"
title contains 'hello' and name contains 'goodbye'

Search for files with a name that does not contain the word "hello"
not title contains 'hello'

Search for files containing the word "hello" in the content
fullText contains 'hello'

Search for files not containing the word "hello" in the content
not fullText contains 'hello'

Search for files containing the exact phrase "hello world" in the content
fullText contains '"hello world"'fullText contains '"hello_world"'

Search for files with a query containing the "\" character (e.g., "\authors")
fullText contains '\\authors'

Search for files writeable by the user "test@example.org"
'test@example.org' in writers

Search for the ID 1234567 in the parents collection. This finds all files and folders located directly in the folder whose ID is 1234567.
'1234567' in parents

Search for the alias ID appDataFolder in the parents collection. This finds all files and folders located directly under the Application Data folder.
'appDataFolder' in parents

Search for files writeable by the users "test@example.org" and "test2@example.org"
'test@example.org' in writers and 'test2@example.org' in writers

Search for files containing the text "important" which are in the trash
fullText contains 'important' and trashed = true

Search for files modified after June 4th 2012
modifiedDate > '2012-06-04T12:00:00' // default time zone is UTC
modifiedDate > '2012-06-04T12:00:00-08:00'

Search for files shared with the authorized user with "hello" in the name
sharedWithMe and title contains 'hello'

Search for files with a custom file property named additionalID with the value 8e8aceg2af2ge72e78.
properties has { key='additionalID' and value='8e8aceg2af2ge72e78' and visibility='PRIVATE' }

Source of this guide is Google Drive documentation.

Possible problems

Unable to upload or update a file

There are several situations when uploading or updating a file fails:

• The uploaded file is too big and exceeds the maximum file size limit allowed for your Google Drive plan or you have exceeded your Google Drive storage limit. You can either upgrade your storage plan or delete existing files from the Google Drive service.

• The selected folder where the file was to be uploaded to no longer exists. The scenario stops and it is then necessary to select a target folder again.

Changelog for Google Drive App

last update: 2020-06-08

• All modules now support all instances - My Drive, Shared With Me, Google Shared Drive (G Suite). The app Google Team Drive is not available as the Google Drive app now supports the same methods.
  The group of modules Google Shared Drive (for G Suite users) has been newly added:
  
  • Watch Shared Drives
  • Search for Shared Drives
  • Get a Shared Drive
  • Update a Shared Drive
  • Delete a Shared Drive
  • Create a Shared Drive
• Watch Files in a Folder - The new module helps the user to control used data and operations by not downloading the files. If needed, the file can be downloaded using the separate Download a File module.
• Watch All Files - The new module helps the user to control used data and operations by not downloading the files. If needed, the file can be downloaded using the separate Download a File module.
• Upload a File/Update a File - advanced feature Convert a File - the solution working with MIME type.
• All modules - Use the separate Recognize a Folder Path module to retrieve the folder ID.
• Get a Share Link - supports advanced modifications of rights for the share link.
• Download a File - formerly Get a File. Now you can manually select the file you want to download.
• Copy a File/Move a File - all instances are supported, e.g. you may copy/move a file from "My Drive" to "G Shared Drive".
• Create a Folder - the Share folder feature - supports advanced modifications of rights for the Share link.
• Create a File from Text - a new module
• Move a File/Folder to Trash - legacy module could trash only files. The new one supports also empty folders.
• Delete a File/Folder - legacy module could delete only files. The new one supports also empty folders.
• Make an API Call - universal module
• Watch Shared Files - deprecated, now the modules Watch All Files or Watch Files in a Folder may be used.