Gmail Connector for Alteryx : Make generic REST API request (bulk write) via SQL

Learn how to make generic REST API request (bulk write) using the Gmail Connector for Alteryx. This connector enables you to read and write Gmail data effortlessly. Send, manage, and sync messages, attachments, labels, and threads — almost no coding required. We'll walk you through the exact setup.

Let's dive in!

Create data source using Gmail ODBC Driver

1. Download and install ODBC PowerPack (if you haven't already).

2. Search for odbc and open the ODBC Data Sources (64-bit):

   

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

   ZappySys API Driver

   
   • Create and use a User DSN if the client application runs under a User Account. This is the ideal option at design time (e.g., when developing in Visual Studio). Use it for both types of applications (64-bit and 32-bit).
   • Create and use a System DSN if the client application runs under a System Account (e.g., as a Windows Service). This is usually the required option in a production environment. If your Windows Service is a 32-bit application, you must use the 32-bit ODBC Data Source Administrator to configure this

4. When the Configuration window appears give your data source a name if you haven't done that already, then select "Gmail" from the list of Popular Connectors. If "Gmail" 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:

   GmailDSN

   Gmail

   

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

   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:

   GmailDSN

   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)

   

6. Then go to Preview tab to start building a SQL query.

7. Once you do that, proceed by opening Query Builder:

   

   ZappySys API Driver - Gmail

   Read and write Gmail data effortlessly. Send, manage, and sync messages, attachments, labels, and threads — almost no coding required.

   GmailDSN

   

8. Then simply select the Make Generic REST API Request (Bulk Write) endpoint (action).

9. Continue by configuring the Required parameters. You can also set optional parameters too.

10. Move on by hitting Preview Data button to preview the results.

