Skip to Content

Jitterbit Harmony Google Sheets Get Sheets Activity

Introduction

A Google Sheets get sheets activity retrieves a spreadsheet from a Google Sheets connection and is used as a source in an operation. After configuring a Google Sheets connection, you can configure as many Google Sheets activities as you like for each Google Sheets connection.

Create a Google Sheets Activity

An instance of an activity is created from a connection using an activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an Activity Instance in Component Reuse.

An existing activity can be edited from these locations:

Accessing Menu Actions

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity Actions Menu in Connector Basics.

Configure a Google Sheets Get Sheets Activity

Follow these steps to configure a Google Sheets get sheets activity:

Step 1: Enter Basic Information

Connections tab

Tip

Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin typing an open square bracket [ into the field or click the variable icon to display existing variables to choose from.

  • Name: Enter a name to use to identify the Google Sheets get sheets activity. The name must be unique for each get sheets activity and must not contain forward slashes (/) or colons (:).

  • Spreadsheet ID: Enter the ID of the Google Sheets spreadsheet.

  • Range: The cells to be retrieved, in A1 notation (optional).

  • Number of Columns: Enter the number of columns to be returned in the response (optional); if not provided, the default value of 26 is used.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Step 2: Review Data Schema

Connections tab

  • Data Schema: The response data schema from Google Sheets will be displayed. If the operation uses a transformation, the data schemas will be displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more.

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

    • Request:

      Request Schema Field/Node Google API Field/Method Notes
      getSheetsRequest spreadsheets.get Request to retrieve a spreadsheet
      SpreadSheetID n/a ID of the spreadsheet (optional)
      ranges n/a Node representing the spreadsheet ranges
      range n/a Range in A1 notation

    • Response:

      Response Schema Field/Node Google API Field Notes
      getSheetsResponse n/a Response from creating the spreadsheet
      Entity n/a Node representing the entire spreadsheet structure
      SpreadSheet n/a Node representing the spreadsheet
      spreadsheetId spreadsheetId ID of the spreadsheet
      Sheets sheets Node representing the sheets
      Sheet sheet Node representing a sheet
      SheetTitle title Sheet title
      SheetID sheetId Sheet ID; must be non-negative and cannot be changed once set
      data GridData Node representing the data for the sheet
      row RowdData Node representing a row of the sheet
      A…Z n/a String data for columns of the sheet; by default, 26 columns are created in a new spreadsheet

  • Add Plugin(s): Plugins are Jitterbit- or user-provided applications that extend Harmony's native capabilities. To apply a plugin to the activity, click to expand this section and select the checkbox next to the plugin to be used. For additional instructions on using plugins, including details on setting any required variables used by the plugin, see Plugins Added to an Activity.

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the endpoint. This action also regenerates the schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Next Steps

After configuring a Google Sheets get sheets activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.

Google Sheets get sheets activities can be used as a source with these operation patterns: - Transformation Pattern - Two-target Archive Pattern (as the first source only) - Two-target HTTP Archive Pattern (as the first source only) - Two-transformation Pattern (as the first or second source)

Other patterns are not valid using Google Sheets get sheets activities. See the validation patterns on the Operation Validity page.

A typical use case is to use a Google Sheets Get activity in the Two-transformation Pattern. In this example, the first transformation (Get Sheets Request) creates a request structure that is passed to the Google Sheets Get activity. The second transformation (Get Sheets Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Get Sheets Response) and a message is then logged by the Write to Operation Log script:

Google Sheets Get Operation

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.