prebid.js 7.22.0 → 7.24.0

package/libraries/video/constants/events.js

@@ -0,0 +1,97 @@
+// Life Cycle
+export const SETUP_COMPLETE = 'setupComplete';
+export const SETUP_FAILED = 'setupFailed';
+export const DESTROYED = 'destroyed';
+
+// Ads
+export const AD_REQUEST = 'adRequest';
+export const AD_BREAK_START = 'adBreakStart';
+export const AD_LOADED = 'adLoaded';
+export const AD_STARTED = 'adStarted';
+export const AD_IMPRESSION = 'adImpression';
+export const AD_PLAY = 'adPlay';
+export const AD_TIME = 'adTime';
+export const AD_PAUSE = 'adPause';
+export const AD_CLICK = 'adClick';
+export const AD_SKIPPED = 'adSkipped';
+export const AD_ERROR = 'adError';
+export const AD_COMPLETE = 'adComplete';
+export const AD_BREAK_END = 'adBreakEnd';
+
+// Media
+export const PLAYLIST = 'playlist';
+export const PLAYBACK_REQUEST = 'playbackRequest';
+export const AUTOSTART_BLOCKED = 'autostartBlocked';
+export const PLAY_ATTEMPT_FAILED = 'playAttemptFailed';
+export const CONTENT_LOADED = 'contentLoaded';
+export const PLAY = 'play';
+export const PAUSE = 'pause';
+export const BUFFER = 'buffer';
+export const TIME = 'time';
+export const SEEK_START = 'seekStart';
+export const SEEK_END = 'seekEnd';
+export const MUTE = 'mute';
+export const VOLUME = 'volume';
+export const RENDITION_UPDATE = 'renditionUpdate';
+export const ERROR = 'error';
+export const COMPLETE = 'complete';
+export const PLAYLIST_COMPLETE = 'playlistComplete';
+
+// Layout
+export const FULLSCREEN = 'fullscreen';
+export const PLAYER_RESIZE = 'playerResize';
+export const VIEWABLE = 'viewable';
+export const CAST = 'cast';
+
+export const allVideoEvents = [
+  SETUP_COMPLETE, SETUP_FAILED, DESTROYED, AD_REQUEST, AD_BREAK_START, AD_LOADED, AD_STARTED,
+  AD_IMPRESSION, AD_PLAY, AD_TIME, AD_PAUSE, AD_CLICK, AD_SKIPPED, AD_ERROR, AD_COMPLETE, AD_BREAK_END, PLAYLIST,
+  PLAYBACK_REQUEST, AUTOSTART_BLOCKED, PLAY_ATTEMPT_FAILED, CONTENT_LOADED, PLAY, PAUSE, BUFFER, TIME, SEEK_START,
+  SEEK_END, MUTE, VOLUME, RENDITION_UPDATE, ERROR, COMPLETE, PLAYLIST_COMPLETE, FULLSCREEN, PLAYER_RESIZE, VIEWABLE,
+  CAST
+];
+
+export const AUCTION_AD_LOAD_ATTEMPT = 'auctionAdLoadAttempt';
+export const AUCTION_AD_LOAD_ABORT = 'auctionAdLoadAbort';
+export const BID_IMPRESSION = 'bidImpression';
+export const BID_ERROR = 'bidError';
+
+export const videoEvents = {
+  SETUP_COMPLETE,
+  SETUP_FAILED,
+  DESTROYED,
+  AD_REQUEST,
+  AD_BREAK_START,
+  AD_LOADED,
+  AD_STARTED,
+  AD_IMPRESSION,
+  AD_PLAY,
+  AD_TIME,
+  AD_PAUSE,
+  AD_CLICK,
+  AD_SKIPPED,
+  AD_ERROR,
+  AD_COMPLETE,
+  AD_BREAK_END,
+  PLAYLIST,
+  PLAYBACK_REQUEST,
+  AUTOSTART_BLOCKED,
+  PLAY_ATTEMPT_FAILED,
+  CONTENT_LOADED,
+  PLAY,
+  PAUSE,
+  BUFFER,
+  TIME,
+  SEEK_START,
+  SEEK_END,
+  MUTE,
+  VOLUME,
+  RENDITION_UPDATE,
+  ERROR,
+  COMPLETE,
+  PLAYLIST_COMPLETE,
+  FULLSCREEN,
+  PLAYER_RESIZE,
+  VIEWABLE,
+  CAST,
+};

