prebid.js 6.2.0 → 6.6.0

package/modules/vidoomyBidAdapter.js

@@ -1,4 +1,4 @@
-import { logError, deepAccess } from '../src/utils.js';
+import { logError, deepAccess, parseSizesInput } from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER, VIDEO} from '../src/mediaTypes.js';
 import {config} from '../src/config.js';
@@ -53,7 +53,7 @@ const isBidResponseValid = bid => {
     case BANNER:
       return Boolean(bid.width && bid.height && bid.ad);
     case VIDEO:
-      return Boolean(bid.vastUrl);
+      return Boolean(bid.vastUrl || bid.vastXml);
     default:
       return false;
   }
@@ -62,14 +62,15 @@ const isBidResponseValid = bid => {
 const buildRequests = (validBidRequests, bidderRequest) => {
   const serverRequests = validBidRequests.map(bid => {
     let adType = BANNER;
-    let w, h;
+    let sizes;
     if (bid.mediaTypes && bid.mediaTypes[BANNER] && bid.mediaTypes[BANNER].sizes) {
-      [w, h] = bid.mediaTypes[BANNER].sizes[0];
+      sizes = bid.mediaTypes[BANNER].sizes;
       adType = BANNER;
     } else if (bid.mediaTypes && bid.mediaTypes[VIDEO] && bid.mediaTypes[VIDEO].playerSize) {
-      [w, h] = bid.mediaTypes[VIDEO].playerSize;
+      sizes = bid.mediaTypes[VIDEO].playerSize;
       adType = VIDEO;
     }
+    const [w, h] = (parseSizesInput(sizes)[0] || '0x0').split('x');
 
     const aElement = document.createElement('a');
     aElement.href = (bidderRequest.refererInfo && bidderRequest.refererInfo.referer) || top.location.href;
@@ -80,6 +81,7 @@ const buildRequests = (validBidRequests, bidderRequest) => {
     const queryParams = {
       id: bid.params.id,
       adtype: adType,
+      auc: bid.adUnitCode,
       w,
       h,
       pos: parseInt(bid.params.position) || 1,
@@ -88,7 +90,7 @@ const buildRequests = (validBidRequests, bidderRequest) => {
       dt: /Mobi/.test(navigator.userAgent) ? 2 : 1,
       pid: bid.params.pid,
       requestId: bid.bidId,
-      d: getDomainWithoutSubdomain(hostname),
+      d: getDomainWithoutSubdomain(hostname), // 'vidoomy.com',
       sp: encodeURIComponent(aElement.href),
       usp: bidderRequest.uspConsent || '',
       coppa: !!config.getConfig('coppa'),
@@ -127,7 +129,7 @@ const interpretResponse = (serverResponse, bidRequest) => {
     let responseBody = serverResponse.body;
     if (!responseBody) return;
     if (responseBody.mediaType === 'video') {
-      responseBody.ad = responseBody.vastUrl;
+      responseBody.ad = responseBody.vastUrl || responseBody.vastXml;
       const videoContext = bidRequest.data.videoContext;
 
       if (videoContext === OUTSTREAM) {
@@ -143,13 +145,12 @@ const interpretResponse = (serverResponse, bidRequest) => {
 
           responseBody.renderer = renderer;
         } catch (e) {
-          responseBody.ad = responseBody.vastUrl;
+          responseBody.ad = responseBody.vastUrl || responseBody.vastXml;
           logError(BIDDER_CODE + ': error while installing renderer to show outstream ad');
         }
       }
     }
     const bid = {
-      vastUrl: responseBody.vastUrl,
       ad: responseBody.ad,
       renderer: responseBody.renderer,
       mediaType: responseBody.mediaType,
@@ -178,6 +179,11 @@ const interpretResponse = (serverResponse, bidRequest) => {
         secondaryCatIds: responseBody.meta.secondaryCatIds
       }
     };
+    if (responseBody.vastUrl) {
+      bid.vastUrl = responseBody.vastUrl;
+    } else if (responseBody.vastXml) {
+      bid.vastXml = responseBody.vastXml;
+    }
 
     const bids = [];
 
@@ -202,7 +208,7 @@ function getUserSyncs (syncOptions, responses, gdprConsent, uspConsent) {
     return [].concat(urls).map(url => ({
       type: pixelType,
       url: url
-        .replace('{{GDPR}}', gdprConsent ? gdprConsent.gdprApplies : '0')
+        .replace('{{GDPR}}', gdprConsent ? (gdprConsent.gdprApplies ? '1' : '0') : '0')
         .replace('{{GDPR_CONSENT}}', gdprConsent ? encodeURIComponent(gdprConsent.consentString) : '')
         .replace('{{USP_CONSENT}}', uspConsent ? encodeURIComponent(uspConsent) : '')
     }));

package/modules/weboramaRtdProvider.js

@@ -2,90 +2,326 @@
  * This module adds Weborama provider to the real time data module
  * The {@link module:modules/realTimeData} module is required
  * The module will fetch contextual data (page-centric) from Weborama server
+ * and may access user-centric data from local storage
  * @module modules/weboramaRtdProvider
  * @requires module:modules/realTimeData
  */
 
 /**
-* @typedef {Object} ModuleParams
-* @property {WeboCtxConf} weboCtxConf
-*/
+ * @typedef {Object} ModuleParams
+ * @property {WeboCtxConf} weboCtxConf
+ * @property {WeboUserDataConf} weboUserDataConf
+ */
 
 /**
-* @typedef {Object} WeboCtxConf
-* @property {string} token required token to be used on bigsea contextual API requests
-* @property {?string} targetURL specify the target url instead use the referer
-* @property {?boolean} setTargeting if true will set the GAM targeting
-* @property {?object} defaultProfile to be used if the profile is not found
-*/
-
-import { deepSetValue, logError, tryAppendQueryString, logMessage } from '../src/utils.js';
-import {submodule} from '../src/hook.js';
-import {ajax} from '../src/ajax.js';
-import {config} from '../src/config.js';
+ * @typedef {Object} WeboCtxConf
+ * @property {string} token required token to be used on bigsea contextual API requests
+ * @property {?string} targetURL specify the target url instead use the referer
+ * @property {?Boolean} setPrebidTargeting if true will set the GAM targeting (default true)
+ * @property {?Boolean} sendToBidders if true, will send the contextual profile to all bidders (default true)
+ * @property {?object} defaultProfile to be used if the profile is not found
+ */
+
+/**
+ * @typedef {Object} WeboUserDataConf
+ * @property {?string} localStorageProfileKey can be used to customize the local storage key (default is 'webo_wam2gam_entry')
+ * @property {?Boolean} setPrebidTargeting if true will set the GAM targeting (default true)
+ * @property {?Boolean} sendToBidders if true, will send the contextual profile to all bidders (default true)
+ * @property {?object} defaultProfile to be used if the profile is not found
+ */
+
+import {
+  getGlobal
+} from '../src/prebidGlobal.js';
+import {
+  deepSetValue,
+  deepAccess,
+  isEmpty,
+  mergeDeep,
+  logError,
+  tryAppendQueryString,
+  logMessage
+} from '../src/utils.js';
+import {
+  submodule
+} from '../src/hook.js';
+import {
+  ajax
+} from '../src/ajax.js';
+import {
+  getStorageManager
+} from '../src/storageManager.js';
+
+const adapterManager = require('../src/adapterManager.js').default;
 
 /** @type {string} */
 const MODULE_NAME = 'realTimeData';
 /** @type {string} */
 const SUBMODULE_NAME = 'weborama';
 /** @type {string} */
-const WEBO_CTX = 'webo_ctx';
+export const DEFAULT_LOCAL_STORAGE_USER_PROFILE_KEY = 'webo_wam2gam_entry';
 /** @type {string} */
-const WEBO_DS = 'webo_ds';
+const LOCAL_STORAGE_USER_TARGETING_SECTION = 'targeting';
+/** @type {number} */
+const GVLID = 284;
+/** @type {object} */
+export const storage = getStorageManager(GVLID, SUBMODULE_NAME);
 
 /** @type {null|Object} */
-let _bigseaContextualProfile = null;
+let _weboContextualProfile = null;
 
-/** function that provides ad server targeting data to RTD-core
-* @param {Array} adUnitsCodes
-* @param {Object} moduleConfig
-* @returns {Object} target data
+/** @type {Boolean} */
+let _weboCtxInitialized = false;
+
+/** @type {null|Object} */
+let _weboUserDataUserProfile = null;
+
+/** @type {Boolean} */
+let _weboUserDataInitialized = false;
+
+/** Initialize module
+ * @param {object} moduleConfig
+ * @return {Boolean} true if module was initialized with success
  */
-function getTargetingData(adUnitsCodes, moduleConfig) {
+function init(moduleConfig) {
   moduleConfig = moduleConfig || {};
   const moduleParams = moduleConfig.params || {};
   const weboCtxConf = moduleParams.weboCtxConf || {};
-  const defaultContextualProfiles = weboCtxConf.defaultProfile || {}
-  const profile = _bigseaContextualProfile || defaultContextualProfiles;
+  const weboUserDataConf = moduleParams.weboUserDataConf;
 
-  if (weboCtxConf.setOrtb2) {
-    const ortb2 = config.getConfig('ortb2') || {};
-    if (profile[WEBO_CTX]) {
-      deepSetValue(ortb2, 'site.ext.data.webo_ctx', profile[WEBO_CTX]);
-    }
-    if (profile[WEBO_DS]) {
-      deepSetValue(ortb2, 'site.ext.data.webo_ds', profile[WEBO_DS]);
-    }
-    config.setConfig({ortb2: ortb2});
-  }
+  _weboCtxInitialized = initWeboCtx(weboCtxConf);
+  _weboUserDataInitialized = initWeboUserData(weboUserDataConf);
 
-  if (weboCtxConf.setTargeting === false) {
-    return {};
+  return _weboCtxInitialized || _weboUserDataInitialized;
+}
+
+/** Initialize contextual sub module
+ * @param {WeboCtxConf} weboCtxConf
+ * @return {Boolean} true if sub module was initialized with success
+ */
+function initWeboCtx(weboCtxConf) {
+  _weboCtxInitialized = false;
+  _weboContextualProfile = null;
+
+  if (!weboCtxConf.token) {
+    logError('missing param "token" for weborama contextual sub module initialization');
+    return false;
   }
 
+  return true;
+}
+
+/** Initialize weboUserData sub module
+ * @param {WeboUserDataConf} weboUserDataConf
+ * @return {Boolean} true if sub module was initialized with success
+ */
+function initWeboUserData(weboUserDataConf) {
+  _weboUserDataInitialized = false;
+  _weboUserDataUserProfile = null;
+
+  return !!weboUserDataConf;
+}
+
+/** function that provides ad server targeting data to RTD-core
+ * @param {Array} adUnitsCodes
+ * @param {Object} moduleConfig
+ * @returns {Object} target data
+ */
+function getTargetingData(adUnitsCodes, moduleConfig) {
+  moduleConfig = moduleConfig || {};
+  const moduleParams = moduleConfig.params || {};
+  const weboCtxConf = moduleParams.weboCtxConf || {};
+  const weboUserDataConf = moduleParams.weboUserDataConf || {};
+  const weboCtxConfTargeting = weboCtxConf.setPrebidTargeting !== false;
+  const weboUserDataConfTargeting = weboUserDataConf.setPrebidTargeting !== false;
+
   try {
-    const formattedProfile = profile;
-    const r = adUnitsCodes.reduce((rp, adUnitCode) => {
+    const profile = getCompleteProfile(moduleParams, weboCtxConfTargeting, weboUserDataConfTargeting);
+
+    if (isEmpty(profile)) {
+      return {};
+    }
+
+    const td = adUnitsCodes.reduce((data, adUnitCode) => {
       if (adUnitCode) {
-        rp[adUnitCode] = formattedProfile;
+        data[adUnitCode] = profile;
       }
-      return rp;
+      return data;
     }, {});
-    return r;
+
+    return td;
   } catch (e) {
     logError('unable to format weborama rtd targeting data', e);
     return {};
   }
 }
 
+/** function that provides complete profile formatted to be used
+ * @param {ModuleParams} moduleParams
+ * @param {Boolean} weboCtxConfTargeting
+ * @param {Boolean} weboUserDataConfTargeting
+ * @returns {Object} complete profile
+ */
+function getCompleteProfile(moduleParams, weboCtxConfTargeting, weboUserDataConfTargeting) {
+  const profile = {};
+
+  if (weboCtxConfTargeting) {
+    const contextualProfile = getContextualProfile(moduleParams.weboCtxConf || {});
+    mergeDeep(profile, contextualProfile);
+  }
+
+  if (weboUserDataConfTargeting) {
+    const weboUserDataProfile = getWeboUserDataProfile(moduleParams.weboUserDataConf || {});
+    mergeDeep(profile, weboUserDataProfile);
+  }
+
+  return profile;
+}
+
+/** return contextual profile
+ * @param {WeboCtxConf} weboCtxConf
+ * @returns {Object} contextual profile
+ */
+function getContextualProfile(weboCtxConf) {
+  const defaultContextualProfile = weboCtxConf.defaultProfile || {};
+  return _weboContextualProfile || defaultContextualProfile;
+}
+
+/** return weboUserData profile
+ * @param {WeboUserDataConf} weboUserDataConf
+ * @returns {Object} weboUserData profile
+ */
+function getWeboUserDataProfile(weboUserDataConf) {
+  const weboUserDataDefaultUserProfile = weboUserDataConf.defaultProfile || {};
+
+  if (storage.localStorageIsEnabled() && !_weboUserDataUserProfile) {
+    const localStorageProfileKey = weboUserDataConf.localStorageProfileKey || DEFAULT_LOCAL_STORAGE_USER_PROFILE_KEY;
+
+    const entry = storage.getDataFromLocalStorage(localStorageProfileKey);
+    if (entry) {
+      const data = JSON.parse(entry);
+      if (data && Object.keys(data).length > 0) {
+        _weboUserDataUserProfile = data[LOCAL_STORAGE_USER_TARGETING_SECTION];
+      }
+    }
+  }
+
+  return _weboUserDataUserProfile || weboUserDataDefaultUserProfile;
+}
+
+/** function that will allow RTD sub-modules to modify the AdUnit object for each auction
+ * @param {Object} reqBidsConfigObj
+ * @param {doneCallback} onDone
+ * @param {Object} moduleConfig
+ * @returns {void}
+ */
+export function getBidRequestData(reqBidsConfigObj, onDone, moduleConfig) {
+  moduleConfig = moduleConfig || {};
+  const moduleParams = moduleConfig.params || {};
+  const weboCtxConf = moduleParams.weboCtxConf || {};
+
+  const adUnits = reqBidsConfigObj.adUnits || getGlobal().adUnits;
+
+  if (!_weboCtxInitialized) {
+    handleBidRequestData(adUnits, moduleParams);
+
+    onDone();
+
+    return;
+  }
+
+  fetchContextualProfile(weboCtxConf, (data) => {
+    logMessage('fetchContextualProfile on getBidRequestData is done');
+
+    setWeboContextualProfile(data);
+  }, () => {
+    handleBidRequestData(adUnits, moduleParams);
+
+    onDone();
+  });
+}
+
+/** function that handles bid request data
+ * @param {Object[]} adUnits
+ * @param {ModuleParams} moduleParams
+ * @returns {void}
+ */
+
+function handleBidRequestData(adUnits, moduleParams) {
+  const weboCtxConf = moduleParams.weboCtxConf || {};
+  const weboUserDataConf = moduleParams.weboUserDataConf || {};
+  const weboCtxConfTargeting = weboCtxConf.sendToBidders !== false;
+  const weboUserDataConfTargeting = weboUserDataConf.sendToBidders !== false;
+  const profile = getCompleteProfile(moduleParams, weboCtxConfTargeting, weboUserDataConfTargeting);
+
+  if (isEmpty(profile)) {
+    return;
+  }
+
+  adUnits.forEach(adUnit => {
+    if (adUnit.hasOwnProperty('bids')) {
+      adUnit.bids.forEach(bid => handleBid(adUnit, profile, bid));
+    }
+  });
+}
+
+/** @type {string} */
+const SMARTADSERVER = 'smartadserver';
+
+/** @type {Object} */
+const bidderAliasRegistry = adapterManager.aliasRegistry || {};
+
+/** handle individual bid
+ * @param {Object} adUnit
+ * @param {Object} profile
+ * @param {Object} bid
+ * @returns {void}
+ */
+function handleBid(adUnit, profile, bid) {
+  const bidder = bidderAliasRegistry[bid.bidder] || bid.bidder;
+
+  logMessage('handle bidder', bidder, bid);
+
+  switch (bidder) {
+    case SMARTADSERVER:
+      handleSmartadserverBid(adUnit, profile, bid);
+
+      break;
+  }
+}
+
+/** handle smartadserver bid
+ * @param {Object} adUnit
+ * @param {Object} profile
+ * @param {Object} bid
+ * @returns {void}
+ */
+function handleSmartadserverBid(adUnit, profile, bid) {
+  const target = [];
+
+  if (deepAccess(bid, 'params.target')) {
+    target.push(bid.params.target.split(';'));
+  }
+
+  Object.keys(profile).forEach(key => {
+    profile[key].forEach(value => {
+      const keyword = `${key}=${value}`;
+      if (target.indexOf(keyword) === -1) {
+        target.push(keyword);
+      }
+    });
+  });
+
+  deepSetValue(bid, 'params.target', target.join(';'));
+}
+
 /** set bigsea contextual profile on module state
- * if the profile is empty, will store the default profile
  * @param {null|Object} data
  * @returns {void}
  */
-export function setBigseaContextualProfile(data) {
+export function setWeboContextualProfile(data) {
   if (data && Object.keys(data).length > 0) {
-    _bigseaContextualProfile = data;
+    _weboContextualProfile = data;
   }
 }
 
@@ -96,9 +332,9 @@ export function setBigseaContextualProfile(data) {
  */
 
 /** onDone callback type
-  * @callback doneCallback
-  * @returns {void}
-  */
+ * @callback doneCallback
+ * @returns {void}
+ */
 
 /** Fetch Bigsea Contextual Profile
  * @param {WeboCtxConf} weboCtxConf
@@ -117,7 +353,7 @@ function fetchContextualProfile(weboCtxConf, onSuccess, onDone) {
   const url = 'https://ctx.weborama.com/api/profile?' + queryString;
 
   ajax(url, {
-    success: function (response, req) {
+    success: function(response, req) {
       if (req.status === 200) {
         try {
           const data = JSON.parse(response);
@@ -126,49 +362,28 @@ function fetchContextualProfile(weboCtxConf, onSuccess, onDone) {
         } catch (e) {
           onDone();
           logError('unable to parse weborama data', e);
+          throw e;
         }
       } else if (req.status === 204) {
         onDone();
       }
     },
-    error: function () {
+    error: function() {
       onDone();
       logError('unable to get weborama data');
     }
   },
-  null,
-  {
+  null, {
     method: 'GET',
     withCredentials: false,
   });
 }
 
-/** Initialize module
- * @param {object} moduleConfig
- * @return {boolean} true if module was initialized with success
- */
-function init(moduleConfig) {
-  _bigseaContextualProfile = null;
-
-  moduleConfig = moduleConfig || {};
-  const moduleParams = moduleConfig.params || {};
-  const weboCtxConf = moduleParams.weboCtxConf || {};
-
-  if (weboCtxConf.token) {
-    fetchContextualProfile(weboCtxConf, setBigseaContextualProfile,
-      () => logMessage('fetchContextualProfile on init is done'));
-  } else {
-    logError('missing param "token" for weborama rtd module initialization');
-    return false;
-  }
-
-  return true;
-}
-
 export const weboramaSubmodule = {
   name: SUBMODULE_NAME,
   init: init,
   getTargetingData: getTargetingData,
+  getBidRequestData: getBidRequestData,
 };
 
 submodule(MODULE_NAME, weboramaSubmodule);

package/modules/weboramaRtdProvider.md

@@ -10,8 +10,6 @@ Maintainer: prebid-support@weborama.com
 
 Weborama provides a Semantic AI Contextual API that classifies in Real-time a web page seen by a web user within generic and custom topics. It enables publishers to better monetize their inventory and unlock it to programmatic.
 
-ORTB2 compliant and FPD support for Prebid versions < 4.29
-
 Contact prebid-support@weborama.com for information.
 
 ### Publisher Usage
@@ -32,17 +30,31 @@ pbjs.setConfig(
                 name: "weborama",
                 waitForIt: true,
                 params: {
-                  weboCtxConf: {
-                      setTargeting: true,
-                      token: "<<token provided by weborama>>",
-                      targetURL: "..." // default is document.URL
+                  weboCtxConf: {  // contextual configuration
+                      token: "<<provided by weborama>>", // mandatory
+                      targetURL: "...",         // default is document.URL
+                      setPrebidTargeting: true, // default
+                      sendToBidders: true,      // default
+                      defaultProfile: {         // optional, default is none
+                        webo_ctx: ['foo'],
+                        webo_ds: ['bar']
+		      }
+                    },
+                    weboUserDataConf: { // user-centric configuration
+                      setPrebidTargeting: true, // default
+                      sendToBidders: true,      // default
+                      defaultProfile: {         // optional, default is none
+                        webo_cs: ['baz'],
+                        webo_audiences: ['bam']
+		      },
+                      localStorageProfileKey: 'webo_wam2gam_entry' // default
                     }
                 }
             }
         ]
     }
     ...
-}
+);
 ```
 
 ### Parameter Descriptions for the Weborama Configuration Section
@@ -55,15 +67,20 @@ pbjs.setConfig(
 | params.weboCtxConf | Object | Weborama Contextual Configuration | Optional |
 | params.weboCtxConf.token | String | Security Token provided by Weborama, unique per client | Mandatory |
 | params.weboCtxConf.targetURL | String | Url to be profiled in the contextual api | Optional. Defaults to `document.URL` |
+| params.weboCtxConf.setPrebidTargeting|Boolean|If true, will use the contextual profile to set the prebid (GPT/GAM or AST) targeting of all adunits managed by prebid.js| Optional. Default is *true*.|
+| params.weboCtxConf.sendToBidders|Boolean|If true, will send the contextual profile to all bidders (only smartadserver is supported now)| Optional. Default is *true*.|
 | params.weboCtxConf.defaultProfile | Object | default value of the profile to be used when there are no response from contextual api (such as timeout)| Optional. Default is `{}` |
-| params.weboCtxConf.setTargeting|Boolean|If true, will use the contextual profile to set the gam targeting of all adunits managed by prebid.js| Optional. Default is *true*.|
-| params.weboCtxConf.setOrtb2|Boolean|If true, will use the contextual profile to set the ortb2 configuration on `site.ext.data`| Optional. Default is *false*.|
+| params.weboUserDataConf | Object | WeboUserData Configuration | Optional |
+| params.weboUserDataConf.setPrebidTargeting|Boolean|If true, will use the contextual profile to set the prebid (GPT/GAM or AST) targeting of all adunits managed by prebid.js| Optional. Default is *true*.|
+| params.weboUserDataConf.sendToBidders|Boolean|If true, will send the contextual profile to all bidders (only smartadserver is supported now)| Optional. Default is *true*.|
+| params.weboUserDataConf.defaultProfile | Object | default value of the profile to be used when there are no response from contextual api (such as timeout)| Optional. Default is `{}` |
+| params.weboUserDataConf.localStorageProfileKey| String | can be used to customize the local storage key | Optional |
 
 ### Testing
 
 To view an example of available segments returned by Weborama's backends:
 
-`gulp serve --modules=rtdModule,weboramaRtdProvider,appnexusBidAdapter`
+`gulp serve --modules=rtdModule,weboramaRtdProvider,smartadserverBidAdapter`
 
 and then point your browser at: