The Google Sheets Synapse enables data synchronization between Google Sheets and Syncari entities using the Google Sheets API. After you authenticate the Synapse, you can activate the Google Sheets Synapse, which enables Syncari to interpret folder structure and sheets as if it were a database schema. This interpretation allows Syncari to make Google Sheets data available within the Syncari Unified Data Model.
Requirements & Reference
- You need to enable Drive SDK API for Syncari to access files in google drive. Follow this Google Support article to enable it in your workspace.
- You need access to Google Drive and be able to setup folders. Syncari maps a folder in Google Drive to an Entity. This folder should contain the actual sheets, with the same headers.
- Syncari also requires a top level folder, that contains all the "Entity" folders.
Supported Synapse Capabilities
- Schema discovery
- Create, Read, Update and Delete rows in any sheet corresponding to an Entity
- Schema Sync
Organize Google Drive and Google Sheets
Syncari requires a specific folder structure for any sheets that you want to use in Syncari.
- A root folder called Syncari. Think of this as the database. This can live anywhere in Drive, even under another folder.
- Subfolders that represent discrete objects—entities in Syncari.
- One sheet in each folder that contains the object data.
- The top row in each sheet represents the fields within the object.
- Each row is a record.
Managing Data Types in Google Sheets and Syncari
All fields will come through as "String" data types by default. This is important because Syncari will use the data type defined in the Google Sheet and sync this data type in Syncari. For any fields with numbers or non-string data types, you will want to select that column → Format → select the appropriate data type (i.e. number, currency, date, date time, etc.).
Note: All numbers coming from Google Sheets will show in Syncari as data type = "double"
Locate the Folder ID of the Syncari Folder
When you authenticate the Google Sheets synapse, you’ll need to enter the folder ID for the root folder. You can find it in the URL of the Syncari root folder.
Configure the Google Sheets Synapse in Syncari
In the previous section, you:
- Set up the folder structure in Google Drive.
- Moved the sheets that you want to add to the Syncari Unified Data Model to their appropriate folders in Google Drive.
- Located the Folder ID for the root Syncari folder.
Now, you can connect the Google Sheets synapse in Syncari:
- 🎥Watch the video.
- 👀 Read the steps below.
- In Syncari, open Synapse Studio.
- Find Google Sheets in the Synapse Library, and drag it to the canvas.
- Complete the information in the Configure step:
- Synapse Name—Enter your own custom name for the synapse.
Note: Stick to letters and numbers. The name must begin with a letter. The only special characters we allow are spaces, hyphens (-), and underscores (_). - Folder Id—Enter the Folder ID of the root Syncari folder. See Locate the Folder ID of the Syncari Folder.
- Authentication Method—Select One Click Oauth.
- Optional: The Sync Rate Limit affects downstream syncs with the synapse. Turn on the Sync Rate Limit if needed to limit the sync rate for updates. You can edit this configuration later if you find you need to manage your downstream syncs.
- Synapse Name—Enter your own custom name for the synapse.
- Click Next.
- Click Sign in With Google and log in with the credentials of the Google Drive where the Syncari folder is located.
- Select all of the access options—required to connect the Google Sheets synapse, and then click Continue.
- Click Next.
- Select Make Synapse Active.
Other options include:- Map Entities in Sync Studio—Syncari takes you to Sync Studio to map the entities before activating the Synapse.
- Activate and Create Pipelines—We don't recommend using this option except in specific use cases (e.g., this is your first synapse, and you want your schema to match that of the synapse). For synapses with default mappings, Syncari updates the Sync Studio canvas and creates draft pipelines for the Syncari Unified Data Model. Contact one of our Onboarding and Support team members before using this option.
- Click Close.