Configuring Google Sheets Accounts

On this Page

This account is used by the Snaps in the Google Sheets Snap Pack.

You will need to use a Google Account that has access to the Google API Admin Role.

You can create an account from Designer or Manager. In Designer, when working on pipelines, every Snap that needs an account prompts you to create a new account or use an existing account. The accounts can be created in or used from:

  • Your private project folder: This folder contains the pipelines that will use the account.
  • Your Project Space’s shared folder: This folder is accessible to all the users that belong to the Project Space.
  • The global shared folder: This folder is accessible to all the users within an organization in the SnapLogic instance.


Account Configuration

In Manager, you can navigate to the required folder and create an account in it (see Accounts). To create an account for Google Sheet: 

  1. Click Create, then select Google Sheets, then Google Dynamic OAuth2 or Spreadsheet Basic Auth Account.

    • Google OAuth2:

      • Supply an account label.
      • Click Authorize. You will be asked to log into a Google account. Log in with your user credentials, and after successfully logging in, you will be asked to provide permission for access. Access is required to make a connection.

      • Click Apply.

    • Google Dynamic OAuth2:

      • Provide a valid access token to make requests against OAuth2 enabled endpoints. 

  2. (Optional) Supply additional information on this account in the Notes field of the Info tab.

Avoid changing account credentials while pipelines using them are in progress. This may lead to unexpected results, including locking the account.

Known Issue

While authorizing accounts, force approval prompts you to request a new refresh token.

Account Types

Spreadsheet Dynamic Auth Account

Account settings

Label


Required. User-provided label for the account instance

Default value: None

Example: Account_Test

Access token


Required. Enter the access token to authorize Google API Client Libraries or Google OAuth 2.0 endpoints to implement OAuth 2.0 authorization to access Google APIs. The access token is retrieved when setting up the account for the endpoint. For more info, see Using OAuth 2.0 to Access Google APIs.

Default value: None

Example: SN3fH-25j53-hh3y77-sss12

Header authenticated


Required. Enable this if endpoint uses bearer header authentication.

Default value: Not selected

Example: Selected

 Account encryption

Standard Encryption

If you are using Standard Encryption, the High sensitivity settings under Enhanced Encryption are followed.


Enhanced Encryption

If you have the Enhanced Account Encryption feature, the following describes which fields are encrypted for each sensitivity level selected per each account.

  • High:
  • Medium + High:
  • Low + Medium + High

Spreadsheet OAuth2 Account

Account settings

Label

Required. User-provided label for the account instance

Access token


Required. The access token for the application. The retrieval of the access token is done when setting up the account for the endpoint. There, the OAuth2 flow will be executed and the resulting access token will be stored in this property. The access token might be refreshable, in that case an optional refresh token can be stored. The user must get a new access token if the access token has expired and no refresh token was defined or both the access and the refresh token have expired.

Refresh token


If you create a new OAuth2 Account and authorize it, you might see that you didn't get a refresh token (or even a consent dialog, because Google knows your Google Account has already authorized our Snap's Google OAuth app and only gives refresh tokens by default on the first authorization per Google Account, not per SnapLogic OAuth2 Account).

To force receiving a new refresh token, change "Approval Prompt" to "force", click the Authorize button, give consent to offline access in the browser, and confirm that you now have a refresh token.

Access token expiration

The time (in seconds) until which the access token must be valid. For example, 12169

OAuth2 Endpoint


Required. Authorization endpoint to authorize the application.

Default valuehttps://accounts.google.com/o/oauth2/auth

OAuth2 Token


Required. Token endpoint to get the access token.

Default value: https://oauth2.googleapis.com/token


Auth endpoint configProvides custom properties for the OAuth2 auth endpoint.

Access type

Indicates whether the Snap needs to access a Google API when the user is not present at the browser. The property value "offline" results in a refresh token being obtained the first time authorization has been received.

Approval prompt

Indicates whether the user should be re-prompted for offline consent to receive a new refresh token. The property value "auto" will only display the consent prompt on the first time through the OAuth 2.0 authorization sequence. To manually acquire a new refresh token, set this property value to "force" and re-authorize.

Default value: auto

Application scope

The scope for the applications execution. As an example, the Snap could define that only a read of data by the application should be allowed.

Default value: https://www.googleapis.com/auth/spreadsheets https://www.googleapis.com/auth/drive

Auto-refresh token

Not supported. No refresh token available for this account type. 
Default value: Not selected
AuthorizeStarts the OAuth authorization flow. Account will be saved before authorize. 

Account encryption

Standard Encryption

If you are using Standard Encryption, the High sensitivity settings under Enhanced Encryption are followed.

Enhanced Encryption

If you have the Enhanced Account Encryption feature, the following describes which fields are encrypted for each sensitivity level selected per each account.

  • High:
  • Medium + High:
  • Low + Medium + High

Snap Pack History

 Click to view/expand


ReleaseSnap Pack VersionDateTypeUpdates

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 typesConnection propertiesRead 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.