rename setRevenueProperties to setEventProperties

Author: djih

README.md

@@ -17,7 +17,7 @@ This Readme will guide you through using Amplitude's Javascript SDK to track use
           s.parentNode.insertBefore(r,s);function i(e,t){e.prototype[t]=function(){this._q.push([t].concat(Array.prototype.slice.call(arguments,0)));
           return this}}var o=function(){this._q=[];return this};var a=["add","append","clearAll","prepend","set","setOnce","unset"];
           for(var u=0;u<a.length;u++){i(o,a[u])}n.Identify=o;var c=function(){this._q=[];return this;
-          };var p=["setProductId","setQuantity","setPrice","setRevenueType","setRevenueProperties"];
+          };var p=["setProductId","setQuantity","setPrice","setRevenueType","setEventProperties"];
           for(var l=0;l<p.length;l++){i(c,p[l])}n.Revenue=c;var d=["init","logEvent","logRevenue","setUserId","setUserProperties","setOptOut","setVersionName","setDomain","setDeviceId","setGlobalUserProperties","identify","clearUserProperties","logRevenueV2"];
           function v(e){function t(t){e[t]=function(){e._q.push([t].concat(Array.prototype.slice.call(arguments,0)));
           }}for(var n=0;n<d.length;n++){t(d[n])}}v(n);e.amplitude=n})(window,document);
@@ -185,7 +185,7 @@ amplitude.clearUserProperties();
 
 # Tracking Revenue #
 