package/libraries/video/constants/ortb.js

@@ -0,0 +1,169 @@
+/**
+ * @typedef {Object} OrtbParams
+ * @property {OrtbVideoParamst} video
+ * @property {OrtbContentParams} content
+ */
+
+/**
+ * @typedef OrtbVideoParams
+ * @property {[string]} mimes - Content MIME types supported (e.g., “video/x-ms-wmv”, “video/mp4”).
+ * @property {number|undefined} minduration - Minimum video ad duration in seconds.
+ * @property {number|undefined} maxduration - Maximum video ad duration in seconds.
+ * @property {[number]} protocols - Supported video protocols. At least one supported protocol must be specified.
+ * @property {number} w - Width of the video player in device independent pixels (DIPS).
+ * @property {number} h - Height of the video player in device independent pixels (DIPS).
+ * @property {number|undefined} startdelay - Indicates the offset of the ad placement.
+ * @property {number|undefined} placement - Placement type for the impression.
+ * @property {number|undefined} linearity - Indicates if the impression must be linear, nonlinear, etc. If omitted, assume all are allowed.
+ * @property {number} skip - Indicates if the player can allow the video to be skipped, where 0 is no, 1 is yes.
+ * @property {number|undefined} skipmin - Only ad creatives with a duration greater than this value can be skippable; only applicable if the ad is skippable.
+ * @property {number|undefined} skipafter - Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable.
+ * @property {number|undefined} sequence - If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives.
+ * @property {[number]|undefined} battr - Blocked creative attributes. Use this to indicate which creatives the player does not support.
+ * @property {number|undefined} maxextended - Maximum extended ad duration if extension is allowed.
+ * @property {number|undefined} minbitrate - Minimum bit rate in Kbps supported by the player.
+ * @property {number|undefined} maxbitrate - Maximum bit rate in Kbps supported by the player.
+ * @property {number|undefined} boxingallowed - Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed. 0 is no, 1 is yes.
+ * @property {[number]|undefined} playbackmethod - Playback methods that may be in use.
+ * @property {number|undefined} playbackend - The scenario that causes playback to end.
+ * @property {[number]|undefined} delivery - Supported delivery methods (e.g., streaming, progressive).
+ * @property {number|undefined} pos - Ad position on screen.
+ * @property {[Object]|undefined} companionad - list of companion ads. Refer to Section 3.2.6 of the oRTB v2.5 spec for the interface of the companion ad object.
+ * @property {[number]|undefined} api - List of supported API frameworks for this impression.
+ * @property {[number]|undefined} companiontype - Supported VAST companion ad types. Refer to List 5.14 of the oRTB v2.5 spec for the interface.
+ * @property {Object|undefined} ext - Placeholder for exchange-specific extensions to OpenRTB.
+ */
+
+/**
+ * @typedef OrtbContentParams
+ * @property {string} id - ID uniquely identifying the content.
+ * @property {string} url - URL of the content, for buy-side contextualization or review.
+ * @property {number|undefined} episode - Episode number.
+ * @property {string|undefined} title - Content title.
+ * @property {string|undefined} series - Content series i.e. “The Office” (television), “Star Wars” (movie).
+ * @property {string|undefined} season - Content season (e.g., “Season 3”).
+ * @property {string|undefined} artist - Artist credited with the content.
+ * @property {string|undefined} genre - Genre that best describes the content (e.g., rock, pop, etc).
+ * @property {string|undefined} album - Album to which the content belongs. Typically for audio.
+ * @property {string|undefined} isrc - International Standard Recording Code conforming to ISO3901.
+ * @property {Object|undefined} producer - Details about the content Producer. For Producer interface visit Section 3.2.17 of the oRTB v2.5 spec.
+ * @property {[string]|undefined} cat - List of IAB content categories that describe the content. Refer to List 5.1. of the oRTB v2.5 spec for the complete list.
+ * @property {number|undefined} prodq - Production quality. Refer to List 5.13 of the oRTB v2.5 spec.
+ * @property {number|undefined} context - Type of content (game, video, text, etc.). Refer to List 5.18 of the oRTB v2.5 spec.
+ * @property {string|undefined} contentrating - Content rating (e.g., MPAA).
+ * @property {string|undefined} userrating - User rating of the content (e.g., number of stars, likes, etc.).
+ * @property {number|undefined} qagmediarating - Media rating per IQG guidelines. Refer to List 5.19 of the oRTB v2.5 spec.
+ * @property {string|undefined} keywords - Comma separated list of keywords describing the content.
+ * @property {number|undefined} livestream - Whether the stream is live or not. 0 means not live (VOD), 1 means content is live streaming.
+ * @property {number|undefined} sourcerelationship - 0 means indirect, 1 means direct.
+ * @property {number} len - Duration of content in seconds.
+ * @property {string|undefined} language - Content language using ISO-639-1-alpha-2.
+ * @property {number|undefined} embeddable - Indicator of whether or not the content is embeddable (e.g., an embeddable video player). 0 means no, 1 means yes.
+ * @property {[Object]|undefined} data - Additional content data. Each Data object represents a different data source. See Section 3.2.21 of the oRTB v2.5 spec.
+ * @property {Object|undefined} ext - Placeholder for exchange-specific extensions to OpenRTB.
+ */
+
+const VIDEO_PREFIX = 'video/';
+const APPLICATION_PREFIX = 'application/';
+
+/**
+ * ORTB 2.5 section 3.2.7 - Video.mimes
+ * @enum OrtbVideoParams.mimes
+ */
+export const VIDEO_MIME_TYPE = {
+  MP4: VIDEO_PREFIX + 'mp4',
+  MPEG: VIDEO_PREFIX + 'mpeg',
+  OGG: VIDEO_PREFIX + 'ogg',
+  WEBM: VIDEO_PREFIX + 'webm',
+  AAC: VIDEO_PREFIX + 'aac',
+  HLS: APPLICATION_PREFIX + 'vnd.apple.mpegurl'
+};
+
+export const JS_APP_MIME_TYPE = APPLICATION_PREFIX + 'javascript';
+export const VPAID_MIME_TYPE = JS_APP_MIME_TYPE;
+
+/**
+ * ORTB 2.5 section 5.9 - Video Placement Types
+ * @enum OrtbVideoParams.placement
+ */
+export const PLACEMENT = {
+  INSTREAM: 1,
+  BANNER: 2,
+  ARTICLE: 3,
+  FEED: 4,
+  INTERSTITIAL: 5,
+  SLIDER: 5,
+  FLOATING: 5,
+  INTERSTITIAL_SLIDER_FLOATING: 5
+};
+
+/**
+ * ORTB 2.5 section 5.4 - Ad Position
+ * @enum OrtbVideoParams.pos
+ */
+export const AD_POSITION = {
+  UNKNOWN: 0,
+  ABOVE_THE_FOLD: 1,
+  BELOW_THE_FOLD: 3,
+  HEADER: 4,
+  FOOTER: 5,
+  SIDEBAR: 6,
+  FULL_SCREEN: 7
+}
+
+/**
+ * ORTB 2.5 section 5.11 - Playback Cessation Modes
+ * @enum OrtbVideoParams.playbackend
+ */
+export const PLAYBACK_END = {
+  VIDEO_COMPLETION: 1,
+  VIEWPORT_LEAVE: 2,
+  FLOATING: 3
+}
+
+/**
+ * ORTB 2.5 section 5.10 - Playback Methods
+ * @enum OrtbVideoParams.playbackmethod
+ */
+export const PLAYBACK_METHODS = {
+  AUTOPLAY: 1,
+  AUTOPLAY_MUTED: 2,
+  CLICK_TO_PLAY: 3,
+  CLICK_TO_PLAY_MUTED: 4,
+  VIEWABLE: 5,
+  VIEWABLE_MUTED: 6
+};
+
+/**
+ * ORTB 2.5 section 5.8 - Protocols
+ * @enum OrtbVideoParams.protocols
+ */
+export const PROTOCOLS = {
+  // VAST_1_0: 1,
+  VAST_2_0: 2,
+  VAST_3_0: 3,
+  // VAST_1_O_WRAPPER: 4,
+  VAST_2_0_WRAPPER: 5,
+  VAST_3_0_WRAPPER: 6,
+  VAST_4_0: 7,
+  VAST_4_0_WRAPPER: 8
+};
+
+/**
+ * ORTB 2.5 section 5.6 - API Frameworks
+ * @enum OrtbVideoParams.api
+ */
+export const API_FRAMEWORKS = {
+  VPAID_1_0: 1,
+  VPAID_2_0: 2,
+  OMID_1_0: 7
+};
+
+/**
+ * ORTB 2.5 section 5.18 - Content Context
+ * @enum OrtbContentParams.context
+ */
+export const CONTEXT = {
+  VIDEO: 1,
+  AUDIO: 3
+};

