prebid.js 5.14.0 → 5.18.0

package/modules/weboramaRtdProvider.js

@@ -0,0 +1,174 @@
+/**
+ * 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
+ * @module modules/weboramaRtdProvider
+ * @requires module:modules/realTimeData
+ */
+
+/**
+* @typedef {Object} ModuleParams
+* @property {WeboCtxConf} weboCtxConf
+*/
+
+/**
+* @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';
+
+/** @type {string} */
+const MODULE_NAME = 'realTimeData';
+/** @type {string} */
+const SUBMODULE_NAME = 'weborama';
+/** @type {string} */
+const WEBO_CTX = 'webo_ctx';
+/** @type {string} */
+const WEBO_DS = 'webo_ds';
+
+/** @type {null|Object} */
+let _bigseaContextualProfile = null;
+
+/** 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 defaultContextualProfiles = weboCtxConf.defaultProfile || {}
+  const profile = _bigseaContextualProfile || defaultContextualProfiles;
+
+  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});
+  }
+
+  if (weboCtxConf.setTargeting === false) {
+    return {};
+  }
+
+  try {
+    const formattedProfile = profile;
+    const r = adUnitsCodes.reduce((rp, adUnitCode) => {
+      if (adUnitCode) {
+        rp[adUnitCode] = formattedProfile;
+      }
+      return rp;
+    }, {});
+    return r;
+  } catch (e) {
+    logError('unable to format weborama rtd targeting data', e);
+    return {};
+  }
+}
+
+/** 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) {
+  if (data && Object.keys(data).length > 0) {
+    _bigseaContextualProfile = data;
+  }
+}
+
+/** onSuccess callback type
+ * @callback successCallback
+ * @param {null|Object} data
+ * @returns {void}
+ */
+
+/** onDone callback type
+  * @callback doneCallback
+  * @returns {void}
+  */
+
+/** Fetch Bigsea Contextual Profile
+ * @param {WeboCtxConf} weboCtxConf
+ * @param {successCallback} onSuccess callback
+ * @param {doneCallback} onDone callback
+ * @returns {void}
+ */
+function fetchContextualProfile(weboCtxConf, onSuccess, onDone) {
+  const targetURL = weboCtxConf.targetURL || document.URL;
+  const token = weboCtxConf.token;
+
+  let queryString = '';
+  queryString = tryAppendQueryString(queryString, 'token', token);
+  queryString = tryAppendQueryString(queryString, 'url', targetURL);
+
+  const url = 'https://ctx.weborama.com/api/profile?' + queryString;
+
+  ajax(url, {
+    success: function (response, req) {
+      if (req.status === 200) {
+        try {
+          const data = JSON.parse(response);
+          onSuccess(data);
+          onDone();
+        } catch (e) {
+          onDone();
+          logError('unable to parse weborama data', e);
+        }
+      } else if (req.status === 204) {
+        onDone();
+      }
+    },
+    error: function () {
+      onDone();
+      logError('unable to get weborama data');
+    }
+  },
+  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,
+};
+
+submodule(MODULE_NAME, weboramaSubmodule);

package/modules/weboramaRtdProvider.md

@@ -0,0 +1,70 @@
+# Weborama Real-Time Data Submodule
+
+```
+Module Name: Weborama Rtd Provider
+Module Type: Rtd Provider
+Maintainer: prebid-support@weborama.com
+```
+
+# Description
+
+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
+
+Compile the Weborama RTD module into your Prebid build:
+
+`gulp build --modules=rtdModule,weboramaRtdProvider`
+
+Add the Weborama RTD provider to your Prebid config.
+
+```javascript
+pbjs.setConfig(
+    ...
+    realTimeData: {
+        auctionDelay: 1000,
+        dataProviders: [
+            {
+                name: "weborama",
+                waitForIt: true,
+                params: {
+                  weboCtxConf: {
+                      setTargeting: true,
+                      token: "<<token provided by weborama>>",
+                      targetURL: "..." // default is document.URL
+                    }
+                }
+            }
+        ]
+    }
+    ...
+}
+```
+
+### Parameter Descriptions for the Weborama Configuration Section
+
+| Name  |Type | Description   | Notes  |
+| :------------ | :------------ | :------------ |:------------ |
+| name | String | Real time data module name | Mandatory. Always 'Weborama' |
+| waitForIt | Boolean | Mandatory. Required to ensure that the auction is delayed until prefetch is complete | Optional. Defaults to false but recommended to true |
+| params | Object | | Optional |
+| 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.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*.|
+
+### Testing
+
+To view an example of available segments returned by Weborama's backends:
+
+`gulp serve --modules=rtdModule,weboramaRtdProvider,appnexusBidAdapter`
+
+and then point your browser at:
+
+`http://localhost:9999/integrationExamples/gpt/weboramaRtdProvider_example.html`

package/modules/winrBidAdapter.js

@@ -1,4 +1,4 @@
-import * as utils from '../src/utils.js';
+import { convertCamelToUnderscore, isArray, isNumber, isPlainObject, deepAccess, logError, convertTypes, getParameterByName, getBidRequest, isEmpty, transformBidderParamKeywords, isFn } from '../src/utils.js';
 import { config } from '../src/config.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER } from '../src/mediaTypes.js';
@@ -139,16 +139,16 @@ export const spec = {
       Object.keys(userObjBid.params.user)
         .filter((param) => includes(USER_PARAMS, param))
         .forEach((param) => {
-          let uparam = utils.convertCamelToUnderscore(param);
+          let uparam = convertCamelToUnderscore(param);
           if (
             param === 'segments' &&
-            utils.isArray(userObjBid.params.user[param])
+            isArray(userObjBid.params.user[param])
           ) {
             let segs = [];
             userObjBid.params.user[param].forEach((val) => {
-              if (utils.isNumber(val)) {
+              if (isNumber(val)) {
                 segs.push({ id: val });
-              } else if (utils.isPlainObject(val)) {
+              } else if (isPlainObject(val)) {
                 segs.push(val);
               }
             });
@@ -228,12 +228,12 @@ export const spec = {
     if (bidRequests[0].userId) {
       let eids = [];
 
-      addUserId(eids, utils.deepAccess(bidRequests[0], `userId.flocId.id`), 'chrome.com', null);
-      addUserId(eids, utils.deepAccess(bidRequests[0], `userId.criteoId`), 'criteo.com', null);
-      addUserId(eids, utils.deepAccess(bidRequests[0], `userId.netId`), 'netid.de', null);
-      addUserId(eids, utils.deepAccess(bidRequests[0], `userId.idl_env`), 'liveramp.com', null);
-      addUserId(eids, utils.deepAccess(bidRequests[0], `userId.tdid`), 'adserver.org', 'TDID');
-      addUserId(eids, utils.deepAccess(bidRequests[0], `userId.uid2.id`), 'uidapi.com', 'UID2');
+      addUserId(eids, deepAccess(bidRequests[0], `userId.flocId.id`), 'chrome.com', null);
+      addUserId(eids, deepAccess(bidRequests[0], `userId.criteoId`), 'criteo.com', null);
+      addUserId(eids, deepAccess(bidRequests[0], `userId.netId`), 'netid.de', null);
+      addUserId(eids, deepAccess(bidRequests[0], `userId.idl_env`), 'liveramp.com', null);
+      addUserId(eids, deepAccess(bidRequests[0], `userId.tdid`), 'adserver.org', 'TDID');
+      addUserId(eids, deepAccess(bidRequests[0], `userId.uid2.id`), 'uidapi.com', 'UID2');
 
       if (eids.length) {
         payload.eids = eids;
@@ -262,7 +262,7 @@ export const spec = {
       if (serverResponse && serverResponse.error) {
         errorMessage += `: ${serverResponse.error}`;
       }
-      utils.logError(errorMessage);
+      logError(errorMessage);
       return bids;
     }
 
@@ -297,12 +297,12 @@ export const spec = {
   },
 
   transformBidParams: function (params, isOpenRtb) {
-    params = utils.convertTypes(
+    params = convertTypes(
       {
         member: 'string',
         invCode: 'string',
         placementId: 'number',
-        keywords: utils.transformBidderParamKeywords,
+        keywords: transformBidderParamKeywords,
         publisherId: 'number',
       },
       params
@@ -322,7 +322,7 @@ export const spec = {
       }
 
       Object.keys(params).forEach((paramKey) => {
-        let convertedKey = utils.convertCamelToUnderscore(paramKey);
+        let convertedKey = convertCamelToUnderscore(paramKey);
         if (convertedKey !== paramKey) {
           params[convertedKey] = params[paramKey];
           delete params[paramKey];
@@ -335,7 +335,7 @@ export const spec = {
 };
 
 function isPopulatedArray(arr) {
-  return !!(utils.isArray(arr) && arr.length > 0);
+  return !!(isArray(arr) && arr.length > 0);
 }
 
 function deleteValues(keyPairObj) {
@@ -352,7 +352,7 @@ function hasPurpose1Consent(bidderRequest) {
       bidderRequest.gdprConsent.apiVersion === 2
     ) {
       result = !!(
-        utils.deepAccess(
+        deepAccess(
           bidderRequest.gdprConsent,
           'vendorData.purpose.consents.1'
         ) === true
@@ -375,7 +375,7 @@ function formatRequest(payload, bidderRequest) {
   }
 
   if (
-    utils.getParameterByName('apn_test').toUpperCase() === 'TRUE' ||
+    getParameterByName('apn_test').toUpperCase() === 'TRUE' ||
     config.getConfig('apn_test') === true
   ) {
     options.customHeaders = {
@@ -403,7 +403,7 @@ function formatRequest(payload, bidderRequest) {
  * @return Bid
  */
 function newBid(serverBid, rtbBid, bidderRequest) {
-  const bidRequest = utils.getBidRequest(serverBid.uuid, [bidderRequest]);
+  const bidRequest = getBidRequest(serverBid.uuid, [bidderRequest]);
   const bid = {
     adType: rtbBid.ad_type,
     requestId: serverBid.uuid,
@@ -463,7 +463,7 @@ function newBid(serverBid, rtbBid, bidderRequest) {
       });
     }
   } catch (error) {
-    utils.logError('Error assigning ad', error);
+    logError('Error assigning ad', error);
   }
   return bid;
 }
@@ -502,8 +502,8 @@ function bidToTag(bid) {
   if (bid.params.externalImpId) {
     tag.external_imp_id = bid.params.externalImpId;
   }
-  if (!utils.isEmpty(bid.params.keywords)) {
-    let keywords = utils.transformBidderParamKeywords(bid.params.keywords);
+  if (!isEmpty(bid.params.keywords)) {
+    let keywords = transformBidderParamKeywords(bid.params.keywords);
 
     if (keywords.length > 0) {
       keywords.forEach(deleteValues);
@@ -511,7 +511,7 @@ function bidToTag(bid) {
     tag.keywords = keywords;
   }
 
-  let gpid = utils.deepAccess(bid, 'ortb2Imp.ext.data.pbadslot');
+  let gpid = deepAccess(bid, 'ortb2Imp.ext.data.pbadslot');
   if (gpid) {
     tag.gpid = gpid;
   }
@@ -531,9 +531,9 @@ function transformSizes(requestSizes) {
   let sizeObj = {};
 
   if (
-    utils.isArray(requestSizes) &&
+    isArray(requestSizes) &&
     requestSizes.length === 2 &&
-    !utils.isArray(requestSizes[0])
+    !isArray(requestSizes[0])
   ) {
     sizeObj.width = parseInt(requestSizes[0], 10);
     sizeObj.height = parseInt(requestSizes[1], 10);
@@ -596,7 +596,7 @@ function addUserId(eids, id, source, rti) {
 }
 
 function getBidFloor(bid) {
-  if (!utils.isFn(bid.getFloor)) {
+  if (!isFn(bid.getFloor)) {
     return (bid.params.reserve) ? bid.params.reserve : null;
   }
 
@@ -605,7 +605,7 @@ function getBidFloor(bid) {
     mediaType: '*',
     size: '*'
   });
-  if (utils.isPlainObject(floor) && !isNaN(floor.floor) && floor.currency === 'USD') {
+  if (isPlainObject(floor) && !isNaN(floor.floor) && floor.currency === 'USD') {
     return floor.floor;
   }
   return null;

package/modules/wipesBidAdapter.js

@@ -1,4 +1,4 @@
-import * as utils from '../src/utils.js';
+import { logWarn } from '../src/utils.js';
 import {config} from '../src/config.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER} from '../src/mediaTypes.js';
@@ -13,7 +13,7 @@ function isBidRequestValid(bid) {
     case !!(bid.params.asid):
       break;
     default:
-      utils.logWarn(`isBidRequestValid Error. ${bid.params}, please check your implementation.`);
+      logWarn(`isBidRequestValid Error. ${bid.params}, please check your implementation.`);
       return false;
   }
   return true;