Gmail Connector for SSIS How to Make Generic API Request

Prerequisites

Before we begin, make sure the following prerequisites are met:

SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).

Make Generic API Request in SSIS

Begin with opening Visual Studio and Create a New Project.
Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

In the new SSIS project screen you will find the following:
- SSIS ToolBox on left side bar
- Solution Explorer and Property Window on right bar
- Control flow, data flow, event Handlers, Package Explorer in tab windows
- Connection Manager Window in the bottom
Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.
Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
Select New Connection to create a new connection:
Use a preinstalled Gmail Connector from Popular Connector List or press Search Online radio button to download Gmail Connector. Once downloaded simply use it in the configuration:

Gmail

Now it's time to configure authentication. Firstly, configure authentication settings in Gmail service and then proceed by configuring API Connection Manager. Start by expanding an authentication type:

User Account

Gmail authentication

To make this work you will have to create a Google Cloud project. This project forms the basis for creating, enabling, and using all Google Cloud services, including managing APIs, enabling billing, adding and removing collaborators, and managing permissions.

Go to the Google Cloud Console
In the Google Cloud console, go to menu IAM & Admin, and then Create a Project.
Enter the name of the new project into the Project Name field and select the appropriate organization, then click Create.
The console navigates to the Dashboard page and your project is created within a few minutes.
In the Google Cloud console, go to menu More products, Google Workspace, and then Product Library.
Now we need to enable the Gmail API.
Search for Gmail API. Select it and then click ENABLE.
Select the Credentials tab on the left side of the screen.
Select the + CREATE CREDENTIALS link to reveal a drop down menu.
In the dropdown menu, select OAuth client ID.
If presented, click the CONFIGURE CONSENT SCREEN button and then elect the appropriate User Type based on your business needs. Otherwise, continue to step 16.
In the OAuth consent screen tab fill in your app's website and domain information, and then click SAVE AND CONTINUE.
In the Scopes section of the app registration, click ADD OR REMOVE SCOPES and add the following scopes:
- openid
- https://mail.google.com/
- https://www.googleapis.com/auth/userinfo.email
- https://www.googleapis.com/auth/userinfo.profile
- https://www.googleapis.com/auth/gmail.labels
- https://www.googleapis.com/auth/gmail.send
- https://www.googleapis.com/auth/gmail.modify
- https://www.googleapis.com/auth/gmail.compose
- https://www.googleapis.com/auth/gmail.readonly
After the scopes have been added, click SAVE AND CONTINUE.
Complete the wizard setting up scopes.
Select the Credentials tab on the left side of the screen.
Select the + CREATE CREDENTIALS link to reveal a drop down menu.
In the dropdown menu, select OAuth client ID.
In the Application type drop down, select Desktop application and then give your app client a name.
Select the CREATE button.
A popup window will appear that provides important information you should record for your records:
- Client ID
- Client secret
And then click OK.
Go to OAuth Consent Screen tab. Under Publishing Status click PUBLISH APP to ensure your refresh token doesnt expire often. If you planning to use App for Private use then do not have to worry about Verification Status after Publish.
Back to Connection UI, Enter the client ID and client secret into the required parameters.

API Connection Manager configuration

Just perform these simple steps to finish authentication configuration:

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

Gmail

User Account [OAuth]

https://gmail.googleapis.com/

Required Parameters
UseCustomApp	Fill-in the parameter...
Authorization URL	Fill-in the parameter...
Token URL	Fill-in the parameter...
Default API Version	Fill-in the parameter...
Default User Id	Fill-in the parameter...
Scope	Fill-in the parameter...
Optional Parameters
Client Id
Client Secret
RetryMode	RetryWhenStatusCodeMatch
RetryStatusCodeList	429
RetryCountMax	5
RetryMultiplyWaitTime	True
Redirect URL (Only for Web App)

Select Generic Table (Bulk Read / Write) table from the dropdown and hit Preview Data:

API Source - Gmail

Read / search Gmail messages, download attachments, send mail and more using Gmail REST API.

