Add campaign measurement tracking

danwilson · Aug 3, 2016 · bd3e2bb · bd3e2bb
1 parent f943047
commit bd3e2bb
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -47,6 +47,9 @@ In your 'deviceready' handler, set up your Analytics tracker:
 To track a Screen (PageView):
 * `window.ga.trackView('Screen Title')`
 
+To track a Screen (PageView) w/ campaign details:
+* `window.ga.trackView('Screen Title', 'my-scheme://content/1111?utm_source=google&utm_campaign=my-campaign')`
+
 To track an Event:
 * `window.ga.trackEvent('Category', 'Action', 'Label', Value)` Label and Value are optional, Value is numeric
 

diff --git a/android/UniversalAnalyticsPlugin.java b/android/UniversalAnalyticsPlugin.java
@@ -47,8 +47,9 @@ public boolean execute(String action, JSONArray args, CallbackContext callbackCo
             this.startTracker(id, callbackContext);
             return true;
         } else if (TRACK_VIEW.equals(action)) {
+            int length = args.length();
             String screen = args.getString(0);
-            this.trackView(screen, callbackContext);
+            this.trackView(screen, length > 1 ? args.getString(1) : "", callbackContext);
             return true;
         } else if (TRACK_EVENT.equals(action)) {
             int length = args.length();
@@ -75,10 +76,7 @@ public boolean execute(String action, JSONArray args, CallbackContext callbackCo
         } else if (TRACK_METRIC.equals(action)) {
             int length = args.length();
             if (length > 0) {
-                this.trackMetric(
-                args.getInt(0),
-                length > 1 ? args.getString(1) : "",
-                callbackContext);
+                this.trackMetric(args.getInt(0), length > 1 ? args.getString(1) : "", callbackContext);
             }
             return true;
         } else if (ADD_DIMENSION.equals(action)) {
@@ -180,7 +178,7 @@ private <T> void addCustomDimensionsToHitBuilder(T builder) {
         }
     }
 
-    private void trackView(String screenname, CallbackContext callbackContext) {
+    private void trackView(String screenname, String campaignUrl, CallbackContext callbackContext) {
         if (! trackerStarted ) {
             callbackContext.error("Tracker not started");
             return;
@@ -192,6 +190,10 @@ private void trackView(String screenname, CallbackContext callbackContext) {
             HitBuilders.ScreenViewBuilder hitBuilder = new HitBuilders.ScreenViewBuilder();
             addCustomDimensionsToHitBuilder(hitBuilder);
 
+            if(!campaignUrl.equals("")){
+                hitBuilder.setCampaignParamsFromUrl(campaignUrl);
+            }
+
             tracker.send(hitBuilder.build());
             callbackContext.success("Track Screen: " + screenname);
         } else {

diff --git a/ios/UniversalAnalyticsPlugin.m b/ios/UniversalAnalyticsPlugin.m
@@ -275,8 +275,26 @@ - (void) trackView: (CDVInvokedUrlCommand*)command
 
         id<GAITracker> tracker = [[GAI sharedInstance] defaultTracker];
         [self addCustomDimensionsToTracker:tracker];
-        [tracker set:kGAIScreenName value:screenName];
-        [tracker send:[[GAIDictionaryBuilder createScreenView] build]];
+
+        NSString* deepLinkUrl = [command.arguments objectAtIndex:1];
+        GAIDictionaryBuilder* openParams = [[GAIDictionaryBuilder alloc] init];
+
+        if (deepLinkUrl) {
+            [[openParams setCampaignParametersFromUrl:deepLinkUrl] build];
+        }
+
+        // Campaign source is the only required campaign field. If previous call
+        // did not set a campaign source, use the hostname as a referrer instead.
+        if(![openParams get:kGAICampaignSource] && [url host].length !=0) {
+            // Set campaign data on the map, not the tracker.
+            [openParams set:@"referrer" forKey:kGAICampaignMedium];
+            [openParams set:[url host] forKey:kGAICampaignSource];
+        }
+
+        NSDictionary *hitParamsDict = [openParams build];
+
+        [tracker set:kGAIScreenName value:screenName];        
+        [tracker send:[[[GAIDictionaryBuilder createScreenView] setAll:hitParamsDict] build]];
 
         pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK];
         [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];

diff --git a/plugin.xml b/plugin.xml
@@ -25,6 +25,7 @@
     <header-file src="ios/UniversalAnalyticsPlugin.h" />
     <source-file src="ios/UniversalAnalyticsPlugin.m" />
     <source-file src="ios/libGoogleAnalyticsServices.a" framework="true" />
+    <source-file src="ios/libAdIdAccess.a" framework="true" />
     <header-file src="ios/GAIDictionaryBuilder.h" />
     <header-file src="ios/GAIFields.h" />
     <header-file src="ios/GAILogger.h" />
@@ -38,6 +39,7 @@
 
     <framework src="SystemConfiguration.framework" />
     <framework src="CoreData.framework" />
+    <framework src="AdSupport.framework" />
     <framework src="libz.dylib" />
     <framework src="libsqlite3.dylib" />
   </platform>
@@ -62,12 +64,12 @@
         </intent-filter>
       </receiver>
       <service android:name="com.google.android.gms.analytics.AnalyticsService" android:enabled="true" android:exported="false"/>
-      <receiver android:name="com.google.android.gms.analytics.CampaignTrackingReceiver" android:exported="true">
+      <receiver android:name="com.google.android.gms.analytics.CampaignTrackingReceiver" android:enabled="true" android:exported="true">
         <intent-filter>
           <action android:name="com.android.vending.INSTALL_REFERRER" />
         </intent-filter>
       </receiver>
-      <service android:name="com.google.android.gms.analytics.CampaignTrackingService" />
+      <service android:name="com.google.android.gms.analytics.CampaignTrackingService" android:enabled="true" android:exported="false"/>
     </config-file>
     <source-file src="android/UniversalAnalyticsPlugin.java" target-dir="src/com/danielcwilson/plugins/analytics" />
   </platform>

diff --git a/www/analytics.js b/www/analytics.js
@@ -29,8 +29,12 @@ UniversalAnalyticsPlugin.prototype.trackMetric = function(key, value, success, e
   cordova.exec(success, error, 'UniversalAnalytics', 'trackMetric', [key, value]);
 };
 
-UniversalAnalyticsPlugin.prototype.trackView = function(screen, success, error) {
-  cordova.exec(success, error, 'UniversalAnalytics', 'trackView', [screen]);
+UniversalAnalyticsPlugin.prototype.trackView = function(screen, campaingUrl, success, error) {
+  if (typeof campaingUrl === 'undefined' || campaingUrl === null) {
+    campaingUrl = '';
+  }
+
+  cordova.exec(success, error, 'UniversalAnalytics', 'trackView', [screen, campaingUrl]);
 };
 
 UniversalAnalyticsPlugin.prototype.addCustomDimension = function(key, value, success, error) {