@mhubcloud/tms_core 1.5.0 → 1.6.0

package/index.js

@@ -1,11 +1,14 @@
 const utils = require('./lib/utils');
 const DefaultPublisher = require('./lib/DefaultPublisher');
-const  Piano = require('./publishers/Piano');
 
 module.exports = {
     utils : utils,
     DefaultPublisher : DefaultPublisher,
     publisher : {
-        Piano : Piano
+        Piano : require('./publishers/Piano'),
+        Facebook : require('./publishers/Facebook'),
+        GoogleAnalytics4 : require('./publishers/GoogleAnalytics4'),
+        CJ : require('./publishers/CJ'),
+        UniversalAnalytics : require('./publishers/UniversalAnalytics')
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mhubcloud/tms_core",
-    "version": "1.5.0",
+    "version": "1.6.0",
     "description": "Core function for mHub Cloud TMS publishers",
     "homepage": "https://mhubcloud.com/",
     "license": "Apache 2.0",

package/publishers/CJ.js

@@ -0,0 +1,66 @@
+const fetch = require('node-fetch');
+const utils = require("../lib/utils");
+const SOURCE = "f_CJAffiliate";
+
+module.exports = {
+    /**
+     * Processed data comming from EventHub to data for further processing
+     * @param {Object} data The data comming from EventHub
+     * @returns {Object} Data for further processing
+     */
+    parse: function parse(data, context) {
+        //ConsumerBase.cs:ConsumeOneEventAsync
+        data.enqueuedAt = context.test ? 1600000000000 : Date.now();
+        return data;
+    },
+
+    /**
+     * Publishes data to Facebook
+     * @param {{cid: string|number, type: string|number}} config Publisher configuration
+     * @param {Object} data Data in publisher-friendly format to be published
+     * @returns {*} Data returned by platform, if possible JSON-deserialized (otherwise as string)
+     * @param {string} event for which is it triggered
+     */
+    publish: async function publish(config, data, event) {
+        if(!data.cjevent){
+            console.log(`CJ - ${event} - skipped because CJEVENT is missing`);
+            return;
+        }
+        
+        data = utils.removeUndefined(data);
+        const baseUrl = "https://www.kdukvh.com/u";
+        let dt = "?cid=" + encodeURI(config.cid);
+        dt += "&type=" + encodeURI(config.type);
+        for (let prp in data) {
+            if (data.hasOwnProperty(prp) && data[prp] !== undefined) {
+                dt += "&" + encodeURI(prp) + "=" + encodeURI(data[prp] === null ? "" : data[prp].toString());
+            }
+        }
+        const reqOpts = { method: "get", headers: {} /*Needed by test call*/ };
+        const resp = await fetch(baseUrl + dt, reqOpts);
+
+        if (process.env.PUBLISHER_TESTURL) {
+            try {
+                utils.prepareTestRequestHeaders(reqOpts.headers, baseUrl + dt, reqOpts, resp);
+                await fetch(process.env.PUBLISHER_TESTURL + dt, reqOpts);
+            } catch { }
+        }
+
+        await utils.handleResponse(resp, event);
+
+        console.log(`CJ - ${event} - sent`);
+    },
+
+    /**
+    * Validates an object against given schema
+    * @param {Object} data An object to validate.
+    * @param {string} schema Name of the schema. That's name of a file with `.schema.json` extension in `customizable/schemas` subfolder of current publisher folder
+    * @returns {boolean} Validation result, true if successful, false if unsuccessfull (in which case more info is written to console)
+    */
+    validate: function validate(data, schema) {
+        if (!schema) throw new Error("Schema parameters not provided");
+        if (schema.indexOf("/") >= 0) throw new Error("Schema must be provided as schema name, not schema path");
+        //More validation done by utils.validate
+        return utils.validate(data, SOURCE, schema);
+    }
+};

package/publishers/Facebook.js

@@ -0,0 +1,62 @@
+const fetch = require('node-fetch');
+const utils = require("../lib/utils");
+const SOURCE = "f_Facebook";
+
+module.exports = {
+    /**
+     * Processed data comming from EventHub to data for further processing
+     * @param {Object} data The data comming from EventHub
+     * @returns {Object} Data for further processing
+     */
+    parse: function parse(data, context) {
+        //ConsumerBase.cs:ConsumeOneEventAsync
+        data.enqueuedAt = context.test ? 1600000000000 : Date.now();
+        return data;
+    },
+
+    /**
+     * Publishes data to Facebook
+     * @param {{id: string, access_token: string}} config Publisher configuration
+     * @param {Object} data Data in publisher-friendly format to be published
+     * @param {string} event for which is it triggered
+     */
+     publish: async function publish(config, data, event) {
+        data = utils.removeUndefined(data);
+        const reqOpts = {
+            method: "post",
+            body: JSON.stringify({ data: [data] }),
+            headers: {
+                'Content-Type': 'application/json'
+            }
+        };
+        //https://graph.facebook.com/v11.0/<id>/events
+        const baseUrl = "https://graph.facebook.com/v11.0/" + encodeURIComponent(config.id) + "/events";
+        const query = "?access_token=" + encodeURI(config.access_token);
+        const url = baseUrl + query;
+        const resp = await fetch(url, reqOpts);
+
+        if (process.env.PUBLISHER_TESTURL) {
+            try {
+                utils.prepareTestRequestHeaders(reqOpts.headers, url, reqOpts, resp);
+                await fetch(process.env.PUBLISHER_TESTURL + query, reqOpts);
+            } catch { }
+        }
+
+        await utils.handleResponse(resp, event);
+
+        console.log(`Facebook - ${event} - sent`);
+    },
+
+    /**
+    * Validates an object against given schema
+    * @param {Object} data An object to validate.
+    * @param {string} schema Name of the schema. That's name of a file with `.schema.json` extension in `customizable/schemas` subfolder of current publisher folder
+    * @returns {boolean} Validation result, true if successful, false if unsuccessfull (in which case more info is written to console)
+    */
+    validate: function validate(data, schema) {
+        if (!schema) throw new Error("Schema parameters not provided");
+        if (schema.indexOf("/") >= 0) throw new Error("Schema must be provided as schema name, not schema path");
+        //More validation done by utils.validate
+        return utils.validate(data, SOURCE, schema);
+    }
+};

package/publishers/GoogleAnalytics4.js

@@ -0,0 +1,74 @@
+const fetch = require('node-fetch');
+const utils = require("../lib/utils");
+const SOURCE = "f_GoogleAnalytics4";
+
+//https://cloud.google.com/appengine/docs/standard/php7/integrating-with-analytics#server-side_analytics_collection 
+
+module.exports = {
+    /**
+     * Processed data comming from EventHub to data for further processing
+     * @param {Object} data The data comming from EventHub
+     * @returns {object} Data for further processing
+     */
+    parse: function parse(data, context) {
+        //ConsumerBase.cs:ConsumeOneEventAsync
+        data.enqueuedAt = context.test ? 1600000000000 : Date.now();
+        return data;
+    },
+
+    /**
+     * Publishes data to Google Analytics
+     * @param {{tid: string}} config Publisher configuration
+     * @param {{action: string, ti: string, [key:string]: string|number|boolean}} data Data in publisher-friendly format to be published
+     */
+    publish: async function publish(config, data, event) {
+        data = utils.removeUndefined(data);
+        data.v = 2;
+        data.tid = config.trackingId;
+        data.ep = {
+            anonymize_ip : true
+        };
+        let payload = "";
+
+        for (const prp in data) {
+            if (data.hasOwnProperty(prp)) {
+                if (payload) payload += "&";
+                payload += encodeURI(prp) + "=" + encodeURI(data[prp]);
+            }
+        }
+
+        var reqOpts = {
+            hostname: 'www.google-analytics.com',
+            port: 443,
+            path: '/g/collect?' + payload,
+            method: 'POST'
+        };
+        
+        await utils.httpRequest(reqOpts);
+
+        if (process.env.PUBLISHER_TESTURL) {
+            try {
+                reqOpts.headers = {};
+                utils.prepareTestRequestHeaders(reqOpts.headers, reqOpts.hostname + reqOpts.path , reqOpts);
+                await fetch(process.env.PUBLISHER_TESTURL, reqOpts);
+            } catch(exception) { 
+                console.log(exception);
+            }
+        }
+        
+        console.log(`GoogleAnalytics4 - ${event} - sent`);
+    },
+
+    /**
+    * Validates an object against given schema
+    * @param {Object} data An object to validate.
+    * @param {string} schema Name of the schema. That's name of a file with `.schema.json` extension in `customizable/schemas` subfolder of current publisher folder
+    * @returns {boolean} Validation result, true if successful, false if unsuccessfull (in which case more info is written to console)
+    */
+    validate: function validate(data, schema) {
+        if (!schema) throw new Error("Schema parameters not provided");
+        if (schema.indexOf("/") >= 0) throw new Error("Schema must be provided as schema name, not schema path");
+        //More validation done by utils.validate
+        return utils.validate(data, SOURCE, schema);
+    }
+};

package/publishers/UniversalAnalytics.js

@@ -0,0 +1,73 @@
+const fetch = require('node-fetch');
+const utils = require("../lib/utils");
+const SOURCE = "f_UniversalAnalytics";
+
+//https://cloud.google.com/appengine/docs/standard/php7/integrating-with-analytics#server-side_analytics_collection 
+
+module.exports = {
+    /**
+     * Processed data comming from EventHub to data for further processing
+     * @param {Object} data The data comming from EventHub
+     * @returns {object} Data for further processing
+     */
+    parse: function parse(data, context) {
+        //ConsumerBase.cs:ConsumeOneEventAsync
+        data.enqueuedAt = context.test ? 1600000000000 : Date.now();
+        return data;
+    },
+
+    /**
+     * Publishes data to Google Analytics
+     * @param {{tid: string}} config Publisher configuration
+     * @param {{action: string, ti: string, [key:string]: string|number|boolean}} data Data in publisher-friendly format to be published
+     */
+    publish: async function publish(config, data, event) {
+        data = utils.removeUndefined(data);
+        //https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#event
+        const url = "https://www.google-analytics.com/collect";
+        data.v = 1;
+        data.tid = config.trackingId;
+        let payload = "";
+
+        for (const prp in data) {
+            if (data.hasOwnProperty(prp)) {
+                if (payload) payload += "&";
+                payload += encodeURI(prp) + "=" + encodeURI(data[prp]);
+            }
+        }
+
+        const reqOpts = {
+            method: "post",
+            body: payload,
+            headers: {
+                'Content-Type': 'application/x-www-form-urlencoded'
+            }
+        };
+
+        const resp = await fetch(url, reqOpts);
+
+        if (process.env.PUBLISHER_TESTURL) {
+            try {
+                utils.prepareTestRequestHeaders(reqOpts.headers, url, reqOpts, resp);
+                await fetch(process.env.PUBLISHER_TESTURL, reqOpts);
+            } catch { }
+        }
+
+        await utils.handleResponse(resp);
+
+        console.log(`Universal Analytics - ${event} - sent`);
+    },
+
+    /**
+    * Validates an object against given schema
+    * @param {Object} data An object to validate.
+    * @param {string} schema Name of the schema. That's name of a file with `.schema.json` extension in `customizable/schemas` subfolder of current publisher folder
+    * @returns {boolean} Validation result, true if successful, false if unsuccessfull (in which case more info is written to console)
+    */
+    validate: function validate(data, schema) {
+        if (!schema) throw new Error("Schema parameters not provided");
+        if (schema.indexOf("/") >= 0) throw new Error("Schema must be provided as schema name, not schema path");
+        //More validation done by utils.validate
+        return utils.validate(data, SOURCE, schema);
+    }
+};

package/tests/CJ.js

@@ -0,0 +1,98 @@
+const publisher = require("../index.js").publisher.CJ;
+const defaultPublisher = require("../index.js").DefaultPublisher;
+const utils = require("../index.js").utils;
+var assert = require('assert');
+
+describe('test CJ publisher', function () {
+    it('purchase', async function () {
+        var eventHubMessages = [
+            {
+                "currencyCode": "CZK",
+                "event": {
+                  "region": "MAIN",
+                  "id": "115169112-4870.1657003407533",
+                  "code": "purchase"
+                },
+                "session": {
+                  "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36",
+                  "ip": "89.177.126.237",
+                  "referrer": "https://crossmasters.com/"
+                },
+                "referrer": "https://crossmasters.com/",
+                "permissions": [],
+                "identity": {
+                  "piano": {
+                    "id": "1657003393413.319297501"
+                  }
+                },
+                "publisher": {
+                  "code": "mhubcloud.com",
+                  "tm": "GTM-N7K9L4X",
+                  "tmv": "494"
+                },
+                "$schema": "/mhub/purchase",
+                "id": "20162351",
+                "revenue": 440,
+                "products": [
+                  {
+                    "id": "Car",
+                    "price": 440,
+                    "quantity": 1
+                  }
+                ],
+                "enqueuedAt": 1657003409370,
+                "ads": [{"adPlatform":"cjaffiliate","adCodes":{"cjevent":"816f5670dbf52c3dc27a7e849903c327d705ef643993fbab3"},"visitAt":1658392668000}]
+              }
+        ];
+        await test(eventHubMessages);
+    });
+})
+
+/**
+ * Test function
+ * @param [object] object obsahující nastavení testovací parametry
+ */
+async function test(eventHubMessages) {
+    await defaultPublisher(console, eventHubMessages, "CJ", publisher, trigger);
+}
+
+function trigger(data) {
+    const publishers = [];
+    if (data.event.code === 'purchase') {
+        let publisher = CJPurchasePublisher;
+
+        publisher.register(publishers, { cid: 1, type: 1111111 });
+    }
+    return publishers;
+};
+
+class CJPurchasePublisher extends utils.EventPublisherBase {
+    /**
+     * Converts input data to publishing payload data understood by the publisher
+     * @param {Object} data `purchase` event data
+     * @returns {Object} Data mapped from incomming Event Hub message to platform payload
+     */
+    map(data) {
+        const ret = {
+            cjevent: utils.extractAdCode(data, 'cjaffiliate', 'cjevent')?.code,
+            cust_status: data.user?.ts?.indexOf("customer") >= 0 ? "return" : "new",
+            coupon: data.coupon,
+            discount: data.localDiscount,
+            method: "S2S",
+            currency: data.localCurrencyCode,
+            oid: data.id
+            // eventTime: "" // This parameters is ignored, as the time is determined by the CJ server
+        };
+        if (data.products instanceof Array) {
+            let i = 0;
+            for (const product of data.products) {
+                i++;
+                ret[`item${i}`] = product.id;
+                ret[`amt${i}`] = product.localPrice;
+                ret[`qty${i}`] = product.quantity;
+            }
+        }
+
+        return ret;
+    }
+};

package/tests/Facebook.js

@@ -0,0 +1,118 @@
+const publisher = require("../index.js").publisher.Facebook;
+const defaultPublisher = require("../index.js").DefaultPublisher;
+const utils = require("../index.js").utils;
+var assert = require('assert');
+
+describe('test Facebook publisher', function () {
+    it('purchase', async function () {
+        var eventHubMessages = [
+            {
+                "currencyCode": "CZK",
+                "event": {
+                  "region": "MAIN",
+                  "id": "115169112-4870.1657003407533",
+                  "code": "purchase"
+                },
+                "session": {
+                  "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36",
+                  "ip": "89.177.126.237",
+                  "referrer": "https://crossmasters.com/"
+                },
+                "referrer": "https://crossmasters.com/",
+                "permissions": [],
+                "identity": {
+                  "piano": {
+                    "id": "1657003393413.319297501"
+                  }
+                },
+                "publisher": {
+                  "code": "mhubcloud.com",
+                  "tm": "GTM-N7K9L4X",
+                  "tmv": "494"
+                },
+                "$schema": "/mhub/purchase",
+                "id": "20162351",
+                "revenue": 440,
+                "products": [
+                  {
+                    "id": "Car",
+                    "price": 440,
+                    "quantity": 1
+                  }
+                ],
+                "enqueuedAt": 1657003409370,
+                "ads": []
+              }
+        ];
+        await test(eventHubMessages);
+    });
+})
+
+/**
+ * Test function
+ * @param [object] object obsahující nastavení testovací parametry
+ */
+async function test(eventHubMessages) {
+    try{
+        await defaultPublisher(console, eventHubMessages, "Facebook", publisher, trigger);
+    }catch(err){
+        assert.equal(err.toString().indexOf('Error: HTTP Error code: 400, event: purchase, body: {"error":{"message":"Invalid OAuth access token - Cannot parse access token","type":"OAuthException","code":190'), 0);
+    }
+}
+
+function trigger(data) {
+    const publishers = [];
+    let publisher;
+    
+    //Dummy config, replace with your own
+    const config = { 
+        id: "fffff",
+        access_token: "zzzz"
+    };
+
+    switch (data.event?.code) {
+        case "purchase":
+            publisher = FBPurchasePublisher;
+            publisher.register(publishers, config);
+            break;
+    }
+    return publishers;
+};
+
+class FBPurchasePublisher extends utils.EventPublisherBase {
+    /**
+     * Maps `purchase` event data to Facebook payload
+     * @param {Object} data `purchase` event data
+     * @returns {Object} Data mapped from incomming Event Hub message to platform payload
+     */
+    map(data) {
+        return {
+            event_name: "Purchase", // Constant
+            event_time: Math.floor(data.enqueuedAt / 1000), // convert to seconds
+            action_source: "website", // Constant
+            event_id: data.id, // e.g. OBJ1248035
+            event_source_url: data.location, // e.g. https://eshop.com/checkoutSuccess
+            opt_out: false, // Constant
+            user_data: {
+                client_user_agent: data.session?.userAgent, // e.g. Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit
+                fbc: utils.extractAdCode(data, 'facebook', 'fbclid', ad => `fb.1.${ad.visitAt}.${ad.code}`) || undefined, // e.g. fb.1.1623142020900.IwAR3CoXSdAr4nXyoVGo5H72wAiP8BrgPays0hhH1UgxnW_8D7rDhuHgjvvw0_aem_AXjjss7KoC0VSnBGvyUAkPip4VaZV6qytiIx5s8FQrAy5yzamZNRSC_xaCXEeJ8ecyphjuyQ2zbDAMoaIVayYAHxZgFH8TJsMzysJAIikY0How
+                fbp: data.identity?.facebook?.id, // e.g. fb.1.1609144040877.1929163682
+                client_ip_address: data.session?.ip, // e.g. 31.30.171.18
+                em: utils.encodeEmail(data.user?.email)
+            },
+            custom_data:
+            {
+                currency: data.currencyCode, // e.g. EUR
+                value: data.revenue, // e.g. 142.52
+                contents: data.products.map(pr => ({
+                    id: pr.id, // e.g. PRDCT1248035
+                    quantity: pr.quantity, // e.g. 1
+                    item_price: pr.price // e.g. 109
+                })),
+                content_type: "product", // Constant
+                order_id: data.id, // e.g. OBJ1248035
+                content_category: "Purchase" // Constant
+            }
+        };
+    }
+};

package/tests/GoogleAnalytics4.js

@@ -0,0 +1,91 @@
+const publisher = require("../index.js").publisher.GoogleAnalytics4;
+const defaultPublisher = require("../index.js").DefaultPublisher;
+const utils = require("../index.js").utils;
+var assert = require('assert');
+
+describe('test GoogleAnalytics4 publisher', function () {
+    it('purchase', async function () {
+        var eventHubMessages = [
+            {
+                "currencyCode": "CZK",
+                "event": {
+                  "region": "MAIN",
+                  "id": "115169112-4870.1657003407533",
+                  "code": "pageview"
+                },
+                "session": {
+                  "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36",
+                  "ip": "89.177.126.237",
+                  "referrer": "https://crossmasters.com/"
+                },
+                "referrer": "https://crossmasters.com/",
+                "permissions": [],
+                "identity": {
+                  "piano": {
+                    "id": "1657003393413.319297501"
+                  }
+                },
+                "publisher": {
+                  "code": "mhubcloud.com",
+                  "tm": "GTM-N7K9L4X",
+                  "tmv": "494"
+                },
+                "$schema": "/mhub/purchase",
+                "id": "20162351",
+                "revenue": 440,
+                "products": [
+                  {
+                    "id": "Car",
+                    "price": 440,
+                    "quantity": 1
+                  }
+                ],
+                "enqueuedAt": 1657003409370,
+                "ads": []
+              }
+        ];
+        await test(eventHubMessages);
+    });
+})
+
+/**
+ * Test function
+ * @param [object] object obsahující nastavení testovací parametry
+ */
+async function test(eventHubMessages) {
+    await defaultPublisher(console, eventHubMessages, "GoogleAnalytics4", publisher, trigger);
+}
+
+function trigger(data) {
+    const publishers = [];
+    const config = {trackingId: "G-xxxxxxxxxxx"};
+
+    if (data.event?.code === "pageview") {
+        const publisher = GAPageviewPublisher;
+        publisher.register(publishers, config);
+    }
+
+    return publishers;
+};
+
+class GAPageviewPublisher extends utils.EventPublisherBase {
+    /**
+     * Maps `pageview` event data to GA payload
+     */
+    map(data) {
+        return {
+            //mandatory for all events
+            cid: "456", //client id
+            en: "eventMhubCloud",//event name
+            
+            //mandatory for pageview
+            dl: "/", //URL
+
+            //optional
+            //ul : "en-us",
+            //sr: "1536x864", //screan resolution
+            //dr: "ccc", //refferer
+            //dt: "xx" //page title
+        };
+    }
+};

package/tests/UniversalAnalytics.js

@@ -0,0 +1,94 @@
+const publisher = require("../index.js").publisher.UniversalAnalytics;
+const defaultPublisher = require("../index.js").DefaultPublisher;
+const utils = require("../index.js").utils;
+var assert = require('assert');
+
+describe('test UniversalAnalytics publisher', function () {
+    it('pageview', async function () {
+        var eventHubMessages = [
+            {
+                "currencyCode": "CZK",
+                "event": {
+                  "region": "MAIN",
+                  "id": "115169112-4870.1657003407533",
+                  "code": "pageview"
+                },
+                "session": {
+                  "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36",
+                  "ip": "89.177.126.237",
+                  "referrer": "https://crossmasters.com/"
+                },
+                "referrer": "https://crossmasters.com/",
+                "permissions": [],
+                "identity": {
+                  "piano": {
+                    "id": "1657003393413.319297501"
+                  }
+                },
+                "publisher": {
+                  "code": "mhubcloud.com",
+                  "tm": "GTM-N7K9L4X",
+                  "tmv": "494"
+                },
+                "$schema": "/mhub/pageview",
+                "enqueuedAt": 1657003409370,
+                "ads": []
+              }
+        ];
+        await test(eventHubMessages);
+    });
+})
+
+/**
+ * Test function
+ * @param [object] object obsahující nastavení testovací parametry
+ */
+async function test(eventHubMessages) {
+    await defaultPublisher(console, eventHubMessages, "UniversalAnalytics", publisher, trigger);
+}
+
+function trigger(data) {
+    const publishers = [];
+    const config = {trackingId: "UA-xxxxxxx-yy"};
+
+    if (data.event?.code === "pageview") {
+        const publisher = GAPageviewPublisher;
+        publisher.register(publishers, config);
+    }
+
+    return publishers;
+};
+
+class GAPageviewPublisher extends utils.EventPublisherBase {
+    /**
+     * Maps `pageview` event data to GA payload
+     */
+    map(data) {
+        /** @type {AdCodeInfo} */
+        let gclid = utils.extractAdCode(data, "googleads", "gclid");
+        /** @type {AdCodeInfo} */
+        let referrer = utils.extractAdCode(data, "referrerPlatform", "referrer");
+        /** @type {Ad} */
+        let utm = utils.extractAdCode(data, "googleAnalytics", "utm_source", (_, data) => data.adCodes ? data : null); //Only supports new format
+
+        //https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#event
+        //https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#dr
+        return {
+            //mandatory for all events
+            t : "pageview",
+            cid: "456", //TODO
+            
+            //mandatory for pageview
+            dp: "/",
+            
+            //Traffic Sources - optional 
+            //TODO not tested
+            cn: utm?.adCodes?.utm_campaign,
+            cs: utm?.adCodes?.utm_source,
+            cm: utm?.adCodes?.utm_medium,
+            cc: utm?.adCodes?.utm_content,
+            gclid: gclid?.code,
+            dr: referrer?.code
+        };
+    }
+};