Google Analytics Integration
This article shows how to use the Telerik Analytics API to implement a custom Google Analytics provider and send information to it.
Setting up Google Analytics Dashboard
This information is relevant at the time of writing of this article (September 2023) and it may not be up-to-date at the moment you read the article.
Create a new Google Analytics 4 Property in your google.com account.
Go to the Admin menu and create a new web data stream. It can point to a dummy website address.
Open the data stream details and copy its MEASUREMENT ID.
Create a Measurement Protocol API secret and copy the secret value.
In order to test the data you send, disable the Internal Traffic filter from the following menu, Admin —> Data Settings —> Data Filters. Also, event sending can be tested with the Google Analytics Event Builder.
The Measurement Id and API secret copied in setps 3 and 4 will be used in the .NET API shown in the Implementing the Analytics Provider section of this article.
Setting up the Project
To send information to the Google Analytics dashboard manually, use the Measurement Protocol (Google Analytics 4) API provided by Google. The API allows you to send http requests with the required event information. The following example uses the GoogleAnalytics.Ga4-Dotnet.Sdk unofficial GA4 SDK to send information to the dashboard.
The GoogleAnalytics.Ga4.DotNet.Sdk is build against .NET 6, which means the example in this article is relevant to projects targeting .NET 6 and later.
Download the source code of the GoogleAnalytics.Ga4-Dotnet.Sdk.
Open the solution and build the GoogleAnalytics.Ga4.DotNet.Sdk project. This will produce the GoogleAnalytics.Ga4.DotNet.Sdk.dll.
Create a new WinForms project (or use an existing one) targeting .NET 6. Then reference GoogleAnalytics.Ga4.DotNet.Sdk.dll.
Add a reference to Telerik.Windows.Controls.dll.
Install the Microsoft.Extensions.Http nuget package.
Implementing the Analytics Provider
To implement analytics provider that sends data to the Google dashboard, create a trace monitor class that implements the ITraceMonitor interface. To apply the new monitor use the TrackerManager class.
The following example demonstrates a simple implementation of the ITraceMonitor interface that uses the MeasurementService class from the GoogleAnalytics.Ga4-Dotnet.Sdk project to send events to the Google Analytics 4 property.
[C#] IHttpClientFactory implementation needed by the MeasurementService
public class HttpClientFactory : IHttpClientFactory
{
private readonly string _baseAddress = "https://www.google-analytics.com";
public HttpClient CreateClient(string name)
{
return new HttpClient()
{
BaseAddress = new Uri(_baseAddress),
DefaultRequestHeaders =
{
{ "Accept", "application/json" },
{ "User-Agent", "My Project Name" }
}
};
}
}
Public Class HttpClientFactory
Implements IHttpClientFactory
Private ReadOnly _baseAddress As String = "https://www.google-analytics.com"
Public Function CreateClient(name As String) As HttpClient Implements IHttpClientFactory.CreateClient
Dim httpClient As HttpClient = New HttpClient()
httpClient.BaseAddress = New Uri(_baseAddress)
httpClient.DefaultRequestHeaders.Add("Accept", "application/json")
httpClient.DefaultRequestHeaders.Add("User-Agent", "My Project Name")
Return httpClient
End Function
End Class
[C#] ITraceMonitor implementation
public class GoogleAnalyticsMonitor : ITraceMonitor
{
private MeasurementService service;
private string uniqueClienId;
public GoogleAnalyticsMonitor(string measurementId, string appSecret)
{
var options = Options.Create(new GoogleAnalyticsClientSettings()
{
MeasurementId = measurementId,
AppSecret = appSecret
});
var client = new BasicHttpClient(new HttpClientFactory(), options);
service = new MeasurementService(client);
uniqueClienId = "UniqueClientIdHere";
}
public async void TrackAtomicFeature(string feature)
{
// "atomic_feature" is a custom event name that will be send to Google Analytics
// "tracked_atomic_feature" is a custom parameter name that will be send to Google Anlaytics
var gaEvent = EventBuilders.BuildCustomEvent("atomic_feature", new Dictionary<string, object>());
gaEvent.AddParameters("tracked_atomic_feature", feature);
var request = new EventRequest(uniqueClienId);
request.AddEvent(gaEvent);
EventResponse result = await service.CreateEventRequest(request).Execute(false);
}
public async void TrackError(string feature, Exception exception)
{
var gaEvent = EventBuilders.BuildCustomEvent("exception", new Dictionary<string, object>());
gaEvent.AddParameters("tracked_exception", exception.Message);
var request = new EventRequest(uniqueClienId);
request.AddEvent(gaEvent);
EventResponse result = await service.CreateEventRequest(request).Execute(false);
}
public async void TrackFeatureCancel(string feature)
{
var gaEvent = EventBuilders.BuildCustomEvent("feature_cancel", new Dictionary<string, object>());
gaEvent.AddParameters("tracked_feature_cancel", feature);
var request = new EventRequest(uniqueClienId);
request.AddEvent(gaEvent);
EventResponse result = await service.CreateEventRequest(request).Execute(false);
}
public async void TrackFeatureEnd(string feature)
{
var gaEvent = EventBuilders.BuildCustomEvent("feature_end", new Dictionary<string, object>());
gaEvent.AddParameters("tracked_feature_end", feature);
var request = new EventRequest(uniqueClienId);
request.AddEvent(gaEvent);
EventResponse result = await service.CreateEventRequest(request).Execute(false);
}
public async void TrackFeatureStart(string feature)
{
var gaEvent = EventBuilders.BuildCustomEvent("feature_start", new Dictionary<string, object>());
gaEvent.AddParameters("tracked_feature_start", feature);
var request = new EventRequest(uniqueClienId);
request.AddEvent(gaEvent);
EventResponse result = await service.CreateEventRequest(request).Execute(false);
}
public async void TrackValue(string feature, long value)
{
var gaEvent = EventBuilders.BuildCustomEvent("value_event", new Dictionary<string, object>());
gaEvent.AddParameters("tracked_value", feature);
var request = new EventRequest(uniqueClienId);
request.AddEvent(gaEvent);
EventResponse result = await service.CreateEventRequest(request).Execute(false);
}
}
Public Class GoogleAnalyticsMonitor
Implements ITraceMonitor
Private service As MeasurementService
Private uniqueClienId As String
Public Sub New(ByVal measurementId As String, ByVal appSecret As String)
Dim clientOptions = Options.Create(New GoogleAnalyticsClientSettings() With {
.MeasurementId = measurementId,
.AppSecret = appSecret
})
Dim client = New BasicHttpClient(New HttpClientFactory(), clientOptions)
service = New MeasurementService(client)
uniqueClienId = "UniqueClientIdHere"
End Sub
Public Async Sub TrackAtomicFeature(feature As String) Implements ITraceMonitor.TrackAtomicFeature
Dim gaEvent = EventBuilders.BuildCustomEvent("atomic_feature", New Dictionary(Of String, Object)())
gaEvent.AddParameters("tracked_atomic_feature", feature)
Dim request = New EventRequest(uniqueClienId)
request.AddEvent(gaEvent)
Dim result As EventResponse = Await service.CreateEventRequest(request).Execute(False)
End Sub
Public Async Sub TrackFeatureStart(feature As String) Implements ITraceMonitor.TrackFeatureStart
Dim gaEvent = EventBuilders.BuildCustomEvent("feature_start", New Dictionary(Of String, Object)())
gaEvent.AddParameters("tracked_feature_start", feature)
Dim request = New EventRequest(uniqueClienId)
request.AddEvent(gaEvent)
Dim result As EventResponse = Await service.CreateEventRequest(request).Execute(False)
End Sub
Public Async Sub TrackFeatureEnd(feature As String) Implements ITraceMonitor.TrackFeatureEnd
Dim gaEvent = EventBuilders.BuildCustomEvent("feature_end", New Dictionary(Of String, Object)())
gaEvent.AddParameters("tracked_feature_end", feature)
Dim request = New EventRequest(uniqueClienId)
request.AddEvent(gaEvent)
Dim result As EventResponse = Await service.CreateEventRequest(request).Execute(False)
End Sub
Public Async Sub TrackFeatureCancel(feature As String) Implements ITraceMonitor.TrackFeatureCancel
Dim gaEvent = EventBuilders.BuildCustomEvent("feature_cancel", New Dictionary(Of String, Object)())
gaEvent.AddParameters("tracked_feature_cancel", feature)
Dim request = New EventRequest(uniqueClienId)
request.AddEvent(gaEvent)
Dim result As EventResponse = Await service.CreateEventRequest(request).Execute(False)
End Sub
Public Async Sub TrackError(feature As String, exception As Exception) Implements ITraceMonitor.TrackError
Dim gaEvent = EventBuilders.BuildCustomEvent("exception", New Dictionary(Of String, Object)())
gaEvent.AddParameters("tracked_exception", exception.Message)
Dim request = New EventRequest(uniqueClienId)
request.AddEvent(gaEvent)
Dim result As EventResponse = Await service.CreateEventRequest(request).Execute(False)
End Sub
Public Async Sub TrackValue(feature As String, value As Long) Implements ITraceMonitor.TrackValue
Dim gaEvent = EventBuilders.BuildCustomEvent("value_event", New Dictionary(Of String, Object)())
gaEvent.AddParameters("tracked_value", feature)
Dim request = New EventRequest(uniqueClienId)
request.AddEvent(gaEvent)
Dim result As EventResponse = Await service.CreateEventRequest(request).Execute(False)
End Sub
End Class
To apply the custom monitor, set the static ControlTraceMonitor.AnalyticsMonitor property, possibly in the constructor of your application.
void SetGoogleAnalyticsMonitor()
{
ControlTraceMonitor.AnalyticsMonitor = new GoogleAnalyticsMonitor("G-NWGCDXW4TJ", "wkl43C69QSqEphQxQsW0vA");
}
Private Sub SetGoogleAnalyticsMonitor()
ControlTraceMonitor.AnalyticsMonitor = New GoogleAnalyticsMonitor("G-NWGCDXW4TJ", "wkl43C69QSqEphQxQsW0vA")
End Sub
Read in details how to setup the Google Analytics dashboards in its documentation.