Add Spreadsheet (Google Sheets) v1.0.0 Help
Creates a spreadsheet in the specified location.
How can I use the Step?
Use the Step to add a spreadsheet directly to a root or specific folder in your Google Drive (via its ID). The Step helps to organize data effectively and access it whenever needed. In the case of collaborative projects, you can add a spreadsheet to a shared folder in Google Drive. The Step comes in handy for generating reports or data analysis as it lets you add spreadsheets to a designated folder.
How does the Step work?
You authorize the Step with the option connected to the Google Sheets/drive account and provide the spreadsheet title and location. You can configure the Flow behavior if a spreadsheet with the same title already exists. As a result, the Step creates a spreadsheet according to the provided details and returns generated by Google Sheets Spreadsheet ID, Sheet ID, and Title.
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.
Spreadsheet settings
To set up this section, follow these steps:
- Enter a Spreadsheet title or provide it via the Merge field.
- Choose Location on the Google Drive where you want to save the spreadsheet. The default location is the Root folder, which is the main page of your Google Drive account. To add the spreadsheet to a specific folder, select this option and provide the Folder ID value.
Note
Folder ID is a unique identifier of an existing folder in a Google Drive account. You can find it in the URL of your folder, after folder/
. Alternatively, you can extract the ID as a Merge field value using the List Items in Folder (Google Drive) or Find Items (Google Drive) Steps.
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 spreadsheet title to avoid title repetition. For example, the spreadsheet's new title would be Spreadsheet_2023-05-23T10:01:02.
- Skip this Step execution.
- Proceed through the Error exit.
Note
If you provide an already existing title when selecting the New title option, a timestamp is automatically applied to it.
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 your spreadsheet generated by Google Sheets. |
sheetId | number | Id of the automatically created sheet(within your spreadsheet) generated by Google Sheets. |
sheetTitle | string | Title of the automatically created sheet (within your spreadsheet) generated by Google Sheets. |
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": "1KxbpXrpaGGzrzZoFShvq9LSGhKRb0JBvIQp",
"sheetId": 0,
"sheetTitle": "Sheet1"
}
{
"spreadsheetId": "1KxbpXrpaGGzrzZoFShvq9LSGhKRb0JBvIQp",
"sheetId": 0,
"sheetTitle": "Sheet1"
}
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