package/libraries/video/constants/vendorCodes.js

@@ -0,0 +1,6 @@
+// Video Vendors
+export const JWPLAYER_VENDOR = 1;
+export const VIDEO_JS_VENDOR = 2;
+
+// Ad Server Vendors
+export const GAM_VENDOR = 'gam';

package/libraries/video/shared/eventHandler.js

@@ -0,0 +1,18 @@
+/**
+ * Builds a standard event handler
+ * @param {String} type Event name
+ * @param {(function(String, Object): Object)} callback Callback defined by publisher to be executed when the event occurs
+ * @param {Object} payload Base payload defined when the event is registered
+ * @param {(function(*): Object)|null|undefined} getExtraPayload Parses the player's event payload to return a normalized payload
+ * @returns {(function(*): void)|*} event handler
+ */
+export function getEventHandler(type, callback, payload, getExtraPayload) {
+  return event => {
+    if (getExtraPayload) {
+      const extraPayload = getExtraPayload(event);
+      Object.assign(payload, extraPayload);
+    }
+
+    callback(type, payload);
+  };
+}

package/libraries/video/shared/parentModule.js

@@ -0,0 +1,82 @@
+/**
+ * @typedef {Object} ParentModule
+ * @summary abstraction for any module to store and reference its submodules
+ * @param {SubmoduleBuilder} submoduleBuilder_
+ * @returns {ParentModule}
+ * @constructor
+ */
+export function ParentModule(submoduleBuilder_) {
+  const submoduleBuilder = submoduleBuilder_;
+  const submodules = {};
+
+  /**
+   * @function ParentModule#registerSubmodule
+   * @summary Stores a submodule
+   * @param {String} id - unique identifier of the submodule instance
+   * @param {String} vendorCode - identifier to the submodule type that must be built
+   * @param {Object} config - additional information necessary to instantiate the submodule
+   */
+  function registerSubmodule(id, vendorCode, config) {
+    if (submodules[id]) {
+      return;
+    }
+
+    let submodule;
+    try {
+      submodule = submoduleBuilder.build(vendorCode, config);
+    } catch (e) {
+      throw e;
+    }
+    submodules[id] = submodule;
+  }
+
+  /**
+   * @function ParentModule#getSubmodule
+   * @summary Stores a submodule
+   * @param {String} id - unique identifier of the submodule instance
+   * @returns {Object} - a submodule instance
+   */
+  function getSubmodule(id) {
+    return submodules[id];
+  }
+
+  return {
+    registerSubmodule,
+    getSubmodule
+  }
+}
+
+/**
+ * @typedef {Object} SubmoduleBuilder
+ * @summary Instantiates submodules
+ * @param {vendorSubmoduleDirectory} submoduleDirectory_
+ * @param {Object|null|undefined} sharedUtils_
+ * @returns {SubmoduleBuilder}
+ * @constructor
+ */
+export function SubmoduleBuilder(submoduleDirectory_, sharedUtils_) {
+  const submoduleDirectory = submoduleDirectory_;
+  const sharedUtils = sharedUtils_;
+
+  /**
+   * @function SubmoduleBuilder#build
+   * @param vendorCode - identifier to the submodule type that must be instantiated
+   * @param config - additional information necessary to instantiate the submodule
+   * @throws
+   * @returns {{init}|*} - a submodule instance
+   */
+  function build(vendorCode, config) {
+    const submoduleFactory = submoduleDirectory[vendorCode];
+    if (!submoduleFactory) {
+      throw new Error('Unrecognized submodule vendor code: ' + vendorCode);
+    }
+
+    const submodule = submoduleFactory(config, sharedUtils);
+    submodule && submodule.init && submodule.init();
+    return submodule;
+  }
+
+  return {
+    build
+  };
+}

