Merge pull request #73 from segment-integrations/update/ee-custom-dimensions

Author: brennan

HISTORY.md

@@ -1,3 +1,8 @@
+2.10.0 / 2018-02-06
+=================
+
+* Support custom dimensions for enhanced ecommerce events.
+
 2.9.6 / 2017-11-28
 =================
 

lib/index.js

@@ -14,6 +14,7 @@ var len = require('object-component').length;
 var push = require('global-queue')('_gaq');
 var reject = require('reject');
 var useHttps = require('use-https');
+var extend = require('extend');
 var user;
 
 /**
@@ -198,6 +199,7 @@ GA.prototype.page = function(page) {
   var pagePath = path(props, this.options);
   var pageTitle = name || props.title;
   var pageReferrer = page.referrer() || '';
+  var self = this;
   var track;
 
   // store for later
@@ -220,18 +222,7 @@ GA.prototype.page = function(page) {
     title: pageTitle
   };
 
-  // custom dimensions, metrics and content groupings
-  var custom = metrics(props, opts);
-  if (len(custom)) {
-    if (opts.setAllMappedProps) {
-      window.ga(this._trackerName + 'set', custom);
-    } else {
-      // Add custom dimensions / metrics to pageview payload
-      each(custom, function(key, value) {
-        pageview[key] = value;
-      });
-    }
-  }
+  pageview = extend(pageview, setCustomDimenionsAndMetrics(props, opts, self._trackerName));
 
   if (pageReferrer !== document.referrer) payload.referrer = pageReferrer; // allow referrer override if referrer was manually set
   window.ga(this._trackerName + 'set', payload);
@@ -291,6 +282,7 @@ GA.prototype.track = function(track, options) {
   opts = defaults(opts, interfaceOpts);
   var props = track.properties();
   var campaign = track.proxy('context.campaign') || {};
+  var self = this;
 
   var payload = {
     eventAction: track.event(),
@@ -307,18 +299,7 @@ GA.prototype.track = function(track, options) {
   if (campaign.content) payload.campaignContent = campaign.content;
   if (campaign.term) payload.campaignKeyword = campaign.term;
 
-  // custom dimensions & metrics
-  var custom = metrics(props, interfaceOpts);
-  if (len(custom)) {
-    if (interfaceOpts.setAllMappedProps) {
-      window.ga(this._trackerName + 'set', custom);
-    } else {
-      // Add custom dimensions / metrics to payload
-      each(custom, function(key, value) {
-        payload[key] = value;
-      });
-    }
-  }
+  payload = extend(payload, setCustomDimenionsAndMetrics(props, interfaceOpts, self._trackerName));
 
   window.ga(this._trackerName + 'send', 'event', payload);
 };
@@ -542,6 +523,31 @@ function path(properties, options) {
   return str;
 }
 
+/**
+ * Set custom dimensions and metrics
+ *
+ * @param {Properties} props
+ * @param {Options} opts
+ * @param {String} trackerName
+ * @return {Object}
+ */
+
+function setCustomDimenionsAndMetrics(props, opts, trackerName) {
+  var ret = {};
+  var custom = metrics(props, opts);
+  if (len(custom)) {
+    if (opts.setAllMappedProps) {
+      window.ga(trackerName + 'set', custom);
+    } else {
+      // Add custom dimensions / metrics to event payload
+      each(custom, function(key, value) {
+        ret[key] = value;
+      });
+      return ret;
+    }
+  }
+}
+
 /**
  * Format the value property to Google's liking.
  *
@@ -614,7 +620,7 @@ GA.prototype.loadEnhancedEcommerce = function(track) {
  * @param {Track} track
  */
 
-GA.prototype.pushEnhancedEcommerce = function(track) {
+GA.prototype.pushEnhancedEcommerce = function(track, opts, trackerName) {
   var self = this;
   // Send a custom non-interaction event to ensure all EE data is pushed.
   // Without doing this we'd need to require page display after setting EE data.
@@ -624,7 +630,7 @@ GA.prototype.pushEnhancedEcommerce = function(track) {
     track.category() || 'EnhancedEcommerce',
     track.event() || 'Action not defined',
     track.properties().label,
-    { nonInteraction: 1 }
+    extend({ nonInteraction: 1 }, setCustomDimenionsAndMetrics(track.properties(), opts, trackerName))
   ]);
   window.ga.apply(window, args);
 };
@@ -671,6 +677,7 @@ GA.prototype.checkoutStepViewedEnhanced = function(track) {
   var props = track.properties();
   var options = extractCheckoutOptions(props);
   var self = this;
+  var opts = this.options;
 
   this.loadEnhancedEcommerce(track);
 
@@ -683,7 +690,7 @@ GA.prototype.checkoutStepViewedEnhanced = function(track) {
     option: options || undefined
   });
 
