Connecting to Gmail
The Sisense Gmail connector is a standalone connector that allows you to import data from Gmail’s API into the ElastiCube Manager. After you have downloaded and installed the connector, you can connect through a connection string you provide Sisense in the ElastiCube Manager. The connection string is used to authenticate users who connect to the Gmail APIs. To obtain a connection string, you will need to register a Gmail app.
Once you have connected to Gmail, you can import a variety of tables from the Gmail API.
This page describes how to install the Gmail connector, how to connect to Gmail with a connection string, and what tables you can import into the ElastiCube Manager:
- Installing the Gmail Connector
- Connecting to the Gmail REST API
- Adding Gmail Tables to your ElastiCube
- Gmail Tables
Sisense provides the Gmail connector as a standalone connector that you can download and add to your list of default Sisense connectors.
To install the Gmail connector:
- Download the Gmail installation file.
- Open the installation file and click Install.
- After the installation process is complete, click Close.
The Gmail connector is displayed in the ElastiCube Manager under Add Data > Web Services.
To access Gmail’s REST API from the ElastiCube Manager, you must provide valid Oauth Gmail credentials through a connection string. These credentials are provided by Gmail when you register an application.
After you receive your credentials from Gmail, you can create the connection string and provide Sisense with it to connect to your data.
Registering an App
Follow the steps below to obtain the OAuth client credentials, the OAuthClientId and OAuthClientSecret necessary for your connection string:
- Log into the Google API Console.
- Click Create Project or select an existing project.
- In the API Manager, click Credentials > Create Credentials > OAuth Client Id.
- Select the application type.If you are making a Web application, select Web application. In the Authorized Redirect URIs box, enter the URL you want to be used as a trusted redirect URL, where the user will return with the token that verifies that they have granted your app access. If you are making a desktop application, select Other.
- Click Create. The OAuthClientId and OAuthClientSecret are displayed.
- Click Library > Gmail API > Enable API.
Sisense uses connection strings to connect to Gmail and import data into Sisense.
The connection string to connect to Gmail has the following structure:
The following is an example of a Gmail connection string:
The connection string should include the following information:
- InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken connection property.
- OAuthClientId: Set this to the Client ID in your app settings.
- OAuthClientSecret: Set this to the Client secret in your app settings.
- User: Set this to the user of the Gmail account.
When you connect the driver opens the OAuth endpoint in your default browser. Log in and grant permissions to the application.
Note: To switch between accounts, you need to delete the file OAuthsettings.txt file located at …\Users\xxx\AppData\Roaming\CData\Gmail Data Provider.
To add Gmail data:
- Sisense, click Add Data and then, Gmail. The Connect to Gmail window is displayed.
- In Datasource Connection String, enter your connection string.
- Click Connect to Server. Gmail is displayed in the Select Database list.
- Click OK. Sisense connects to Gmail and displays a list of tables available for you to import.
- Select the relevant tables and click Add. The tables are displayed in Sisense.
Switching between Accounts
When you connect to the Gmail data source, Sisense saves your OAuth values in the file OAuthsettings.txt file located at …\Users\xxx\AppData\Roaming\CData\Gmail Data Provider on your Sisense server. To connect to the Gmail data source with another user on the same machine, you must delete the OAuthsettings.txt file. Sisense will then generate a new file for that user.
Another option to support multiple users is to define the location and file name of an OAuthsettings file for each unique user in your connection string through the OAuthSettingsLocation parameter. When each user connects to the data source, Sisense generates the OAuth file with the file name you specify in the location you define. In the examples below, two users are allowed to access the Gmail data source and for each user, Sisense generates a file that contains that user’s OAuth values in the location defined in the string.
In the example above, to OAuth files are created, one for John and one for Sally in the location C:\Gmail\auth\.
This is useful if you support many users who each need to access the Gmail data source.
Gmail’s RESTful APIs expose the following Gmail tables that you can import into Sisense through the Sisense Gmail connector:
- Gmail/All Mail
- Gmail/Sent Mail
- Test Label
- The default Gmail table names contain a backslash; some also contain spaces. You can use square brackets to escape the table names for the default Gmail folders. For example: SELECT * FROM [Gmail/All Mail]
- The default number of messages returned is 100. This can be changed by setting either LIMIT or MaxItems. If you wish to return all mail within a mailbox, specify a value of 0 or -1.
- Aggregate functions not supported.