API: Google Analytics – OSKAR

This requires Admin or Data Admin privileges for implementation. Updated as of 04/22/2022.

Please Note: If you do not have the correct privileges to access Data Hub you will receive the following upon your login attempt. If you get this message and think it is an error please see your organization's iDashboards Administrator for assistance as Support is unable to give you access.

Your Dashboards wepage, MUST utilize a top level domain name and also requrie SSL to be implemented (https) to use Google Analytics, as many APIs are now requiring both.

*** If you do not have both please obtain a top level domain name, and an SSL Certificate please see Tomcat: SSL Certificate Installation for more details on SSL Certificates. ***

Connecting to Google Analytics API

Creating Data Sets from Your Connection

Creating an ETL Job

Connecting to Google Analytics API

This document goes over the process required to create an API connection to Google Analytics. This process will flow from initializing the API connection to creating a job in the ETL tool that transfers that API data into a database table/data source, to adding a chart connecting to that data source. If you don't have a developer account go here to create one.

Once you create a developer account you will see a screen like the one below. At this screen you will:

Click Select a Project (iDashboards is the project selected)

This box will pop up and you will click NEW PROJECT

You will then type in the box Project Name and Location, after you will then click CREATE.

Now select: +Enable APIS AND SERVICES.

At this time you will type in the search box Google Analytics API and then hit Enter

Please check that your search matches the one below and click Google Analytics API

Click ENABLE

Here you will click CREATE CREDENTIALS.

Which then brings you to the following where you will:

- Select an API
- Select Application Data
- Next No, I'm Not Using Them
- Then click Next

This will prompt you to Create a Service Account

- Service Account Name: iDashboards/TruOi/WhateverWorksForYou
- Service Account ID: MUST be UNIQUE
- Service Account Description: If you have multiple analytics going to our software something that will help you know which one, like Development Data, Test Data, Production Data, etc.
- Then click Create and Continue

Now Select a Role for Your Service Account, if you will be the primary Google Analytics User, you will likely select Owner unless your Google Analytics Account is created by someone else in your Organization then consult whomever made the account to know what priveledges you have, then click CONTINUE

If you need to give others access to the account please do so here, othewise click DONE

In the drop down menu you will select OAuth Consent Screen

It may not appear fully until you go to click on it. On the next screen...

Select Your User Type:

- If you have no need to utilize this data outside of your Organization choose Internal.
  - If you own the Google Analytics Account Select you may want to select this one.
- If you will use this in various environments you may want to read Learn more about user type to see if External would be a better option for you. If you choose External it will have extra steps you will need to go through, and those will take some extra time as Google verifies your app.
  - If you do not own the Google Analytics Account either select this one, or consult your Organization's Google Analtyics Main User.

When Selecting External you will need the following:

- Applicatoin Name
- User Support Email
- Application Logo
- Applicatoin Home Page
- Application Privacy Policy Link
- Application Terms of Service Link

Then you Scroll Down for the rest of the External App Registration

- Add Your Domain Name: You MUST utilize a top level domain name to use Google Analytics
- Google Analaytics Developer Email Address
- Then click Save and Continue

Next Add or Remove Scopes for the Applicatoin then click Save and Continue

Add Users for testing the Appliction then click Save and Continue

The next page is just a summary, check to make sure everything is correct and click Back to Dashboard

When you are ready to fully ultizize it click Publish App

Now select again +Create Credentials

Select Oauth Client ID again

Where it says Application type select Web application

For Name enter the Application name in the box provided

Then scroll down and add the Authorized Redirect URIs: In Data Hub...

In a new tab, keep the Google API page open at http(s)://yourdomain:6700/idbdata/

Click on API Accounts

Then Add Account

Select Google Analytics then Next

Now Copy the Redirect URL:

http(s)://yourdomainname:6700/idbdata/console/api/callback

Now Add the Redirect URL as an Authorized Redirect URI

Finally click Create

Keep both Data Hub and Google API pages up

Here you will copy your Client ID, go back to to the open Data Hub tab and paste it where it says Client ID. If it has anything in the box delete it before pasting the Client ID.

The buttons next to the Client ID and Client Secret are to make copying them Easy for You

Once you have the Client ID pasted into the box, then go back to the Google Analytics tab and copy the Client Secret into the box.

Your screen will now look similar to below and you can now click Log In.

It will then prompt you to log into Google Analytics: After logging into the site if you have strict network settings you may see the following message below, click where it says Advanced.

It will then expand, and click Go to iDashboards Data Hub (unsafe)

Once you see this screen you will be successfully connected to your Google Analytics account through your iDashboards Data Hub.

When that box disappears you can begin using your Google Analytics data on your dashboards. At this time you can close out of your Google Analytics tab and only use Data Hub.

Connecting to Google Analytics API

Creating an ETL Job

Creating Data Sets from Your Connection

Now you can create a data set from your Google Analytics account by clicking on Data Sets

Then select: New Data Set

Then click: Cloud API

Now you will see the following screen, if you have other API connections they will show up here, select Google Analytics and click Add Account.

You can then configure the data, parameters and filters you would like to use.

Once you have that done click Save and move on to the next screen where you can move the columns around if they are not in the correct order, click Save As. Once you have it saved you can close out of this, as your data set is now created.

Connecting to Google Analytics API

Creating Data Sets from Your Connection

Creating an ETL Job

You will now be at the Data Hub Lobby: here you can select +NEW ETL JOB

What is an ETL job?

E - Extract Data from your data source

T - Transform Data or make changes

L - Load Data into a target table

Here are the various types of transformations available:

Looking back at the previous picture if you Click and Drag the E, T, and L you can set up your job.

Once you click on the E to Extract your data, you get the Extract Data (1) box. When you hoover your mouse over it you get the gear on the left (you can also double click on the Task to configure the task), the up arrow in the middle to send your data to be transformed (T) or loaded (L). If you do not have any transformations that need to be done, you can pull down the L and connect the E and L with the up arrow by dragging it from the E to the middle of the L.

Connecting the E and L as shown below, allows your data to be used to make: dashboards, charts, picklists and forms.

Connecting to Google Analytics API

Creating Data Sets from Your Connection

Creating an ETL Job

Please Note: If you are running on software at or below v9.7f please contact support for assistance in upgrading.

For More Information:

iDashboards Data Hub Manual 8. Extract, Transform and Load
UA Query Explorer (Data Analyst + Dashboard Builders)
Read Next: Google Analytics Pack

If the above is unable to resolve the issue, then please contact iDashboards Support for further assistance.