prebid-universal-creative 1.14.2 → 1.15.0

package/src/mobileAndAmpRender.js

@@ -0,0 +1,239 @@
+import { getCreativeCommentMarkup, triggerPixel, createTrackPixelHtml, loadScript, getCreativeComment, writeAdUrl, transformAuctionTargetingData, sendRequest, getUUID } from './utils';
+import { isSafeFrame, isMobileApp } from './environment';
+import { insertElement } from './domHelper';
+import { writeAdHtml } from './postscribeRender';
+
+const DEFAULT_CACHE_HOST = 'prebid.adnxs.com';
+const DEFAULT_CACHE_PATH = '/pbc/v1/cache';
+
+/**
+ * Render mobile or amp ad
+ * @param {string} cacheHost Cache host
+ * @param {string} cachePath Cache path
+ * @param {string} uuid id to render response from cache endpoint
+ * @param {string} size size of the creative
+ * @param {string} hbPb final price of the winning bid
+ * @param {Bool} isMobileApp flag to detect mobile app
+ */
+export function renderAmpOrMobileAd(dataObject) {
+  const targetingData = transformAuctionTargetingData(dataObject);
+  let { cacheHost, cachePath, uuid, size, hbPb } = targetingData;
+  uuid = uuid || '';
+  // For MoPub, creative is stored in localStorage via SDK.
+  let search = 'Prebid_';
+  if (uuid.substr(0, search.length) === search) {
+    loadFromLocalCache(uuid);
+    //register creative right away to not miss initial geom-update
+    updateIframe(size);
+  } else {
+    let adUrl = `${getCacheEndpoint(cacheHost, cachePath)}?uuid=${uuid}`;
+    //register creative right away to not miss initial geom-update
+    updateIframe(size);
+    sendRequest(adUrl, responseCallback(isMobileApp(targetingData.env), hbPb));
+  }
+}
+
+/**
+ * Load response from localStorage. In case of MoPub, sdk caches response
+ * @param {string} cacheId
+ */
+function loadFromLocalCache(cacheId) {
+  let bid = window.localStorage.getItem(cacheId);
+  let displayFn = responseCallback(true);
+  displayFn(bid);
+}
+
+/**
+ * update iframe by using size string to resize
+ * @param {string} size
+ */
+function updateIframe(size) {
+  if (size) {
+    const sizeArr = size.split('x').map(Number);
+    resizeIframe(sizeArr[0], sizeArr[1]);
+  } else {
+    console.log('Targeting key hb_size not found to resize creative');
+  }
+}
+
+/**
+ * Resize container iframe
+ * @param {Number} width width of creative
+ * @param {Number} height height of creative
+ */
+function resizeIframe(width, height) {
+  if (isSafeFrame(window)) {
+    const iframeWidth = window.innerWidth;
+    const iframeHeight = window.innerHeight;
+
+    function resize(status) {
+      let newWidth = width - iframeWidth;
+      let newHeight = height - iframeHeight;
+      window.$sf.ext.expand({ r: newWidth, b: newHeight, push: true });
+    }
+
+    if (iframeWidth !== width || iframeHeight !== height) {
+      window.$sf.ext.register(width, height, resize);
+      // we need to resize the DFP container as well
+      window.parent.postMessage({
+        sentinel: 'amp',
+        type: 'embed-size',
+        width: width,
+        height: height
+      }, '*');
+    }
+  }
+}
+
+/**
+ * Returns cache endpoint concatenated with cache path
+ * @param {string} cacheHost Cache Endpoint host
+ * @param {string} cachePath Cache Endpoint path
+ */
+function getCacheEndpoint(cacheHost, cachePath) {
+  let host = (typeof cacheHost === 'undefined' || cacheHost === "") ? DEFAULT_CACHE_HOST : cacheHost;
+  let path = (typeof cachePath === 'undefined' || cachePath === "") ? DEFAULT_CACHE_PATH : cachePath;
+
+  return `https://${host}${path}`;
+}
+
+
+/**
+ * Cache request Callback to display creative
+ * @param {Bool} isMobileApp
+ * @param {string} hbPb final price of the winning bid
+ * @returns {function} a callback function that parses response
+ */
+function responseCallback(isMobileApp, hbPb) {
+  return function (response) {
+    let bidObject = parseResponse(response);
+    let auctionPrice = bidObject.price || hbPb;
+    let ad = getCreativeCommentMarkup(bidObject);
+    let width = (bidObject.width) ? bidObject.width : bidObject.w;
+    let height = (bidObject.height) ? bidObject.height : bidObject.h;
+
+    // When Prebid Universal Creative reads from Prebid Cache, we need to have it check for the existence of the wurl parameter. If it exists, hit it.
+    if (bidObject.wurl) {
+      triggerPixel(decodeURIComponent(bidObject.wurl));
+    }
+
+    if (bidObject.adm) {
+      if (auctionPrice) { // replace ${AUCTION_PRICE} macro with the bidObject.price or hb_pb.
+        bidObject.adm = bidObject.adm.replace('${AUCTION_PRICE}', auctionPrice);
+      } else {
+        /*
+          From OpenRTB spec 2.5: If the source value is an optional parameter that was not specified, the macro will simply be removed (i.e., replaced with a zero-length string).
+         */
+        bidObject.adm = bidObject.adm.replace('${AUCTION_PRICE}', '');
+      }
+      ad += (isMobileApp) ? constructMarkup(bidObject.adm, width, height) : bidObject.adm;
+      if (bidObject.nurl) {
+        ad += createTrackPixelHtml(decodeURIComponent(bidObject.nurl));
+      }
+      if (bidObject.burl) {
+        let triggerBurl = function () { triggerPixel(bidObject.burl); };
+        if (isMobileApp) {
+          let mraidScript = loadScript(window, 'mraid.js',
+            function () { // Success loading MRAID
+              let result = registerMRAIDViewableEvent(triggerBurl);
+              if (!result) {
+                triggerBurl(); // Error registering event
+              }
+            },
+            triggerBurl // Error loading MRAID
+          );
+        } else {
+          triggerBurl(); // Not a mobile app
+        }
+      }
+      writeAdHtml(ad);
+    } else if (bidObject.nurl) {
+      if (isMobileApp) {
+        let adhtml = loadScript(window, bidObject.nurl);
+        ad += constructMarkup(adhtml.outerHTML, width, height);
+
+        writeAdHtml(ad);
+      } else {
+        let nurl = bidObject.nurl;
+        let commentElm = getCreativeComment(bidObject);
+        insertElement(commentElm, document, 'body');
+        writeAdUrl(nurl, width, height);
+      }
+    }
+  }
+};
+
+/**
+ * Parse response
+ * @param {string} response
+ * @returns {Object} bidObject parsed response
+ */
+function parseResponse(response) {
+  let bidObject;
+  try {
+    bidObject = JSON.parse(response);
+  } catch (error) {
+    console.log(`Error parsing response from cache host: ${error}`);
+  }
+  return bidObject;
+}
+
+/**
+ * Wrap mobile app creative in div
+ * @param {string} ad html for creative
+ * @param {Number} width width of creative
+ * @param {Number} height height of creative
+ * @returns {string} creative markup
+ */
+function constructMarkup(ad, width, height) {
+  let id = getUUID();
+  return `<div id="${id}" style="border-style: none; position: absolute; width:100%; height:100%;">
+      <div id="${id}_inner" style="margin: 0 auto; width:${width}px; height:${height}px; position: absolute; top: 50%; left: 50%; transform: translate(-50%, -50%);">${ad}</div>
+      </div>`;
+}
+
+
+function registerMRAIDViewableEvent(callback) {
+
+  function exposureChangeListener(exposure) {
+    if (exposure > 0) {
+      mraid.removeEventListener('exposureChange', exposureChangeListener);
+      callback();
+    }
+  }
+
+  function viewableChangeListener(viewable) {
+    if (viewable) {
+      mraid.removeEventListener('viewableChange', viewableChangeListener);
+      callback();
+    }
+  }
+
+  function registerViewableChecks() {
+    if (window.MRAID_ENV && parseFloat(window.MRAID_ENV.version) >= 3) {
+      mraid.addEventListener('exposureChange', exposureChangeListener);
+    } else if (window.MRAID_ENV && parseFloat(window.MRAID_ENV.version) < 3) {
+      if (mraid.isViewable()) {
+        callback();
+      } else {
+        mraid.addEventListener('viewableChange', viewableChangeListener);
+      }
+    }
+  }
+
+  function readyListener() {
+    mraid.removeEventListener('ready', readyListener);
+    registerViewableChecks();
+  }
+
+  if (window.mraid && window.MRAID_ENV) {
+    if (mraid.getState() == 'loading') {
+      mraid.addEventListener('ready', readyListener);
+    } else {
+      registerViewableChecks();
+    }
+    return true;
+  } else {
+    return false;
+  }
+}

