Versions Compared

Old Version 41

changes.mady.by.user Gouri Bhagchandani

Saved on

compared with

New Version Current

changes.mady.by.user Gouri Bhagchandani

Saved on

Key

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

In this article

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

Overview

You can use Google Sheets Reader Snap to read a worksheet from the specified spreadsheet.

Note
iconfalse
titleImpact on Migration of API from v3 to v4:

Enhances the Google Sheets 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 Sheets Pipelines from V3 to V4.

Snap Type

Google Sheets Reader Snap is a READ-type Snap that reads a worksheet in the given spreadsheet.

Prerequisites

A valid Google Spreadsheet account. 

Support for Ultra Pipelines

Works in Ultra Pipelines.

Limitations

  • If the spreadsheet or worksheet that you want to read contains one or more leading or trailing spaces, the Google Sheets Reader Snap displays 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.

  • When you provide a Spreadsheet ID to fetch data, and if a Spreadsheet with the same ID already exists as the Spreadsheet name, then the Google Sheets Reader Snap fails to fetch the data of the specified Spreadsheet ID. The Snap fails with an error: Failed to read the worksheet '<spreadsheetID>' in the spreadsheet. Hence, if you want to fetch data of the specified Spreadsheet ID, ensure that you specify a uniqueSpreadsheetNameorSpreadsheetName with Spreadsheet ID.

Multiexcerpt include macro
nameME_GS_V3toV4
pageGoogle Sheets Browser

Known Issue

Multiexcerpt include macro
nameME_GS_KI
pageGoogle Sheets Browser

Snap Views

TypeFormatNumber 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 specified worksheet.

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

  • Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the rest of the records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

Field Name

Field Type

Description


Label*


Default Name: Google Sheets Reader
Example: Read Sheet1


String

Specify a unique and meaningful name for the Snap.


Include Shared Drives


Default Value: Deselected
Example: Selected

Checkbox

Select this checkbox to read files from the shared drive.

Deselect this checkbox if you do not want the Snap to read files from the shared drive.


Display Spreadsheet ID in Suggestions


Default Value: Deselected
Example: Selected

Checkbox

Select this checkbox to display Spreadsheets ID along with the Spreadsheet name in the Spreadsheets Suggestions list.


Spreadsheet*


Default Value: [None]
Example: My Google Sheet

String/Expression/Suggestion

Specify the name of the spreadsheet containing the worksheet to be read. Alternatively, click the Suggestion  icon to populate the list of spreadsheets associated to the account and select the required spreadsheet.


Worksheet*


Default Value: None
Example: Sheet 1


String/Expression/Suggestion

Specify the name of the worksheet to be read. Alternatively, click the Suggestion  icon to populate the list of worksheets associated to the account and select the required worksheet.

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.


Header exists


Default Value: Selected
Example: Deselected

Checkbox

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


Preserve data types


Default Value: Deselected
Example: Selected

Checkbox

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 this checkbox if the file to be read is large (more than 50K rows in one sheet), as it makes the Snap read the data faster.


Allow empty rows

Default Value: Deselected
Example: Selected

Checkbox


Google Sheets Reader Snap fetches only those rows that have data and ignores the empty rows. Select this checkbox to fetch empty rows between the rows that contain data.

Number of Retries


Default Value: 3
Example: 3

Integer/Expression

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


Retry Interval (seconds)


Default Value: 1
Example: 1

Integer/Expression

Specify the time interval in seconds for each retry attempt.


Connection properties

Read timeout in seconds


Default Value: 180
Example: 100

Integer/Expression

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


Connection timeout in seconds


Default Value: 20 
Example: 10

Integer/Expression

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.


Snap Execution


Default Value: Validate & Execute 
Example: Execute Only

Dropdown list

Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read



Insert excerpt
Google Sheets Snap Pack
Google Sheets Snap Pack
nopaneltrue