Skip to Content

Google Sheets Update Sheets Activity

Introduction

A Google Sheets Update Sheets activity, using its Google Sheets connection, updates a Google Sheets spreadsheet and is intended to be used as a target to consume data in an operation.

Create a Google Sheets Update Sheets Activity

An instance of a Google Sheets Update Sheets activity is created from a Google Sheets connection using its Update 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 Update Sheets activity can be edited from these locations:

Configure a Google Sheets Update Sheets Activity

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

Step 1: Enter a Name and Specify Settings

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

Google Sheets Update Sheets Activity Configuration Step 1

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

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

  • Continue on Error: Select to continue the activity execution if an error is encountered for a dataset in a batch request. If any errors are encountered, they are written to the operation log.

  • 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 Update 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, type Notes
      updateSheetsRequest spreadsheets.update Request to update a spreadsheet
      spreadsheetId spreadsheetId ID of the spreadsheet to be updated
      title title Sheet title
      request node Each request is one of findReplaceRequest, addSheetRequest, updateSheetRequest, deleteSheetRequest, deleteCellRequest, or updateCellRequest
      findReplaceRequest FindReplaceRequest Finds and replaces data in cells over a range, sheet, or all sheets
      find String The value to search
      replacement String The value to use as the replacement
      matchCase Boolean True if the search is case sensitive
      searchByRegex Boolean True if the find value is a regex. The regular expression and replacement should follow Java regex rules.
      matchEntireCell Boolean True if the find value should match the entire cell
      includeFormulas Boolean True if the search should include cells with formulas. False to skip cells with formulas.
      unionFields node Union field scope: The scope over which to find/replace; one of SheetID, allSheets, or gridRange must be set
    • Response:

      Response Schema Field/Node Google API Field Notes
      updateSheetsResponse n/a Response from creating the spreadsheet
      spreadsheetId spreadsheetId ID of the newly-updated spreadsheet
      sheets n/a Node representing the spreadsheet
      properties n/a Node representing the properties returned
      code n/a Error code returned (if any)
      message n/a Message returned upon creation (if any)
  • 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 Update 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 Update Sheets activities can be used as a target 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.