Reading Google Calendar data in SQL Server using ZappySys Data Gateway

This section covers steps for setting up Google Calendar Connector in the ZappySys Data Gateway data source (based on API Driver) to read Google Calendar data in SQL Server:

Create Data Source in ZappySys Data Gateway based on API Driver

1. Download and install ODBC PowerPack.

2. Search for gateway in start menu and Open ZappySys Data Gateway:
   

3. 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:
   

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

   
   

5. 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:

   GoogleCalendarDSN

   Google Calendar

   

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

    User Account [OAuth]

   User accounts represent a developer, administrator, or any other person who interacts with Google APIs and services. User accounts are managed as Google Accounts, either with Google Workspace or Cloud Identity. They can also be user accounts that are managed by a third-party identity provider and federated with Workforce Identity Federation. [API reference]

   Steps how to get and use Google Calendar credentials
   

   Follow these steps on how to create Client Credentials (User Account principle) to authenticate and access Google Calendar API in SSIS package or ODBC data source:

   WARNING: If you are planning to automate processes, we recommend that you use a Service Account authentication method. In case, you still need to use User Account, then make sure you use a system/generic account (e.g. automation@my-company.com). When you use a personal account which is tied to a specific employee profile and that employee leaves the company, the token may become invalid and any automated processes using that token will start to fail.

   Step-1: Create project

   This step is optional, if you already have a project in Google Cloud and can use it. However, if you don't, proceed with these simple steps to create one:

   1. First of all, go to Google API Console.

   2. Then click Select a project button and then click NEW PROJECT button:

      

   3. Name your project and click CREATE button:

      

   4. Wait until the project is created:

      
   5. Done! Let's proceed to the next step.

   Step-2: Enable Google Calendar API

   In this step we will enable Google Calendar API:

   1. Select your project on the top bar:

      

   2. Then click the "hamburger" icon on the top left and access APIs & Services:

      

   3. Now let's enable several APIs by clicking ENABLE APIS AND SERVICES button:

      

   4. In the search bar search for calendar and then locate and select Google Calendar API:

      

   5. Enable Google Calendar API:

      
   6. Done! Let's proceed to the next step.

   Step-3: Create OAuth application

   1. First of all, click the "hamburger" icon on the top left and then hit VIEW ALL PRODUCTS:

      

   2. Then access Google Auth Platform to start creating an OAuth application:

      

   3. Start by pressing GET STARTED button:

      

   4. Next, continue by filling in App name and User support email fields:

      

   5. Choose Internal option, if it's enabled, otherwise select External:

      

   6. Optional step if you used Internal option in the previous step. Nevertheless, if you had to use External option, then click ADD USERS to add a user:

      

   7. Then add your contact Email address:

      

   8. Finally, check the checkbox and click CREATE button:

      
   9. Done! Let's create Client Credentials in the next step.

   Step-4: Create Client Credentials

   1. In Google Auth Platform, select Clients menu item and click CREATE CLIENT button:

      

   2. Choose Desktop app as Application type and name your credentials:

      

   3. Continue by opening the created credentials:

      

   4. Finally, copy Client ID and Client secret for the later step:

      
   5. Done! We have all the data needed for authentication, let's proceed to the last step!

   Step-5: Configure connection

   1. Now go to SSIS package or ODBC data source and use previously copied values in User Account authentication configuration:

      • In the ClientId field paste the Client ID value.
      • In the ClientSecret field paste the Client secret value.

   2. Press Generate Token button to generate Access and Refresh Tokens.

   3. Finally, click Test Connection to confirm the connection is working.

   4. Done! Now you are ready to use Google Calendar Connector!

   Fill in all required parameters and set optional parameters if needed:

   GoogleCalendarDSN

   Google Calendar

   User Account [OAuth]

   https://www.googleapis.com/calendar/v3/

   Required Parameters
   UseCustomApp	Fill-in the parameter...
   Optional Parameters
   ClientId
   ClientSecret
   Scope	https://www.googleapis.com/auth/calendar
   RetryMode	RetryWhenStatusCodeMatch
   RetryStatusCodeList	403|429
   RetryCountMax	5
   RetryMultiplyWaitTime	True
   Redirect URL (Only for Web App)

   

    Service Account [OAuth]

   Service accounts are accounts that do not represent a human user. They provide a way to manage authentication and authorization when a human is not directly involved, such as when an application needs to access Google Cloud resources. Service accounts are managed by IAM. [API reference]

   Steps how to get and use Google Calendar credentials
   

   Follow these steps on how to create Service Account to authenticate and access Google Calendar API in SSIS package or ODBC data source:

   Step-1: Create project

   This step is optional, if you already have a project in Google Cloud and can use it. However, if you don't, proceed with these simple steps to create one:

   1. First of all, go to Google API Console.

   2. Then click Select a project button and then click NEW PROJECT button:

      

   3. Name your project and click CREATE button:

      

   4. Wait until the project is created:

      
   5. Done! Let's proceed to the next step.

   Step-2: Enable Google Calendar API

   In this step we will enable Google Calendar API:

   1. Select your project on the top bar:

      

   2. Then click the "hamburger" icon on the top left and access APIs & Services:

      

   3. Now let's enable several APIs by clicking ENABLE APIS AND SERVICES button:

      

   4. In the search bar search for calendar and then locate and select Google Calendar API:

      

   5. Enable Google Calendar API:

      
   6. Done! Let's proceed to the next step.

   Step-3: Create Service Account

   Use the steps below to create a Service Account in Google Cloud:

   1. First of all, go to IAM & Admin in Google Cloud console:

      

   2. Once you do that, click Service Accounts on the left side and click CREATE SERVICE ACCOUNT button:

      

   3. Then name your service account and click CREATE AND CONTINUE button:

      

   4. Continue by clicking Select a role dropdown and start granting service account Project Viewer roles:

      

   5. Find Project group and select Viewer role:

      

   6. Finish adding roles by clicking CONTINUE button:

      
      You can always add or modify permissions later in IAM & Admin.

   7. Finally, in the last step, just click button DONE:

      

   8. Done! We are ready to add a Key to this service account in the next step.

   Step-4: Add Key to Service Account

   We are ready to add a Key (P12 certificate) to the created Service Account:

   1. In Service Accounts open newly created service account:

      

   2. Next, copy email address of your service account for the later step:

      

   3. Continue by selecting KEYS tab, then press ADD KEY dropdown, and click Create new key menu item:

      

   4. Finally, select P12 option and hit CREATE button:

      
   5. P12 certificate downloads into your machine. We have all the data needed for authentication, let's proceed to the last step!

   Step-5: Share Google Calendar with Service Account

   Now it's time to grant Google Calendar read/write permissions to the created service account:

   1. Login to https://calendar.google.com with Google account credentials whose calendar you want to share with the service account.
   2. On the top right click gear icon and click Settings item to open configuration.
   3. Then on the left, click Settings of my calendars section.
   4. Locate the calendar you want to share and select it.
   5. In the dropdown hit Share with specific people or groups and click Add people and groups button.
   6. Enter the service account email address we obtained in the previous section.
   7. Finally, choose the permissions, e.g. Make changes to events:
   8. 
   9. Click Send button to share the calendar.
   10. That's it! Let's proceed to the configuration!

   Step-6: Configure connection

   1. Now go to SSIS package or ODBC data source and configure these fields in Service Account authentication configuration:

      • In the Service Account Email field paste the service account Email address value you copied in the previous step.
      • In the Service Account Private Key Path (i.e. *.p12) field use downloaded certificate's file path.
   2. Done! Now you are ready to use Google Calendar Connector!

   Fill in all required parameters and set optional parameters if needed:

   GoogleCalendarDSN

   Google Calendar

   Service Account [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	https://www.googleapis.com/auth/calendar
   RetryMode	RetryWhenStatusCodeMatch
   RetryStatusCodeList	403|429
   RetryCountMax	5
   RetryMultiplyWaitTime	True
   Impersonate As (Enter Email Id)

   

7. Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:

   

   - Google Calendar

   Read / write Google Calendar data inside your app; perform many Google Calendar operations without coding, just using easy to use high performance API Connector for Google Calendar

   GoogleCalendarDSN

   

8. Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in to retrieve data from Google Calendar. Hit OK button to use this query in the next step.

   SELECT * FROM Calendars

   
   Some parameters configured in this window will be passed to the Google Calendar API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful data much faster.

9. Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in :

   

   - Google Calendar

   Read / write Google Calendar data inside your app; perform many Google Calendar operations without coding, just using easy to use high performance API Connector for Google Calendar

   GoogleCalendarDSN

   SELECT * FROM Calendars

   
   You can also access data quickly from the tables dropdown by selecting <Select table>.
   A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the Google Calendar API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Google Calendar servers).

