Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Drive / Search Files

  • Article
  • 4 minutes to read

Operation Information

Searches Google Drive for files. Returns the name and ID of the first 5 files returned.

API Documentation: https://developers.google.com/drive/api/v3/reference/files/list.

This is a Free Tier Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type Google Drive.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose Google Drive in the Type pick list;
  • Give the Google Drive KeySafe key a Title (this is the name / identifier for the Google Drive account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Click the Create Key button to create your new key;
  • Once the Key is created, you will need to connect to the target service, and your account, in order to authorize the connector app access to the listed operations. Click the Connect button and you will be redirected to the service provider in a popup window;
  • Log in to your account, and then you will be prompted to review the options you are authorizing the Hornbill connector to be allowed to perform using the chosen account;
  • Accept the review and you will be returned to your KeySafe key.

Tip

If you have revoked your Google KeySafe Token with the Revoke Access button, before you can reconnect Hornbill to your Google account you will need to log in to your Google account and remove Hornbill from the list of third-party apps with account access.

If this is not performed prior to reconnecting your account, then Hornbill will only be able to access the account for up to 1 hour before the access token is expired.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just hit the Revoke button in the relevant KeySafe key(s).

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked Google Drive account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Corpora corpora string Comma-separated list of bodies of items (files/documents) to which the query applies. Supported bodies are ‘user’, ‘domain’, ‘teamDrive’ and ‘allTeamDrives’. ‘allTeamDrives’ must be combined with ‘user’; all other values must be used in isolation. Prefer ‘user’ or ‘teamDrive’ to ‘allTeamDrives’ for efficiency. No None provided
Include Team Drive Items includeTeamDriveItems boolean Whether Team Drive items should be included in results. (Default: false) No None provided
Order By orderBy string A comma-separated list of sort keys. Valid keys are ‘createdTime’, ‘folder’, ‘modifiedByMeTime’, ‘modifiedTime’, ‘name’, ‘name_natural’, ‘quotaBytesUsed’, ‘recency’, ‘sharedWithMeTime’, ‘starred’, and ‘viewedByMeTime’. Each key sorts ascending by default, but may be reversed with the ‘desc’ modifier. Example usage: folder,modifiedTime desc,name. Please note that there is a current Google limitation for users with approximately one million files in which the requested sort order is ignored. No None provided
Query query string A query for filtering the file results. See the [Search for Files and Team Drives]https://developers.google.com/drive/api/v3/search-parameters guide for the supported syntax. Example: name contains 'project' No None provided
Spaces spaces string A comma-separated list of spaces to query within the corpus. Supported values are ‘drive’, ‘appDataFolder’ and ‘photos’. No None provided
Supports Team Drives supportsTeamDrives boolean Whether the requesting application supports Team Drives. (Default: false) No None provided
Team Drive ID teamDriveId string None provided No None provided

Output Parameters

Display Name ID Type Description
Success? success boolean Boolean value, is only set when the API call is successful.
Count count number The number of files returned.
File 1 ID fileId1 string The ID of File 1
File 1 Name fileName1 string The Name of File 1
File 2 ID fileId2 string The ID of File 2
File 2 Name fileName2 string The Name of File 2
File 3 ID fileId3 string The ID of File 3
File 3 Name fileName3 string The Name of File 3
File 4 ID fileId4 string The ID of File 4
File 4 Name fileName4 string The Name of File 4
File 5 ID fileId5 string The ID of File 5
File 5 Name fileName5 string The Name of File 5
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document