Google Drive connection¶
Introduction¶
A Google Drive connection, created using the Google Drive connector, establishes access to Google Drive. Once a connection is configured, you can create instances of Google Drive activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).
Note
The Google Drive folder you wish to access must be shared with the Google that is used in the connection. Documents outside the shared folder cannot be accessed.
Create or edit a Google Drive connection¶
A new Google Drive connection is created using the Google Drive connector from one of these locations:
- The design component palette's Project endpoints and connectors tab (see Design component palette).
- The Global Connections page (see Create a global endpoint in Global Connections).
An existing Google Drive connection can be edited from these locations:
- The design component palette's Project endpoints and connectors tab (see Design component palette).
- The project pane's Components tab (see Component actions menu in Project pane Components tab).
- The Global Connections page (see Edit a global endpoint in Global Connections).
Configure a Google Drive connection¶
Each user interface element of the Google Drive connection configuration screen is described below.
Tip
Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [
into the field or by clicking the variable icon to display a list of the existing variables to choose from.
-
Connection Name: Enter a name to use to identify the connection. The name must be unique for each Google Drive connection and must not contain forward slashes
/
or colons:
. This name is also used to identify the Google Drive endpoint, which refers to both a specific connection and its activities. -
Project ID: Enter the
project_id
provided by the credentials JSON file as described in Google Drive prerequisites. -
Client Email: Enter the
client_email
provided by the credentials JSON file as described in Google Drive prerequisites. -
Private Key String: Enter the
private_key
provided by the credentials JSON file as described in Google Drive prerequisites. The private key should be entered in this format:-----BEGIN PRIVATE KEY----- <private_key> -----END PRIVATE KEY-----
Note
All newline characters (
\n
) present in theprivate_key
string must be replaced with a carriage return in the Private Key String field. Otherwise, an error will occur when testing the connection. -
Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.
-
Save Changes: Click to save and close the connection configuration.
-
Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.
-
Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.
Next steps¶
After a Google Drive connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).
Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.
These activity types are available:
-
Update File: Updates files in Google Drive and is intended to be used as a target in an operation.
-
Delete File: Deletes a file from Google Drive and is intended to be used as a target in an operation.
-
Create File: Creates files in Google Drive and is intended to be used as a target in an operation.
-
List Files: Retrieves a list of files (matching a query) from Google Drive and is intended to be used as a source in an operation.
-
Get File: Retrieves a file from Google Drive and is intended to be used as a source in an operation.