10. Click OK to finish creating the data source.

Read data in SQL Server

1. First, let's open SQL Server Management Studio, create a new Linked Server, and start configuring it:

   LS_TO_GOOGLE_CALENDAR_IN_GATEWAY

   Microsoft OLE DB Driver for SQL Server

   localhost,5000

   GoogleCalendarDSN

   GoogleCalendarDSN

   
   Choose SQL Server Native Client 11.0 as Provider if you don't see the option shown above.

2. Then click on Security option and configure username we created in ZappySys Data Gateway in one of the previous steps:

   

3. Optional step. Under the Server Options, Enable RPC and RPC Out and Disable Promotion of Distributed Transactions(MSDTC).

   

   You need to enable RPC Out if you plan to use EXEC(...) AT [LS_TO_GOOGLE_CALENDAR_IN_GATEWAY] rather than OPENQUERY.
   If don't enabled it, you will encounter the Server 'LS_TO_GOOGLE_CALENDAR_IN_GATEWAY' is not configured for RPC error.

   Query Example:

   EXEC('SELECT * FROM Calendars') AT [LS_TO_GOOGLE_CALENDAR_IN_GATEWAY]

   ---

   If you plan to use 'INSERT INTO <TABLE> EXEC(...) AT [LS_TO_GOOGLE_CALENDAR_IN_GATEWAY]' in that case you need to Disable Promotion of Distributed Transactions(MSDTC).
   If don't disabled it, you will encounter the The operation could not be performed because OLE DB provider "SQLNCLI11" for linked server "MY_LINKED_SERVER_NAME" was unable to begin a distributed transaction. error.

   Query Example:

   INSERT INTO dbo.Products
   EXEC('SELECT * FROM Calendars') AT [LS_TO_GOOGLE_CALENDAR_IN_GATEWAY]
   

