GoogleAnalyticsTracker - A C# library for tracking Google Analytics
C# Batchfile
Latest commit 95501f8 Mar 6, 2017 @maartenba Update README.md

README.md

googleanalyticstracker MyGet Build Status

GoogleAnalyticsTracker

GoogleAnalyticsTracker - A C# library for tracking Google Analytics.

Like this project?

via PayPal.

What can it be used for?

GoogleAnalyticsTracker was created to have a means of tracking specific URLs directly from C#. For example, when creating an API using the ASP.NET MVC framework, GoogleAnalyticsTracker enables you to track usage of the API by calling directly into Google Analytics.

Note that for GoogleAnalyticsTracker to work, you should configure Google Analytics as a website. This library will not work when the Google Analytics account is configured as an app.

Get it on NuGet!

Depending on the type of application you are using, use any of the following NuGet packages:

Windows applications (WinForms, WPF, Console):

Install-Package GoogleAnalyticsTracker.Simple

ASP.NET MVC 4 applications:

Install-Package GoogleAnalyticsTracker.MVC4

ASP.NET MVC 5 applications:

Install-Package GoogleAnalyticsTracker.MVC5

ASP.NET Web API v1 applications:

Install-Package GoogleAnalyticsTracker.WebAPI

ASP.NET Web API v2 applications:

Install-Package GoogleAnalyticsTracker.WebAPI2

OWIN applications:

Install-Package GoogleAnalyticsTracker.Owin

Nancy applications:

Install-Package GoogleAnalyticsTracker.Nancy

(deprecated) Windows Store (8 and 8.1) application:

Install-Package GoogleAnalyticsTracker.RT

(deprecated) Windows Phone (8 and 8.1) applications:

Install-Package GoogleAnalyticsTracker.WP8

Example usage

Using GoogleAnalyticsTracker is very straightforward. In your code, add the following structure wherever you want to track page views (note: when using GoogleAnalyticsTracker.Simple, the class to use is SimpleTracker):

using (Tracker tracker = new Tracker("UA-XXXXXX-XX", "www.example.org"))
{
    await tracker.TrackPageViewAsync("My API - Create", "api/create");
    await tracker.TrackPageViewAsync("MY API - List", "api/list");
}

Or without a using block:

Tracker tracker = new Tracker("UA-XXXXXX-XX", "www.example.org");
await tracker.TrackPageViewAsync("My API - Create", "api/create");

A number of extension methods are available which use the provided HttpContext as the source for URL and user properties:

Tracker tracker = new Tracker("UA-XXXXXX-XX", "www.example.org");
await tracker.TrackPageViewAsync(HttpContext, "My API - Create");

Finally, an ActionFilter for use with ASP.NET MVC is available:

[ActionTracking("UA-XXXXXX-XX", "www.example.org")]
public class ApiController  : Controller
{
    public JsonResult Create()
    {
        return Json(true);
    }
}

This filter can also be applied as a global action filter, optionally filtering the requests to log:

public class MvcApplication : System.Web.HttpApplication
{
    public static void RegisterGlobalFilters(GlobalFilterCollection filters)
    {
        filters.Add(new HandleErrorAttribute());
        filters.Add(new ActionTrackingAttribute(
            "UA-XXXXXX-XX", "www.example.org",
            action => action.ControllerContext.ControllerDescriptor.ControllerName == "Api")
        );
    }
}

An hook is also available for NancyFx:

public class HelloModule : NancyModule
{
    private readonly ActionTrackingHookAsync actionTrackingHook = new ActionTrackingHookAsync("UA-XXXXXX-XX", "www.example.org");

    public HelloModule()
    {
        Before += async (ctx, ct) =>
        {
            await actionTrackingHook.OnActionExecutingAsync(ctx, ct);
            return null;
        };

        Get["/ping"] = _ => Response.AsJson(new { Value = "Pong" });
        Get["Index","/"] = _ => "Hello World";
    }
}

Characteristics

GoogleAnalyticsTracker does not track your users. It simply serves as an interface to Google Analytics where you should provide all tracking data that is required. Of course. GoogleAnalyticsTracker sends some data that can be inferred from usage, such as the hostname on which it is running, but not the hostname of your client. Sessions are also untracked: every event that is tracked counts as a new unique visitor to Google Analytics.

  • If you do need to track user sessions, implement a custom IAnalyticsSession and pass it to the constructor of the Tracker object.
  • If you do need to track actual user data, it can be set on the Tracker object using its properties like Hostname, Language, UserAgent and so on.

License

MS-PL License

Building the source

After cloning the repository, run build.cmd. A folder named "Build" will be created and populated with:

  • Assemblies
  • PDB files
  • NuGet package

Who uses GoogleAnalyticsTracker?