Google Sheets Connection¶

Introduction¶

A Google Sheets connection, created using the Google Sheets connector, establishes access to Google Sheets. Once a connection is configured, you can create instances of Google Sheets 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).

Important

To use the Google Sheets connector, you will need credentials that allow you to access the Google Sheets API, as described in Google Sheets Prerequisites.

Create or Edit a Google Sheets Connection¶

A new Google Sheets connection is created using the Google Sheets connector from one of these locations:

The design component palette's Connections tab (see Design Component Palette).
The Global Connections page (see Create a Global Connection in Global Connections).

An existing Google Sheets connection can be edited from these locations:

The design component palette's Connections 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 Connection in Global Connections).

Configure a Google Sheets Connection¶

Each user interface element of the Google Sheets connection configuration screen is described below.

Google Sheets connection configuration

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 Sheets connection and must not contain forward slashes / or colons :. This name is also used to identify the Google Sheets 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 Sheets Prerequisites.
Client Email: Enter the client_email provided by the credentials JSON file as described in Google Sheets Prerequisites.
Private Key String: Enter the private_key provided by the credentials JSON file as described in Google Sheets Prerequisites.
Key Algorithm: From the menu, select the encryption algorithm of the private key string. Currently, only RSA is supported.
Optional Settings: Click to expand additional settings:
- Connection Timeout (milliseconds): Specify the timeout for the connection (in milliseconds). The maximum value allowed is 3600000 milliseconds (1 hour). The default value is 20000 milliseconds (20 seconds).
- Read Timeout (milliseconds) Specify the request timeout for the Get Sheets activity (in milliseconds). The maximum value allowed is 3600000 milliseconds (1 hour). The default value is 20000 milliseconds (20 seconds).
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 Sheets 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:

Get Sheets: Retrieves a Google Sheets spreadsheet and is intended to be used as a source in an operation.
Update Sheets: Updates a Google Sheets spreadsheet and is intended to be used as a target in an operation.
Create Sheets: Creates a spreadsheet and places it into Google Sheets and is intended to be used as a target in an operation.