Skip to end of banner
Go to start of banner

Google Sheets Subscribe

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 29 Current »

In this article

Overview

You can use this Snap to subscribe to the specified spreadsheet for notifications of the changes in the Google Sheet.

Snap Type

Google Sheets Subscribe Snap is a READ-type Snap.

Prerequisites

None.

Support for Ultra Pipelines  

Works in Ultra Pipelines. 

Limitations

  • This Snap does not support Shared Drive or other Drives—it supports only My Drive.

  • If you subscribe to a Spreadsheet with multiple channels simultaneously, you will receive multiple notifications.

  • If you configure Webhook URL using a Triggered task, there is a two to four-minute delay in receiving notifications on the Channel or Spreadsheet.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Mapper

  • Copy

The Spreadsheet name or ID, Channel ID, and Webhook URL.

Output

Document

  • Min: 1

  • Max: 1

  • Mapper

The Snap returns ID, resource ID, and resource URI.

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:

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

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining 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

  • Asterisk ( * ): Indicates a mandatory field.

  • Suggestion icon ((blue star)): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon ((blue star) ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon ( (blue star) ): Indicates that you can add fields in the fieldset.

  • Remove icon ((blue star)): Indicates that you can remove fields from the fieldset.

Field Name

Field Type

Description

Label*

Default Value: Google Sheet Subscribe
Example: Subscribe Accounts

String

Specify a unique name for the Snap.

Include Shared Drives

Default Value: Deselected
Example: Selected

Checkbox

Select this checkbox to include files from the shared drive.

Deselect this checkbox to exclude files from the shared drive.

This Snap does not support Shared Drive or other Drives—it supports only My Drive.

Display Spreadsheet ID in Suggestions

Default Value: Deselected
Example: Selected

Checkbox

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

Spreadsheet

Default value: N/A
Example: My Google Sheet

String/Expression/Suggestion

Specify or select the spreadsheet name or ID (or both) containing the worksheet to be subscribed to.

Webhook URL

Default value: N/A
Example: https://snap.elastic.snaplogicdev.com/api/1/rest/slsched/feed/QA/AccountValidation/shared/Test_PipelineyPHNzSUAvY7pUxZhjei35rgkCJ87gzzr

String/Expression

Specify the Webhook URL to allow Google to send notifications.

Webhook URL is similar to Target URL. To get a target URL, you must create a triggered task. Learn more about Creating a Triggered Task and Running a Triggered Task.

Watch the video for more information about how to obtain Webhook URL.

Channel ID

Default value: Math.randomUUID()
Example: Math.randomUUID()

String/Expression

Specify a UUID or similar unique string that identifies the channel.

Expiration (in Minutes)

Default value: 60
Example: 40

Integer/Expression

Specify the time in minutes after which the subscription expires.

The maximum allowed subscription time is 24 hours.

Snap Execution

Default Value: Validate & Execute
Example: Execute only

Dropdown list

Select one of the following three modes in which the Snap executes:

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

Example

Subscribing and Unsubscribing to a Google Spreadsheet

This example Pipeline demonstrates how to subscribe to and unsubscribe from a spreadsheet using Google Sheet Subscribe and Unsubscribe Snaps.

First, configure the Google Sheet Subscribe Snap to subscribe to the new spreadsheet for update notifications. Specify the following details:

  • Spreadsheet: The spreadsheet name to subscribe.

  • Webhook URL: The target URL to which the notifications should be delivered.

  • Channel ID: The ID of the channel to which the spreadsheet belongs.

  • Expiration: The expiration time for the subscription with the resource ID.

The following image shows how to do this configuration and the resulting output:


Next, configure the Mapper Snap to extract the $id and $resourceId:


Finally, configure the Google Sheet Unsubscribe Snap to unsubscribe the spreadsheet as shown.

Download this Pipeline.

Video Demonstration

The following video demonstrates how to obtain Webhook URL.

Obtain Webhook URL Using Google Sheet Subscribe.mp4

Downloads

  1. Download and import the Pipeline into SnapLogic.

  2. Configure Snap accounts as applicable.

  3. Provide Pipeline parameters as applicable.

Snap Pack History

 Click to view/expand


ReleaseSnap Pack VersionDateTypeUpdates
May 2024main26341 StableUpdated and certified against the current SnapLogic Platform release.
February 2024main25112 StableUpdated and certified against the current SnapLogic Platform release.
November 2023main23721 StableUpdated and certified against the current SnapLogic Platform release.
August 2023main22460 StableUpdated and certified against the current SnapLogic Platform release.

May 2023

main21015 

Stable

Upgraded with the latest SnapLogic Platform release.

February 2023main19844 StableUpgraded with the latest SnapLogic Platform release.
November 2022main18944 StableUpgraded with the latest SnapLogic Platform release.
August 2022main17386 Stable

  • The Allow empty rows checkbox in the Worksheet Reader Snap allows you to output empty rows. Select this checkbox to include empty rows between other rows that contain data.

  • The Worksheet Writer Snap supports expressions for the Starting Cell Reference field. This Snap also includes a warning about potential overwriting of existing data for the Starting Cell Reference field when writing data in the same range of cells.

4.29429patches16975 Latest
  • Fixed an issue with the Worksheet Writer Snap where the Snap failed to write data correctly after each batch write. 









    When the Write Mode is Create New Worksheet and Overwrite worksheet if it exists checkbox is selected, the cell data is shifted by five columns to the right after each batch in the resulting worksheet. Now, the data is written correctly in the worksheet.

  • Introduced the following Snaps:

4.29main15993 Stable

  • Enhanced the Spreadsheets Browser, Worksheet Reader, and Worksheet Writer Snaps with the Include Shared Drives checkbox to support working with the Google Shared Drives.

  • Enhanced the Worksheet Reader and Worksheet Writer Snaps with the Display Spreadsheet ID in Suggestions checkbox. You can select this checkbox to display both spreadsheet ID and the spreadsheet name in the suggestions. This helps you to choose among the spreadsheets having the same name.

  • Enhanced the Worksheet Writer Snap with the Write Mode dropdown list to perform the desired write option for the given worksheet—that is either create a new worksheet or append or edit an existing worksheet. You can write new data to the worksheet by specifying a cell reference as the starting point or append data to the worksheet at the last row in the worksheet containing content.

4.28 Patches428 patches14755 Latest

  • Enhanced the Spreadsheet Browser Snap with the Fetch Mode dropdown list. You can fetch:

    • Spreadsheets and worksheets within that Spreadsheet, or

    • Only Spreadsheets.

4.28main14627 StableUpgraded with the latest SnapLogic Platform release.

4.27

main12833

 

Stable

Upgraded with the latest SnapLogic Platform release.
4.26main11181 LatestEnhanced the Worksheet Writer Snap to populate the target schema preview with headers and associated data types (when the data is written to an existing worksheet with a valid header) in the upstream Snap.
4.25main9554
 
Stable

Upgraded with the latest SnapLogic Platform release.

4.24main8556
StableUpgraded with the latest SnapLogic Platform release.
4.23 Patch423patches7848 Latest

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

4.23main7430
 
StableUpgraded with the latest SnapLogic Platform release.
4.22main6403
 
StableUpgraded with the latest SnapLogic Platform release.
4.21snapsmrc542

 

StableUpgraded with the latest SnapLogic Platform release.
4.20snapsmrc535
 
StableUpgraded with the latest SnapLogic Platform release.
4.19 Patch google/spreadsheet8333 Latest

Fixed an issue with the Google Worksheet Reader Snap wherein the Snap produces output documents for empty rows.

4.19snaprsmrc528
 
StableUpgraded with the latest SnapLogic Platform release.
4.18snapsmrc523
 
StableUpgraded with the latest SnapLogic Platform release.
4.17 Patchgoogle/spreadsheet7283 Latest

Fixed an issue with the Google Worksheet Writer Snap wherein the No of valid records written field in the output document would count the header row.

4.17ALL7402
 
Latest

Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17snapsmrc515
 
Latest

Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.

4.16 Patchgoogle/spreadsheet6995 Latest

Fixed an issue wherein the Spreadsheets Browser Snap fails if a spreadsheet name contains / or : in Windows plex.

4.16snapsmrc508
 
StableUpgraded with the latest SnapLogic Platform release.
4.15 Patchgoogle/spreadsheet6835 Latest

Added a new property, Parse data, to the Worksheet Writer Snap which helps preserve the date data type.

4.15 Patchgoogle/spreadsheet6639 Latest

Added new properties, Preserve data types, Connection properties, Read timeout in seconds, and Connection timeout in seconds, to the Worksheet Reader Snap. These properties let you convert input data types to strings and handle connection timeouts. Also, fixed issues with header count, column count mismatch and rendering of columns with no headers.

4.15snapsmrc500
 
StableUpgraded with the latest SnapLogic Platform release.
4.14 Patch google/spreadsheet5730  Latest

Migrated Google Sheets from API v3 to v4. Implemented retries to overcome defects in Sheets API.

4.14snapsmrc490
 
StableUpgraded with the latest SnapLogic Platform release.
4.13 Patch spreadsheet5293 Latest

Fixed the Google Worksheet Writer Snap that incorrectly displays numeric values as a string in the spreadsheet when writing in batch mode. The spreadsheet now preserves the exact data type of the input value.  

4.13

snapsmrc486

 
StableUpgraded with the latest SnapLogic Platform release.
4.12

snapsmrc480

 
Stable

Added the Batch write property  in Worksheet Writer to enable writing the input documents into the worksheet as a single batch instead of writing the input data one cell at a time.

4.11snapsmrc465
 
StableUpgraded with the latest SnapLogic Platform release.
4.10 Patch spreadsheet3626
LatestAddressed an issue where Worksheet Reader failed unexpectedly when validation mode input exceeded limitations.
4.10

snapsmrc414

 
Stable

Updated the Google Worksheet Writer Snap with Row count property to resolve the ' Data writing error'.

4.9.0 Patch spreadsheet3104 Latest

Addressed an issue with Google Worksheet writer: Fails with " Data writing error "

4.9snapsmrc405
 
StableUpgraded with the latest SnapLogic Platform release.
4.8

snapsmrc398

 
StableUpgraded with the latest SnapLogic Platform release.
4.7

snapsmrc382

 
StableUpgraded with the latest SnapLogic Platform release.
4.6snapsmrc362
 
StableUpgraded with the latest SnapLogic Platform release.
4.5.1

snapsmrc344

 
StableUpgraded with the latest SnapLogic Platform release.
4.5

snapsmrc344

Stable

Enhanced the error view output to include error, reason, and resolution.

Related Content

  • No labels

Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.