Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this Page

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

Snap type:

Write

Description:

This Snap writes to a worksheet in a Google spreadsheet.

  • Expected upstream Snaps Generators (CSV, JSON), Mapper.
  • Expected downstream SnapsNone.
  • Expected inputThe 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:
  • Inputs without any format restrictions are accepted when the expression toggle is enabled and a pipeline parameter is provided for the following fields:
    • Number of retries
    • Retry interval
    • Read timeout in seconds
    • Connection timeout in seconds
  • For an expression input, the value is evaluated and accepted if it meets the expression criteria, if not then the default value is used.
    Multiexcerpt include macro
    nameME_GS_V3toV4
    pageSpreadsheets Browser
    • 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 IssuesIssue:

    There is a long-standing bug in the Google Sheets endpoint that doesn't allow users to use colon ':' in the worksheet names so we cannot support such inputs, see https://stackoverflow.com/a/55696445.

    Multiexcerpt include macro
    nameME_GS_KI
    pageSpreadsheets Browser

    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

    Multiexcerpt include macro
    nameSnap Execution
    pageSOAP Execute

    Multiexcerpt include macro
    nameExecution_Detail_Write
    pageSOAP Execute


    Insert excerpt
    Google Spreadsheet Snap Pack
    Google Spreadsheet Snap Pack
    nopaneltrue