Skip to content

Latest commit

 

History

History
288 lines (237 loc) · 10 KB

README.md

File metadata and controls

288 lines (237 loc) · 10 KB

Analytics plugin for Phonegap

The analytics client allows you to send page views, events, timings to Google Analytics. It also allows you to set custom dimensions that have been set up on this account (see below).

Adding the Plugin to your project

Using this plugin requires PhoneGap Cordova library for Android version 1.9 or above.

  1. To install the plugin, move www/analytics.js to your project's www folder and include a reference to it in your html file after cordova.js.

    <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
    <script type="text/javascript" charset="utf-8" src="analytics.js"></script>

  2. Create a directory within your project called src/com/phonegap/plugins/analytics and copy src/com/phonegap/plugins/analytics/GoogleAnalyticsTracker.java into it.

  3. Add the following activity to your AndroidManifest.xml file, inside the <application> tag if it isn't already there.

    <activity android:name="com.phonegap.DroidGap" android:label="@string/app_name">
    <intent-filter>
    </intent-filter>
    </activity>

  4. Download GoogleAnalytics library (tested with v2.0 Beta 4; Use the version from this repo if needed) and copy lib/libGoogleAnalyticsV2.jar into the libs directory within your project. You may also need to right click on this file in eclipse and add the jar to the build path.

  5. In your res/xml/config.xml file add the following line:

<plugin name="GoogleAnalyticsTracker" value="com.phonegap.plugins.analytics.GoogleAnalyticsTracker" />

  1. Copy the res/values/analytics.xml file to the corresponding location in your project and set your App's Tracking ID in there. Documentation

Using the plugin

The plugin creates the object window.plugins.analytics. To use, call one of the following, available methods:

####start(successCallback, failureCallback)#### Sample use:


	window.plugins.analytics.start(
			function(){
				console.log("Start: success");
			},
		    function(){
		    	console.log("Start: failure");
		    }
	);

####stop(successCallback, failureCallback);#### Sample use:


	window.plugins.analytics.stop(
			function(){
				console.log("Stop: success");
			},
	     	function(){
	     		console.log("Stop: failure");
	     	}
	);

####trackPageView(key, successCallback, failureCallback);####

/**
 * @param key				The name of the tracked item (can be a url or some logical name).
 * 							The key name will be presented in Google Analytics report.  
 * @param successCallback	The success callback
 * @param failureCallback	The error callback 
 */

Sample use:


    window.plugins.analytics.trackPageView(
    			"page1.html",
    			 function(){
    			 	console.log("Track: success");
    			 },
    			 function(){
    			 	console.log("Track: failure");
    			 }
    );

####trackEvent(category, action, label, value, successCallback, failureCallback)####

/**
 * @param category			The name that you supply as a way to group objects that you want to track
 * @param action			The name the type of event or interaction you want to track for a particular web object
 * @param label				Provides additional information for events that you want to track (optional)
 * @param value				Assign a numerical value to a tracked page object (optional)

 * @param successCallback	The success callback
 * @param failureCallback	The error callback 
 */

Sample use:


	window.plugins.analytics.trackEvent(
				"category",
			    "action",
			    "event",
			     1,
			    function(){
			    	console.log("Track: success");
			    }, 
			    function(){
			    	console.log("Track: failure");
			    }
	);

####trackTiming(category, timing, name, label, successCallback, failureCallback)#### Used to track timings within your app, such as load times, server calls, page changes etc.

This is new to SDK v2 and only works with beta 4 and above. Reporting is still sketchy. https://developers.google.com/analytics/devguides/collection/android/v2/usertimings?hl=en

/**
* @param category The category of timing
* @param timing The timing value to track (in ms)
* @param name The name of the timing value
* @param label Provides additional information for timing events that you want to track (optional)

* @param successCallback The success callback
* @param failureCallback The error callback
*/

Sample use:


	window.plugins.analytics.trackTiming(
					"load",
					1248,
					"page1",
					"label",
					function(){
				    	console.log("Track: success");
				    }, 
				    function(){
				    	console.log("Track: failure");
				    }
	);

####setCustomDimension(index,value, successCallback, failureCallback)#### Set a custom dimension. This replaces custom variables from v1. see https://developers.google.com/analytics/devguides/platform/features/customdimsmets

Note: The dimension must be set up through the analytics web console to show up. see http://support.google.com/analytics/bin/answer.py?hl=en&answer=2709829

/**
* @param index The index of the dimension (set on Google Analytics)
* @param value The value to set
* 
* @param successCallback The success callback
* @param failureCallback The error callback
 */


	window.plugins.analytics.setCustomDimension(
					1,
					"wifi",
					function(){
				    	console.log("Track: success");
				    }, 
				    function(){
				    	console.log("Track: failure");
				    }
	);

}; Please keep in mind that these methods, as in any other plugin, are ready to be invoked only after 'deviceready' event has been fired One good practice would be to manually stop the session, when the app closes. Add this code to your main activity:

    
@Override
public void onDestroy() 
{
    super.onDestroy();
    com.google.analytics.tracking.android.EasyTracker.getInstance().activityStop(this);
}

RELEASE NOTES

NOV, 14, 2012

  • Upgraded to support Version 2 of the Google Analytics SDK
  • Added the stop method

AUG, 14, 2012

  • Added suppport for Cordova 1.9 and above

AUG, 10, 2011

  • Added event tracking

Jul 24, 2011

  • Initial release

BUGS AND CONTRIBUTIONS

LICENSE

PhoneGap is available under either the terms of the modified BSD license or the MIT License (2008). As a recipient of PhonegGap, you may choose which license to receive this code under (except as noted in per-module LICENSE files). Some modules may not be the copyright of Nitobi. These modules contain explicit declarations of copyright in both the LICENSE files in the directories in which they reside and in the code itself. No external contributions are allowed under licenses which are fundamentally incompatible with the MIT or BSD licenses that PhoneGap is distributed under.

The text of the MIT and BSD licenses is reproduced below.

The "New" BSD License

Copyright (c) 2005-2010, Nitobi Software Inc. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of Phonegap/Nitobi nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The MIT License

Copyright (c) <2010> <Nitobi Software Inc., et. al., >

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

libGoogleAnalytics.jar

The libGoogleAnalyticsV2.jar is distributed under Apache License, Version 2.0. License URL: http://www.apache.org/licenses/LICENSE-2.0 libGoogleAnalyticsV2.jar URL: https://dl.google.com/gaformobileapps/GoogleAnalyticsAndroid.zip