Search results

Connecting Bold BI to Gmail data source

What is Gmail Gmail offers free cloud storage for storing emails in the web. Gmail makes emailing, chatting, drafting and archiving your mails and conversations easy and convenient. It’s necessary to create a Gmail account.

Note: Gmail data source is available in On-Premises Deployment but not in Syncfusion Managed Cloud Server.

Connecting to a Gmail

You can connect to web services of popular site like Gmail connection type. To enable this connection, follow the given steps.

Click the Data Source button in the configuration panel to add a new data connection.

Data source panel

Click CREATE NEW to launch a new connection from the connection type panel.

Add data source

Click Gmail connection button in the connection panel.

Gmail icon

Click Connect an Account in the window opens.

Create account

The login window opens to authorize the user.

Enter an appropriate username and password. The authorization window opens.

Sign in

Click Allow in the authorization window. The datasource window opens.

Allow access

To get data through datasource window, follow the given steps:

  • Enter an API in URL text box which must be the valid REST API.

IMPORTANT: Refer to the Gmail API Documentation to build a query for discovering more data requests. Test the query before entering it in the URL text box. Use Google APIs Explorer, to build the query.

  • Choose appropriate method for the API. Refer API documentation link given below URL text box to get appropriate API.

  • Add Header information, if necessary.

  • Choose appropriate refresh settings for API.

  • Choose appropriate data format.

  • Authentication type will be set as Gmail automatically, if the login gets success.

Click connect to get data.

API

The choose schema(s) window opens as follows. You can select the schema and click Connect.

Choose Schema

Now, you can get into the data design view window with selected table schema.

Table

Drag and drop the table and click Save button to save the data source with valid name.

Save button

How to Obtain the Google Client ID and Client Secret

Note: Google OAuth credentials are required for the On-Premises Deployment but not needed in Syncfusion Managed Cloud Server.

  1. Go to the Google API Console at Google API Console.

  2. Select the existing project or create a new project by clicking on the Select Project dropdown at the top of the page and give your project a name. Then click on Create.

    New Project

  3. Click on the menu and select APIs & services, and then click on the Enabled APIs and services button.

    EnableApi

  4. To enable the required Google API in Bold BI, click on the +ENABLE APIS AND SERVICES.

    ApiServices

  5. Search and enable the People API by clicking the ENABLE button.

    Oauth Concert screen

NOTE: Need to enable the required APIs to connect the connector in the Bold BI.

Connector Required API
Google Drive Google Drive API
Google Drive Activity API
Drive Lable API
Google Sheets Google Sheets API
Google AdSense AdSense Host API
AdSense Management API
Google Analytics
Google Analytics V4
Google Analytics API
Google Analytics Reporting API
Google Analytics Data API
Google Ads Google Ads API
Google Search Console Google Search Console API
Google Calendar Google Calendar API
  1. Click on the OAuth consent screen and follow the prompts and provide the required details.

    Oauth Concert screen

  2. In the second step, click on ADD OR REMOVE SCOPES and add the required read scopes for the API that needs to be connected in Bold BI. Then click on Save and Continue.

    Add Scopes

Scopes

Google Service Functions
Google Drive email

https://www.googleapis.com/auth/userinfo.profile

https://www.googleapis.com/auth/drive.metadata.readonly

https://www.googleapis.com/auth/drive.readonly

Google Sheets email

https://www.googleapis.com/auth/userinfo.profile

https://www.googleapis.com/auth/drive.metadata.readonly

https://www.googleapis.com/auth/drive.readonly

Google Adsense email

https://www.googleapis.com/auth/userinfo.profile

https://www.googleapis.com/auth/adsense.readonly

https://www.googleapis.com/auth/adsensehost

Google Analytics email

https://www.googleapis.com/auth/userinfo.profile

https://www.googleapis.com/auth/analytics.readonly

https://www.googleapis.com/auth/adsense.readonly

https://www.googleapis.com/auth/youtube.readonly

https://www.googleapis.com/auth/youtubepartner

Google Analytics V4 https://www.googleapis.com/auth/analytics.readonly
Google Ads V4 https://www.googleapis.com/auth/adwords
Google Search Console email

https://www.googleapis.com/auth/userinfo.profile

https://www.googleapis.com/auth/webmasters.readonly

Google Calendar email

https://www.googleapis.com/auth/userinfo.profile

https://www.googleapis.com/auth/calendar.readonly

https://www.googleapis.com/auth/calendar.events.readonly

  1. To create OAuth 2.0 credentials, click the Credentials menu item in the left sidebar. Click the + CREATE CREDENTIALS button and select the “OAuth client ID”.

    Credentials

  2. Choose the Web application application type, and enter a name for your OAuth 2.0 app.

  3. Add the Redirect URL as mentioned here by clicking Add URI.

    Redirect uri

NOTE: The Bold BI redirect URL should be added in the proper format. Please refer to this URL structure, https://hostname/bi/designer/v1.0/oauth/agent.

  1. After creating your OAuth 2.0 client, you will be able to view and copy your Client ID and Client Secret from the Google API Console.

    ClientCredentials

NOTE: Save the client ID and client secret in Bold BI by following the OAuth Configuration guide for more details.

Gmail reference

API documentation

Gmail API documentation

API explorer

Google APIs explorer

Sample query

https://www.googleapis.com/gmail/v1/users/abc4052%40gmail.com/messages?includeSpamTrash=false&fields=messages%2CnextPageToken%2CresultSizeEstimate&key={DEFAULT}

Data Transformation

Editing a Data Connection

Dashboard Designer Walkthrough