In this article

Overview

You can use the Google Sheets Browser Snap to browse the given Google Drive folder and list the spreadsheet names matching the provided name filter. The Snap also displays the worksheets within each spreadsheet.

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 Browser Snap is a Read-type Snap that reads spreadsheets from Google Drive.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines.

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.

Known Issue

A long-standing bug​ in the Google Sheets endpoint does not allow the use of a colon ':' in the worksheet names; hence, these inputs are not supported.

Snap Views

TypeFormatNumber of ViewsExamples of Upstream and Downstream SnapsDescription
OutputDocument
  • Min:0
  • Max:1
  • None
The name filter to select the desired spreadsheets.
InputDocument
  • Min:1
  • Max:1
  • File Writer
  • Transform
List of spreadsheets available in the provided folder matching the provided name filter. Provides Sheet ID, Sheet name, and Worksheets within.

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.

  • 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 value: Google Sheets Browser
Example: Google Sheets Browser

String

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.


Include Shared Drives


Default Value: Deselected
Example: Selected

Checkbox

Select this checkbox to write files from the shared drive.

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


Name filter


Default value: None
Example: Filter1

String/Expression

Specify the GLOB pattern to look for spreadsheets having name patterns.


Fetch Mode


Default Value: Spreadsheets and Worksheets
Example: Spreadsheets

Dropdown list

Choose an option to fetch the Spreadsheets. The available options are:

  • Spreadsheets and Worksheets: Fetches Spreadsheets and Worksheets within the Spreadsheet.

  • Spreadsheets: Fetches only the Spreadsheets.


Number of Retries


Default value: 3
Example: 2

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: 2

Integer/Expression

Specify the time interval in seconds for each retry attempt.


Snap Execution


Default value: Validate & Execute
Example: Execute only

Dropdown list