Google Sheets Create Sheets activity

Introduction

A Google Sheets Create Sheets activity, using its Google Sheets connection, creates a spreadsheet and places it into Google Sheets and is intended to be used as a target to consume data in an operation.

Create a Google Sheets Create Sheets activity

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

• The design canvas (see Component actions menu in Design canvas).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).

Configure a Google Sheets Create Sheets activity

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

• Step 1: Enter a name and specify settings
  Provide a name for the activity and specify the spreadsheet name and number of columns.

• Step 2: Review the data schemas
  Any request or response schemas are displayed.

Step 1: Enter a name and specify settings

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

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

• Spreadsheet Name: Enter the name to be used when creating the spreadsheet.

• 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.

• 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
    createSheetsRequest	spreadsheets.create	Request to create a spreadsheet
    folder_id	n/a	Folder ID of the parent of the Google Sheet (optional) If provided, the spreadsheet is created in that folder If not provided, the spreadsheet is created in the folder shared with the connection service account
    Entity	n/a
    Sheets	n/a	Node representing the spreadsheet
    Sheet	n/a	Node representing each sheet of the spreadsheet
    startRow	startRow	The first row the sheet data refers to, zero-based
    startColumn	startColumn	The first column the sheet data refers to, zero-based
    SheetID	sheetId	Sheet ID; must be non-negative and cannot be changed once set
    SheetTitle	title	Sheet title
    data	GridData	Node representing the data for the sheet
    row	RowData	Node representing a row of the sheet
    A…Z	n/a	String data for columns of a sheet; by default, 26 columns are created in a new spreadsheet

  • Response:

    Response Schema Field/Node	Google API Field	Notes
    createSheetsResponse	n/a	Response from creating the spreadsheet
    sheets	n/a	Node representing the spreadsheet
    spreadsheetId	spreadsheetId	ID of the newly-created spreadsheet
    properties	n/a	Node representing the properties returned
    message	n/a	Message returned upon creation (if any)
    code	n/a	Error code returned (if any)

• Refresh: Click the 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 Create 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 Create Sheets activities can be used as a target with these operation patterns:

• Transformation pattern
• Two-transformation pattern (as the first or second target)

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.