Google Calendar Connector for Azure Data Factory (Pipeline)

Create ODBC Data Source (DSN) based on ZappySys API Driver

Step-by-step instructions

To get data from Google Calendar using Azure Data Factory (Pipeline) we first need to create a DSN (Data Source) which will access data from Google Calendar. We will later be able to read data using Azure Data Factory (Pipeline). Perform these steps:

1. Download and install ODBC PowerPack.

2. Open ODBC Data Sources (x64):

   

3. Create a User data source (User DSN) based on ZappySys API Driver:

   ZappySys API Driver

   
   • Create and use User DSN if the client application is run under a User Account. This is an ideal option in design-time, when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit.
   • Create and use System DSN if the client application is launched under a System Account, e.g. as a Windows Service. Usually, this is an ideal option to use in a production environment. Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.
   Azure Data Factory (Pipeline) uses a Service Account, when a solution is deployed to production environment, therefore for production environment you have to create and use a System DSN.

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

   

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

   Google Calendar authentication

   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]

   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!

   API Connection Manager configuration

   Just perform these simple steps to finish authentication configuration:

   1. Set Authentication Type to User Account [OAuth]
   2. Optional step. Modify API Base URL if needed (in most cases default will work).
   3. Fill in all the required parameters and set optional parameters if needed.
   4. Press Generate Token button to generate the tokens.
   5. Finally, hit OK button:

   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 (Using *.json OR *.p12 key file)

   Google Calendar authentication

   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]

   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!

   API Connection Manager configuration

   Just perform these simple steps to finish authentication configuration:

   1. Set Authentication Type to Service Account (Using *.json OR *.p12 key file) [OAuth]
   2. Optional step. Modify API Base URL if needed (in most cases default will work).
   3. Fill in all the required parameters and set optional parameters if needed.
   4. Finally, hit OK button:

   GoogleCalendarDSN

   Google Calendar

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

   

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

   

   ZappySys API Driver - 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

   

7. 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 Azure Data Factory (Pipeline) 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.

8. 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 Azure Data Factory (Pipeline):

   

   ZappySys API Driver - 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).

9. Click OK to finish creating the data source.

Video Tutorial

Read data in Azure Data Factory (ADF) from ODBC datasource (Google Calendar)

1. Sign in to Azure Portal

   • Open your browser and go to: https://portal.azure.com

   • Enter your Azure credentials and complete MFA if required.

   • After login, go to Data factories.

   

2. Under Azure Data Factory Resource - Create or select the Data Factory you want to work with.

   

3. Inside the Data Factory resource page, click Launch studio.

   

4. Create a New Integration Runtime (Self-Hosted):

   • In Azure Data Factory Studio, go to the Manage section (left menu).

   • Under Connections, select Integration runtimes.

   • Click + New to create a new integration runtime.

   

5. Select Azure, Self-Hosted option:

   

6. Select Self-Hosted option:

   

7. Set a name, we will use OnPremisesRuntime:

   

8. Download and install Microsoft Integration Runtime.

   

9. Launch Integration Runtime and copy/paste Authentication Key from Integration Runtime configuration in Azure Portal:

   

10. After finishing registering the Integration Runtime node, you should see a similar view:

    

11. Go back to Azure Portal and finish adding new Integration Runtime. You should see it was successfully added:

    

12. Create a New Linked service:

    • In the Manage section (left menu).

    • Under Connections, select Linked services.

    • Click + New to create a new Linked service based on ODBC.

    

13. Select ODBC service:

    

14. Configure new ODBC service. Use the same DSN name we used in the previous step and copy it to Connection string box:

    GoogleCalendarDSN

    DSN=GoogleCalendarDSN

    

15. For created ODBC service create ODBC-based dataset:

    

16. Go to your pipeline and add Copy data connector into the flow. In Source section use OdbcDataset we created as a source dataset:

    

17. Then go to Sink section and select a destination/sink dataset. In this example we use precreated AzureBlobStorageDataset which saves data into an Azure Blob:

    

18. Finally, run the pipeline and see data being transferred from OdbcDataset to your destination dataset:

    

Executing SQL queries using Lookup activity

If you need to execute commands in Google Calendar instead of retrieving data, use the Lookup activity for that purpose. Use this approach when you want data to be changed on the Google Calendar side, but you don't need the data on your side (a "fire-and-forget" scenario).

Perform these simple steps to accomplish that:

1. Go to your pipeline in Azure Data Factory

2. Find Lookup activity in the Activities pane

3. Then drag-and-drop the Lookup activity onto your pipeline canvas

4. Click Settings tab

5. Select OdbcDataset in the Source dataset field

6. Finally, enter your SQL query in the Query text box:

SELECT * FROM create_event WITH ( "CalendarId" = 'abcd-1234-calendarid' )

Centralized data access via Data Gateway

In some situations, you may need to provide Google Calendar data access to multiple users or services. Configuring the data source on a Data Gateway creates a single, centralized connection point for this purpose.

This configuration provides two primary advantages:

• Centralized data access
  The data source is configured once on the gateway, eliminating the need to set it up individually on each user's machine or application. This significantly simplifies the management process.
• Centralized access control
  Since all connections route through the gateway, access can be governed or revoked from a single location for all users.

If you need any of these requirements, you will have to create a data source in Data Gateway to connect to Google Calendar, and to create an ODBC data source to connect to Data Gateway in Azure Data Factory (Pipeline).

