Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ArcBees/universal-analytics
Complete GWT wrapper for Google's Universal Analytics
https://github.com/ArcBees/universal-analytics
Last synced: 20 days ago
JSON representation
Complete GWT wrapper for Google's Universal Analytics
- Host: GitHub
- URL: https://github.com/ArcBees/universal-analytics
- Owner: ArcBees
- Created: 2014-04-28T15:58:14.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-10-29T05:59:50.000Z (about 9 years ago)
- Last Synced: 2024-04-16T10:30:20.763Z (8 months ago)
- Language: Java
- Homepage:
- Size: 838 KB
- Stars: 17
- Watchers: 14
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- gwt-boot-awesome-lili - universal-analytics - Analytics library (Analytics)
- gwt-boot-awesome-lili - universal-analytics - Analytics library (Analytics)
README
#Universal Analytics
A universal analytics implementation and service provider.
##Install
Add the following to your pom
```
com.arcbees.analytics
universal-analytics
2.1
```
Add the following to your gwt.xml
```
```
Then in your gin module:
```
install(new AnalyticsModule.Builder("UA-XXXXXXXX-X").build());
```
##Advanced Install
By default AnalyticsModule.Builder will automatically create a tracker for you.
If you want to set up your tracker manually (eg because you want to use plugins) call:
```
install(new AnalyticsModule.Builder("UA-XXXXXXXX-X").autoCreate(false).build());
```
Then in your entry point or bootstrapper(GWTP) call the following:
```
analytics.create().go();
analytics.enablePlugin(AnalyticsPlugin.DISPLAY); // (optional) Provides demographics information.
analytics.sendPageView().go(); // (recommended) track the initial pageview
```
##Mobile Install
When running in mobile applications under `file:` protocol, there is no cookie for UA to store
the data, thus there are some additional steps on mobile:
1. Set autoCreate to false (instructions in "Advanced Install" section)
2. Disable cookies storage
3. Set a clientId (should represent a unique user)
4. Disable protocol check (otherwise it aborts when protocol is not http/https)
[More details here](https://developers.google.com/analytics/devguides/collection/analyticsjs/domains#disableCookies)
It can be done as follows:
```
createOpts = analytics.create(trackerCode);
createOpts.clientId('client_id').storage(Storage.NONE).go();
analytics.setGlobalSettings().generalOptions().disableTask(Task.CHECK_PROTOCOL).go();
```
##Basic Usage
Inject Analytics into the class you want to track events from.
**REMEMBER TO CALL GO()**
Analytics uses a version of the builder pattern where you call the type of tracking method you want, then chain the options you need to the call followed by go().
eg:
```
analytics.sendPageView().go(); //track a pageview
analytics.sendPageView().documentPath("/foo").go(); //track a pageview for page /foo
analytics.sendEvent("button", "click").eventLabel("my label").go(); //send event with label
```
If you want to change the global settings call setGlobalSettings in the same way.
```
analytics.setGlobalSettings().anonymizeIp(true).go(); //anonymize ips
```
##Mobile Usage
When dealing with mobile analytics the [ScreenView
events should be used instead of PageView](https://developers.google.com/analytics/devguides/collection/analyticsjs/screens).
It's also mandatory to send `AppName` otherwise the realtime analytics won't work.
Another useful information to send is the ScreenName.
e.g.:
```
analytics.sendScreenView().screenName('current_page_name').appTrackingOptions().applicationName('my_app_name').go();
```
##Server Side
```
install(new ServerAnalyticsModule("UA-XXXXXX-X"));
```
You can use analytics on the server exactly the same as you do on the client.
Server side calls work via the [Measurement Protocol](https://developers.google.com/analytics/devguides/collection/protocol/v1/)
A filter will automatically fill out the Measurement Protocol required fields for you from the _ga cookie or create the cookie if it doesn't exist.
`setGlobalOptions()` and `enablePlugin()` have no effect on server calls.
If you're using multiple trackers then you should call `create().trackerName("My Tracker").go()` once at the beginning of each request to create your secondary trackers before calling any analytics methods. All other options sent to create() on the server will be ignored.
If you're setting a custom cookie name on the client then the automatic filter will not work correctly because it assumes that the cookie name is : _ga. Raise an issue on this project if you need to set the cookie name for some reason.
##Timing Events
To start a timing event call
```
analytics.startTimingEvent("My Category", "My Timing Variable Name");
```
Then to end it call.
```
analytics.endTimingEvent("My Category", "My Timing Variable Name").userTimingLabel("My Label").go();
```
This will automatically create a timing event marking the difference between when the start and end calls are made.
The category and variable names for the start and end calls must be exactly the same, or the call will have no effect.
##Credits
Thanks to Richard Wallis (https://github.com/rdwallis) for his initial pull request against GWTP (https://github.com/ArcBees/GWTP/pull/521)
See his repo here https://github.com/rdwallis/gwt-universal-analytics
##Thanks to
[](http://arcbees.com)
[](https://www.atlassian.com/)
[](http://www.jetbrains.com/idea/index.html)