package/src/nativeAssetManager.js

@@ -6,9 +6,7 @@
 import { addNativeClickTrackers, fireNativeImpressionTrackers } from './nativeORTBTrackerManager';
 import { sendRequest, loadScript } from './utils';
 import {prebidMessenger} from './messaging.js';
-import { newEnvironment } from './environment.js';
-
-const envionment = newEnvironment(window);
+import { isSafeFrame } from './environment.js';
 /*
  * Native asset->key mapping from Prebid.js/src/constants.json
  * https://github.com/prebid/Prebid.js/blob/8635c91942de9df4ec236672c39b19448545a812/src/constants.json#L67
@@ -18,6 +16,7 @@ const NATIVE_KEYS = {
   body: 'hb_native_body',
   body2: 'hb_native_body2',
   privacyLink: 'hb_native_privacy',
+  privacyIcon: 'hb_native_privicon',
   sponsoredBy: 'hb_native_brand',
   image: 'hb_native_image',
   icon: 'hb_native_icon',
@@ -328,7 +327,7 @@ export function newNativeAssetManager(win, pubUrl) {
       } else if ((data.hasOwnProperty('adTemplate') && data.adTemplate)||(hasPbNativeData() && win.pbNativeData.hasOwnProperty('adTemplate'))) {
         const template =  (hasPbNativeData() && win.pbNativeData.hasOwnProperty('adTemplate') && win.pbNativeData.adTemplate) || data.adTemplate;
         const newHtml = replace(template, data);
-
+        
         renderAd(newHtml, data);
       } else {
         const newHtml = replace(body, data);
@@ -350,7 +349,7 @@ export function newNativeAssetManager(win, pubUrl) {
         if (!currentParentWindow.frames || !currentParentWindow.frames.length) return null;
         for (let idx = 0; idx < currentParentWindow.frames.length; idx++)
             if (currentParentWindow.frames[idx] === currentWindow) {
-              if (!currentParentWindow.document) return null;
+              if (!currentParentWindow.document) return null; 
                 for (let frameElement of currentParentWindow.document.getElementsByTagName('iframe')) {
                     if (!frameElement.contentWindow) return null;
                     if (frameElement.contentWindow === currentWindow) {
@@ -366,10 +365,10 @@ export function newNativeAssetManager(win, pubUrl) {
     // current iframe width to the width of the container. This
     // is to handle the case where the native ad is rendered inside
     // a GAM display ad.
-    if (!envionment.isSafeFrame()) {
+    if (!isSafeFrame(window)) {
       let iframeContainer = getCurrentFrameContainer(win);
       if (iframeContainer && iframeContainer.children && iframeContainer.children[0]) {
-        const iframe = iframeContainer.children[0];
+        const iframe = iframeContainer.children[0]; 
         if (iframe.width === '1' && iframe.height === '1') {
           let width =  iframeContainer.getBoundingClientRect().width;
           win.document.body.style.width = `${width}px`;
@@ -421,7 +420,7 @@ export function newNativeAssetManager(win, pubUrl) {
     if (ortb.link) {
       html = html.replaceAll("##hb_native_linkurl##", ortb.link.url);
     }
-
+  
     return html;
   }
 

package/src/nativeRender.js

@@ -1,7 +1,7 @@
 import { newNativeRenderManager } from './nativeRenderManager';
 
-window.pbNativeTag = (window.pbNativeTag || {});
 const nativeRenderManager = newNativeRenderManager(window);
 
-window.pbNativeTag.renderNativeAd = nativeRenderManager.renderNativeAd;
+window.ucTag = (window.ucTag || {});
 
+window.ucTag.renderAd = nativeRenderManager.renderNativeAd;

package/src/nativeRenderManager.js

@@ -1,7 +1,7 @@
 /*
  * Script to handle firing impression and click trackers from native teamplates
  */
