prebid.js 6.2.0 → 6.6.0

package/modules/glimpseBidAdapter.js

@@ -40,28 +40,21 @@ export const spec = {
    * @returns {ServerRequest}
    */
   buildRequests: (validBidRequests, bidderRequest) => {
-    const demo = config.getConfig('glimpse.demo') || false
-    const account = config.getConfig('glimpse.account') || -1
-    const demand = config.getConfig('glimpse.demand') || 'glimpse'
-    const keywords = config.getConfig('glimpse.keywords') || {}
-
     const auth = getVaultJwt()
     const referer = getReferer(bidderRequest)
     const gdprConsent = getGdprConsentChoice(bidderRequest)
-    const bids = validBidRequests.map((bidRequest) => {
-      return processBidRequest(bidRequest, keywords)
-    })
+    const bidRequests = validBidRequests.map(processBidRequest)
+    const firstPartyData = getFirstPartyData()
 
     const data = {
       auth,
       data: {
-        bidderCode: spec.code,
-        demo,
-        account,
-        demand,
         referer,
         gdprConsent,
-        bids,
+        bidRequests,
+        site: firstPartyData.site,
+        user: firstPartyData.user,
+        bidderCode: spec.code,
       }
     }
 
@@ -91,35 +84,12 @@ export const spec = {
   },
 }
 
-function processBidRequest(bidRequest, globalKeywords) {
-  const sizes = normalizeSizes(bidRequest.sizes)
-  const bidKeywords = bidRequest.params.keywords || {}
-  const keywords = {
-    ...globalKeywords,
-    ...bidKeywords,
-  }
-
-  return {
-    unitCode: bidRequest.adUnitCode,
-    bidId: bidRequest.bidId,
-    placementId: bidRequest.params.placementId,
-    keywords,
-    sizes,
-  }
+function setVaultJwt(auth) {
+  storageManager.setDataInLocalStorage(LOCAL_STORAGE_KEY.vault.jwt, auth)
 }
 
-function normalizeSizes(sizes) {
-  const isSingleSize =
-    isArray(sizes) &&
-    sizes.length === 2 &&
-    !isArray(sizes[0]) &&
-    !isArray(sizes[1])
-
-  if (isSingleSize) {
-    return [sizes]
-  }
-
-  return sizes
+function getVaultJwt() {
+  return storageManager.getDataFromLocalStorage(LOCAL_STORAGE_KEY.vault.jwt) || ''
 }
 
 function getReferer(bidderRequest) {
@@ -138,11 +108,17 @@ function getReferer(bidderRequest) {
 function getGdprConsentChoice(bidderRequest) {
   const hasGdprConsent =
     hasValue(bidderRequest) &&
-    hasValue(bidderRequest.gdprConsent) &&
-    hasStringValue(bidderRequest.gdprConsent.consentString)
+    hasValue(bidderRequest.gdprConsent)
 
   if (hasGdprConsent) {
-    return bidderRequest.gdprConsent
+    const gdprConsent = bidderRequest.gdprConsent
+    const hasGdprApplies = hasBooleanValue(gdprConsent.gdprApplies)
+
+    return {
+      consentString: gdprConsent.consentString || '',
+      vendorData: gdprConsent.vendorData || {},
+      gdprApplies: hasGdprApplies ? gdprConsent.gdprApplies : true,
+    }
   }
 
   return {
@@ -152,12 +128,64 @@ function getGdprConsentChoice(bidderRequest) {
   }
 }
 
-function setVaultJwt(auth) {
-  storageManager.setDataInLocalStorage(LOCAL_STORAGE_KEY.vault.jwt, auth)
+function processBidRequest(bidRequest) {
+  const demand = bidRequest.params.demand || 'glimpse'
+  const sizes = normalizeSizes(bidRequest.sizes)
+  const keywords = bidRequest.params.keywords || {}
+
+  return {
+    demand,
+    sizes,
+    keywords,
+    bidId: bidRequest.bidId,
+    placementId: bidRequest.params.placementId,
+    unitCode: bidRequest.adUnitCode,
+  }
 }
 
-function getVaultJwt() {
-  return storageManager.getDataFromLocalStorage(LOCAL_STORAGE_KEY.vault.jwt) || ''
+function normalizeSizes(sizes) {
+  const isSingleSize =
+    isArray(sizes) &&
+    sizes.length === 2 &&
+    !isArray(sizes[0]) &&
+    !isArray(sizes[1])
+
+  if (isSingleSize) {
+    return [sizes]
+  }
+
+  return sizes
+}
+
+function getFirstPartyData() {
+  const siteKeywords = parseGlobalKeywords('site')
+  const userKeywords = parseGlobalKeywords('user')
+
+  const siteAttributes = getConfig('ortb2.site.ext.data', {})
+  const userAttributes = getConfig('ortb2.user.ext.data', {})
+
+  return {
+    site: {
+      keywords: siteKeywords,
+      attributes: siteAttributes,
+    },
+    user: {
+      keywords: userKeywords,
+      attributes: userAttributes,
+    },
+  }
+}
+
+function parseGlobalKeywords(scope) {
+  const keywords = getConfig(`ortb2.${scope}.keywords`, '')
+
+  return keywords
+    .split(', ')
+    .filter((keyword) => keyword !== '')
+}
+
+function getConfig(path, defaultValue) {
+  return config.getConfig(path) || defaultValue
 }
 
 function isValidBidResponse(bidResponse) {
@@ -177,6 +205,13 @@ function hasValue(value) {
   )
 }
 
+function hasBooleanValue(value) {
+  return (
+    hasValue(value) &&
+    typeof value === 'boolean'
+  )
+}
+
 function hasStringValue(value) {
   return (
     hasValue(value) &&

package/modules/gptPreAuction.js

@@ -48,10 +48,35 @@ const sanitizeSlotPath = (path) => {
   return path;
 }
 
+const defaultPreAuction = (adUnit, adServerAdSlot) => {
+  const context = adUnit.ortb2Imp.ext.data;
+
+  // use pbadslot if supplied
+  if (context.pbadslot) {
+    return context.pbadslot;
+  }
+
+  // confirm that GPT is set up
+  if (!isGptPubadsDefined()) {
+    return;
+  }
+
+  // find all GPT slots with this name
+  var gptSlots = window.googletag.pubads().getSlots().filter(slot => slot.getAdUnitPath() === adServerAdSlot);
+
+  if (gptSlots.length === 0) {
+    return; // should never happen
+  }
+
+  if (gptSlots.length === 1) {
+    return adServerAdSlot;
+  }
+
+  // else the adunit code must be div id. append it.
+  return `${adServerAdSlot}#${adUnit.code}`;
+}
+
 export const appendPbAdSlot = adUnit => {
-  adUnit.ortb2Imp = adUnit.ortb2Imp || {};
-  adUnit.ortb2Imp.ext = adUnit.ortb2Imp.ext || {};
-  adUnit.ortb2Imp.ext.data = adUnit.ortb2Imp.ext.data || {};
   const context = adUnit.ortb2Imp.ext.data;
   const { customPbAdSlot } = _currentConfig;
 
@@ -84,11 +109,32 @@ export const appendPbAdSlot = adUnit => {
 
 export const makeBidRequestsHook = (fn, adUnits, ...args) => {
   appendGptSlots(adUnits);
+  const { useDefaultPreAuction, customPreAuction } = _currentConfig;
   adUnits.forEach(adUnit => {
-    const usedAdUnitCode = appendPbAdSlot(adUnit);
-    // gpid should be set to itself if already set, or to what pbadslot was (as long as it was not adUnit code)
-    if (!adUnit.ortb2Imp.ext.gpid && !usedAdUnitCode) {
-      adUnit.ortb2Imp.ext.gpid = adUnit.ortb2Imp.ext.data.pbadslot;
+    // init the ortb2Imp if not done yet
+    adUnit.ortb2Imp = adUnit.ortb2Imp || {};
+    adUnit.ortb2Imp.ext = adUnit.ortb2Imp.ext || {};
+    adUnit.ortb2Imp.ext.data = adUnit.ortb2Imp.ext.data || {};
+    const context = adUnit.ortb2Imp.ext;
+
+    // if neither new confs set do old stuff
+    if (!customPreAuction && !useDefaultPreAuction) {
+      const usedAdUnitCode = appendPbAdSlot(adUnit);
+      // gpid should be set to itself if already set, or to what pbadslot was (as long as it was not adUnit code)
+      if (!context.gpid && !usedAdUnitCode) {
+        context.gpid = context.data.pbadslot;
+      }
+    } else {
+      let adserverSlot = deepAccess(context, 'data.adserver.adslot');
+      let result;
+      if (customPreAuction) {
+        result = customPreAuction(adUnit, adserverSlot);
+      } else if (useDefaultPreAuction) {
+        result = defaultPreAuction(adUnit, adserverSlot);
+      }
+      if (result) {
+        context.gpid = context.data.pbadslot = result;
+      }
     }
   });
   return fn.call(this, adUnits, ...args);
@@ -100,6 +146,8 @@ const handleSetGptConfig = moduleConfig => {
     'customGptSlotMatching', customGptSlotMatching =>
       typeof customGptSlotMatching === 'function' && customGptSlotMatching,
     'customPbAdSlot', customPbAdSlot => typeof customPbAdSlot === 'function' && customPbAdSlot,
+    'customPreAuction', customPreAuction => typeof customPreAuction === 'function' && customPreAuction,
+    'useDefaultPreAuction', useDefaultPreAuction => useDefaultPreAuction === true,
   ]);
 
   if (_currentConfig.enabled) {

package/modules/gridBidAdapter.js

@@ -291,10 +291,11 @@ export const spec = {
     if (!hasSynced && syncOptions.pixelEnabled) {
       let params = '';
 
-      if (gdprConsent && typeof gdprConsent.consentString === 'string') {
+      if (gdprConsent) {
         if (typeof gdprConsent.gdprApplies === 'boolean') {
-          params += `&gdpr=${Number(gdprConsent.gdprApplies)}&gdpr_consent=${gdprConsent.consentString}`;
-        } else {
+          params += `&gdpr=${Number(gdprConsent.gdprApplies)}`;
+        }
+        if (typeof gdprConsent.consentString === 'string') {
           params += `&gdpr_consent=${gdprConsent.consentString}`;
         }
       }

package/modules/gumgumBidAdapter.js

@@ -296,8 +296,8 @@ function buildRequests(validBidRequests, bidderRequest) {
     let gpid = '';
 
     const date = new Date();
-    const lt = date && date.getTime();
-    const to = date && date.getTimezoneOffset();
+    const lt = date.getTime();
+    const to = date.getTimezoneOffset();
     if (to) {
       lt && (data.lt = lt);
       data.to = to;

package/modules/idImportLibrary.js

@@ -9,6 +9,7 @@ let conf;
 const LOG_PRE_FIX = 'ID-Library: ';
 const CONF_DEFAULT_OBSERVER_DEBOUNCE_MS = 250;
 const CONF_DEFAULT_FULL_BODY_SCAN = false;
+const CONF_DEFAULT_INPUT_SCAN = false;
 const OBSERVER_CONFIG = {
   subtree: true,
   attributes: true,
@@ -78,7 +79,13 @@ function targetAction(mutations, observer) {
   }
 }
 
-function addInputElementsElementListner(conf) {
+function addInputElementsElementListner() {
+  if (doesInputElementsHaveEmail()) {
+    _logInfo('Email found in input elements ' + email);
+    _logInfo('Post data on email found in target without');
+    postData();
+    return;
+  }
   _logInfo('Adding input element listeners');
   const inputs = document.querySelectorAll('input[type=text], input[type=email]');
 
@@ -89,6 +96,19 @@ function addInputElementsElementListner(conf) {
   }
 }
 
+function addFormInputElementsElementListner(id) {
+  _logInfo('Adding input element listeners');
+  if (doesFormInputElementsHaveEmail(id)) {
+    _logInfo('Email found in input elements ' + email);
+    postData();
+    return;
+  }
+  _logInfo('Adding input element listeners');
+  const input = document.getElementById(id);
+  input.addEventListener('change', event => processInputChange(event));
+  input.addEventListener('blur', event => processInputChange(event));
+}
+
 function removeInputElementsElementListner() {
   _logInfo('Removing input element listeners');
   const inputs = document.querySelectorAll('input[type=text], input[type=email]');
@@ -149,12 +169,6 @@ function handleTargetElement() {
 }
 
 function handleBodyElements() {
-  if (doesInputElementsHaveEmail()) {
-    _logInfo('Email found in input elements ' + email);
-    _logInfo('Post data on email found in target without');
-    postData();
-    return;
-  }
   email = getEmail(document.body.innerHTML);
   if (email !== null) {
     _logInfo('Email found in body ' + email);
@@ -162,7 +176,7 @@ function handleBodyElements() {
     postData();
     return;
   }
-  addInputElementsElementListner();
+
   if (conf.fullscan === true) {
     const bodyObserver = new MutationObserver(debounce(bodyAction, conf.debounce, false));
     bodyObserver.observe(document.body, OBSERVER_CONFIG);
@@ -182,6 +196,17 @@ function doesInputElementsHaveEmail() {
   return false;
 }
 
+function doesFormInputElementsHaveEmail(formElementId) {
+  const input = document.getElementById(formElementId);
+  if (input) {
+    email = getEmail(input.value);
+    if (email !== null) {
+      return true;
+    }
+  }
+  return false;
+}
+
 function syncCallback() {
   return {
     success: function () {
@@ -213,6 +238,10 @@ function associateIds() {
   if (window.MutationObserver || window.WebKitMutationObserver) {
     if (conf.target) {
       handleTargetElement();
+    } else if (conf.formElementId) {
+      addFormInputElementsElementListner(conf.formElementId);
+    } else if (conf.inputscan) {
+      addInputElementsElementListner();
     } else {
       handleBodyElements();
     }
@@ -236,6 +265,14 @@ export function setConfig(config) {
     config.fullscan = CONF_DEFAULT_FULL_BODY_SCAN;
     _logInfo('Set default fullscan ' + CONF_DEFAULT_FULL_BODY_SCAN);
   }
+  if (typeof config.inputscan !== 'boolean') {
+    config.inputscan = CONF_DEFAULT_INPUT_SCAN;
+    _logInfo('Set default input scan ' + CONF_DEFAULT_INPUT_SCAN);
+  }
+
+  if (typeof config.formElementId == 'string') {
+    _logInfo('Looking for formElementId ' + config.formElementId);
+  }
   conf = config;
   associateIds();
 }

package/modules/idImportLibrary.md

@@ -8,6 +8,8 @@
 | `url`      | Yes      | String  | N/A     | URL endpoint used to post the hashed email and user IDs. |
 | `debounce` | No       | Number  | 250     | Time in milliseconds before the email and IDs are fetched. |
 | `fullscan` | No       | Boolean | false   | Enable/disable a full page body scan to get email. |
+| `formElementId`   | No      | String  | N/A     | ID attribute of the input (type=text/email)  from which the email can be read. |
+| `inputscan`   | No      | Boolean  | N/A     | Enable/disable a input element (type=text/email) scan to get email. |
 
 ## Example
 
@@ -18,5 +20,7 @@ pbjs.setConfig({
         url: 'https://example.com',
         debounce: 250,
         fullscan: false,
+        inputscan: false,
+        formElementId: "userid"
     },
 });

package/modules/improvedigitalBidAdapter.js

@@ -1,4 +1,4 @@
-import { deepSetValue, logError, _each, getBidRequest, isNumber, isArray, deepAccess, isFn, isPlainObject, logWarn, getBidIdParameter, getUniqueIdentifierStr, isEmpty, isInteger } from '../src/utils.js';
+import { deepSetValue, logError, _each, getBidRequest, isNumber, isArray, deepAccess, isFn, isPlainObject, logWarn, getBidIdParameter, getUniqueIdentifierStr, isEmpty, isInteger, isStr } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { config } from '../src/config.js';
 import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
@@ -11,7 +11,7 @@ const RENDERER_URL = 'https://acdn.adnxs.com/video/outstream/ANOutstreamVideo.js
 const VIDEO_TARGETING = ['skip', 'skipmin', 'skipafter'];
 
 export const spec = {
-  version: '7.4.0',
+  version: '7.6.0',
   code: BIDDER_CODE,
   gvlid: 253,
   aliases: ['id'],
@@ -45,8 +45,24 @@ export const spec = {
       libVersion: this.version
     };
 
-    if (bidderRequest && bidderRequest.gdprConsent && bidderRequest.gdprConsent.consentString) {
-      requestParameters.gdpr = bidderRequest.gdprConsent.consentString;
+    const gdprConsent = deepAccess(bidderRequest, 'gdprConsent')
+    if (gdprConsent) {
+      // GDPR Consent String
+      if (gdprConsent.consentString) {
+        requestParameters.gdpr = gdprConsent.consentString;
+      }
+
+      // Additional Consent String
+      const additionalConsent = deepAccess(gdprConsent, 'addtlConsent');
+      if (additionalConsent && additionalConsent.indexOf('~') !== -1) {
+        // Google Ad Tech Provider IDs
+        const atpIds = additionalConsent.substring(additionalConsent.indexOf('~') + 1);
+        deepSetValue(
+          requestParameters,
+          'user.ext.consented_providers_settings.consented_providers',
+          atpIds.split('.').map(id => parseInt(id, 10))
+        );
+      }
     }
 
     if (bidderRequest && bidderRequest.uspConsent) {
@@ -57,6 +73,22 @@ export const spec = {
       requestParameters.referrer = bidderRequest.refererInfo.referer;
     }
 
+    // Adding first party data
+    const site = config.getConfig('ortb2.site');
+    if (site) {
+      const pageCategory = site.pagecat || site.cat;
+      if (pageCategory && isArray(pageCategory)) {
+        requestParameters.pagecat = pageCategory.filter((category) => {
+          return category && isStr(category)
+        });
+      }
+      const genre = deepAccess(site, 'content.genre');
+      if (genre && isStr(genre)) {
+        requestParameters.genre = genre;
+      }
+    }
+    // End of adding first party data
+
     requestParameters.schain = bidRequests[0].schain;
 
     if (bidRequests[0].userId) {
@@ -605,6 +637,12 @@ export function ImproveDigitalAdServerJSClient(endPoint) {
     if (requestParameters.schain) {
       impressionBidRequestObject.schain = requestParameters.schain;
     }
+    if (requestParameters.pagecat) {
+      impressionBidRequestObject.pagecat = requestParameters.pagecat;
+    }
+    if (requestParameters.genre) {
+      impressionBidRequestObject.genre = requestParameters.genre;
+    }
     if (requestParameters.user) {
       impressionBidRequestObject.user = requestParameters.user;
     }

package/modules/instreamTracking.js

@@ -3,11 +3,11 @@ import { config } from '../src/config.js';
 import { auctionManager } from '../src/auctionManager.js';
 import { INSTREAM } from '../src/video.js';
 import * as events from '../src/events.js';
-import { BID_STATUS, EVENTS, TARGETING_KEYS } from '../src/constants.json';
+import CONSTANTS from '../src/constants.json'
 
-const {CACHE_ID, UUID} = TARGETING_KEYS;
-const {BID_WON, AUCTION_END} = EVENTS;
-const {RENDERED} = BID_STATUS;
+const {CACHE_ID, UUID} = CONSTANTS.TARGETING_KEYS;
+const {BID_WON, AUCTION_END} = CONSTANTS.EVENTS;
+const {RENDERED} = CONSTANTS.BID_STATUS;
 
 const INSTREAM_TRACKING_DEFAULT_CONFIG = {
   enabled: false,

package/modules/invibesBidAdapter.js

@@ -4,7 +4,8 @@ import {getStorageManager} from '../src/storageManager.js';
 
 const CONSTANTS = {
   BIDDER_CODE: 'invibes',
-  BID_ENDPOINT: 'https://bid.videostep.com/Bid/VideoAdContent',
+  BID_ENDPOINT: '.videostep.com/Bid/VideoAdContent',
+  BID_SUBDOMAIN: 'https://bid',
   SYNC_ENDPOINT: 'https://k.r66net.com/GetUserSync',
   TIME_TO_LIVE: 300,
   DEFAULT_CURRENCY: 'EUR',
@@ -78,14 +79,14 @@ function buildRequest(bidRequests, bidderRequest) {
   bidderRequest = bidderRequest || {};
   const _placementIds = [];
   const _adUnitCodes = [];
-  let _loginId, _customEndpoint, _userId;
+  let _customEndpoint, _userId, _domainId;
   let _ivAuctionStart = bidderRequest.auctionStart || Date.now();
 
   bidRequests.forEach(function (bidRequest) {
     bidRequest.startTime = new Date().getTime();
     _placementIds.push(bidRequest.params.placementId);
     _adUnitCodes.push(bidRequest.adUnitCode);
-    _loginId = _loginId || bidRequest.params.loginId;
+    _domainId = _domainId || bidRequest.params.domainId;
     _customEndpoint = _customEndpoint || bidRequest.params.customEndpoint;
     _customUserSync = _customUserSync || bidRequest.params.customUserSync;
     _userId = _userId || bidRequest.userId;
@@ -102,7 +103,6 @@ function buildRequest(bidRequests, bidderRequest) {
   let bidParamsJson = {
     placementIds: _placementIds,
     adUnitCodes: _adUnitCodes,
-    loginId: _loginId,
     auctionStartTime: _ivAuctionStart,
     bidVersion: CONSTANTS.PREBID_VERSION
   };
@@ -146,9 +146,11 @@ function buildRequest(bidRequests, bidderRequest) {
     }
   }
 
+  let endpoint = createEndpoint(_customEndpoint, _domainId, _placementIds);
+
   return {
     method: CONSTANTS.METHOD,
-    url: _customEndpoint || CONSTANTS.BID_ENDPOINT,
+    url: endpoint,
     data: data,
     options: {withCredentials: true},
     // for POST: { contentType: 'application/json', withCredentials: true }
@@ -280,6 +282,48 @@ function createBid(bidRequest, requestPlacement, multipositionEnabled, usedPlace
   };
 }
 
+function createEndpoint(customEndpoint, domainId, placementIds) {
+  if (customEndpoint != null) {
+    return customEndpoint;
+  }
+
+  if (domainId != null) {
+    return extractEndpointFromId(domainId - 1000);
+  }
+
+  if (placementIds.length > 0) {
+    for (var i = 0; i < placementIds.length; i++) {
+      const id = extractFromPlacement(placementIds[i]);
+      if (id != null) {
+        return extractEndpointFromId(id);
+      }
+    }
+  }
+
+  return extractEndpointFromId(1);
+}
+
+function extractEndpointFromId(domainId) {
+  if (domainId < 2) {
+    return CONSTANTS.BID_SUBDOMAIN + CONSTANTS.BID_ENDPOINT;
+  }
+
+  return CONSTANTS.BID_SUBDOMAIN + domainId + CONSTANTS.BID_ENDPOINT;
+}
+
+function extractFromPlacement(placementId) {
+  if (placementId == null) { return null; }
+
+  var pattern = /_ivbs([0-9]+)/g;
+
+  var match = pattern.exec(placementId);
+  if (match != null && match[1] != null) {
+    return parseInt(match[1]);
+  }
+
+  return null;
+}
+
 function addMeta(bidModelMeta) {
   var meta = {};
   if (bidModelMeta != null) {

package/modules/invibesBidAdapter.md

@@ -20,7 +20,8 @@ Connect to Invibes for bids.
                    {
                        bidder: 'invibes',
                        params: {
-                           placementId: '12345'
+                           placementId: '12345',
+                           domainId: 1001
                        }
                    }
                ]