On this Page
You can use this Snap to write to a worksheet in a Google sheet.
Enhances the Google Sheets Snap Pack by migrating from version 3 to 4 API as Google announces sunsetting the v3 API on June 8, 2021. For more information, see Migrating Google Sheets Pipelines from V3 to V4. |
A valid Google Spreadsheet account.
Works in Ultra Pipelines.
Spreadsheet not found
" error.Workaround: Enclose the names of the spreadsheet and worksheet in quotes (") and enable expressions for both Spreadsheet and Worksheet fields.
Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| The name of the worksheet and spreadsheet information to be written to. |
Output | Document |
|
| Statistics (Number of records written successfully and number of invalid records.) |
Field Name | Field Dependency | Description | ||
---|---|---|---|---|
Label* | N/A | Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline. | ||
Spreadsheet* | N/A | Specify the name of the spreadsheet containing the worksheet to be written to. If the spreadsheet does not exist, you can type the name of the sheet to be created at the root level. Default value: None | ||
Worksheet* | N/A | Specify the name of the worksheet to be written to. If the worksheet does not exist, you can type the name of the worksheet to be created.
Default value: None | ||
Overwrite worksheet if it exists | N/A | Select this checkbox to overwrite existing information if the worksheet exists. Default value: Not selected | ||
Write header row | N/A | Select this checkbox if the row containing column names should be written to the worksheet. | ||
Parse data | N/A | Specify whether the input value must be preserved or parsed. Available options are:
Default value: RAW | ||
Number of Retries | N/A | Specify the maximum number of retry attempts that the Snap must make to write into the worksheet. Default value: 3 | ||
Retry Interval (seconds) | N/A | Specify the time interval in seconds for each retry attempt. Default value: 1 | ||
Connection properties | N/A | Configure the connection properties to specify the read and connection timeouts. | ||
Read timeout in seconds | N/A | Specify the time limit in seconds for the Snap to read the data. If this limit is crossed, the Snap skips to the next batch of records. Default value: 180 | ||
Connection timeout in seconds | N/A | Specify the time in seconds. In the event of a connection failure, the Snap stops a connection attempt after the specified time. For example, if the HTTP timeout is set to 30 seconds, and the Snap fails to establish a connection until 30 seconds, the pipeline logs a timeout exception and aborts execution. Default value: 20 | ||
Snap Execution | N/A |
The following example Pipeline demonstrates the population of target schema in the upstream Mapper Snap when the data is written to an existing worksheet using the Worksheet Writer Snap.
First, we configure the Worksheet Writer Snap to write the data on an existing worksheet.
Next, we configure the Mapper Snap to map the fields to the respective columns using the fields from the Target Schema. Note that the headers and the respective data types are populated (highlighted below) in the Target Schema.