Gmail Connector for SSIS How to Get labels

Prerequisites

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

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

Get labels in SSIS

  1. Begin with opening Visual Studio and Create a New Project.

  2. 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
    SSIS Project Screen
    Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.
  3. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.

    SSIS Data Flow Task - Drag and Drop
  4. From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:

    SSIS API Source (Predefined Templates) - Drag and Drop
  5. Select New Connection to create a new connection:

    API Source - New Connection
  6. 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
    Gmail Connector Selection
  7. 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:

    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.

    1. Go to the Google Cloud Console
    2. In the Google Cloud console, go to menu IAM & Admin, and then Create a Project.
    3. Enter the name of the new project into the Project Name field and select the appropriate organization, then click Create.
    4. The console navigates to the Dashboard page and your project is created within a few minutes.
    5. In the Google Cloud console, go to menu More products, Google Workspace, and then Product Library.
    6. Now we need to enable the Gmail API.
    7. Search for Gmail API. Select it and then click ENABLE.
    8. Select the Credentials tab on the left side of the screen.
    9. Select the + CREATE CREDENTIALS link to reveal a drop down menu.
    10. In the dropdown menu, select OAuth client ID.
    11. 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.
    12. In the OAuth consent screen tab fill in your app's website and domain information, and then click SAVE AND CONTINUE.
    13. 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
    14. After the scopes have been added, click SAVE AND CONTINUE.
    15. Complete the wizard setting up scopes.
    16. Select the Credentials tab on the left side of the screen.
    17. Select the + CREATE CREDENTIALS link to reveal a drop down menu.
    18. In the dropdown menu, select OAuth client ID.
    19. In the Application type drop down, select Desktop application and then give your app client a name.
    20. Select the CREATE button.
    21. A popup window will appear that provides important information you should record for your records:
      • Client ID
      • Client secret
      And then click OK.
    22. 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.
    23. 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:

    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:
    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)
    ZappySys OAuth Connection
  8. Select Labels 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
    Labels
    There are no parameters to configure.
    SSIS API Source - Read from table or endpoint
  9. 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)

    Execute Package - Reading data from Gmail and load into target

More actions supported by Gmail Connector

Learn how to perform other actions directly in SSIS with these how-to guides:

More integrations

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications