Versions Compared

Old Version 34

changes.mady.by.user Kalpana Malladi

Saved on

compared with

New Version 35

changes.mady.by.user Kalpana Malladi

Saved on

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

Overview

You can use this Snap to read a worksheet in a spreadsheet and writes the data to the output view.

Note
iconfalse
titleImpact 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:

Image Added

Read

Description:

This Snap reads a worksheet in a spreadsheet and writes the data to the output view.

  • Expected upstream Snaps: [None]
  • Expected downstream Snaps: File Writer or any Transform Snap.
  • Expected input: The name of the worksheet to be read, including the base folder and spreadsheet information.
  • Expected output: The data of the provided worksheet.

Image Removed

Prerequisites:

[None]

Support and limitations:

Prerequisites

A valid Google Spreadsheet account. 

Support for Ultra Pipelines

Works in Ultra

Task

Pipelines.

Limitations

  • If the spreadsheet or worksheet that you want to read contains one or more leading or trailing spaces, the Worksheet Reader Snap throws an error.
    Workaround: Enclose the names of the spreadsheet and worksheet in quotes (") and enable expressions for both Spreadsheet and Worksheet fields. For example, "Sheet 1."
  • If you select Preserve Data Types and name the worksheet similar to the Google spreadsheet column-row range; for example, AB123, then you may receive a bad request error.

Multiexcerpt include macro
nameME_GS_V3toV4
pageSpreadsheets Browser

Known Issue

:

Multiexcerpt include macro
nameME_GS_KI
pageSpreadsheets Browser

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, and so on) or Google Dynamic OAuth2 Account (Access Token). See Configuring Google Sheets Accounts for more information.

Views:
InputThis Snap has at most one document input view.
OutputThis Snap has exactly 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

Snap Input and Output

Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
InputDocument
  • Min:0
  • Max:1
  • None
The name of the worksheet to be read, including the base folder and spreadsheet information.
OutputDocument
  • Min:1
  • Max:1
  • File Writer
  • Transform Snap

The data of the provided worksheet.

Snap Settings

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.

Pipeline.

Default Name: Worksheet Reader
Example: Read Sheet1

Spreadsheet

Required. The

*



N/A

Specify the name of the spreadsheet containing the worksheet to be read.  It is suggestible based on the base folder.

Example: My Google Sheet

Default value: [None]
Example: My Google Sheet

Worksheet

Required. The

*


N/A

Specify the name of the worksheet to be read. It is suggestible based on the spreadsheet.

Note
  • Hidden and Protected sheets are not a part of worksheet suggestions. However, you can manually enter the name of the existing worksheet that is hidden or protected to enable the Snap to overwrite based on your account permissions.
    • Worksheets with hidden range appear in the suggestion list.
    • Worksheets with protected range do not appear in the suggestion list.
  • You can view the list of hidden sheets in the Google Sheets UI by clicking View and then selecting Hidden Sheets.
  • You can view the protected ranges in Google Sheets UI by clicking Data and then selecting Protected sheets and ranges.
Example: Sheet 1

Default value: None
Example: Sheet 1

Header existsN/A

Select this

option

checkbox if the worksheet's first row is a header.

Default value: Selected

Preserve data typesN/A

This Snap converts all input data types to strings. Select this check box to preserve the data type of the data coming into this Snap.

Info

We recommend that you deselect Preserve data types if the file to be read is large (>50K rows in one sheet), as it makes the Snap read the data faster.

Default value: Not selected

Number of
retries
RetriesN/A

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

Default value: 3

Retry
interval
Interval (seconds)N/A

Specify the time interval in seconds for each retry attempt.

Default value: 1

Connection propertiesN/AConfigure the connection properties to specify the read timeout and connection timeouts.
Read timeout in seconds
Time
N/A

Specify the time in seconds. In the event of a connection failure, the Snaps stops trying to read the data after the specified time.

Default value: 180

Connection timeout in seconds
Time
N/A

Specify the time in seconds. In the event of a connection failure, the Snaps 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

name

Snap Execution

pageAnaplan Read
N/A

Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read


Insert excerpt
Google Sheets Snap Pack
Google Sheets Snap Pack
nopaneltrue