Skip to end of metadata
Go to start of metadata


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.

Creating a Google Sheets Activity

From the design canvas, open the Connectivity tab of the design component palette:

Connectivity tab

Within the Endpoints filter, click the Google Sheets connection block to display activities that are available to be used with a Google Sheets connection:

Connectivity tab

To create an activity that can be configured, the activity must first be added to an operation on the design canvas. To add an activity to an operation, drag the activity block from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see Operation Creation and Configuration.

Accessing Menu Actions

After a Google Sheets activity has been added to an operation, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas:

  • Project Pane: In the Workflows or Components tab of the project pane, hover over an activity name and click the actions menu icon to open the actions menu.

  • Design Canvas: Within the operation, click an existing activity block to open the actions menu.

Each of these menu actions is available:

  • View/Edit: This opens the activity configuration screen for you to configure the activity. For details, see Configuring a Google Sheets Get Sheets Activity later on this page.

  • Delete: This is used to permanently delete the activity.

  • Rename: This positions the cursor on the activity name in the project pane for you to make edits.

  • View Dependencies: This changes the view in the project pane to display any other parts of the project that the activity is dependent on.

  • Remove: Available only from the actions menu on the design canvas, this removes the activity as a step in the operation without deleting it from the project. When you remove an activity that is adjacent to a transformation, if schemas are provided within that activity, they will no longer be referenced by the transformation. Removed components can be accessed or permanently deleted from the project pane.

  • Deploy: This deploys the activity and any components it is dependent on.

  • Configurable Deploy: This opens the deployment screen, where you can select project components to deploy.

  • Add to group: This opens a prompt to create a new custom group or to add the component to an existing group.

  • Duplicate: This creates a copy of the activity as a new, unreferenced component. Upon creating the component copy, the cursor is positioned on the component name within the project pane for you to rename the component.

Configuring a Google Sheets Get Sheets Activity

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

Step 1: Enter Basic Information

Connectivity 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

Connectivity 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/NodeGoogle API Field/MethodNotes
      getSheetsRequestspreadsheets.getRequest to retrieve a spreadsheet
      SpreadSheetIDn/aID of the spreadsheet (optional)
      rangesn/aNode representing the spreadsheet ranges
      rangen/aRange in A1 notation
    • Response:

      Response Schema Field/NodeGoogle API FieldNotes
      getSheetsResponsen/aResponse from creating the spreadsheet
      Entityn/aNode representing the entire spreadsheet structure
      SpreadSheetn/aNode representing the spreadsheet
      spreadsheetIdspreadsheetIdID of the spreadsheet
      SheetssheetsNode representing the sheets
      SheetsheetNode representing a sheet
      SheetTitletitleSheet title
      SheetIDsheetIdSheet ID; must be non-negative and cannot be changed once set
      dataGridDataNode representing the data for the sheet
      rowRowdDataNode representing a row of the sheet
      A…Zn/aString 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:

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

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.

On This Page

Last updated:  Dec 20, 2019

  • No labels