package/libraries/video/shared/state.js

@@ -0,0 +1,47 @@
+/**
+ * @typedef {Object} State
+ * @summary simple state object. Can be subclassed
+ * @function updateState
+ * @function getState
+ * @function clearState
+ */
+
+/**
+ * @summary factory to create a simple state object
+ * @returns {State}
+ */
+export default function stateFactory() {
+  let state = {};
+
+  /**
+   * @function State#updateState
+   * @summary updates the state
+   * @param {Object} stateUpdate
+   */
+  function updateState(stateUpdate) {
+    Object.assign(state, stateUpdate);
+  }
+
+  /**
+   * @function State#getState
+   * @summary provides the current state
+   * @returns {Object} the current state
+   */
+  function getState() {
+    return state;
+  }
+
+  /**
+   * @function State#clearState
+   * @summary erases the current state
+   */
+  function clearState() {
+    state = {};
+  }
+
+  return {
+    updateState,
+    getState,
+    clearState
+  };
+}

package/libraries/video/shared/vastXmlBuilder.js

@@ -0,0 +1,77 @@
+import { getGlobal } from '../../../src/prebidGlobal.js';
+
+export function buildVastWrapper(adId, adTagUrl, impressionUrl, impressionId, errorUrl) {
+  let wrapperBody = getAdSystemNode('Prebid org', getGlobal().version);
+
+  if (adTagUrl) {
+    wrapperBody += getAdTagUriNode(adTagUrl);
+  }
+
+  if (impressionUrl) {
+    wrapperBody += getImpressionNode(impressionUrl, impressionId);
+  }
+
+  if (errorUrl) {
+    wrapperBody += getErrorNode(errorUrl);
+  }
+
+  return getVastNode(getAdNode(getWrapperNode(wrapperBody), adId), '4.2');
+}
+
+export function getVastNode(body, vastVersion) {
+  return getNode('VAST', body, { version: vastVersion });
+}
+
+export function getAdNode(body, adId) {
+  return getNode('Ad', body, { id: adId });
+}
+
+export function getWrapperNode(body) {
+  return getNode('Wrapper', body);
+}
+
+export function getAdSystemNode(system, version) {
+  return getNode('AdSystem', system, { version });
+}
+
+export function getAdTagUriNode(adTagUrl) {
+  return getUrlNode('VASTAdTagURI', adTagUrl);
+}
+
+export function getImpressionNode(pingUrl, id) {
+  return getUrlNode('Impression', pingUrl, { id });
+}
+
+export function getErrorNode(pingUrl) {
+  return getUrlNode('Error', pingUrl);
+}
+
+// Helpers
+
+function getUrlNode(labelName, url, attributes) {
+  const body = `<![CDATA[${url}]]>`;
+  return getNode(labelName, body, attributes);
+}
+
+function getNode(labelName, body, attributes) {
+  const openingLabel = getOpeningLabel(labelName, attributes);
+  return `<${openingLabel}>${body}</${labelName}>`;
+}
+
+/*
+attributes is a KVP Object.
+ */
+function getOpeningLabel(name, attributes) {
+  if (!attributes) {
+    return name;
+  }
+
+  return Object.keys(attributes).reduce((label, key) => {
+    const value = attributes[key];
+    if (!value) {
+      return label;
+    }
+
+    return label + ` ${key}="${value}"`;
+  }, name);
+}