-import {newNativeAssetManager} from './nativeAssetManager';
+import { newNativeAssetManager } from './nativeAssetManager';
 import {prebidMessenger} from './messaging.js';
 
 const AD_ANCHOR_CLASS_NAME = 'pb-click';
@@ -48,7 +48,7 @@ export function newNativeRenderManager(win) {
   }
 
   // START OF MAIN CODE
-  let renderNativeAd = function(nativeTag) {
+  let renderNativeAd = function(doc, nativeTag) {
     window.pbNativeData = nativeTag;
     sendMessage = prebidMessenger(nativeTag.pubUrl, win);
     const nativeAssetManager = newNativeAssetManager(window, nativeTag.pubUrl);
@@ -56,17 +56,17 @@ export function newNativeRenderManager(win) {
     if (nativeTag.hasOwnProperty('adId')) {
 
       if (nativeTag.hasOwnProperty('rendererUrl') && !nativeTag.rendererUrl.match(/##.*##/i)) {
-        const scr = document.createElement('SCRIPT');
+        const scr = doc.createElement('SCRIPT');
         scr.src = nativeTag.rendererUrl,
         scr.id = 'pb-native-renderer';
-        document.body.appendChild(scr);
+        doc.body.appendChild(scr);
       }
       nativeAssetManager.loadAssets(nativeTag.adId, () => {
         fireNativeImpTracker(nativeTag.adId);
         fireNativeCallback();
       });
     } else {
-      console.warn('Prebid Native Tag object was missing \'adId\'.');
+      console.warn("Prebid Native Tag object was missing 'adId'.");
     }
   }
 

package/src/postscribeRender.js

@@ -0,0 +1,8 @@
+import postscribe from 'postscribe';
+
+export function writeAdHtml(markup) {
+    postscribe(document.body, markup, {
+      error: console.error
+    });
+  }
+