Add analyticsTags to trackConversion (#454)

Author: esezen

spec/src/modules/tracker.js

@@ -4082,6 +4082,34 @@ describe(`ConstructorIO - Tracker${bundledDescriptionSuffix}`, () => {
 
       expect(tracker.trackConversion(term, requiredParameters)).to.equal(true);
     });
+
+    it('Should respond with a valid response when analyticsTags are provided', (done) => {
+      const { tracker } = new ConstructorIO({
+        apiKey: testApiKey,
+        fetch: fetchSpy,
+        ...requestQueueOptions,
+      });
+      const parametersWithAnalyticsTags = {
+        ...requiredParameters,
+        analyticsTags: testAnalyticsTag,
+      };
+
+      tracker.on('success', (responseParams) => {
+        const requestParams = helpers.extractBodyParamsFromFetch(fetchSpy);
+
+        // Request
+        expect(fetchSpy).to.have.been.called;
+        expect(requestParams).to.have.property('analytics_tags').to.deep.equal(testAnalyticsTag);
+
+        // Response
+        expect(responseParams).to.have.property('method').to.equal('POST');
+        expect(responseParams).to.have.property('message').to.equal('ok');
+
+        done();
+      });
+
+      expect(tracker.trackConversion(term, parametersWithAnalyticsTags)).to.equal(true);
+    });
   });
 
   describe('trackPurchase', () => {

src/modules/tracker.js

@@ -1028,6 +1028,7 @@ class Tracker {
    * @param {boolean} [parameters.isCustomType] - Specify if type is custom conversion type
    * @param {string} [parameters.displayName] - Display name for the custom conversion type
    * @param {string} [parameters.section="Products"] - Index section
+   * @param {object} [parameters.analyticsTags] - Pass additional analytics data
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {(true|Error)}
@@ -1070,6 +1071,7 @@ class Tracker {
         type,
         is_custom_type,
         isCustomType = is_custom_type,
+        analyticsTags,
       } = parameters;
 
       // Ensure support for both item_id and customer_id as parameters
@@ -1111,6 +1113,10 @@ class Tracker {
         bodyParams.display_name = displayName;
       }
 
+      if (analyticsTags) {
+        bodyParams.analytics_tags = analyticsTags;
+      }
+
       const requestURL = `${requestPath}${applyParamsAsString(queryParams, this.options)}`;
       const requestMethod = 'POST';
       const requestBody = applyParams(bodyParams, { ...this.options, requestMethod });

src/types/tracker.d.ts

@@ -119,6 +119,7 @@ declare class Tracker {
       displayName?: string;
       resultId?: string;
       section?: string;
+      analyticsTags?: Record<string, string>;
     },
     networkParameters?: NetworkParameters
   ): true | Error;