Gmail

Generic Table (Bulk Read / Write)

Required Parameters
HTTP - Url or File Path	Fill-in the parameter...
HTTP - Request Method	Fill-in the parameter...
Optional Parameters
HTTP - Request Body
HTTP - Is MultiPart Body (Pass File data/Mixed Key/value)
HTTP - Request Format (Content-Type)	ApplicationJson
HTTP - Headers (e.g. hdr1:aaa \|\| hdr2:bbb)	Accept: / \|\| Cache-Control: no-cache
Parser - Response Format (Default=Json)	Default
Parser - Filter (e.g. $.rows[*] )
Parser - Encoding
Parser - CharacterSet
Download - Enable reading binary data	False
Download - File overwrite mode	AlwaysOverwrite
Download - Save file path
Download - Enable raw output mode as single row	False
Download - Raw output data RowTemplate	{Status:'Downloaded'}
Download - Request Timeout (Milliseconds)
General - Enable Custom Search/Replace
General - SearchFor (e.g. (\d)-(\d)--regex)
General - ReplaceWith (e.g. $1-***)
General - File Compression Type
General - Date Format
General - Enable Big Number Handling	False
General - Wait time (Ms) - Helps to slow down pagination (Use for throttling)	0
JSON/XML - ExcludedProperties (e.g. meta,info)
JSON/XML - Flatten Small Array (Not preferred for more than 10 items)
JSON/XML - Max Array Items To Flatten	10
JSON/XML - Array Transform Type
JSON/XML - Array Transform Column Name Filter
JSON/XML - Array Transform Row Value Filter
JSON/XML - Array Transform Enable Custom Columns
JSON/XML - Enable Pivot Transform
JSON/XML - Array Transform Custom Columns
JSON/XML - Pivot Path Replace With
JSON/XML - Enable Pivot Path Search Replace	False
JSON/XML - Pivot Path Search For
JSON/XML - Include Pivot Path	False
JSON/XML - Throw Error When No Match for Filter	False
JSON/XML - Parent Column Prefix
JSON/XML - Include Parent When Child Null	False
Pagination - Mode
Pagination - Attribute Name (e.g. page)
Pagination - Increment By (e.g. 100)	1
Pagination - Expression for Next URL (e.g. $.nextUrl)
Pagination - Wait time after each request (milliseconds)	0
Pagination - Max Rows Expr
Pagination - Max Pages Expr
Pagination - Max Rows DataPath Expr
Pagination - Max Pages	0
Pagination - End Rules
Pagination - Next URL Suffix
Pagination - Next URL End Indicator
Pagination - Stop Indicator Expr
Pagination - Current Page
Pagination - End Strategy Type	DetectBasedOnRecordCount
Pagination - Stop based on this Response StatusCode
Pagination - When EndStrategy Condition Equals	True
Pagination - Max Response Bytes	0
Pagination - Min Response Bytes	0
Pagination - Error String Match
Pagination - Enable Page Token in Body	False
Pagination - Placeholders (e.g. {page})
Pagination - Has Different NextPage Info	False
Pagination - First Page Body Part
Pagination - Next Page Body Part
Csv - Column Delimiter	,
Csv - Has Header Row	True
Csv - Throw error when column count mismatch	False
Csv - Throw error when no record found	False
Csv - Allow comments (i.e. line starts with # treat as comment and skip line)	False
Csv - Comment Character	#
Csv - Skip rows	0
Csv - Ignore Blank Lines	True
Csv - Skip Empty Records	False
Csv - Skip Header Comment Rows	0
Csv - Trim Headers	False
Csv - Trim Fields	False
Csv - Ignore Quotes	False
Csv - Treat Any Blank Value As Null	False
Xml - ElementsToTreatAsArray

SSIS API Source - Read from table or endpoint

That's it! We are done! Just in a few clicks we configured the call to Gmail using Gmail Connector.

You can load the source data into your desired destination using the Upsert Destination , which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV , Excel , Azure Table , Salesforce , and more . You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)