Merge pull request #6 from amplitude/logRevenue

allanca · allanca · commit d7b1e8793001 · 2015-03-23T12:56:19.000-07:00
Add logRevenue support
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ Amplitude-Javascript
           n.async=true;n.src="https://d24n15hnbwhuhn.cloudfront.net/libs/amplitude-2.0.4-min.js";
           var s=t.getElementsByTagName("script")[0];s.parentNode.insertBefore(n,s);r._q=[];
           function a(e){r[e]=function(){r._q.push([e].concat(Array.prototype.slice.call(arguments,0)))
-          }}var i=["init","logEvent","setUserId","setUserProperties","setOptOut","setVersionName","setDomain","setDeviceId","setGlobalUserProperties"];
+          }}var i=["init","logEvent","logRevenue","setUserId","setUserProperties","setOptOut","setVersionName","setDomain","setDeviceId","setGlobalUserProperties"];
           for(var o=0;o<i.length;o++){a(i[o])}e.amplitude=r})(window,document);
 
           amplitude.init("YOUR_API_KEY_HERE");
@@ -57,6 +57,15 @@ To add properties that are tracked in every event, you can set properties for a
     userProperties.key = "value";
     amplitude.setUserProperties(userProperties);
 
+# Tracking Revenue #
+
+To track revenue from a user, call
+
+    amplitude.logRevenue(9.99, 1, "product");
+
+The function takes a unit price, a quantity, and a product identifier. Quantity and product identifier are optional parameters.
+
+This allows us to automatically display data relevant to revenue on the Amplitude website, including average revenue per daily active user (ARPDAU), 7, 30, and 90 day revenue, lifetime value (LTV) estimates, and revenue by advertising campaign cohort and daily/weekly/monthly cohorts.
 
 # Opting User Out of Logging #
 
diff --git a/amplitude-snippet.min.js b/amplitude-snippet.min.js
@@ -2,5 +2,5 @@
 n.async=true;n.src="https://d24n15hnbwhuhn.cloudfront.net/libs/amplitude-2.0.4-min.js";
 var s=t.getElementsByTagName("script")[0];s.parentNode.insertBefore(n,s);r._q=[];
 function a(e){r[e]=function(){r._q.push([e].concat(Array.prototype.slice.call(arguments,0)))
-}}var i=["init","logEvent","setUserId","setUserProperties","setOptOut","setVersionName","setDomain","setDeviceId","setGlobalUserProperties"];
+}}var i=["init","logEvent","logRevenue","setUserId","setUserProperties","setOptOut","setVersionName","setDomain","setDeviceId","setGlobalUserProperties"];
 for(var o=0;o<i.length;o++){a(i[o])}e.amplitude=r})(window,document);
diff --git a/amplitude.js b/amplitude.js
@@ -384,7 +384,10 @@ Amplitude.prototype.setVersionName = function(versionName) {
   }
 };
 