package/libraries/video/shared/vastXmlEditor.js

@@ -0,0 +1,115 @@
+import { getErrorNode, getImpressionNode, buildVastWrapper } from './vastXmlBuilder.js';
+
+export const XML_MIME_TYPE = 'application/xml';
+
+export function VastXmlEditor(xmlUtil_) {
+  const xmlUtil = xmlUtil_;
+
+  function getVastXmlWithTracking(vastXml, adId, impressionUrl, impressionId, errorUrl) {
+    const impressionDoc = getImpressionDoc(impressionUrl, impressionId);
+    const errorDoc = getErrorDoc(errorUrl);
+    if (!adId && !impressionDoc && !errorDoc) {
+      return vastXml;
+    }
+
+    const vastXmlDoc = xmlUtil.parse(vastXml);
+    appendTrackingNodes(vastXmlDoc, impressionDoc, errorDoc);
+    replaceAdId(vastXmlDoc, adId);
+    return xmlUtil.serialize(vastXmlDoc);
+  }
+
+  function appendTrackingNodes(vastXmlDoc, impressionDoc, errorDoc) {
+    const nodes = vastXmlDoc.querySelectorAll('InLine,Wrapper');
+    const nodeCount = nodes.length;
+    for (let i = 0; i < nodeCount; i++) {
+      const node = nodes[i];
+      // A copy of the child is required until we reach the last node.
+      const requiresCopy = i < nodeCount - 1;
+      appendChild(node, impressionDoc, requiresCopy);
+      appendChild(node, errorDoc, requiresCopy);
+    }
+  }
+
+  function replaceAdId(vastXmlDoc, adId) {
+    if (!adId) {
+      return;
+    }
+
+    const adNode = vastXmlDoc.querySelector('Ad');
+    if (!adNode) {
+      return;
+    }
+
+    adNode.id = adId;
+  }
+
+  return {
+    getVastXmlWithTracking,
+    buildVastWrapper
+  }
+
+  function getImpressionDoc(impressionUrl, impressionId) {
+    if (!impressionUrl) {
+      return;
+    }
+
+    const impressionNode = getImpressionNode(impressionUrl, impressionId);
+    return xmlUtil.parse(impressionNode);
+  }
+
+  function getErrorDoc(errorUrl) {
+    if (!errorUrl) {
+      return;
+    }
+
+    const errorNode = getErrorNode(errorUrl);
+    return xmlUtil.parse(errorNode);
+  }
+
+  function appendChild(node, child, copy) {
+    if (!child) {
+      return;
+    }
+
+    const doc = copy ? child.cloneNode(true) : child;
+    node.appendChild(doc.documentElement);
+  }
+}
+
+function XMLUtil() {
+  let parser;
+  let serializer;
+
+  function getParser() {
+    if (!parser) {
+      // DOMParser instantiation is costly; instantiate only once throughout Prebid lifecycle.
+      parser = new DOMParser();
+    }
+    return parser;
+  }
+
+  function getSerializer() {
+    if (!serializer) {
+      // XMLSerializer instantiation is costly; instantiate only once throughout Prebid lifecycle.
+      serializer = new XMLSerializer();
+    }
+    return serializer;
+  }
+
+  function parse(xmlString) {
+    return getParser().parseFromString(xmlString, XML_MIME_TYPE);
+  }
+
+  function serialize(xmlDoc) {
+    return getSerializer().serializeToString(xmlDoc);
+  }
+
+  return {
+    parse,
+    serialize
+  };
+}
+
+export function vastXmlEditorFactory() {
+  return VastXmlEditor(XMLUtil());
+}