-The preferred method of tracking revenue for a user now is to use `logRevenueV2()` in conjunction with the provided `Revenue` interface. `Revenue` instances will store each revenue transaction and allow you to define several special revenue properties (such as revenueType, productId, etc) that are used in Amplitude dashboard's Revenue tab. You can now also add event properties to the revenue event, via the revenueProperties field. These `Revenue` instance objects are then passed into `logRevenueV2` to send as revenue events to Amplitude servers. This allows us to automatically display data relevant to revenue on the Amplitude website, including average revenue per daily active user (ARPDAU), 1, 7, 14, 30, 60, and 90 day revenue, lifetime value (LTV) estimates, and revenue by advertising campaign cohort and daily/weekly/monthly cohorts.
+The preferred method of tracking revenue for a user now is to use `logRevenueV2()` in conjunction with the provided `Revenue` interface. `Revenue` instances will store each revenue transaction and allow you to define several special revenue properties (such as revenueType, productId, etc) that are used in Amplitude dashboard's Revenue tab. You can now also add event properties to the revenue event, via the eventProperties field. These `Revenue` instance objects are then passed into `logRevenueV2` to send as revenue events to Amplitude servers. This allows us to automatically display data relevant to revenue on the Amplitude website, including average revenue per daily active user (ARPDAU), 1, 7, 14, 30, 60, and 90 day revenue, lifetime value (LTV) estimates, and revenue by advertising campaign cohort and daily/weekly/monthly cohorts.
 
 Each time a user generates revenue, you create a `Revenue` object and fill out the revenue properties:
 ```javascript
@@ -201,9 +201,9 @@ amplitude.logRevenueV2(revenue);
 | 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    |
+| eventProperties    | 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.
+Note: the price can be negative, which might be useful for tracking revenue lost, for example refunds or costs. Also note, you can set event properties on the revenue event just as you would with logEvent by passing in a object of string key value pairs. These event properties, however, will only appear in the Event Segmentation tab, not in the Revenue tab.
 
 ### Backwards compatibility ###
 

amplitude-segment-snippet.min.js

@@ -2,7 +2,7 @@
 this._q.push([t].concat(Array.prototype.slice.call(arguments,0)));return this}}var s=function(){
 this._q=[];return this};var i=["add","append","clearAll","prepend","set","setOnce","unset"];
 for(var o=0;o<i.length;o++){n(s,i[o])}r.Identify=s;var a=function(){this._q=[];return this;
-};var u=["setProductId","setQuantity","setPrice","setRevenueType","setRevenueProperties"];
+};var u=["setProductId","setQuantity","setPrice","setRevenueType","setEventProperties"];
 for(var c=0;c<u.length;c++){n(a,u[c])}r.Revenue=a;var l=["init","logEvent","logRevenue","setUserId","setUserProperties","setOptOut","setVersionName","setDomain","setDeviceId","setGlobalUserProperties","identify","clearUserProperties","logRevenueV2"];
 function p(e){function t(t){e[t]=function(){e._q.push([t].concat(Array.prototype.slice.call(arguments,0)));
 }}for(var r=0;r<l.length;r++){t(l[r])}}p(r);e.amplitude=r})(window,document);

amplitude-snippet.min.js

@@ -4,7 +4,7 @@ r.onload=function(){e.amplitude.runQueuedFunctions()};var s=t.getElementsByTagNa
 s.parentNode.insertBefore(r,s);function i(e,t){e.prototype[t]=function(){this._q.push([t].concat(Array.prototype.slice.call(arguments,0)));
 return this}}var o=function(){this._q=[];return this};var a=["add","append","clearAll","prepend","set","setOnce","unset"];
 for(var u=0;u<a.length;u++){i(o,a[u])}n.Identify=o;var c=function(){this._q=[];return this;
-};var p=["setProductId","setQuantity","setPrice","setRevenueType","setRevenueProperties"];
+};var p=["setProductId","setQuantity","setPrice","setRevenueType","setEventProperties"];
 for(var l=0;l<p.length;l++){i(c,p[l])}n.Revenue=c;var d=["init","logEvent","logRevenue","setUserId","setUserProperties","setOptOut","setVersionName","setDomain","setDeviceId","setGlobalUserProperties","identify","clearUserProperties","logRevenueV2"];
 function v(e){function t(t){e[t]=function(){e._q.push([t].concat(Array.prototype.slice.call(arguments,0)));
 }}for(var n=0;n<d.length;n++){t(d[n])}}v(n);e.amplitude=n})(window,document);

amplitude.js

@@ -3380,17 +3380,17 @@ Revenue.prototype.setRevenueType = function setRevenueType(revenueType) {
 /**
  * Set event properties for the revenue event.
  * @public
- * @param {object} properties - Revenue event properties to set.
+ * @param {object} eventProperties - Revenue event properties to set.
  * @return {Revenue} Returns the same Revenue object, allowing you to chain multiple method calls together.
  * @example var event_properties = {'city': 'San Francisco'};
- * var revenue = new amplitude.Revenue().setProductId('productIdentifier').setPrice(10.99).setRevenueProperties(event_properties);
+ * var revenue = new amplitude.Revenue().setProductId('productIdentifier').setPrice(10.99).setEventProperties(event_properties);
  * amplitude.logRevenueV2(revenue);
 */
-Revenue.prototype.setRevenueProperties = function setRevenueProperties(revenueProperties) {
-  if (type(revenueProperties) !== 'object') {
-    utils.log('Unsupported type for revenueProperties: ' + type(revenueProperties) + ', expecting object');
+Revenue.prototype.setEventProperties = function setEventProperties(eventProperties) {
+  if (type(eventProperties) !== 'object') {
+    utils.log('Unsupported type for eventProperties: ' + type(eventProperties) + ', expecting object');
   } else {
-    this._properties = utils.validateProperties(revenueProperties);
+    this._properties = utils.validateProperties(eventProperties);
   }
   return this;
 };

amplitude.min.js

@@ -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 Tue Apr 19 2016 17:19:27 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Wed Apr 20 2016 00:37:56 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

documentation/Amplitude.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 Tue Apr 19 2016 17:19:27 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Wed Apr 20 2016 00:37:56 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

documentation/Identify.html

@@ -151,15 +151,14 @@ <h3 class="subsection-title">Methods</h3>
 
 
 
-    <h4 class="name" id="setPrice"><span class="type-signature"></span>setPrice<span class="signature">(price)</span><span class="type-signature"> &rarr; {<a href="Revenue.html">Revenue</a>}</span></h4>
+    <h4 class="name" id="setEventProperties"><span class="type-signature"></span>setEventProperties<span class="signature">(eventProperties)</span><span class="type-signature"> &rarr; {<a href="Revenue.html">Revenue</a>}</span></h4>
 
 
 
 
 
 <div class="description">
-    Set a value for the price. This field is required for all revenue being logged.
-Note revenue amount is calculated as price * quantity.
+    Set event properties for the revenue event.
 </div>
 
 
@@ -195,13 +194,13 @@ <h5>Parameters:</h5>
 
         <tr>
 
-                <td class="name"><code>price</code></td>
+                <td class="name"><code>eventProperties</code></td>
 
 
             <td class="type">
 
 
-<span class="param-type">number</span>
+<span class="param-type">object</span>
 
 
 
@@ -211,7 +210,7 @@ <h5>Parameters:</h5>
 
 
 
-            <td class="description last">Double value for the quantity.</td>
+            <td class="description last">Revenue event properties to set.</td>
         </tr>
 
 
@@ -252,7 +251,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="revenue.js.html">revenue.js</a>, <a href="revenue.js.html#line78">line 78</a>
+        <a href="revenue.js.html">revenue.js</a>, <a href="revenue.js.html#line113">line 113</a>
     </li></ul></dd>
 
 
@@ -301,7 +300,8 @@ <h5>Returns:</h5>
 
     <h5>Example</h5>
 
-    <pre class="prettyprint"><code>var revenue = new amplitude.Revenue().setProductId('productIdentifier').setPrice(10.99);
+    <pre class="prettyprint"><code>var event_properties = {'city': 'San Francisco'};
+var revenue = new amplitude.Revenue().setProductId('productIdentifier').setPrice(10.99).setEventProperties(event_properties);
 amplitude.logRevenueV2(revenue);</code></pre>
 
 
@@ -311,14 +311,15 @@ <h5>Example</h5>
 
 
 
-    <h4 class="name" id="setProductId"><span class="type-signature"></span>setProductId<span class="signature">(productId)</span><span class="type-signature"> &rarr; {<a href="Revenue.html">Revenue</a>}</span></h4>
+    <h4 class="name" id="setPrice"><span class="type-signature"></span>setPrice<span class="signature">(price)</span><span class="type-signature"> &rarr; {<a href="Revenue.html">Revenue</a>}</span></h4>
 
 
 
 
 
 <div class="description">
-    Set a value for the product identifer. This field is required for all revenue being logged.
+    Set a value for the price. This field is required for all revenue being logged.
+Note revenue amount is calculated as price * quantity.
 </div>
 
 
@@ -354,13 +355,13 @@ <h5>Parameters:</h5>
 
         <tr>
 
-                <td class="name"><code>productId</code></td>
+                <td class="name"><code>price</code></td>
 
 
             <td class="type">
 
 
-<span class="param-type">string</span>
+<span class="param-type">number</span>
 
 
 
@@ -370,7 +371,7 @@ <h5>Parameters:</h5>
 
 
 
-            <td class="description last">The value for the product identifier. Empty and invalid strings are ignored.</td>
+            <td class="description last">Double value for the quantity.</td>
         </tr>
 
 
@@ -411,7 +412,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="revenue.js.html">revenue.js</a>, <a href="revenue.js.html#line41">line 41</a>
+        <a href="revenue.js.html">revenue.js</a>, <a href="revenue.js.html#line78">line 78</a>
     </li></ul></dd>
 
 
@@ -470,14 +471,14 @@ <h5>Example</h5>
 
 
 
-    <h4 class="name" id="setQuantity"><span class="type-signature"></span>setQuantity<span class="signature">(quantity)</span><span class="type-signature"> &rarr; {<a href="Revenue.html">Revenue</a>}</span></h4>
+    <h4 class="name" id="setProductId"><span class="type-signature"></span>setProductId<span class="signature">(productId)</span><span class="type-signature"> &rarr; {<a href="Revenue.html">Revenue</a>}</span></h4>
 
 
 
 
 
 <div class="description">
-    Set a value for the quantity. Note revenue amount is calculated as price * quantity.
+    Set a value for the product identifer. This field is required for all revenue being logged.
 </div>
 
 
@@ -513,13 +514,13 @@ <h5>Parameters:</h5>
 
         <tr>
 
-                <td class="name"><code>quantity</code></td>
+                <td class="name"><code>productId</code></td>
 
 
             <td class="type">
 
 
-<span class="param-type">number</span>
+<span class="param-type">string</span>
 
 
 
@@ -529,7 +530,7 @@ <h5>Parameters:</h5>
 
 
 
-            <td class="description last">Integer value for the quantity. If not set, quantity defaults to 1.</td>
+            <td class="description last">The value for the product identifier. Empty and invalid strings are ignored.</td>
         </tr>
 
 
@@ -570,7 +571,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="revenue.js.html">revenue.js</a>, <a href="revenue.js.html#line60">line 60</a>
+        <a href="revenue.js.html">revenue.js</a>, <a href="revenue.js.html#line41">line 41</a>
     </li></ul></dd>
 
 
@@ -619,7 +620,7 @@ <h5>Returns:</h5>
 
     <h5>Example</h5>
 
-    <pre class="prettyprint"><code>var revenue = new amplitude.Revenue().setProductId('productIdentifier').setPrice(10.99).setQuantity(5);
+    <pre class="prettyprint"><code>var revenue = new amplitude.Revenue().setProductId('productIdentifier').setPrice(10.99);
 amplitude.logRevenueV2(revenue);</code></pre>
 
 
@@ -629,14 +630,14 @@ <h5>Example</h5>
 
 
 
-    <h4 class="name" id="setRevenueProperties"><span class="type-signature"></span>setRevenueProperties<span class="signature">(properties)</span><span class="type-signature"> &rarr; {<a href="Revenue.html">Revenue</a>}</span></h4>
+    <h4 class="name" id="setQuantity"><span class="type-signature"></span>setQuantity<span class="signature">(quantity)</span><span class="type-signature"> &rarr; {<a href="Revenue.html">Revenue</a>}</span></h4>
 
 
 
 
 
 <div class="description">
-    Set event properties for the revenue event.
+    Set a value for the quantity. Note revenue amount is calculated as price * quantity.
 </div>
 
 
@@ -672,13 +673,13 @@ <h5>Parameters:</h5>
 
         <tr>
 
-                <td class="name"><code>properties</code></td>
+                <td class="name"><code>quantity</code></td>
 
 
             <td class="type">
 
 
-<span class="param-type">object</span>
+<span class="param-type">number</span>
 
 
 
@@ -688,7 +689,7 @@ <h5>Parameters:</h5>
 
 
 
-            <td class="description last">Revenue event properties to set.</td>
+            <td class="description last">Integer value for the quantity. If not set, quantity defaults to 1.</td>
         </tr>
 
 
@@ -729,7 +730,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="revenue.js.html">revenue.js</a>, <a href="revenue.js.html#line113">line 113</a>
+        <a href="revenue.js.html">revenue.js</a>, <a href="revenue.js.html#line60">line 60</a>
     </li></ul></dd>
 
 
@@ -778,8 +779,7 @@ <h5>Returns:</h5>
 
     <h5>Example</h5>
 
-    <pre class="prettyprint"><code>var event_properties = {'city': 'San Francisco'};
-var revenue = new amplitude.Revenue().setProductId('productIdentifier').setPrice(10.99).setRevenueProperties(event_properties);
+    <pre class="prettyprint"><code>var revenue = new amplitude.Revenue().setProductId('productIdentifier').setPrice(10.99).setQuantity(5);
 amplitude.logRevenueV2(revenue);</code></pre>
 
 
@@ -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 Tue Apr 19 2016 17:19:27 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Wed Apr 20 2016 00:37:56 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

documentation/Revenue.html

@@ -1093,7 +1093,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 Tue Apr 19 2016 17:19:27 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Wed Apr 20 2016 00:37:56 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

documentation/amplitude.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 Tue Apr 19 2016 17:19:27 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Wed Apr 20 2016 00:37:56 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>