Add Sheet (Google Sheets) v1.0.0 Help ​

Creates a sheet in the specified spreadsheet.

How can I use the Step? ​

Use the Step to add a new sheet to a spreadsheet. The Step helps to import and integrate data from various sources into a single spreadsheet. You can create separate sheets for each data source and then use formulas to consolidate and analyze the combined data. Also, you can use the Step to segment and organize different data types within a one spreadsheet. Adding sheets lets you create multiple reports within a single spreadsheet. For instance, if you're preparing a monthly financial report, you can dedicate a sheet to each month, making it convenient to compare and analyze various data. Additionally, you can configure the conditions for adding a sheet, even if the sheet name already exists.

How does the Step work? ​

You authorize the Step with the option connected to the Google Sheets/drive account and provide the new sheet's location (spreadsheet ID), title, and size. You can also configure the Flow behavior if a sheet with the same title already exists. As a result, the Step creates a sheet within the specified spreadsheet according to the provided details and returns Spreadsheet ID, Title, and Sheet ID.

Prerequisites ​

To enable the use of any Step from the Google Sheets toolkit, complete the Prerequisites.

Authorization ​

First, you must select the Authorization type. The Google Sheets, Google Drive, and Google Calendar toolkits support two types:

• OAuth 2.0: to authenticate as an end user and access user data in your app. It requires your app to request and receive consent from the user.
• Service account: to authenticate as a robot service account or to access resources on behalf of Google Workspace or Cloud Identity users through domain-wide delegation. A service account is a special kind of account used by an application rather than a person. Read more in the Service accounts overview.

You can authorize the Step in two ways:

• Inherit from the previous step: use the already configured authorization with the same type from the last executed Step of the Google Sheets/Drive/Calendar toolkits in the Flow. If you previously configured authorization in another Step from the toolkits and its authorization type matches the current Step, the Inherit from the previous step option is the default. If this option is selected, but there is no Step with the matching authorization type in the Flow, the Step results in an error.
• Select authorization in the current step: choose authorization from the list of existing ones or create a new one. The gear button contains options to add a new authorization, delete an existing one, or refresh the list of added authorizations. Click Edit to update the fields of a service account authorization. An OAuth 2.0 authorization can be reauthorized.

If you need to create a new authorization, complete the following steps:

1. Select the Authorization type in the corresponding dropdown.
2. Click the Select authorization in current step.
3. Click the Gear button, then Add. Alternatively, select Create new authorization in the dropdown.
4. A modal window for creating a new authorization pops up. Follow the instructions in the modal's collapsible. When finished, the created Authorization name will be added to the list in the dropdown.
5. Select the corresponding Authorization name in the Select authorization in current step dropdown.

Sheet settings ​

In this section, you can provide the required data for new sheet creation. It includes the following parameters:

• Spreadsheet ID: unique identifier of a spreadsheet where you want to add a new sheet. The value also can be used dynamically through the Merge field. Use the List Spreadsheets in Folder (Google Sheets) Step to get the Spreadsheet ID, or see Google Sheets API Overview for info. Be aware that an incorrect ID results in an error.
• Sheet title: name of your sheet (up to 100 characters). If the field only contains white space as a title, an error occurs. The value also can be provided dynamically through the Merge field.
• Number of columns (optional): the number of columns you want to add to your sheet. By default, it is set to 26, and the maximum available number is 18,278.
• Number of rows (optional): the number of columns you want to add to your sheet. By default, it is set to 1000, and the maximum number of rows that can be created simultaneously is 40,000.

Conflict handling ​

In this section, you can configure the Flow behaviour in case a spreadsheet with the specified title already exists. By default, the Flow proceeds down the exists exit.

In addition, you have the following alternatives to manage the case:

• Apply a New title provided in the appeared field.
• Add a Timestamp to the original sheet title to avoid title repetition. For example, the sheet's new title would be Sheet_2023-05-23T10:01:02.
• Skip this Step execution.
• Proceed through the Error exit.

Merge field settings ​

The Step returns the result as a JSON object and stores it under the provided Merge field name. The output includes the following properties:

To learn more about Merge fields and how to work with them, see our Merge fields guide.

Output example ​

The output has the following structure:

{
    "spreadsheetId": "1ODo6wbbinfBslcTijwoi_8WxVf85J7HIAnrTqB",
    "title": "Test1",
    "sheetId": 278519870
}

{
    "spreadsheetId": "1ODo6wbbinfBslcTijwoi_8WxVf85J7HIAnrTqB",
    "title": "Test1",
    "sheetId": 278519870
}

Error handling ​

By default, the Step handles errors using a separate exit. If any error occurs during the Step execution, the Flow proceeds down the error exit. For more information, see Error and timeout handling.

Reporting ​

The Step automatically generates Reporting events during its execution, allowing for real-time tracking and analysis of its performance and user interactions. To learn more, see Reporting events.

Log level ​

By default, the Step inherits its log level from Flow's log level. You can change the Step's log level by selecting an appropriate option from the Log level list.

Tags ​

You can specify tags to organize the collected dat and filter session information when generating reports.

Service dependencies ​

• flow builder v3.49.1
• event-manager v2.0.1
• deployer v2.18.0

Release notes ​

v1.0.0 ​

• Initial release