4. Finally, open a new query and execute a query we saved in one of the previous steps:
   

   SELECT * FROM OPENQUERY([LS_TO_GOOGLE_CALENDAR_IN_GATEWAY], 'SELECT * FROM Calendars')

   

   SELECT * FROM OPENQUERY([LS_TO_GOOGLE_CALENDAR_IN_GATEWAY], 'SELECT * FROM Calendars')

Google Calendar Connector Examples

The ZappySys API Driver is a user-friendly interface designed to facilitate the seamless integration of various applications with the Google Calendar API. With its intuitive design and robust functionality, the ZappySys API Driver simplifies the process of configuring specific API endpoints to efficiently read or write data from Google Calendar.

Click here to find more Google Calendar Connector examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.

Consume Data inside your App / Programming Language

ODBC inside ETL / Reporting / BI Tools

• Power BI
• Tableau
• Excel
• Informatica PowerCenter
• QlikView
• SQL Server / Linked Server
• SSRS (SQL Server Reporting Services)

ODBC inside Programming Languages

• C# (CSharp)
• JAVA
• PHP
• PowerShell
• Python
• T-SQL / SQL Server Linked Server

Key features of the ZappySys API Driver include:

The API ODBC driver facilitates the reading and writing of data from numerous popular online services (refer to the complete list here) using familiar SQL language without learning complexity of REST API calls. The driver allows querying nested structure and output as a flat table. You can also create your own ODBC / Data Gateway API connector file and use it with this driver.

1. Intuitive Configuration: The interface is designed to be user-friendly, enabling users to easily set up the specific API endpoints within Google Calendar without requiring extensive technical expertise or programming knowledge.

2. Customizable Endpoint Setup: Users can conveniently configure the API endpoint settings, including the HTTP request method, endpoint URL, and any necessary parameters, to precisely target the desired data within Google Calendar.

3. Data Manipulation Capabilities: The ZappySys API Driver allows for seamless data retrieval and writing, enabling users to fetch data from Google Calendar and perform various data manipulation operations as needed, all through an intuitive and straightforward interface.

4. Secure Authentication Integration: The driver provides secure authentication integration, allowing users to securely connect to the Google Calendar API by inputting the necessary authentication credentials, such as API tokens or other authentication keys.

5. Error Handling Support: The interface is equipped with comprehensive error handling support, ensuring that any errors or exceptions encountered during the data retrieval or writing process are efficiently managed and appropriately communicated to users for prompt resolution.

6. Data Visualization and Reporting: The ZappySys API Driver facilitates the seamless processing and presentation of the retrieved data from Google Calendar, enabling users to generate comprehensive reports and visualizations for further analysis and decision-making purposes.

Overall, the ZappySys API Driver serves as a powerful tool for streamlining the integration of applications with Google Calendar, providing users with a convenient and efficient way to access and manage data, all through a user-friendly and intuitive interface.