Release 2.3.0

*Update value for Product Added and Product Viewed to take either properties.value or properties.price

Author: amnoonan

HISTORY.md

@@ -1,3 +1,7 @@
+2.3.0 / 2016-11-15
+==================
+
+  * Update value for Product Added and Product Viewed to take either properties.value or properties.price
 
 2.2.1 / 2016-09-13
 ==================

lib/index.js

@@ -19,6 +19,7 @@ var FacebookPixel = module.exports = integration('Facebook Pixel')
   .global('fbq')
   .option('pixelId', '')
   .option('agent', 'seg')
+  .option('valueIdentifier', 'value')
   .option('initWithExistingTraits', false)
   .mapping('standardEvents')
   .mapping('legacyEvents')
@@ -159,7 +160,7 @@ FacebookPixel.prototype.productViewed = function(track) {
     content_name: track.name() || '',
     content_category: track.category() || '',
     currency: track.currency(),
-    value: formatRevenue(track.price())
+    value: this.options.valueIdentifier === 'value' ? formatRevenue(track.value()) : formatRevenue(track.price())
   });
 
   // fall through for mapped legacy conversions
@@ -185,7 +186,7 @@ FacebookPixel.prototype.productAdded = function(track) {
     content_name: track.name() || '',
     content_category: track.category() || '',
     currency: track.currency(),
-    value: formatRevenue(track.price())
+    value: this.options.valueIdentifier === 'value' ? formatRevenue(track.value()) : formatRevenue(track.price())
   });
 
   // fall through for mapped legacy conversions

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@segment/analytics.js-integration-facebook-pixel",
   "description": "The Facebook Pixel analytics.js integration.",
-  "version": "2.2.1",
+  "version": "2.3.0",
   "keywords": [
     "analytics.js",
     "analytics.js-integration",

test/index.test.js

@@ -232,10 +232,11 @@ describe('Facebook Pixel', function() {
             product_id: '507f1f77bcf86cd799439011',
             currency: 'USD',
             quantity: 1,
-            price: 24.75,
+            price: 44.33,
             name: 'my product',
             category: 'cat 1',
-            sku: 'p-298'
+            sku: 'p-298',
+            value: 24.75
           });
           analytics.called(window.fbq, 'track', 'ViewContent', {
             content_ids: ['507f1f77bcf86cd799439011'],
@@ -247,15 +248,38 @@ describe('Facebook Pixel', function() {
           });
         });
 
+        it('Should map properties.price to facebooks value if price is selected', function() {
+          facebookPixel.options.valueIdentifier = 'price';
+          analytics.track('Product Viewed', {
+            product_id: '507f1f77bcf86cd799439011',
+            currency: 'USD',
+            quantity: 1,
+            price: 44.33,
+            name: 'my product',
+            category: 'cat 1',
+            sku: 'p-298',
+            value: 24.75
+          });
+          analytics.called(window.fbq, 'track', 'ViewContent', {
+            content_ids: ['507f1f77bcf86cd799439011'],
+            content_type: 'product',
+            content_name: 'my product',
+            content_category: 'cat 1',
+            currency: 'USD',
+            value: '44.33'
+          });
+        });
+
         it('Adding to Cart', function() {
           analytics.track('Product Added', {
             product_id: '507f1f77bcf86cd799439011',
             currency: 'USD',
             quantity: 1,
-            price: 24.75,
+            price: 44.33,
             name: 'my product',
             category: 'cat 1',
-            sku: 'p-298'
+            sku: 'p-298',
+            value: 24.75
           });
           analytics.called(window.fbq, 'track', 'AddToCart', {
             content_ids: ['507f1f77bcf86cd799439011'],
@@ -267,6 +291,28 @@ describe('Facebook Pixel', function() {
           });
         });
 
+        it('Should map properties.price to facebooks value if price is selected', function() {
+          facebookPixel.options.valueIdentifier = 'price';
+          analytics.track('Product Added', {
+            product_id: '507f1f77bcf86cd799439011',
+            currency: 'USD',
+            quantity: 1,
+            price: 44.33,
+            name: 'my product',
+            category: 'cat 1',
+            sku: 'p-298',
+            value: 24.75
+          });
+          analytics.called(window.fbq, 'track', 'AddToCart', {
+            content_ids: ['507f1f77bcf86cd799439011'],
+            content_type: 'product',
+            content_name: 'my product',
+            content_category: 'cat 1',
+            currency: 'USD',
+            value: '44.33'
+          });
+        });
+
         it('Completing an Order', function() {
           analytics.track('Order Completed', {
             products: [