How to read data from Google Calendar in ZappySys Data Gateway
In this section we will learn how to configure and use Google Calendar Connector in the API Driver to extract data from the Google Calendar.
Create Data Source in ZappySys Data Gateway based on ZappySys API Driver-
Download and install ZappySys ODBC PowerPack.
-
Search for gateway in start menu and Open ZappySys Data Gateway:
-
Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
-
Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.
GoogleCalendarDSN
-
When the Configuration window appears give your data source a name if you haven't done that already, then select "Google Calendar" from the list of Popular Connectors. If "Google Calendar" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:
GoogleCalendarDSNGoogle Calendar -
Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.
Steps to get Google Calendar Credentials
To make this work you will have to create an OAuth application. To register an App, perform the following steps (Detailed steps found in the help link at the end):
- Go to Google API Console
- From the Project Dropdown (usually found at the top bar) click Select Project
- On Project Propup click CREATE PROJECT
- Once project is created you can click Select Project to switch the context (You can click on Notification link or Choose from Top Dropdown)
- Click ENABLE APIS AND SERVICES
- Now we need to enable Google Drive API.
- Search Google Drive API. Select and click ENABLE
- Go to back to main screen of Google API Console
- Click OAuth Concent Screen Tab. Enter necessary details and Save.
- Click Credentials Tab
- Click CREATE CREDENTIALS (some where in topbar) and select OAuth Client ID option.
- When prompted Select Application Type as Desktop App and click Create to receive your ClientID and Secret. You can use this information now to configure Connection with UseCustomApp=true.
Fill in all required parameters and set optional parameters if needed:
GoogleCalendarDSNUser Account [OAuth]https://www.googleapis.com/calendar/v3/Required Parameters UseCustomApp Fill in the parameter... Optional Parameters ClientId Fill in the parameter... ClientSecret Fill in the parameter... Scope Fill in the parameter... RetryMode Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... Steps to get Google Calendar Credentials
Use these steps to authenticate as service account rather than Google / GSuite User. Learn more about service account here Basically to call Google API as Service account we need to perform following steps listed in 3 sections (Detailed steps found in the help link at the end)Create Project
First thing is create a Project so we can call Google API. Skip this section if you already have Project (Go to next section)- Go to Google API Console
- From the Project Dropdown (usually found at the top bar) click Select Project
- On Project Propup click CREATE PROJECT
- Once project is created you can click Select Project to switch the context (You can click on Notification link or Choose from Top Dropdown)
- Click ENABLE APIS AND SERVICES
- Now we need to enable API - Google Calendar API
- Search Drive. Select and click ENABLE
Create Service Account
Once Project is created and APIs are enabled we can now create a service account under that project. Service account has its ID which looks like some email ID (not to confuse with Google /Gmail email ID)- Go to Create Service Account
- From the Project Dropdown (usually found at the top bar) click Select Project
- Enter Service account name and Service account description
- For Role, do not select anything for now and Click Continue and then click Done. Next we will create Key.
Create Key
Once service account is created we need to create key file (i.e. credentials).- In the Cloud Console, click the email address for the service account that you created.
- Click Keys.
- Click Add key, then click Create new key.
- Click Create and select P12 format. A P12 key file is downloaded to your computer. We will use this file in our API connection.
- Click Close.
- Now you may use downloaded *.p12 key file as secret file and Service Account Email as Client ID (e.g. some-service-account-name@your-project-id.iam.gserviceaccount.com ).
Add Permission
Now last thing is give read/write permission to Service Account for Calendar you like to access using API.- Copy the email address of your service account we created in previous step (its usually like this some-service-account-name@your-project-id.iam.gserviceaccount.com).
- Login to https://calendar.google.com/calendar and make sure you see the calendar you like to access via API
- On the left, find the "My calendars" section. To expand it, click the Down arrow Down arrow.
- Hover over the calendar you want to share, and click 3 dots next to it. Click "Settings and sharing".
- Find "Share with specific people", Click Add people button and enter the service account email id we obtained in the previous section.
- Select correct permission you like to give for sharing. Click Send button to share. Thats it now we can read / write Calendar Events using Service account approach.
- For more information check this link https://support.google.com/calendar/answer/37082?hl=en
Fill in all required parameters and set optional parameters if needed:
GoogleCalendarDSNService Account (Using Private Key File) [OAuth]https://www.googleapis.com/calendar/v3/Required Parameters Service Account Email Fill in the parameter... Service Account Private Key Path (i.e. *.p12) Fill in the parameter... Optional Parameters Scope Fill in the parameter... RetryMode Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... -
Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
-
Click OK to finish creating the data source.
- Firstly, to get data from ODBC data source based on ZappySys ODBC driver, in your client application, you would need to connect to ODBC source and then from the list select the data source.
-
Finally, to read the data just read tables/views in your app or enter a SQL statement to extract data, e.g.:
SELECT * FROM Events
- Power BI
- Tableau
- Excel
- Informatica PowerCenter
- QlikView
- SQL Server / Linked Server
- SSRS (SQL Server Reporting Services)