tGoogleDriveList Standard properties

Property Type

Select the way the connection details will be set.

• Built-In: The connection details will be set locally for this component. You need to specify the values for all related connection properties manually.

• Repository: The connection details stored centrally in Repository > Metadata will be reused by this component. You need to click the [...] button next to it and in the pop-up Repository Content dialog box, select the connection details to be reused, and all related connection properties will be automatically filled in.

This property is not available when other connection component is selected from the Connection Component drop-down list.

Connection Component

Select the component that opens the database connection to be reused by this component.

Application Name

The application name required by Google Drive to get access to its APIs.

OAuth Method

Select an OAuth method used to access Google Drive from the drop-down list.

• Access Token (deprecated): uses an access token to access Google Drive.

• Installed Application (Id & Secret): uses the client ID and client secret created through Google API Console to access Google Drive. For more information about this method, see Google Identity Platform > Installed applications .

• Installed Application (JSON): uses the client secret JSON file that is created through Google API Console and contains the client ID, client secret, and other OAuth 2.0 parameters to access Google Drive.

• Service Account: uses a service account JSON file created through Google API Console to access Google Drive. For more information about this method, see Google Identity Platform > Service accounts.

For more detailed information about how to access Google Drive using each method, see OAuth methods for accessing Google Drive.

Access Token

The access token generated through Google Developers OAuth 2.0 Playground.

This property is available only when Access Token is selected from the OAuth Method drop-down list.

Client ID and Client Secret

The client ID and client secret.

These two properties are available only when Installed Application (Id & Secret) is selected from the OAuth Method drop-down list.

Client Secret JSON

The path to the client secret JSON file.

This property is available only when Installed Application (JSON) is selected from the OAuth Method drop-down list.

Service Account JSON

The path to the service account JSON file.

This property is available only when Service Account is selected from the OAuth Method drop-down list.

Use Proxy

Select this check box when you are working behind a proxy. With this check box selected, you need to specify the value for the following parameters:

• Host: The IP address of the HTTP proxy server.

• Port: The port number of the HTTP proxy server.

Use SSL

Select this check box if an SSL connection is used to access Google Drive. With this check box selected, you need to specify the value for the following parameters:

• Algorithm: The name of the SSL cryptography algorithm.

• Keystore File: The path to the certificate TrustStore file that contains the list of certificates the client trusts.

• Password: The password used to check the integrity of the TrustStore data.

Folder Name

The name or ID of the folder in which the files/folders will be listed.

Access Method

Select the method by which the folder is specified, either by Name or by Id.

FileList Type

Select the type of data you want to list.

• Files: Only files.

• Directories: Only folders.

• Both: Both files and folders.

Include SubDirectories

Select this check box to list also the files/folders in the subdirectories.

Schema and Edit schema

A schema is a row description, and it defines the fields to be processed and passed on to the next component.

The schema of this component is read-only. You can click the [...] button next to Edit schema to view the predefined schema which contains the following fields:

• id: The ID of the file/folder.

• name: The name of the file/folder.

• mimeType: The MIME type of the file/folder.

• modifiedTime: The last modification date of the file/folder.

• size: The file size in bytes.

• kind: The kind of the resource.

• trashed: Whether the file has been trashed.

• parents: The ID of the parent folder.

• webViewLink: A link for opening the file in a Google editor or viewer in a browser.

DataStore Path

The path to the credential file that stores the refresh token.

This property is available only when Installed Application (Id & Secret) or Installed Application (JSON) is selected from the OAuth Method drop-down list.

Read Timeout

Enter the read timeout value in seconds. An exception will occur if the timeout expires before there is data available for read. The default value is 30 and 0 means an infinite time out. This option is available if the component does not use an existing connection.

Use query

Select this check box to customize your searches.

If you select this check box, trashed files are included by default.

If you select this check box, the Include trashed files option is hidden in Advanced settings and the Include SubDirectories option is hidden in Basic settings.

Query

Type in a query to search for specific files and folders. For more information about the query syntax, see https://developers.google.com/drive/api/v3/search-files#query_string_examples.

This property is available only when the Use query check box is selected.

Include shared folders/files

Select this check box to take into account files and folders that have been shared with you.

Include trashed files

Select this check box to also take into account files and folders that have been removed from the specified path.

Include shared drives

Select this check box to take into account drives that have been shared with you.

It is recommended to use the by Id Access Method in Basic settings when you select this check box, as using the by Name Access Method can affect performance.

Corpora type

This property is available only when the Include shared drives check box is selected.

Set the maximum number of files to return per page. You can set a value between 1 and 1000 included.

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at the Job level as well as at each component level.

ERROR_MESSAGE

The error message generated by the component when an error occurs. This is an After variable and it returns a string.

Usage rule

This component is usually used as a start component of a Job or subJob and it always needs an output link.