prebid.js 6.28.0 → 6.29.2

package/modules/gdprEnforcement.js

@@ -18,6 +18,8 @@ const TCF2 = {
   'purpose7': { id: 7, name: 'measurement' }
 }
 
+const VENDORLESS_MODULE_TYPES = ['fpid-module'];
+
 /*
   These rules would be used if `consentManagement.gdpr.rules` is undefined by the publisher.
 */
@@ -123,9 +125,10 @@ function getGvlidForAnalyticsAdapter(code) {
  * @param {Object} consentData - gdpr consent data
  * @param {string=} currentModule - Bidder code of the current module
  * @param {number=} gvlId - GVL ID for the module
+ * @param {string=} moduleType module type
  * @returns {boolean}
  */
-export function validateRules(rule, consentData, currentModule, gvlId) {
+export function validateRules(rule, consentData, currentModule, gvlId, moduleType) {
   const purposeId = TCF2[Object.keys(TCF2).filter(purposeName => TCF2[purposeName].name === rule.purpose)[0]].id;
 
   // return 'true' if vendor present in 'vendorExceptions'
@@ -138,12 +141,14 @@ export function validateRules(rule, consentData, currentModule, gvlId) {
   const vendorConsent = deepAccess(consentData, `vendorData.vendor.consents.${gvlId}`);
   const liTransparency = deepAccess(consentData, `vendorData.purpose.legitimateInterests.${purposeId}`);
 
+  const vendorlessModule = includes(VENDORLESS_MODULE_TYPES, moduleType);
+
   /*
     Since vendor exceptions have already been handled, the purpose as a whole is allowed if it's not being enforced
     or the user has consented. Similar with vendors.
   */
   const purposeAllowed = rule.enforcePurpose === false || purposeConsent === true;
-  const vendorAllowed = rule.enforceVendor === false || vendorConsent === true;
+  const vendorAllowed = rule.enforceVendor === false || vendorConsent === true || vendorlessModule === true;
 
   /*
     Few if any vendors should be declaring Legitimate Interest for Device Access (Purpose 1), but some are claiming
@@ -162,15 +167,16 @@ export function validateRules(rule, consentData, currentModule, gvlId) {
  * @param {Function} fn reference to original function (used by hook logic)
  * @param {Number=} gvlid gvlid of the module
  * @param {string=} moduleName name of the module
+ * @param {string=} moduleType module type
  */
-export function deviceAccessHook(fn, gvlid, moduleName, result) {
+export function deviceAccessHook(fn, gvlid, moduleName, moduleType, result) {
   result = Object.assign({}, {
     hasEnforcementHook: true
   });
   if (!hasDeviceAccess()) {
     logWarn('Device access is disabled by Publisher');
     result.valid = false;
-    fn.call(this, gvlid, moduleName, result);
+    fn.call(this, gvlid, moduleName, moduleType, result);
   } else {
     const consentData = gdprDataHandler.getConsentData();
     if (consentData && consentData.gdprApplies) {
@@ -183,24 +189,24 @@ export function deviceAccessHook(fn, gvlid, moduleName, result) {
           gvlid = getGvlid(moduleName) || gvlid;
         }
         const curModule = moduleName || curBidder;
-        let isAllowed = validateRules(purpose1Rule, consentData, curModule, gvlid);
+        let isAllowed = validateRules(purpose1Rule, consentData, curModule, gvlid, moduleType);
         if (isAllowed) {
           result.valid = true;
-          fn.call(this, gvlid, moduleName, result);
+          fn.call(this, gvlid, moduleName, moduleType, result);
         } else {
           curModule && logWarn(`TCF2 denied device access for ${curModule}`);
           result.valid = false;
           storageBlocked.push(curModule);
-          fn.call(this, gvlid, moduleName, result);
+          fn.call(this, gvlid, moduleName, moduleType, result);
         }
       } else {
         // The module doesn't enforce TCF1.1 strings
         result.valid = true;
-        fn.call(this, gvlid, moduleName, result);
+        fn.call(this, gvlid, moduleName, moduleType, result);
       }
     } else {
       result.valid = true;
-      fn.call(this, gvlid, moduleName, result);
+      fn.call(this, gvlid, moduleName, moduleType, result);
     }
   }
 }

package/modules/insticatorBidAdapter.js

@@ -1,5 +1,5 @@
 import {config} from '../src/config.js';
-import {BANNER} from '../src/mediaTypes.js';
+import {BANNER, VIDEO} from '../src/mediaTypes.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {deepAccess, generateUUID, logError, isArray} from '../src/utils.js';
 import {getStorageManager} from '../src/storageManager.js';
@@ -48,14 +48,9 @@ function setUserId(userId) {
   }
 }
 
-function buildImpression(bidRequest) {
+function buildBanner(bidRequest) {
   const format = [];
-  const ext = {
-    insticator: {
-      adUnitId: bidRequest.params.adUnitId,
-    },
-  }
-
+  const pos = deepAccess(bidRequest, 'mediaTypes.banner.pos');
   const sizes =
     deepAccess(bidRequest, 'mediaTypes.banner.sizes') || bidRequest.sizes;
 
@@ -66,27 +61,47 @@ function buildImpression(bidRequest) {
     });
   }
 
-  const gpid = deepAccess(bidRequest, 'ortb2Imp.ext.gpid');
-
-  if (gpid) {
-    ext.gpid = gpid;
+  return {
+    format,
+    pos,
   }
+}
 
-  const instl = deepAccess(bidRequest, 'ortb2Imp.instl')
-  const secure = location.protocol === 'https:' ? 1 : 0;
-  const pos = deepAccess(bidRequest, 'mediaTypes.banner.pos');
+function buildVideo(bidRequest) {
+  const w = deepAccess(bidRequest, 'mediaTypes.video.w');
+  const h = deepAccess(bidRequest, 'mediaTypes.video.h');
+  const mimes = deepAccess(bidRequest, 'mediaTypes.video.mimes');
 
   return {
+    mimes,
+    w,
+    h,
+  }
+}
+
+function buildImpression(bidRequest) {
+  const imp = {
     id: bidRequest.bidId,
     tagid: bidRequest.adUnitCode,
-    instl,
-    secure,
-    banner: {
-      format,
-      pos,
+    instl: deepAccess(bidRequest, 'ortb2Imp.instl'),
+    secure: location.protocol === 'https:' ? 1 : 0,
+    ext: {
+      gpid: deepAccess(bidRequest, 'ortb2Imp.ext.gpid'),
+      insticator: {
+        adUnitId: bidRequest.params.adUnitId,
+      },
     },
-    ext,
-  };
+  }
+
+  if (deepAccess(bidRequest, 'mediaTypes.banner')) {
+    imp.banner = buildBanner(bidRequest);
+  }
+
+  if (deepAccess(bidRequest, 'mediaTypes.video')) {
+    imp.video = buildVideo(bidRequest);
+  }
+
+  return imp;
 }
 
 function buildDevice() {
@@ -252,31 +267,83 @@ function validateSizes(sizes) {
   );
 }
 
-export const spec = {
-  code: BIDDER_CODE,
-  gvlid: GVLID,
-  supportedMediaTypes: [BANNER],
+function validateAdUnitId(bid) {
+  if (!bid.params.adUnitId) {
+    logError('insticator: missing adUnitId bid parameter');
+    return false;
+  }
 
-  isBidRequestValid: function (bid) {
-    if (!bid.params.adUnitId) {
-      logError('insticator: missing adUnitId bid parameter');
-      return false;
-    }
+  return true;
+}
 
-    if (!(BANNER in bid.mediaTypes)) {
-      logError('insticator: expected banner in mediaTypes');
-      return false;
-    }
+function validateMediaType(bid) {
+  if (!(BANNER in bid.mediaTypes || VIDEO in bid.mediaTypes)) {
+    logError('insticator: expected banner or video in mediaTypes');
+    return false;
+  }
 
-    if (
-      !validateSizes(bid.sizes) &&
-      !validateSizes(bid.mediaTypes.banner.sizes)
-    ) {
-      logError('insticator: banner sizes not specified or invalid');
-      return false;
-    }
+  return true;
+}
 
+function validateBanner(bid) {
+  const banner = deepAccess(bid, 'mediaTypes.banner');
+
+  if (banner === undefined) {
     return true;
+  }
+
+  if (
+    !validateSizes(bid.sizes) &&
+    !validateSizes(bid.mediaTypes.banner.sizes)
+  ) {
+    logError('insticator: banner sizes not specified or invalid');
+    return false;
+  }
+
+  return true;
+}
+
+function validateVideo(bid) {
+  const video = deepAccess(bid, 'mediaTypes.video');
+
+  if (video === undefined) {
+    return true;
+  }
+
+  const videoSize = [
+    deepAccess(bid, 'mediaTypes.video.w'),
+    deepAccess(bid, 'mediaTypes.video.h'),
+  ];
+
+  if (
+    !validateSize(videoSize)
+  ) {
+    logError('insticator: video size not specified or invalid');
+    return false;
+  }
+
+  const mimes = deepAccess(bid, 'mediaTypes.video.mimes');
+
+  if (!Array.isArray(mimes) || mimes.length === 0) {
+    logError('insticator: mimes not specified');
+    return false;
+  }
+
+  return true;
+}
+
+export const spec = {
+  code: BIDDER_CODE,
+  gvlid: GVLID,
+  supportedMediaTypes: [ BANNER, VIDEO ],
+
+  isBidRequestValid: function (bid) {
+    return (
+      validateAdUnitId(bid) &&
+      validateMediaType(bid) &&
+      validateBanner(bid) &&
+      validateVideo(bid)
+    );
   },
 
   buildRequests: function (validBidRequests, bidderRequest) {

package/modules/ixBidAdapter.js

@@ -30,7 +30,8 @@ import {Renderer} from '../src/Renderer.js';
 const BIDDER_CODE = 'ix';
 const ALIAS_BIDDER_CODE = 'roundel';
 const GLOBAL_VENDOR_ID = 10;
-const SECURE_BID_URL = 'https://htlb.casalemedia.com/cygnus';
+const MODULE_TYPE = 'bid-adapter';
+const SECURE_BID_URL = 'https://htlb.casalemedia.com/openrtb/pbjs';
 const SUPPORTED_AD_TYPES = [BANNER, VIDEO];
 const BANNER_ENDPOINT_VERSION = 7.2;
 const VIDEO_ENDPOINT_VERSION = 8.1;
@@ -1086,7 +1087,7 @@ function localStorageHandler(data) {
       hasEnforcementHook: false,
       valid: hasDeviceAccess()
     };
-    validateStorageEnforcement(GLOBAL_VENDOR_ID, BIDDER_CODE, DEFAULT_ENFORCEMENT_SETTINGS, (permissions) => {
+    validateStorageEnforcement(GLOBAL_VENDOR_ID, BIDDER_CODE, MODULE_TYPE, DEFAULT_ENFORCEMENT_SETTINGS, (permissions) => {
       if (permissions.valid) {
         storeErrorEventData(data);
       }

package/modules/ixBidAdapter.md

@@ -423,4 +423,4 @@ The `size` parameter is no longer a required field, the `siteId` will now be ass
 In your browser of choice, create a new tab and open the developer tools. In
 developer tools, select the network tab. Then, navigate to a page where IX is
 setup to bid. Now, in the network tab, search for requests to
-`casalemedia.com/cygnus`. These are the bid requests.
+`casalemedia.com/openrtb/pbjs`. These are the bid requests.

package/modules/lassoBidAdapter.js

@@ -0,0 +1,133 @@
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER } from '../src/mediaTypes.js';
+import { getStorageManager } from '../src/storageManager.js';
+import { ajax } from '../src/ajax.js';
+import { config } from '../src/config.js';
+
+const BIDDER_CODE = 'lasso';
+const ENDPOINT_URL = 'https://trc.lhmos.com/prebid';
+const GET_IUD_URL = 'https://secure.adnxs.com/getuid?';
+const COOKIE_NAME = 'aim-xr';
+const storage = getStorageManager({bidderCode: BIDDER_CODE});
+
+export const spec = {
+  code: BIDDER_CODE,
+  isBidRequestValid: function(bid) {
+    return !!(bid.params && bid.params.adUnitId);
+  },
+
+  buildRequests: function(validBidRequests, bidderRequest) {
+    if (validBidRequests.length === 0) {
+      return [];
+    }
+
+    let aimXR = '';
+    if (storage.cookiesAreEnabled) {
+      aimXR = storage.getCookie(COOKIE_NAME, undefined);
+    }
+
+    return validBidRequests.map(bidRequest => {
+      let sizes = []
+      if (bidRequest.mediaTypes && bidRequest.mediaTypes[BANNER] && bidRequest.mediaTypes[BANNER].sizes) {
+        sizes = bidRequest.mediaTypes[BANNER].sizes;
+      }
+
+      const payload = {
+        auctionStart: bidderRequest.auctionStart,
+        url: encodeURIComponent(window.location.href),
+        bidderRequestId: bidRequest.bidderRequestId,
+        adUnitCode: bidRequest.adUnitCode,
+        auctionId: bidRequest.auctionId,
+        bidId: bidRequest.bidId,
+        transactionId: bidRequest.transactionId,
+        device: JSON.stringify(getDeviceData()),
+        sizes,
+        aimXR,
+        uid: '$UID',
+        params: JSON.stringify(bidRequest.params),
+        crumbs: JSON.stringify(bidRequest.crumbs),
+        prebidVersion: '$prebid.version$',
+        version: 1,
+        coppa: config.getConfig('coppa') == true ? 1 : 0,
+        ccpa: bidderRequest.uspConsent || undefined
+      }
+
+      return {
+        method: 'GET',
+        url: getBidRequestUrl(aimXR),
+        data: payload,
+        options: {
+          withCredentials: false
+        },
+      };
+    });
+  },
+
+  interpretResponse: function(serverResponse) {
+    const response = serverResponse && serverResponse.body;
+    const bidResponses = [];
+
+    if (!response) {
+      return bidResponses;
+    }
+
+    const bidResponse = {
+      requestId: response.bidid,
+      cpm: response.bid.price,
+      currency: response.cur,
+      width: response.bid.w,
+      height: response.bid.h,
+      creativeId: response.bid.crid,
+      netRevenue: response.netRevenue,
+      ttl: response.ttl,
+      ad: response.bid.ad,
+      mediaType: response.bid.mediaType,
+      meta: {
+        secondaryCatIds: response.bid.cat,
+        advertiserDomains: response.bid.advertiserDomains,
+        advertiserName: response.meta.advertiserName,
+        mediaType: response.bid.mediaType
+      }
+    };
+    bidResponses.push(bidResponse);
+    return bidResponses;
+  },
+
+  onTimeout: function(timeoutData) {
+    if (timeoutData === null) {
+      return;
+    }
+    ajax(ENDPOINT_URL + '/timeout', null, JSON.stringify(timeoutData), {
+      method: 'POST',
+      withCredentials: false
+    });
+  },
+
+  onBidWon: function(bid) {
+    ajax(ENDPOINT_URL + '/won', null, JSON.stringify(bid), {
+      method: 'POST',
+      withCredentials: false
+    });
+  },
+
+  supportedMediaTypes: [BANNER]
+}
+
+function getBidRequestUrl(aimXR) {
+  if (!aimXR) {
+    return GET_IUD_URL + ENDPOINT_URL + '/request';
+  }
+  return ENDPOINT_URL + '/request'
+}
+
+function getDeviceData() {
+  const win = window.top;
+  return {
+    ua: navigator.userAgent,
+    width: win.innerWidth || win.document.documentElement.clientWidth || win.document.body.clientWidth,
+    height: win.innerHeight || win.document.documentElement.clientHeight || win.document.body.clientHeight,
+    browserLanguage: navigator.language,
+  }
+}
+
+registerBidder(spec);

package/modules/lassoBidAdapter.md

@@ -0,0 +1,29 @@
+# Overview
+
+**Module Name**: Lasso Bidder Adapter  
+**Module Type**: Bidder Adapter  
+**Maintainer**: headerbidding@lassomarketing.io
+
+# Description
+
+Connects to Lasso demand source to fetch bids.
+Only banner format supported.
+
+# Test Parameters
+
+```
+var adUnits = [{
+   code: 'banner-ad-unit',
+   mediaTypes: {
+      banner: {
+          sizes: [[300, 250]],
+      }
+   },
+   bids: [{
+     bidder: 'lasso',
+     params: {
+       adUnitId: '0'
+     }
+   }]
+}];
+```

package/modules/merkleIdSystem.js

@@ -11,7 +11,7 @@ import {submodule} from '../src/hook.js'
 import {getStorageManager} from '../src/storageManager.js';
 
 const MODULE_NAME = 'merkleId';
-const ID_URL = 'https://id2.sv.rkdms.com/identity/';
+const ID_URL = 'https://prebid.sv.rkdms.com/identity/';
 const DEFAULT_REFRESH = 7 * 3600;
 const SESSION_COOKIE_NAME = '_svsid';
 
@@ -30,19 +30,19 @@ function getSession(configParams) {
 function setCookie(name, value, expires) {
   let expTime = new Date();
   expTime.setTime(expTime.getTime() + expires * 1000 * 60);
-  storage.setCookie(name, value, expTime.toUTCString());
+  storage.setCookie(name, value, expTime.toUTCString(), 'Lax');
 }
 
 function setSession(storage, response) {
-  logInfo('Merkle setting session ');
-  if (response && response.c && response.c.value && typeof response.c.value === 'string') {
-    setCookie(SESSION_COOKIE_NAME, response.c.value, storage.expires);
+  logInfo('Merkle setting ' + `${SESSION_COOKIE_NAME}`);
+  if (response && response[SESSION_COOKIE_NAME] && typeof response[SESSION_COOKIE_NAME] === 'string') {
+    setCookie(SESSION_COOKIE_NAME, response[SESSION_COOKIE_NAME], storage.expires);
   }
 }
 
 function constructUrl(configParams) {
   const session = getSession(configParams);
-  let url = configParams.endpoint + `?vendor=${configParams.vendor}&sv_cid=${configParams.sv_cid}&sv_domain=${configParams.sv_domain}&sv_pubid=${configParams.sv_pubid}`;
+  let url = configParams.endpoint + `?sv_domain=${configParams.sv_domain}&sv_pubid=${configParams.sv_pubid}&ssp_ids=${configParams.ssp_ids.join()}`;
   if (session) {
     url = `${url}&sv_session=${session}`;
   }
@@ -86,45 +86,52 @@ function generateId(configParams, configStorage) {
 /** @type {Submodule} */
 export const merkleIdSubmodule = {
   /**
-   * used to link submodule with config
-   * @type {string}
-   */
+     * used to link submodule with config
+     * @type {string}
+     */
   name: MODULE_NAME,
+
   /**
-   * decode the stored id value for passing to bid requests
-   * @function
-   * @param {string} value
-   * @returns {{merkleId:string}}
-   */
+     * decode the stored id value for passing to bid requests
+     * @function
+     * @param {string} value
+     * @returns {{eids:arrayofields}}
+     */
   decode(value) {
+    // Legacy support for a single id
     const id = (value && value.pam_id && typeof value.pam_id.id === 'string') ? value.pam_id : undefined;
     logInfo('Merkle id ' + JSON.stringify(id));
-    return id ? {'merkleId': id} : undefined;
+
+    if (id) {
+      return {'merkleId': id}
+    }
+
+    // Supports multiple IDs for different SSPs
+    const merkleIds = (value && value?.merkleId && Array.isArray(value.merkleId)) ? value.merkleId : undefined;
+    logInfo('merkleIds: ' + JSON.stringify(merkleIds));
+
+    return merkleIds ? {'merkleId': merkleIds} : undefined;
   },
+
   /**
-   * performs action to obtain id and return a value in the callback's response argument
-   * @function
-   * @param {SubmoduleConfig} [config]
-   * @param {ConsentData} [consentData]
-   * @returns {IdResponse|undefined}
-   */
+     * performs action to obtain id and return a value in the callback's response argument
+     * @function
+     * @param {SubmoduleConfig} [config]
+     * @param {ConsentData} [consentData]
+     * @returns {IdResponse|undefined}
+     */
   getId(config, consentData) {
     logInfo('User ID - merkleId generating id');
 
     const configParams = (config && config.params) || {};
 
-    if (!configParams || typeof configParams.vendor !== 'string') {
-      logError('User ID - merkleId submodule requires a valid vendor to be defined');
-      return;
-    }
-
-    if (typeof configParams.sv_cid !== 'string') {
-      logError('User ID - merkleId submodule requires a valid sv_cid string to be defined');
+    if (typeof configParams.sv_pubid !== 'string') {
+      logError('User ID - merkleId submodule requires a valid sv_pubid string to be defined');
       return;
     }
 
-    if (typeof configParams.sv_pubid !== 'string') {
-      logError('User ID - merkleId submodule requires a valid sv_pubid string to be defined');
+    if (!Array.isArray(configParams.ssp_ids)) {
+      logError('User ID - merkleId submodule requires a valid ssp_ids array to be defined');
       return;
     }
 
@@ -132,6 +139,7 @@ export const merkleIdSubmodule = {
       logError('User ID - merkleId submodule does not currently handle consent strings');
       return;
     }
+
     if (typeof configParams.endpoint !== 'string') {
       logWarn('User ID - merkleId submodule endpoint string is not defined');
       configParams.endpoint = ID_URL
@@ -146,7 +154,7 @@ export const merkleIdSubmodule = {
     return {callback: resp};
   },
   extendId: function (config = {}, consentData, storedId) {
-    logInfo('User ID - merkleId stored id ' + storedId);
+    logInfo('User ID - stored id ' + storedId);
     const configParams = (config && config.params) || {};
 
     if (typeof configParams.endpoint !== 'string') {
@@ -162,15 +170,18 @@ export const merkleIdSubmodule = {
     if (typeof configParams.sv_domain !== 'string') {
       configParams.sv_domain = merkleIdSubmodule.findRootDomain();
     }
+
     const configStorage = (config && config.storage) || {};
     if (configStorage && configStorage.refreshInSeconds && typeof configParams.refreshInSeconds === 'number') {
       return {id: storedId};
     }
+
     let refreshInSeconds = DEFAULT_REFRESH;
     if (configParams && configParams.refreshInSeconds && typeof configParams.refreshInSeconds === 'number') {
       refreshInSeconds = configParams.refreshInSeconds;
       logInfo('User ID - merkleId param refreshInSeconds' + refreshInSeconds);
     }
+
     const storedDate = new Date(storedId.date);
     let refreshNeeded = false;
     if (storedDate) {
@@ -181,6 +192,7 @@ export const merkleIdSubmodule = {
         return {callback: resp};
       }
     }
+
     logInfo('User ID - merkleId not refreshed');
     return {id: storedId};
   }

package/modules/pubCommonId.js

@@ -9,7 +9,8 @@ import * as events from '../src/events.js';
 import CONSTANTS from '../src/constants.json';
 import { getStorageManager } from '../src/storageManager.js';
 
-const storage = getStorageManager();
+const MODULE_TYPE = 'fpid-module';
+const storage = getStorageManager({moduleType: MODULE_TYPE});
 
 const ID_NAME = '_pubcid';
 const OPTOUT_NAME = '_pubcid_optout';