Skip to Content

Google Sheets connector

Summary

The Google Sheets connector establishes access to Google Sheets.

The Google Sheets connector provides an interface for creating a Google Sheets connection, the foundation used for generating instances of Google Sheets activities. These activities, once configured, interact with Google Sheets through the connection.

The Google Sheets connector is accessed from the design component palette's Project endpoints and connectors tab (see Design component palette).

Connector overview

This connector is used to first configure a Google Sheets connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Together, a specific Google Sheets connection and its activities are referred to as a Google Sheets endpoint:

Google Sheets activity types

  • Get Sheets: Retrieves a spreadsheet from Google Sheets and is intended to be used as a source in an operation.

  • Update Sheets: Updates a spreadsheet in Google Sheets and is intended to be used as a target in an operation.

  • Create Sheets: Creates a spreadsheet in Google Sheets and is intended to be used as a target in an operation.

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Prerequisites and supported API versions

The Google Sheets connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

The Google Sheets connector uses the Google Sheets API v4. Refer to the API documentation for information on the schema nodes and fields.

To use the Google Sheets connector, you must have a Google service account for your project with appropriate permissions set, and certain credentials obtained from the service account as described in Google Sheets prerequisites.

Troubleshooting

If you experience issues with the Google Sheets connector, these troubleshooting steps are recommended:

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for cloud agents or for private agents) to generate additional log files and data.

  4. If using private agents, you can enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.sheets" level="DEBUG"/>
    
  5. If using private agents, you can check the agent logs for more information.

  6. For additional troubleshooting considerations, see Operation troubleshooting.