On this Page
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
This account is used by the Snaps in the Google Sheets Snap Pack.
| Note |
|---|
| 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:
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.
- (Optional) Supply additional information on this account in the Notes field of the Info tab.
| Warning |
|---|
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.
| |
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 number of seconds time (in seconds) until which the access token must be valid. For example, 12169 |
OAuth2 Endpoint | Required. Authorization endpoint to authorize the application. Default value: https://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 config | Provides 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 |
| Authorize | Starts 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.
| |
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|