-Amplitude.prototype.logEvent = function(eventType, eventProperties) {
+/**
+ * Private logEvent method. Keeps apiProperties from being publicly exposed.
+ */
+Amplitude.prototype._logEvent = function(eventType, eventProperties, apiProperties) {
   if (!eventType || this.options.optOut) {
     return;
   }
@@ -405,6 +408,7 @@ Amplitude.prototype.logEvent = function(eventType, eventProperties) {
     object.merge(userProperties, this.options.userProperties || {});
     object.merge(userProperties, this._utmProperties);
 
+    apiProperties = apiProperties || {};
     eventProperties = eventProperties || {};
     var event = {
       device_id: this.options.deviceId,
@@ -419,6 +423,7 @@ Amplitude.prototype.logEvent = function(eventType, eventProperties) {
       os_version: ua.browser.version,
       device_model: ua.os.family,
       language: this.options.language,
+      api_properties: apiProperties,
       event_properties: eventProperties,
       user_properties: userProperties,
       uuid: UUID(),
@@ -439,6 +444,30 @@ Amplitude.prototype.logEvent = function(eventType, eventProperties) {
   }
 };
 
+Amplitude.prototype.logEvent = function(eventType, eventProperties) {
+  this._logEvent(eventType, eventProperties);
+};
+
+// Test that n is a number or a numeric value.
+var _isNumber = function(n) {
+  return !isNaN(parseFloat(n)) && isFinite(n);
+};
+
+Amplitude.prototype.logRevenue = function(price, quantity, product) {
+  // Test that the parameters are of the right type.
+  if (!_isNumber(price) || quantity !== undefined && !_isNumber(quantity)) {
+    // log('Price and quantity arguments to logRevenue must be numbers');
+    return;
+  }
+
+  this._logEvent('revenue_amount', {}, {
+    productId: product,
+    special: 'revenue_amount',
+    quantity: quantity || 1,
+    price: price
+  });
+};
+
 Amplitude.prototype.sendEvents = function() {
   if (!this._sending && !this.options.optOut) {
     this._sending = true;
diff --git a/amplitude.min.js b/amplitude.min.js
diff --git a/src/amplitude-snippet.js b/src/amplitude-snippet.js
@@ -12,8 +12,8 @@
       amplitude._q.push([fn].concat(Array.prototype.slice.call(arguments, 0)));
     };
   }
-  var funcs = ["init", "logEvent", "setUserId", "setUserProperties", "setOptOut",
-               "setVersionName", "setDomain", "setDeviceId",
+  var funcs = ["init", "logEvent", "logRevenue", "setUserId", "setUserProperties",
+               "setOptOut", "setVersionName", "setDomain", "setDeviceId",
                "setGlobalUserProperties"];
   for (var i = 0; i < funcs.length; i++) {
     proxy(funcs[i]);
diff --git a/src/amplitude.js b/src/amplitude.js
@@ -272,7 +272,10 @@ Amplitude.prototype.setVersionName = function(versionName) {
   }
 };
 
-Amplitude.prototype.logEvent = function(eventType, eventProperties) {
+/**
+ * Private logEvent method. Keeps apiProperties from being publicly exposed.
+ */
+Amplitude.prototype._logEvent = function(eventType, eventProperties, apiProperties) {
   if (!eventType || this.options.optOut) {
     return;
   }
@@ -293,6 +296,7 @@ Amplitude.prototype.logEvent = function(eventType, eventProperties) {
     object.merge(userProperties, this.options.userProperties || {});
     object.merge(userProperties, this._utmProperties);
 
+    apiProperties = apiProperties || {};
     eventProperties = eventProperties || {};
     var event = {
       device_id: this.options.deviceId,
@@ -307,6 +311,7 @@ Amplitude.prototype.logEvent = function(eventType, eventProperties) {
       os_version: ua.browser.version,
       device_model: ua.os.family,
       language: this.options.language,
+      api_properties: apiProperties,
       event_properties: eventProperties,
       user_properties: userProperties,
       uuid: UUID(),
@@ -327,6 +332,30 @@ Amplitude.prototype.logEvent = function(eventType, eventProperties) {
   }
 };
 
+Amplitude.prototype.logEvent = function(eventType, eventProperties) {
+  this._logEvent(eventType, eventProperties);
+};
+
+// Test that n is a number or a numeric value.
+var _isNumber = function(n) {
+  return !isNaN(parseFloat(n)) && isFinite(n);
+};
+
+Amplitude.prototype.logRevenue = function(price, quantity, product) {
+  // Test that the parameters are of the right type.
+  if (!_isNumber(price) || quantity !== undefined && !_isNumber(quantity)) {
+    // log('Price and quantity arguments to logRevenue must be numbers');
+    return;
+  }
+
+  this._logEvent('revenue_amount', {}, {
+    productId: product,
+    special: 'revenue_amount',
+    quantity: quantity || 1,
+    price: price
+  });
+};
+
 Amplitude.prototype.sendEvents = function() {
   if (!this._sending && !this.options.optOut) {
     this._sending = true;
diff --git a/test/amplitude.js b/test/amplitude.js
@@ -341,6 +341,65 @@ describe('Amplitude', function() {
     });
   });
 
+  describe('logRevenue', function() {
+    beforeEach(function() {
+      amplitude.init(apiKey);
+    });
+
+    afterEach(function() {
+      reset();
+    });
+
+    /**
+     * Deep compare an object against the api_properties of the
+     * event queued for sending.
+     */
+    function revenueEqual(api, event) {
+      assert.lengthOf(server.requests, 1);
+      var events = JSON.parse(querystring.parse(server.requests[0].requestBody).e);
+      assert.deepEqual(events[0].api_properties, api || {});
+      assert.deepEqual(events[0].event_properties, event || {});
+    }
+
+    it('should log simple amount', function() {
+      amplitude.logRevenue(10.10);
+      revenueEqual({
+        special: 'revenue_amount',
+        price: 10.10,
+        quantity: 1
+      })
+    });
+
+    it('should log complex amount', function() {
+      amplitude.logRevenue(10.10, 7);
+      revenueEqual({
+        special: 'revenue_amount',
+        price: 10.10,
+        quantity: 7
+      })
+    });
+
+    it('shouldn\'t log invalid price', function() {
+      amplitude.logRevenue('kitten', 7);
+      assert.lengthOf(server.requests, 0);
+    });
+
+    it('shouldn\'t log invalid quantity', function() {
+      amplitude.logRevenue(10.00, 'puppy');
+      assert.lengthOf(server.requests, 0);
+    });
+
+    it('should log complex amount with product id', function() {
+      amplitude.logRevenue(10.10, 7, 'chicken.dinner');
+      revenueEqual({
+        special: 'revenue_amount',
+        price: 10.10,
+        quantity: 7,
+        productId: 'chicken.dinner'
+      });
+    });
+  });
+
   describe('sessionId', function() {
 
     var clock;
diff --git a/test/browser/amplitudejs.html b/test/browser/amplitudejs.html
@@ -16,7 +16,7 @@
             };
         }
 
-        var funcs = ["init", "logEvent", "setUserId", "setUserProperties", "setOptOut", "setVersionName", "setDomain", "setGlobalUserProperties"];
+        var funcs = ["init", "logEvent", "logRevenue", "setUserId", "setUserProperties", "setOptOut", "setVersionName", "setDomain", "setGlobalUserProperties"];
         for (var i = 0; i < funcs.length; i++) {
             proxy(funcs[i]);
         }

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`};`
`17`	`17`	`}`
`18`	`18`
`19`		`- var funcs = ["init", "logEvent", "setUserId", "setUserProperties", "setOptOut", "setVersionName", "setDomain", "setGlobalUserProperties"];`
	`19`	`+ var funcs = ["init", "logEvent", "logRevenue", "setUserId", "setUserProperties", "setOptOut", "setVersionName", "setDomain", "setGlobalUserProperties"];`
`20`	`20`	`for (var i = 0; i < funcs.length; i++) {`
`21`	`21`	`proxy(funcs[i]);`
`22`	`22`	`}`