Copy Sheet (Google Sheets) v1.0.0 Help
Makes a copy of a sheet within the same or another spreadsheet.
How can I use the Step?
Use the Step to copy a sheet and save it to the same or another spreadsheet. This Step helps to backup data and manage its versions. Having multiple copies lets you restore previous versions if you accidentally delete or modify something without affecting the original sheet. In the case of collaborative work, making copies can help distribute sheets to different people or groups. Each person can work on their copy without affecting the original file, which minimizes the risk of data conflicts. If you have a frequently used template sheet, you can easily copy it with this Step for further use.
How does the Step work?
You authorize the Step with the option connected to the Google Sheets/drive account and provide the original spreadsheet and sheet IDs together with the ID of the spreadsheet where the copy must be located. You can configure the Flow behavior if a spreadsheet with the same title already exists within the specified location. As a result, the Step creates a sheet copy according to the provided details and returns Spreadsheet ID, Sheet ID, and Sheet title. The created copy gets a copy of <original title>
suffix as a name. If multiple copies of the same sheet are added to the Spreadsheet and the title with the suffix already exists, then the suffix gets numbering at the end. It starts with 1, and the title appears like copy of <original title> 1
, copy of <original title> 2
and so on.
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.
Warning
If the user created an external app in their OAuth Consent Screen, the created authorization needs to be reauthorized in any Flow once approximately every 7 days.
If you need to create a new authorization, complete the following steps:
- Select the Authorization type in the corresponding dropdown.
- Click the Select authorization in current step.
- Click the Gear button, then Add. Alternatively, select Create new authorization in the dropdown.
- 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.
- Select the corresponding Authorization name in the Select authorization in current step dropdown.
Sheet copying settings
In this section, you must provide the following details about a sheet you want to copy:
- Spreadsheet ID: a unique identifier of a spreadsheet that contains the sheet you want to copy.
- Sheet ID: a unique identifier of the sheet you want to copy.
You can use a Merge field to provide these values. Be aware that an incorrect ID results in an error.
Note
Use the List Spreadsheets in Folder (Google Sheets) Step to get the Spreadsheet ID, or see Google Sheets API Overview for info.
Sheet destination settings
You must enter the Spreadsheet ID where to save a sheet copy. Alternatively, you can provide the ID via a Merge field.
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:
Key | Type | Description |
---|---|---|
spreadsheetId | string | Id of spreadsheet where the sheet copy is located. |
sheetId | number | Id of a sheet copy. |
sheetTitle | string | The name of the sheet copy. |
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": "1dDjPL3P3rI5vpl8ceNL4hK3onu1-AjFEz1L28RZ1Q",
"sheetId": 102986267,
"sheetTitle": "Copy of Test1"
}
{
"spreadsheetId": "1dDjPL3P3rI5vpl8ceNL4hK3onu1-AjFEz1L28RZ1Q",
"sheetId": 102986267,
"sheetTitle": "Copy of Test1"
}
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.
Note
If you disable the Handle error toggle, the Step does not handle errors. With this setup, if any error occurs during the Step execution, the Flow fails immediately after exceeding the Flow's timeout. To prevent the Flow from being suspended while continuing to handle errors in the Flow, place the Flow Error Handling Step before the main Flow logic.
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