Let's not wait and get going!

Creating Google Calendar data source in Gateway

In this section we will create a data source for Google Calendar in Data Gateway. Let's follow these steps to accomplish that:

1. Search for gateway in Windows Start Menu and open ZappySys Data Gateway Configuration:

   

2. Go to Users tab and follow these steps to add a Data Gateway user:

   • Click Add button
   • In Login field enter username, e.g., john
   • Then enter a Password
   • Check Is Administrator checkbox
   • Click OK to save
   

3. Now we are ready to add a data source:

   • Click Add button
   • Give Datasource a name (have it handy for later)
   • Then select Native - ZappySys API Driver
   • Finally, click OK
   GoogleCalendarDSN

   ZappySys API Driver

   

4. When the ZappySys API Driver configuration window opens, configure the Data Source the same way you configured it in ODBC Data Sources (64-bit), in the beginning of this article.

5. Very important step. Now, after creating or modifying the data source make sure you:

   • Click the Save button to persist your changes.
   • Hit Yes, once asked if you want to restart the Data Gateway service.

   This will ensure all changes are properly applied:

   
   Skipping this step may result in the new settings not taking effect and, therefore you will not be able to connect to the data source.

Creating ODBC data source for Data Gateway

In this part we will create ODBC data source to connect to Data Gateway from Azure Data Factory (Pipeline). To achieve that, let's perform these steps:

1. Open ODBC Data Sources (x64):

   

2. Create a User data source (User DSN) based on ODBC Driver 17 for SQL Server:

   ODBC Driver 17 for SQL Server

   
   If you don't see ODBC Driver 17 for SQL Server driver in the list, choose a similar version driver.

3. Then set a Name of the data source (e.g. Gateway) and the address of the Data Gateway:

   GatewayDSN

   localhost,5000

   
   Make sure you separate the hostname and port with a comma, e.g. localhost,5000.

4. Proceed with authentication part:

   • Select SQL Server authentication
   • In Login ID field enter the user name you used in Data Gateway, e.g., john
   • Set Password to the one you configured in Data Gateway
   

5. Then set the default database property to GoogleCalendarDSN (the one we used in Data Gateway):

   GoogleCalendarDSN

   

6. Continue by checking Trust server certificate option:

   

7. Once you do that, test the connection:

   

8. If connection is successful, everything is good:

   

9. Done!

We are ready to move to the final step. Let's do it!

Accessing data in Azure Data Factory (Pipeline) via Data Gateway

Finally, we are ready to read data from Google Calendar in Azure Data Factory (Pipeline) via Data Gateway. Follow these final steps:

1. Go back to Azure Data Factory (Pipeline).

2. Create a New Linked service:

   • In the Manage section (left menu).

   • Under Connections, select Linked services.

   • Click + New to create a new Linked service based on ODBC.

   

3. Select ODBC service:

   

4. Configure new ODBC service. Use the same DSN name we used in the previous step and copy it to Connection string box:

   GatewayDSN

   DSN=GatewayDSN

   

5. Read the data the same way we discussed at the beginning of this article.

6. That's it!

Now you can connect to Google Calendar data in Azure Data Factory (Pipeline) via the Data Gateway.

Actions supported by Google Calendar Connector

Learn how to perform common Google Calendar actions directly in Azure Data Factory (Pipeline) with these how-to guides:

• Create event
• Delete event
• Get event
• List calendars
• List events
• Move event to another calendar
• Make Generic API Request
• Make Generic API Request (Bulk Write)

Conclusion

In this article we showed you how to connect to Google Calendar in Azure Data Factory (Pipeline) and integrate data without any coding, saving you time and effort.

We encourage you to download Google Calendar Connector for Azure Data Factory (Pipeline) and see how easy it is to use it for yourself or your team.

If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.

Download Google Calendar Connector for Azure Data Factory (Pipeline) Documentation

More integrations

Other connectors for Azure Data Factory (Pipeline)

Amazon Ads

Amazon Athena

Amazon Selling Partner (SP-API)

Apache Derby

Apache Hive

Apache Spark

Asana

Azure DevOps

Cosmos DB

Dropbox

ElasticSearch

FastSpring

Gmail

Google Ads

Google BigQuery

Google Drive

Google Search Console

Google Sheets

Hubspot

Infor Data Lake

Jira

Mailchimp

ManagedEngine ServiceDesk Plus (Zoho)

MariaDB

OData

OneDrive

Outlook Mail (Office 365)

Parquet (DuckDB)

Power BI

ServiceNow

SharePoint Online

Shopify

Smartsheet

Starburst

Stripe

Trino

YouTube

Zendesk

Zoho CRM

Zoho SalesIQ

Zoom

REST API

JSON

JSON File

XML

SOAP

XML File

JDBC-ODBC Bridge

Salesforce

CSV

Amazon S3 JSON File

Amazon S3 XML File

Amazon S3 CSV File

Azure Blob JSON File

Azure Blob XML File

Azure Blob CSV File

FTP/SFTP JSON File

FTP/SFTP XML File

FTP/SFTP CSV File

Build your own Custom API Connector

Other application integration scenarios for Google Calendar

SSIS

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

C#

Python

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (SSIS)

Talend Studio

UiPath

PowerShell

ODBC