$customHeader
Skip to end of banner
Go to start of banner

Worksheet Writer

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 39 Next »

On this Page

Impact on Migration of API from v3 to v4:

Enhances the Google Spreadsheet Snap Pack by migrating from v3 to v4 API as Google announces sunsetting the v3 API on June 8, 2021. For more information, see Migrating Google Spreadsheet Pipelines from V3 to V4.


Snap type:

Write

Description:

This Snap writes to a worksheet in a Google spreadsheet.

  • Expected upstream Snaps:  Generators (CSV, JSON), Mapper.
  • Expected downstream Snaps: None.
  • Expected input: The name of the worksheet and spreadsheet information to be written to.
  • Expected output:  Statistics (Number of records written successfully, Number of invalid records)
Prerequisites:

A valid Google Spreadsheet account. 

Support and Limitations:

Page lookup error: page "Spreadsheets Browser" not found.

If you're experiencing issues please see our Troubleshooting Guide.

  • The Snap conforms to the limitations imposed by Google Drive service. A spreadsheet may contain multiple worksheets. The cell count limit applies to the sum of the cells in all the worksheets in a spreadsheet.
  • If the spreadsheet or worksheet to which you want to write contains one or more leading or trailing spaces, the Worksheet Writer Snap does not function as expected:
    • If the spreadsheet name contains leading or trailing spaces, the Snap displays a "Spreadsheet not found" error.
    • If the worksheet name contains leading or trailing spaces, the Snap creates a new worksheet in the target spreadsheet using the worksheet name specified, without the extra space. 

Workaround: Enclose the names of the spreadsheet and worksheet in quotes (") and enable expressions for both Spreadsheet and Worksheet fields.

Known Issue:

Page lookup error: page "Spreadsheets Browser" not found.

If you're experiencing issues please see our Troubleshooting Guide.

Impact on Migration of API from v3 to v4:Enhances the Google Spreadsheet Snap Pack by migrating from v3 to v4 API as Google announces sunsetting the v3 API on June 8, 2021. For more information, see Impact on Migrating Google Spreadsheet Pipelines from v3 to v4.
Account

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. This Snap uses a Google OAuth2 Account (Client ID, Client Secret, etc) or Google Dynamic OAuth2 Account (Access Token). See Configuring Google Spreadsheet Accounts for more information.

Views
InputThis Snap has exactly one document input view.
OutputThis Snap has at most one document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.

Settings

Label

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



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

Example: My Google Sheet

Default value: None

Worksheet


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

Example: Sheet1

Default value:  None

Overwrite worksheet if it exists

Select this option to overwrite existing information if the worksheet exists.

Default value: Not selected

Write header row

Select this option if the row containing column names should be written to the worksheet.
Default value: Selected

Parse data

Specify whether the input value must be preserved or parsed. Available options are:

  • RAW: The input is not parsed and is inserted as a string. For example, "=1+2" places the string "=1+2" in the cell, not the implied result.
  • USER_ENTERED: The input is parsed exactly as if it were entered into the Google Sheets UI. For example, "Mar 1 2016" becomes a date, and "=1+2" becomes a formula. Formats may also be inferred; so "$100.15" becomes a number with currency formatting.

Default value: RAW

Number of retries

Specify the maximum number of retry attempts that the Snap must make to write into the worksheet.

Default value: 3

Retry interval (seconds)

Specify the time interval in seconds for each retry attempt.

Default value: 1

Connection propertiesConfigure the connection properties to specify the read and connection timeouts.
Read timeout in seconds

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

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

Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.
  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Error rendering macro 'excerpt-include' : No link could be created for 'Google Spreadsheet Snap Pack'.

  • No labels
$customFooter