Articles in this section
Category / Section

How to set up OAuth2 authorization to access Google applications in Bold BI?

Published:

Integrating Google services with Bold BI requires setting up OAuth2 authorization to ensure secure access to Google applications. OAuth is a widely adopted open standard for access delegation, serving as a secure method for users to grant websites or applications permission to access their information on various platforms without disclosing their passwords. It is a crucial component for service connectors, verifying the authorization of client applications to retrieve data securely.

Bold BI On-Premises supports various Google data source connectors, including Google Drive, Google Sheets, Google Calendar, Google Analytics, Google AdSense, Google Search Console, and YouTube. To utilize these connectors, OAuth application configuration is necessary.

Steps to Acquire Google Client ID and Client Secret for Bold BI Integration

If you do not have an existing app with the service provider, you must register a new app with the service. Each OAuth connector in Bold BI includes a Help link that directs you to the developer documentation for the service provider.

To connect Bold BI with Google services, you must first obtain a Google Client ID and Client Secret. These credentials are essential for the OAuth2 authorization process. This guide will walk you through the process of acquiring these credentials from the Google API Console.

Step 1: Access Google API Console

Navigate to the Google API Console.

Step 2: Select or Create Project

Choose an existing project or create a new one by selecting the Select Project dropdown and naming your project. Click Create to proceed.
image.png

Step 3: Enable APIs and Services

Click on the menu and go to APIs & services. Then, click on the Enabled APIs and services button.
image.png

Step 4: Enable Required Google API

Click on +ENABLE APIS AND SERVICES and search for the People API. Enable it by clicking the ENABLE button.
image.png

image.png

Important: It’s essential to enable the APIs that will be connected in Bold BI.

Connector Required API
Google Drive Google Drive API
Google Drive Activity API
Drive Label 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

Step 5: Configure OAuth Consent Screen

Select OAuth consent screen from the menu and provide the necessary details as prompted.

image.png

Step 6: Add Scopes

Click on ADD OR REMOVE SCOPES and include the required read scopes for the API. Save your changes by clicking Save and Continue.

image.png

Important: When integrating Google data sources with Bold BI On-Premise, it is essential to configure the correct scopes to ensure proper functionality and data access. Below is a comprehensive list of Google services and their corresponding scopes required for Bold BI On-Premise.

Google Service Scopes
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

Note:

  • Ensure that you have the necessary permissions to grant these scopes when setting up your data sources in Bold BI.
  • Please note that the scopes provided above are subject to change based on updates from Google and Bold BI. Always refer to the latest documentation for the most accurate information.

Step 7: Create OAuth Credentials

In the sidebar, click on Credentials and then + CREATE CREDENTIALS. Choose OAuth client ID as the credential type.

image.png

Step 8: Set Up OAuth Client

Select Web application as the application type and give your OAuth 2.0 app a name.

Step 9: Add Redirect URI

Add the Redirect URI provided by Bold BI by clicking Add URI.

image.png

Note: Ensure the Bold BI redirect URL is in the correct format: https://hostname/bi/designer/v1.0/oauth/agent

Step 10: Obtain Client ID and Client Secret

Once the OAuth client is created, the Google API Console will display your Client ID and Client Secret. Copy these credentials for use in Bold BI.

image.png

By following these steps, you will have successfully obtained the Google Client ID and Client Secret necessary for integrating Google services with Bold BI.

Enabling APIs and Adding Scopes

To enable APIs and add scopes for your Google application, follow these steps, In this example, we enable the Google Sheets API and required scopes.

  1. Visit the Google API library page and select the required service.
    image.png
  2. Choose the appropriate API based on the connection type you will use in Bold BI.
    image.png
  3. Click Enable to activate the selected API.
    image.png
  4. After enabling the API, select the Credentials option and click on the Credentials in APIs and Services link as follows.
    image.png
  5. Select the OAuth consent screen menu from the left panel under APIs and Services to add the scopes to request access to your Google APIs. To request access using OAuth 2.0, you need the scope information and the information that Google supplies when you register your application, such as the client ID and the client secret.
    image.png
  6. Click Add Scope to add the scopes, which are mandatory for your selected connection type, and then click Add to add the scope.
    image.png
  7. Once the scopes are added, you can proceed to connect your data source to Bold BI.

By following these steps, you can successfully set up OAuth2 authorization for accessing Google applications within Bold BI, enabling you to leverage the full potential of your data.

Steps to Configure OAuth Data Connectors

After successfully acquiring the Google client ID and client secret, the next step is to configure OAuth for data sources within the Bold BI platform. This can be accomplished by following the detailed steps outlined below.

Step 1: Navigate to Settings

Start by clicking the Settings icon located on the left pane of the Bold BI dashboard.

Step 2: Open Connectors Tab

Within the settings, select the Connectors tab. Here, you’ll find a list of all the data sources that Bold BI supports.
image.png

Step 3: Service Connectors – OAuth

Look for the Service Connectors – OAuth section and expand it to view the available OAuth connectors.

Step 4: Enable Connectors

You have the option to click Enable All to activate all listed connectors. Alternatively, you can enable individual connectors based on your requirements.

Step 5: Configure OAuth Details

Next to each connector, there’s a Configure button. Click this to enter the OAuth details for the selected Google data source.
image.png

Step 6: Enter Credentials

For the chosen Google connector, input the required Client ID and Client Secret. These credentials can be modified later if necessary.

Step 7: Save Configuration

Finally, click Save to store your configuration settings. Remember, if you exit without saving, you won’t be able to establish a connection to the data source.
image.png

By following these steps, you can successfully configure OAuth for your data connectors in Bold BI, ensuring secure and seamless integration with your data sources.

Refer to this documentation for the steps to create a new data source in Bold BI.

Additional References

Was this article useful?
Like
Dislike
Help us improve this page
Please provide feedback or comments
VS
Written by Venkataprasad Subramani
Updated:
Comments
Please  to leave a comment
Access denied
Access denied