Skip to Content

Google Sheets Get Sheets activity

Introduction

A Google Sheets Get Sheets activity, using its Google Sheets connection, retrieves a Google Sheets spreadsheet and is intended to be used as a source to provide data in an operation.

Create a Google Sheets Get Sheets activity

An instance of a Google Sheets Get Sheets activity is created from a Google Sheets connection using its Get Sheets 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 Create an activity instance in Component reuse.

An existing Google Sheets Get Sheets activity can be edited from these locations:

Configure a Google Sheets Get Sheets activity

Follow these steps to configure a Google Sheets Get Sheets activity:

Step 1: Enter a name and specify settings

In this step, provide a name for the activity and specify the spreadsheet ID, range, and number of columns. Each user interface element of this step is described below.

Google Sheets Get Sheets activity configuration step 1

Tip

Fields with a variable icon 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.

  • Name: Enter a name to identify the activity. The name must be unique for each Google Sheets 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 to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the data schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

Google Sheets Get Sheets activity configuration step 2

  • Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

    Note

    Data supplied in a transformation takes precedence over the activity configuration.

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

    • Request:

      Request Schema Field/Node Google API Field/Method Notes
      getSheetRequest 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

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the Google Sheets endpoint. This action also regenerates a 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 to close the configuration without saving changes made to any step. A message asks 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 the operation settings, which include the ability to chain operations together that are in the same or different workflows.

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

Google Sheets Get Sheets activities can be used as a source with these operation patterns:

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.