AdkernelAdn analytics adapter (prebid#1868)

* AdkernelAdn analytics adapter

* Markdown page fix

Author: ckbo3hrk

modules/adkernelAdnAnalyticsAdapter.js

@@ -0,0 +1,365 @@
+import adapter from 'src/AnalyticsAdapter';
+import CONSTANTS from 'src/constants.json';
+import adaptermanager from 'src/adaptermanager';
+import {parse} from 'src/url';
+import * as utils from 'src/utils';
+import {ajax} from 'src/ajax';
+
+const ANALYTICS_VERSION = '1.0.0';
+const DEFAULT_QUEUE_TIMEOUT = 4000;
+const DEFAULT_HOST = 'tag.adkernel.com';
+
+const ADK_HB_EVENTS = {
+  AUCTION_INIT: 'auctionInit',
+  BID_REQUEST: 'bidRequested',
+  BID_RESPONSE: 'bidResponse',
+  BID_WON: 'bidWon',
+  AUCTION_END: 'auctionEnd',
+  TIMEOUT: 'adapterTimedOut'
+};
+
+function buildRequestTemplate(pubId) {
+  const url = utils.getTopWindowUrl();
+  const ref = utils.getTopWindowReferrer();
+  const topLocation = utils.getTopWindowLocation();
+
+  return {
+    ver: ANALYTICS_VERSION,
+    domain: topLocation.hostname,
+    path: topLocation.pathname,
+    accId: pubId,
+    env: {
+      screen: {
+        w: window.screen.width,
+        h: window.screen.height
+      },
+      lang: navigator.language
+    },
+    src: getUmtSource(url, ref)
+  }
+}
+
+let analyticsAdapter = Object.assign(adapter({analyticsType: 'endpoint'}),
+  {
+    track({ eventType, args }) {
+      if (!analyticsAdapter.context) {
+        return;
+      }
+      let handler = null;
+      switch (eventType) {
+        case CONSTANTS.EVENTS.AUCTION_INIT:
+          if (analyticsAdapter.context.queue) {
+            analyticsAdapter.context.queue.init();
+          }
+          handler = trackAuctionInit;
+          break;
+        case CONSTANTS.EVENTS.BID_REQUESTED:
+          handler = trackBidRequest;
+          break;
+        case CONSTANTS.EVENTS.BID_RESPONSE:
+          handler = trackBidResponse;
+          break;
+        case CONSTANTS.EVENTS.BID_WON:
+          handler = trackBidWon;
+          break;
+        case CONSTANTS.EVENTS.BID_TIMEOUT:
+          handler = trackBidTimeout;
+          break;
+        case CONSTANTS.EVENTS.AUCTION_END:
+          handler = trackAuctionEnd;
+          break;
+      }
+      if (handler) {
+        let events = handler(args);
+        if (analyticsAdapter.context.queue) {
+          analyticsAdapter.context.queue.push(events);
+        }
+        if (eventType === CONSTANTS.EVENTS.AUCTION_END) {
+          sendAll();
+        }
+      }
+    }
+  });
+
+analyticsAdapter.context = {};
+
+analyticsAdapter.originEnableAnalytics = analyticsAdapter.enableAnalytics;
+
+analyticsAdapter.enableAnalytics = (config) => {
+  if (!config.options.pubId) {
+    utils.logError('PubId is not defined. Analytics won\'t work');
+    return;
+  }
+  analyticsAdapter.context = {
+    host: config.options.host || DEFAULT_HOST,
+    pubId: config.options.pubId,
+    requestTemplate: buildRequestTemplate(config.options.pubId),
+    queue: new ExpiringQueue(sendAll, config.options.queueTimeout || DEFAULT_QUEUE_TIMEOUT)
+  };
+  analyticsAdapter.originEnableAnalytics(config);
+};
+
+adaptermanager.registerAnalyticsAdapter({
+  adapter: analyticsAdapter,
+  code: 'adkernelAdn'
+});
+
+export default analyticsAdapter;
+
+function sendAll() {
+  let events = analyticsAdapter.context.queue.popAll();
+  if (events.length !== 0) {
+    let req = Object.assign({}, analyticsAdapter.context.requestTemplate, {hb_ev: events});
+    ajax(`//${analyticsAdapter.context.host}/hb-analytics`, () => {
+    }, JSON.stringify(req));
+  }
+}
+
+function trackAuctionInit() {
+  analyticsAdapter.context.auctionTimeStart = Date.now();
+  const event = createHbEvent(undefined, ADK_HB_EVENTS.AUCTION_INIT);
+  return [event];
+}
+
+function trackBidRequest(args) {
+  return args.bids.map(bid =>
+    createHbEvent(args.bidderCode, ADK_HB_EVENTS.BID_REQUEST, bid.placementCode));
+}
+
+function trackBidResponse(args) {
+  const event = createHbEvent(args.bidderCode, ADK_HB_EVENTS.BID_RESPONSE,
+    args.adUnitCode, args.cpm, args.timeToRespond / 1000);
+  return [event];
+}
+
+function trackBidWon(args) {
+  const event = createHbEvent(args.bidderCode, ADK_HB_EVENTS.BID_WON, args.adUnitCode, args.cpm);
+  return [event];
+}
+
+function trackAuctionEnd(args) {
+  const event = createHbEvent(undefined, ADK_HB_EVENTS.AUCTION_END, undefined,
+    undefined, (Date.now() - analyticsAdapter.context.auctionTimeStart) / 1000);
+  return [event];
+}
+
+function trackBidTimeout(args) {
+  return args.map(bidderName => createHbEvent(bidderName, ADK_HB_EVENTS.TIMEOUT));
+}
+
+function createHbEvent(adapter, event, tagid = undefined, value = 0, time = 0) {
+  let ev = { event: event };
+  if (adapter) {
+    ev.adapter = adapter
+  }
+  if (tagid) {
+    ev.tagid = tagid;
+  }
+  if (value) {
+    ev.val = value;
+  }
+  if (time) {
+    ev.time = time;
+  }
+  return ev;
+}
+
+const UTM_TAGS = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
+  'utm_c1', 'utm_c2', 'utm_c3', 'utm_c4', 'utm_c5'];
+const ADKERNEL_PREBID_KEY = 'adk_dpt_analytics';
+const DIRECT = '(direct)';
+const REFERRAL = '(referral)';
+const ORGANIC = '(organic)';
+
+export function getUmtSource(pageUrl, referrer) {
+  let prevUtm = getPreviousTrafficSource();
+  let currUtm = getCurrentTrafficSource(pageUrl, referrer);
+  let [updated, actual] = chooseActualUtm(prevUtm, currUtm);
+  if (updated) {
+    storeUtm(actual);
+  }
+  return actual;
+
+  function getPreviousTrafficSource() {
+    let val = localStorage.getItem(ADKERNEL_PREBID_KEY);
+    if (!val) {
+      return getDirect();
+    }
+    return JSON.parse(val);
+  }
+
+  function getCurrentTrafficSource(pageUrl, referrer) {
+    var source = getUTM(pageUrl);
+    if (source) {
+      return source;
+    }
+    if (referrer) {
+      let se = getSearchEngine(referrer);
+      if (se) {
+        return asUtm(se, ORGANIC, ORGANIC);
+      }
+      let parsedUrl = parse(pageUrl);
+      let [refHost, refPath] = getReferrer(referrer);
+      if (refHost && refHost !== parsedUrl.hostname) {
+        return asUtm(refHost, REFERRAL, REFERRAL, '', refPath);
+      }
+    }
+    return getDirect();
+  }
+
+  function getSearchEngine(pageUrl) {
+    let engines = {
+      'google': /^https?\:\/\/(?:www\.)?(?:google\.(?:com?\.)?(?:com|cat|[a-z]{2})|g.cn)\//i,
+      'yandex': /^https?\:\/\/(?:www\.)?ya(?:ndex\.(?:com|net)?\.?(?:asia|mobi|org|[a-z]{2})?|\.ru)\//i,
+      'bing': /^https?\:\/\/(?:www\.)?bing\.com\//i,
+      'duckduckgo': /^https?\:\/\/(?:www\.)?duckduckgo\.com\//i,
+      'ask': /^https?\:\/\/(?:www\.)?ask\.com\//i,
+      'yahoo': /^https?\:\/\/(?:[-a-z]+\.)?(?:search\.)?yahoo\.com\//i
+    };
+
+    for (let engine in engines) {
+      if (engines.hasOwnProperty(engine) && engines[engine].test(pageUrl)) {
+        return engine;
+      }
+    }
+  }
+
+  function getReferrer(referrer) {
+    let ref = parse(referrer);
+    return [ref.hostname, ref.pathname];
+  }
+
+  function getUTM(pageUrl) {
+    let urlParameters = parse(pageUrl).search;
+    if (!urlParameters['utm_campaign'] || !urlParameters['utm_source']) {
+      return;
+    }
+    let utmArgs = [];
+    for (let utmTagName of UTM_TAGS) {
+      let utmValue = urlParameters[utmTagName] || '';
+      utmArgs.push(utmValue);
+    }
+    return asUtm.apply(this, utmArgs);
+  }
+
+  function getDirect() {
+    return asUtm(DIRECT, DIRECT, DIRECT);
+  }
+
+  function storeUtm(utm) {
+    let val = JSON.stringify(utm);
+    localStorage.setItem(ADKERNEL_PREBID_KEY, val);
+  }
+
+  function asUtm(source, medium, campaign, term = '', content = '', c1 = '', c2 = '', c3 = '', c4 = '', c5 = '') {
+    let result = {
+      source: source,
+      medium: medium,
+      campaign: campaign
+    };
+    if (term) {
+      result.term = term;
+    }
+    if (content) {
+      result.content = content;
+    }
+    if (c1) {
+      result.c1 = c1;
+    }
+    if (c2) {
+      result.c2 = c2;
+    }
+    if (c3) {
+      result.c3 = c3;
+    }
+    if (c4) {
+      result.c4 = c4;
+    }
+    if (c5) {
+      result.c5 = c5;
+    }
+    return result;
+  }
+
+  function chooseActualUtm(prev, curr) {
+    if (ord(prev) < ord(curr)) {
+      return [true, curr];
+    } if (ord(prev) > ord(curr)) {
+      return [false, prev];
+    } else {
+      if (prev.campaign === REFERRAL && prev.content !== curr.content) {
+        return [true, curr];
+      } else if (prev.campaign === ORGANIC && prev.source !== curr.source) {
+        return [true, curr];
+      } else if (isCampaignTraffic(prev) && (prev.campaign !== curr.campaign || prev.source !== curr.source)) {
+        return [true, curr];
+      }
+    }
+    return [false, prev];
+  }
+
+  function ord(utm) {
+    switch (utm.campaign) {
+      case DIRECT:
+        return 0;
+      case ORGANIC:
+        return 1;
+      case REFERRAL:
+        return 2;
+      default:
+        return 3;
+    }
+  }
+
+  function isCampaignTraffic(utm) {
+    return [DIRECT, REFERRAL, ORGANIC].indexOf(utm.campaign) === -1;
+  }
+}
+
+/**
+ * Expiring queue implementation. Fires callback on elapsed timeout since last last update or creation.
+ * @param callback
+ * @param ttl
+ * @constructor
+ */
+export function ExpiringQueue(callback, ttl) {
+  let queue = [];
+  let timeoutId;
+
+  this.push = (event) => {
+    if (event instanceof Array) {
+      queue.push.apply(queue, event);
+    } else {
+      queue.push(event);
+    }
+    reset();
+  };
+
+  this.popAll = () => {
+    let result = queue;
+    queue = [];
+    reset();
+    return result;
+  };
+
+  /**
+   * For test/debug purposes only
+   * @return {Array}
+   */
+  this.peekAll = () => {
+    return queue;
+  };
+
+  this.init = reset;
+
+  function reset() {
+    if (timeoutId) {
+      clearTimeout(timeoutId);
+    }
+    timeoutId = setTimeout(() => {
+      if (queue.length) {
+        callback();
+      }
+    }, ttl);
+  }
+}

modules/adkernelAdnAnalyticsAdapter.md

@@ -0,0 +1,22 @@
+# Overview
+Module Name: Adkernel ADN Analytics Adapter
+
+Module Type: Analytics Adapter
+
+Maintainer: [email protected]
+
+# Description
+
+Analytics adapter for Adkernel Ad Delivery Network. Contact [email protected] for information.
+
+# Test Parameters
+
+```
+{
+  provider: 'adkernelAdn',
+    options : {
+      pubId : 50357,   //id provided by adkernel
+      host: 'dsp-staging.adkernel.com'  //optional host for validation purposes
+    }
+}
+```