update readme, only add properties to object if value is not null

djih · djih · commit 9da80e3fa75f · 2016-04-19T16:39:38.000-07:00
diff --git a/README.md b/README.md
@@ -193,33 +193,18 @@ var revenue = new amplitude.Revenue().setProductId('com.company.productId').setP
 amplitude.logRevenueV2(revenue);
 ```
 
-`productId`, `price`, and `quantity` are required fields. Each field has a corresponding `set` method (for example `setProductId`, `setQuantity`, etc), as well as a corresponding event property key (see below for how to send revenue properties in event properties). This table describes the different fields available:
+`productId` and `price` are required fields. `quantity` defaults to 1 if not specified. Each field has a corresponding `set` method (for example `setProductId`, `setQuantity`, etc). This table describes the different fields available:
 
-| Name               | Type       | Description                                                                                              | default | property key |
-|--------------------|------------|----------------------------------------------------------------------------------------------------------|---------|--------------|
-| productId          | String     | Required: an identifier for the product (we recommend something like the Google Play Store product Id)   | null    | $productId   |
-| quantity           | Integer    | Required: the quantity of products purchased. Defaults to 1 if not specified. Revenue = quantity * price | 1       | $quantity    |
-| price              | Double     | Required: the price of the products purchased (can be negative). Revenue = quantity * price              | null    | $price       |
-| revenueType        | String     | Optional: the type of revenue (ex: tax, refund, income)                                                  | null    | $revenueType |
-| revenueProperties  | Object     | Optional: an object of event properties to include in the revenue event                                  | null    | n/a          |
+| Name               | Type       | Description                                                                                              | default |
+|--------------------|------------|----------------------------------------------------------------------------------------------------------|---------|
+| productId          | String     | Required: an identifier for the product (we recommend something like the Google Play Store product Id)   | null    |
+| quantity           | Integer    | Required: the quantity of products purchased. Defaults to 1 if not specified. Revenue = quantity * price | 1       |
+| price              | Double     | Required: the price of the products purchased (can be negative). Revenue = quantity * price              | null    |
+| revenueType        | String     | Optional: the type of revenue (ex: tax, refund, income)                                                  | null    |
+| revenueProperties  | Object     | Optional: an object of event properties to include in the revenue event                                  | null    |
 
 Note: the price can be negative, which might be useful for tracking revenue lost, for example refunds or costs.
 
-### Sending Revenue as Event Properties ###
-
-Instead of sending revenue through Amplitude's special revenue event, you can send revenue properties as event properties on any event you log. The `property key` column in the above table denotes the string key to use when declaring the event property. Note: you still need to set a productId and a price. If quantity is not set, it is assumed to be 1:
-
-```java
-var properties = {
-  'description': 'some event description',
-  'color': 'green',
-  '$productId': 'productIdentifier',
-  '$price': 10.99,
-  '$quantity': 2
-};
-amplitude.logEvent('Completed purchase', properties);
-```
-
 ### Backwards compatibility ###
 
 The existing `logRevenue` methods still work but are deprecated. Fields such as `revenueType` will be missing from events logged with the old methods, so Revenue segmentation on those events will be limited in Amplitude dashboards.
diff --git a/amplitude.js b/amplitude.js
@@ -3414,10 +3414,19 @@ Revenue.prototype._isValidRevenue = function _isValidRevenue() {
  */
 Revenue.prototype._toJSONObject = function _toJSONObject() {
   var obj = type(this._properties) === 'object' ? this._properties : {};
-  obj[constants.REVENUE_PRODUCT_ID] = this._productId;
-  obj[constants.REVENUE_QUANTITY] = this._quantity;
-  obj[constants.REVENUE_PRICE] = this._price;
-  obj[constants.REVENUE_REVENUE_TYPE] = this._revenueType;
+
+  if (this._productId !== null) {
+    obj[constants.REVENUE_PRODUCT_ID] = this._productId;
+  }
+  if (this._quantity !== null) {
+    obj[constants.REVENUE_QUANTITY] = this._quantity;
+  }
+  if (this._price !== null) {
+    obj[constants.REVENUE_PRICE] = this._price;
+  }
+  if (this._revenueType !== null) {
+    obj[constants.REVENUE_REVENUE_TYPE] = this._revenueType;
+  }
   return obj;
 };
 
diff --git a/amplitude.min.js b/amplitude.min.js
diff --git a/documentation/Amplitude.html b/documentation/Amplitude.html
@@ -2483,7 +2483,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Apr 18 2016 22:40:49 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Apr 19 2016 16:37:04 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/documentation/Identify.html b/documentation/Identify.html
@@ -1295,7 +1295,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Apr 18 2016 22:40:49 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Apr 19 2016 16:37:04 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/documentation/Revenue.html b/documentation/Revenue.html
@@ -965,7 +965,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Apr 18 2016 22:40:49 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Apr 19 2016 16:37:04 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/documentation/amplitude.js.html b/documentation/amplitude.js.html
@@ -1092,7 +1092,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Apr 18 2016 22:40:49 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Apr 19 2016 16:37:04 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/documentation/identify.js.html b/documentation/identify.js.html
@@ -226,7 +226,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Apr 18 2016 22:40:49 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Apr 19 2016 16:37:04 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/documentation/index.html b/documentation/index.html
@@ -56,7 +56,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Apr 18 2016 22:40:49 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Apr 19 2016 16:37:04 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/documentation/revenue.js.html b/documentation/revenue.js.html
@@ -167,10 +167,19 @@ <h1 class="page-title">Source: revenue.js</h1>
  */
 Revenue.prototype._toJSONObject = function _toJSONObject() {
   var obj = type(this._properties) === 'object' ? this._properties : {};
-  obj[constants.REVENUE_PRODUCT_ID] = this._productId;
-  obj[constants.REVENUE_QUANTITY] = this._quantity;
-  obj[constants.REVENUE_PRICE] = this._price;
-  obj[constants.REVENUE_REVENUE_TYPE] = this._revenueType;
+
+  if (this._productId !== null) {
+    obj[constants.REVENUE_PRODUCT_ID] = this._productId;
+  }
+  if (this._quantity !== null) {
+    obj[constants.REVENUE_QUANTITY] = this._quantity;
+  }
+  if (this._price !== null) {
+    obj[constants.REVENUE_PRICE] = this._price;
+  }
+  if (this._revenueType !== null) {
+    obj[constants.REVENUE_REVENUE_TYPE] = this._revenueType;
+  }
   return obj;
 };
 
@@ -191,7 +200,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Apr 18 2016 22:40:49 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Apr 19 2016 16:37:04 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/src/revenue.js b/src/revenue.js
@@ -139,10 +139,19 @@ Revenue.prototype._isValidRevenue = function _isValidRevenue() {
  */
 Revenue.prototype._toJSONObject = function _toJSONObject() {
   var obj = type(this._properties) === 'object' ? this._properties : {};
-  obj[constants.REVENUE_PRODUCT_ID] = this._productId;
-  obj[constants.REVENUE_QUANTITY] = this._quantity;
-  obj[constants.REVENUE_PRICE] = this._price;
-  obj[constants.REVENUE_REVENUE_TYPE] = this._revenueType;
+
+  if (this._productId !== null) {
+    obj[constants.REVENUE_PRODUCT_ID] = this._productId;
+  }
+  if (this._quantity !== null) {
+    obj[constants.REVENUE_QUANTITY] = this._quantity;
+  }
+  if (this._price !== null) {
+    obj[constants.REVENUE_PRICE] = this._price;
+  }
+  if (this._revenueType !== null) {
+    obj[constants.REVENUE_REVENUE_TYPE] = this._revenueType;
+  }
   return obj;
 };
 
diff --git a/test/browser/amplitudejs.html b/test/browser/amplitudejs.html
@@ -68,6 +68,10 @@
     var logRevenue = function() {
         amplitude.logRevenue(9.99, 1, 'productA');
     }
+    var logRevenueV2 = function() {
+        var revenue = new amplitude.Revenue().setProductId('other.productId').setQuantity(15).setPrice(145.99);
+        amplitude.logRevenueV2(revenue);
+    }
 </script>
 <script>
     amplitude.init('a2dbce0e18dfe5f8e74493843ff5c053', null, {includeReferrer: true}, function() {
@@ -97,6 +101,7 @@ <h3>Amplitude JS Test</h3>
     <li><a href="javascript:setOncePhotoCount();">Set photo count once</a></li>
     <li><a href="javascript:setCity();">Set city via setUserProperties</a></li>
     <li><a href="javascript:amplitude.clearUserProperties();">Clear all user properties</a></li>
+    <li><a href="javascript:logRevenueV2();">LogRevenueV2</a></li>
     <br><br>
     <li><a href="/test/browser/amplitudejs2.html">Go to second page</a></li>
 </body>
