This will require Data Admin privileges to setup and Builder for implementation.
iDashboards is able to connect to a Google Search API by using a JDBC driver to access and customize the Google Search bar. A JDBC driver is a software component enabling a Java application to interact with a database. To connect with individual databases, JDBC (Java Database Connectivity API) requires specific drivers for each database. The JDBC driver gives out the connection to the database and implements the protocol for transferring the query and result between the client and the database. iDashboards implements native protocols and does not require additional software installed on the driver host. In other words, iDashboards provides driver connectivity with the JDBC Data Source via the specified driver. This document explains a step-by-step procedure to create the Data Source with a Premium Data Connector. If you do not have access to the Premium Data Connectors please contact your Client Success Manager.
CData JDBC Driver for Google Search is where we get the documentation on making this connection, however, the Premium Data Connectors are not a straight forward process which is why we make articles like this to help you make the connections more easily. This one requires a few steps, with a few different links to get very specific pieces of information to make this connection within iDashboards. The Google Search API is part of the Premium Data Connectors if you do not have these please contact your Client Success Manager.
Get Your Google Search Information
Programmable Search Engine
Go to the Programmable Search Engine and log in with your Google credentials.
- Click on New Search Engine
- In Sites to Search type in your website URL: https://idashboards.com
- In Name of the Search Engine type in your website name: iDashboards
- Click CREATE, you will then see the following image appear:
- Click on Control Panel, you will then see the image below:
- You will need to copy your Search Engine ID into notepad or text editor of your choice as it will become your Custom Search ID in your database URL.
Custom Search API
Go to the Google Developers API Console and log in with your Google credentials. It will look like the image below once you are logged in.
- Click on +ENABLE APIS AND SERVICES
- You are now at the API Library, in the Search bar type in: Custom Search API
- Click ENABLE
- Now go to Credentials in the left side menu, where the key icon is, it will open up once you move your cursor over there and show you that the key icon is Credentials.
- In many of our data connections we ask you to get the OAuth 2.0 Client ID and Client Secret, this time we will not be doing that, instead we will be obtaining an API Key. So you will click on Credentials in APIs & Services
- Now click on +Create Credentials
- Then click on API Key
- A box will appear as shown below, here you will copy your API key and paste it into that notepad document with you Search Engine ID, which will become your Custom Search ID.
What Should You have Obtained by Now?
- Search Engine ID
- Search Engine ID (Google) = Custom Search ID (CDATA)
- API key
With these two items you will be able to make your Data Source connection within the iDashboards Admin or Data Hub.
Go to either Data Hub or iDashboards Admin and log in with your iDashboards credentials.
- Click Data Sources
- Then click on New
- You will then fill out the highlighted fields:
- Then Click Save
- Create a New Data Set (if using iDashboards, create a new chart in Builder)
- Select Table/View
- Select the Table you would like to use either ImageSearch or WebSearch
- Where you see Specify Filters click on the + below to add a new filter, then you will see the following image below appear. It is here to warn you that you can NOT use the 'IS NOT' operator. You must use an '='. Click OK
- Here choose: SearchTerms='technology' so 'technology' is the only thing in the text box.
Please note: You MUST Pass Search Terms as a FILTER: SearchTerms=’technology’ for this API to work. Once it has been configured the first time technology can be changed to any SearchTerm of your choice.
For More Information:
- Creating a Database URL (Connection String)
- CData JDBC Driver for Google Search
- Programmable Search Engine
- Google Developers API Console
- Google Custom Search API Documentation
- iDashboards Admin Manual 10. Managing Data Sources
Limitations and Disclaimers
Limitations: Google search has an aggregate function called TotalResults() that is similar like Count(*). TotalResults() can be used if you want to get the number of result based on your query. However, the Google Search API limits the number of items returned to 100 so count(*) will not be the actual number of search results.
Disclaimer: iDashboards Technical Support Engineers are not proficient in the Management and Integration of every API that exists as new APIs are being created everyday with each company that wants to provide seamless integration with other software. However, we do our best to help you make these connections because we want to assist you in your success. If you do not see an article for a connection you would like to make please contact iDashboards Support and know that it will take a bit of time to figure out what is necessary for this integration.
If the above is unable to resolve the issue, then please contact iDashboards Support for further assistance.