11. If you see the results you need, simply copy the generated query:

    Make Generic REST API Request (Bulk Write)

    Optional Parameters
    Url	/something/123
    IsMultiPart
    Filter
    Headers	Accept: */* || Cache-Control: no-cache
    ApiVersion	v1
    UserId
    Advanced Properties
    Request Method	POST
    Request Format (Content-Type)	Default
    Body	{$rows$}
    JsonOutputFormat	Multicontent
    DoNotOutputNullProperty
    Batch Size (Default=1)	1
    Meta Detection Order	StaticDynamicVirtual
    Input Columns - For Mapping (e.g. MyCol1:string(10); MyCol2:int32 ...) - Use bool, int32, int64, datetime, decimal, double
    Output Columns (e.g. MyCol1:string(10); MyCol2:int32 ...) - Use bool, int32, int64, datetime, decimal, double
    Request Format
    Response Format	Default
    Csv - Column Delimiter	,
    Csv - Row Delimiter	{NEWLINE}
    Csv - Quote Around Value	True
    Csv - Always Quote regardless type
    Encoding
    CharacterSet
    Writer DateTime Format
    Csv - Has Header Row	True
    Xml - ElementsToTreatAsArray
    Layout Map	<?xml version="1.0" encoding="utf-8"?> <!-- Example#1: Output all columns --> <settings> <dataset id="root" main="True" readfrominput="True" /> <map src="*" /> </settings> <!-- Example#2: Records under array <?xml version="1.0" encoding="utf-8"?> <settings singledataset="True"> <dataset id="root" main="True" readfrominput="True" /> <map name="MyArray" dataset="root" maptype="DocArray"> <map src="OrderID" name="OrderID" /> <map src="OrderDate" name="OrderDate" /> </map> </settings> --> <!-- Example#3: Records under nested section <?xml version="1.0" encoding="utf-8"?> <settings> <dataset id="dsRoot" main="True" readfrominput="True" /> <map name="NestedSection"> <map src="OrderID" name="OrderID_MyLabel" /> <map src="OrderDate" name="OrderDate_MyLabel" /> </map> </settings> -->

    SELECT * FROM __DynamicRequest__
    WITH
    (
        "Url" = '/something/123',
        "RequestMethod" = 'POST'
    )

    

12. Click OK to use built SQL query and close the Query Builder.

13. 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 Alteryx:

    

    ZappySys API Driver - Gmail

    Read and write Gmail data effortlessly. Send, manage, and sync messages, attachments, labels, and threads — almost no coding required.

    GmailDSN

    SELECT * FROM __DynamicRequest__
    WITH
    (
        "Url" = '/something/123',
        "RequestMethod" = 'POST'
    )

    
    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 Gmail 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 Gmail servers).

Let's not stop here and explore SQL query examples, including how to use them in Stored Procedures and Views (virtual tables) in the next steps.

Gmail SQL query examples

Use these SQL queries in your Alteryx data source:

Make generic rest api request

SELECT * FROM __DynamicRequest__
WITH
(
    "Url" = '/something/123',
    "RequestMethod" = 'POST'
)

Create SQL view in ODBC data source

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
   

2. Enter the desired Table name and click on OK:
   

3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
   Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
   

   SELECT
     "ShipCountry",
     "OrderID",
     "CustomerID",
     "EmployeeID",
     "OrderDate",
     "RequiredDate",
     "ShippedDate",
     "ShipVia",
     "Freight",
     "ShipName",
     "ShipAddress",
     "ShipCity",
     "ShipRegion",
     "ShipPostalCode"
   FROM "Orders"
   Where "ShipCountry"='USA'

   
   

5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:

   SELECT * FROM "vt__usa_orders_only"

   

Make generic REST API request in Alteryx via SQL view

1. Open Alteryx Designer.

2. First, verify your DCM Settings to ensure you can access ODBC drivers. Go to Options > User Settings > Edit User Settings.

   If DCM Mode is set to DCM Only, change it to DCM Optional if you would like to access the legacy Generic ODBC Connection.

   
   After changing this setting, you may need to click Save and restart the connection window for the "Generic ODBC" icon to appear.

3. Drag an Input Data tool onto your Alteryx canvas.

   

4. In the Configuration pane, click Set Up a Connection.

   

5. Note for DCM Users: If your environment has DCM (Data Connection Manager) enabled, the classic "Generic ODBC" icon may be hidden. To find it, select Data sources on the left and type "ODBC" in the search bar.

6. Once the ODBC window opens, click Connect Asset and select your GmailDSN DSN from the list.

   
   Ensure you have configured a 64-bit System DSN in the Windows ODBC Data Source Administrator before this step.

7. After selecting your DSN, configure your SQL Query in the Input Data tool configuration:

   

8. To save your data, drag an Output Data tool and connect it to the Input Data tool.

9. Configure the Output Data tool to write to a CSV file:

   

10. Press Run (Ctrl+R) to execute the workflow. Verify the results in the Results Window at the bottom.

    

Advanced topics

Creating SQL stored procedures

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
   

2. Enter the desired Procedure name and click on OK:
   

3. Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver. Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

   CREATE PROCEDURE [usp_get_orders]
       @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
    AS
       SELECT * FROM Orders where OrderDate >= '<@fromdate>';
   

   

4. That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:

   Exec usp_get_orders '1996-01-01';

   

Conclusion

And there you have it — a complete guide on how to make generic REST API request (bulk write) in Alteryx without writing complex code. All of this was powered by Gmail ODBC Driver, which handled the REST API pagination and authentication for us automatically.

Download the trial now or ping us via chat if you have any questions or are looking for a specific feature (you can also reach out to us by submitting a ticket):

More actions supported by Gmail Connector

Got another use case in mind? We've documented the exact setups for a variety of essential Gmail operations directly in Alteryx, so you can skip the trial and error. Find your next step-by-step guide below:

• Download Message Attachments (With search condition)
• Get a Specific Attachment included in a Specific Message for the Current User
• Get a Specific Message for a Specific User
• Get a Specific Message for the Current User
• Get labels
• Get List of Messages for a Specific User
• Get List of Messages for the Current User
• Get message attachment for user
• Get Message Attachments (With search condition)
• Send a New Message for the specified User
• Make Generic REST API Request

More Gmail integrations

SSIS

SQL Server

Microsoft Fabric

Power BI

SSRS

Informatica PowerCenter

MS Access

Excel

SSAS

C#

Python

Java

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

UiPath

PowerShell

ODBC