package/modules/.submodules.json

@@ -52,6 +52,7 @@
     ],
     "rtdModule": [
       "1plusXRtdProvider",
+      "aaxBlockmeterRtdProvider",
       "airgridRtdProvider",
       "akamaiDapRtdProvider",
       "blueconicRtdProvider",
@@ -63,6 +64,7 @@
       "iasRtdProvider",
       "jwplayerRtdProvider",
       "medianetRtdProvider",
+      "mgidRtdProvider",
       "oneKeyRtdProvider",
       "optimeraRtdProvider",
       "permutiveRtdProvider",
@@ -75,6 +77,10 @@
       "enrichmentFpdModule",
       "validationFpdModule",
       "topicsFpdModule"
+    ],
+    "videoModule": [
+      "jwplayerVideoProvider",
+      "videojsVideoProvider"
     ]
   }
-}
+}

package/modules/aaxBlockmeterRtdProvider.js

@@ -0,0 +1,59 @@
+import {isEmptyStr, isStr, logError, isFn, logWarn} from '../src/utils.js';
+import {submodule} from '../src/hook.js';
+import { loadExternalScript } from '../src/adloader.js';
+
+export const _config = {
+  MODULE: 'aaxBlockmeter',
+  ADSERVER_TARGETING_KEY: 'atk',
+  BLOCKMETER_URL: 'c.aaxads.com/aax.js',
+  VERSION: '1.2'
+};
+
+window.aax = window.aax || {};
+
+function loadBlockmeter(_rtdConfig) {
+  if (!(_rtdConfig.params && _rtdConfig.params.pub) || !isStr(_rtdConfig.params && _rtdConfig.params.pub) || isEmptyStr(_rtdConfig.params && _rtdConfig.params.pub)) {
+    logError(`${_config.MODULE}: params.pub should be a string`);
+    return false;
+  }
+
+  const params = [];
+  params.push(`pub=${_rtdConfig.params.pub}`);
+  params.push(`dn=${window.location.hostname}`);
+
+  let url = _rtdConfig.params.url;
+  if (!url || isEmptyStr(url)) {
+    logWarn(`${_config.MODULE}: params.url is missing, using default url.`);
+    url = `${_config.BLOCKMETER_URL}?ver=${_config.VERSION}`;
+  }
+
+  const scriptUrl = `https://${url}&${params.join('&')}`;
+  loadExternalScript(scriptUrl, _config.MODULE);
+  return true;
+}
+
+function markAdBlockInventory(codes, _rtdConfig, _userConsent) {
+  return codes.reduce((targets, code) => {
+    targets[code] = targets[code] || {};
+    const getAaxTargets = () => isFn(window.aax.getTargetingData)
+      ? window.aax.getTargetingData(code, _rtdConfig, _userConsent)
+      : {};
+    targets[code] = {
+      [_config.ADSERVER_TARGETING_KEY]: code,
+      ...getAaxTargets()
+    };
+    return targets;
+  }, {});
+}
+
+export const aaxBlockmeterRtdModule = {
+  name: _config.MODULE,
+  init: loadBlockmeter,
+  getTargetingData: markAdBlockInventory,
+};
+
+function registerSubModule() {
+  submodule('realTimeData', aaxBlockmeterRtdModule);
+}
+
+registerSubModule();