-  this.pushEnhancedEcommerce(track);
+  this.pushEnhancedEcommerce(track, opts, self._trackerName);
 };
 
 /**
@@ -727,6 +734,7 @@ GA.prototype.orderCompletedEnhanced = function(track) {
   var orderId = track.orderId();
   var products = track.products();
   var props = track.properties();
+  var opts = this.options;
   var self = this;
 
   // orderId is required.
@@ -748,7 +756,7 @@ GA.prototype.orderCompletedEnhanced = function(track) {
     coupon: track.coupon()
   });
 
-  this.pushEnhancedEcommerce(track);
+  this.pushEnhancedEcommerce(track, opts, self._trackerName);
 };
 
 /**
@@ -764,6 +772,7 @@ GA.prototype.orderRefundedEnhanced = function(track) {
   var orderId = track.orderId();
   var products = track.products();
   var self = this;
+  var opts = this.options;
 
   // orderId is required.
   if (!orderId) return;
@@ -783,7 +792,7 @@ GA.prototype.orderRefundedEnhanced = function(track) {
     id: orderId
   });
 
-  this.pushEnhancedEcommerce(track);
+  this.pushEnhancedEcommerce(track, opts, self._trackerName);
 };
 
 /**
@@ -797,10 +806,11 @@ GA.prototype.orderRefundedEnhanced = function(track) {
 
 GA.prototype.productAddedEnhanced = function(track) {
   var self = this;
+  var opts = this.options;
 
   this.loadEnhancedEcommerce(track);
   enhancedEcommerceProductAction(track, 'add', null, self._trackerName);
-  this.pushEnhancedEcommerce(track);
+  this.pushEnhancedEcommerce(track, opts, self._trackerName);
 };
 
 /**
@@ -814,10 +824,11 @@ GA.prototype.productAddedEnhanced = function(track) {
 
 GA.prototype.productRemovedEnhanced = function(track) {
   var self = this;
+  var opts = this.options;
 
   this.loadEnhancedEcommerce(track);
   enhancedEcommerceProductAction(track, 'remove', null, self._trackerName);
-  this.pushEnhancedEcommerce(track);
+  this.pushEnhancedEcommerce(track, opts, self._trackerName);
 };
 
 /**
@@ -833,12 +844,13 @@ GA.prototype.productViewedEnhanced = function(track) {
   var props = track.properties();
   var data = {};
   var self = this;
+  var opts = this.options;
 
   this.loadEnhancedEcommerce(track);
   // list property is optional
   if (props.list) data.list = props.list;
   enhancedEcommerceProductAction(track, 'detail', data, self._trackerName);
-  this.pushEnhancedEcommerce(track);
+  this.pushEnhancedEcommerce(track, opts, self._trackerName);
 };
 
 /**
@@ -854,12 +866,13 @@ GA.prototype.productClickedEnhanced = function(track) {
   var props = track.properties();
   var data = {};
   var self = this;
+  var opts = this.options;
 
   this.loadEnhancedEcommerce(track);
   // list property is optional
   if (props.list) data.list = props.list;
   enhancedEcommerceProductAction(track, 'click', data, self._trackerName);
-  this.pushEnhancedEcommerce(track);
+  this.pushEnhancedEcommerce(track, opts, self._trackerName);
 };
 
 /**
@@ -874,6 +887,7 @@ GA.prototype.productClickedEnhanced = function(track) {
 GA.prototype.promotionViewedEnhanced = function(track) {
   var props = track.properties();
   var self = this;
+  var opts = this.options;
 
   this.loadEnhancedEcommerce(track);
   window.ga(self._trackerName + 'ec:addPromo', {
@@ -882,7 +896,7 @@ GA.prototype.promotionViewedEnhanced = function(track) {
     creative: props.creative,
     position: props.position
   });
-  this.pushEnhancedEcommerce(track);
+  this.pushEnhancedEcommerce(track, opts, self._trackerName);
 };
 
 /**
@@ -897,6 +911,7 @@ GA.prototype.promotionViewedEnhanced = function(track) {
 GA.prototype.promotionClickedEnhanced = function(track) {
   var props = track.properties();
   var self = this;
+  var opts = this.options;
 
   this.loadEnhancedEcommerce(track);
   window.ga(self._trackerName + 'ec:addPromo', {
@@ -906,7 +921,7 @@ GA.prototype.promotionClickedEnhanced = function(track) {
     position: props.position
   });
   window.ga(self._trackerName + 'ec:setAction', 'promo_click', {});
-  this.pushEnhancedEcommerce(track);
+  this.pushEnhancedEcommerce(track, opts, self._trackerName);
 };
 
 /**
@@ -922,6 +937,7 @@ GA.prototype.productListViewedEnhanced = function(track) {
   var props = track.properties();
   var products = track.products();
   var self = this;
+  var opts = this.options;
 
   this.loadEnhancedEcommerce(track);
   each(products, function(product) {
@@ -945,7 +961,7 @@ GA.prototype.productListViewedEnhanced = function(track) {
     window.ga(self._trackerName + 'ec:addImpression', impressionObj);
   });
 
-  this.pushEnhancedEcommerce(track);
+  this.pushEnhancedEcommerce(track, opts, self._trackerName);
 };
 
 /**
@@ -965,6 +981,7 @@ GA.prototype.productListFilteredEnhanced = function(track) {
   var filters = props.filters.map(function(obj) { return obj.type + ':' + obj.value;}).join();
   var sorts = props.sorts.map(function(obj) { return obj.type + ':' + obj.value;}).join();
   var self = this;
+  var opts = this.options;
 
   this.loadEnhancedEcommerce(track);
   each(products, function(product) {
@@ -987,7 +1004,7 @@ GA.prototype.productListFilteredEnhanced = function(track) {
     window.ga(self._trackerName + 'ec:addImpression', impressionObj);
   });
 
-  this.pushEnhancedEcommerce(track);
+  this.pushEnhancedEcommerce(track, opts, self._trackerName);
 };
 
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@segment/analytics.js-integration-google-analytics",
   "description": "The Google Analytics analytics.js integration.",
-  "version": "2.9.6",
+  "version": "2.10.0",
   "keywords": [
     "analytics.js",
     "analytics.js-integration",
@@ -26,6 +26,7 @@
     "@ndhoule/defaults": "^2.0.1",
     "@segment/analytics.js-integration": "^3.1.0",
     "component-each": "^0.2.6",
+    "extend": "^3.0.1",
     "global-queue": "^1.0.1",
     "is": "^3.1.0",
     "obj-case": "^0.2.0",