add tracking options to api_properties

Author: djih

src/amplitude-client.js

@@ -896,7 +896,9 @@ AmplitudeClient.prototype._logEvent = function _logEvent(eventType, eventPropert
     _saveCookieData(this);
 
     userProperties = userProperties || {};
-    apiProperties = merge(apiProperties || {});
+    var trackingOptions = _generateApiPropertiesTrackingConfig(this);
+    trackingOptions = Object.keys(trackingOptions).length > 0 ? {trackingOptions: trackingOptions} : {};
+    apiProperties = merge(trackingOptions, (apiProperties || {}));
     eventProperties = eventProperties || {};
     groups = groups || {};
     var event = {
@@ -951,6 +953,19 @@ var _shouldTrackField = function _shouldTrackField(scope, field) {
   return !!scope.options.trackingOptions[field];
 };
 
+var _generateApiPropertiesTrackingConfig = function _generateApiPropertiesTrackingConfig(scope) {
+  // to limit size of config payload, only send fields that have been disabled
+  var fields = ['city', 'country', 'dma', 'ip_address', 'region'];
+  var config = {};
+  for (var i = 0; i < fields.length; i++) {
+    var field = fields[i];
+    if (!_shouldTrackField(scope, field)) {
+      config[field] = false;
+    }
+  }
+  return config;
+};
+
 /**
  * Remove old events from the beginning of the array if too many have accumulated. Default limit is 1000 events.
  * @private

src/options.js

@@ -24,6 +24,7 @@ export default {
   sessionTimeout: 30 * 60 * 1000,
   trackingOptions: {
     city: true,
+    country: true,
     device_model: true,
     dma: true,
     ip_address: true,

test/amplitude-client.js

@@ -724,6 +724,7 @@ it ('should load saved events from localStorage new keys and send events', funct
       // check config loaded correctly
       assert.deepEqual(amplitude2.options.trackingOptions, {
         city: false,
+        country: true,
         device_model: true,
         dma: true,
         ip_address: false,
@@ -1150,6 +1151,7 @@ describe('setVersionName', function() {
       clock = sinon.useFakeTimers();
       var trackingOptions = {
         city: false,
+        country: true,
         ip_address: false,
         language: false,
         platform: false,
@@ -1165,12 +1167,27 @@ describe('setVersionName', function() {
 
     it('should not track language or platform', function() {
       assert.equal(amplitude.options.trackingOptions.language, false);
+      assert.equal(amplitude.options.trackingOptions.platform, false);
       amplitude.logEvent('Event Type 1');
       assert.lengthOf(server.requests, 1);
       var events = JSON.parse(querystring.parse(server.requests[0].requestBody).e);
       assert.equal(events[0].language, null);
       assert.equal(events[0].platform, null);
     });
+
+    it('should send trackingOptions in api properties', function() {
+      amplitude.logEvent('Event Type 2');
+      assert.lengthOf(server.requests, 1);
+      var events = JSON.parse(querystring.parse(server.requests[0].requestBody).e);
+
+      // verify country is not sent since it matches the default value of true
+      assert.deepEqual(events[0].api_properties, {
+        trackingOptions: {
+          city: false,
+          ip_address: false,
+        }
+      });
+    });
   });
 
   describe('logEvent', function() {
@@ -1247,6 +1264,14 @@ describe('setVersionName', function() {
       assert.isNotNull(events[0].language);
     });
 
+    it('should not send trackingOptions in api properties', function() {
+      amplitude.logEvent('Event Should Not Send Tracking Properties');
+      assert.lengthOf(server.requests, 1);
+      var events = JSON.parse(querystring.parse(server.requests[0].requestBody).e);
+      assert.equal(events.length, 1);
+      assert.deepEqual(events[0].api_properties, {});
+    });
+
     it('should send platform', function() {
       amplitude.logEvent('Event Should Send Platform');
       assert.lengthOf(server.requests, 1);