prebid.js 6.1.0 → 6.5.0

package/modules/goldbachBidAdapter.md

@@ -0,0 +1,151 @@
+#Overview
+
+```
+Module Name:  Goldbach Bid Adapter
+Module Type:  Bidder Adapter
+Maintainer: dusan.veljovic@goldbach.com
+```
+
+# Description
+
+Connects to Xandr exchange for bids.
+
+Goldbach bid adapter supports Banner, Video (instream and outstream) and Native.
+
+# Test Parameters
+```
+var adUnits = [
+   // Banner adUnit
+   {
+      code: 'banner-div',
+      mediaTypes: {
+        banner: {
+          sizes: [[300, 250], [300,600]]
+        }
+      },
+      bids: [{
+         bidder: 'goldbach',
+         params: {
+           placementId: 13144370
+         }
+       }]
+   },
+   // Native adUnit
+   {
+      code: 'native-div',
+      sizes: [[1, 1]],
+      mediaTypes: {
+        native: {
+          title: {
+            required: true
+          },
+          body: {
+            required: true
+          },
+          image: {
+            required: true
+          },
+          sponsoredBy: {
+            required: true
+          },
+          icon: {
+            required: false
+          }
+        }
+      },
+      bids: [{
+        bidder: 'goldbach',
+        params: {
+          placementId: 13232354,
+          allowSmallerSizes: true
+        }
+      }]
+   },
+   // Video instream adUnit
+   {
+      code: 'video-instream',
+      sizes: [[640, 480]],
+      mediaTypes: {
+        video: {
+          playerSize: [[640, 480]],
+          context: 'instream'
+        },
+      },
+      bids: [{
+        goldbach: 'goldbach',
+        params: {
+          placementId: 13232361,
+          video: {
+            skippable: true,
+            playback_methods: ['auto_play_sound_off']
+          }
+        }
+      }]
+   },
+   // Video outstream adUnit
+   {
+     code: 'video-outstream',
+     sizes: [[300, 250]],
+     mediaTypes: {
+       video: {
+         playerSize: [[300, 250]],
+         context: 'outstream',
+         // Certain ORTB 2.5 video values can be read from the mediatypes object; below are examples of supported params.
+         // To note - goldbach supports additional values for our system that are not part of the ORTB spec.  If you want
+         // to use these values, they will have to be declared in the bids[].params.video object instead using the goldbach syntax.
+         // Between the corresponding values of the mediaTypes.video and params.video objects, the properties in params.video will 
+         // take precedence if declared; eg in the example below, the `skippable: true` setting will be used instead of the `skip: 0`.
+         minduration: 1,
+         maxduration: 60,
+         skip: 0,   // 1 - true, 0 - false
+         skipafter: 5,
+         playbackmethod: [2], // note - we only support options 1-4 at this time
+         api: [1,2,3]   // note - option 6 is not supported at this time
+       }
+     },
+     bids: [
+       {
+         bidder: 'goldbach',
+         params: {
+           placementId: 13232385,
+           video: {
+             skippable: true,
+             playback_method: 'auto_play_sound_off'
+           }
+         }
+       }
+     ]
+   },
+   // Banner adUnit in a App Webview
+   // Only use this for situations where prebid.js is in a webview of an App
+   // See Prebid Mobile for displaying ads via an SDK
+   {
+     code: 'banner-div',
+     mediaTypes: {
+       banner: {
+         sizes: [[300, 250], [300,600]]
+       }
+     }
+     bids: [{
+       bidder: 'goldbach',
+       params: {
+         placementId: 13144370,
+         app: {
+           id: "B1O2W3M4AN.com.prebid.webview",
+           geo: {
+             lat: 40.0964439,
+             lng: -75.3009142
+           },
+           device_id: {
+             idfa: "4D12078D-3246-4DA4-AD5E-7610481E7AE", // Apple advertising identifier
+             aaid: "38400000-8cf0-11bd-b23e-10b96e40000d", // Android advertising identifier
+             md5udid: "5756ae9022b2ea1e47d84fead75220c8", // MD5 hash of the ANDROID_ID
+             sha1udid: "4DFAA92388699AC6539885AEF1719293879985BF", // SHA1 hash of the ANDROID_ID
+             windowsadid: "750c6be243f1c4b5c9912b95a5742fc5" // Windows advertising identifier
+           }
+         }
+       }
+     }]
+   }
+];
+```

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

@@ -286,7 +286,8 @@ function buildRequests(validBidRequests, bidderRequest) {
       schain,
       transactionId,
       userId = {},
-      ortb2Imp
+      ortb2Imp,
+      adUnitCode = ''
     } = bidRequest;
     const { currency, floor } = _getFloor(mediaTypes, params.bidfloor, bidRequest);
     const eids = getEids(userId);
@@ -295,13 +296,16 @@ 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;
     }
 
+    // ADTS-169 add adUnitCode to requests
+    if (adUnitCode) data.aun = adUnitCode
+
     // ADTS-134 Retrieve ID envelopes
     for (const eid in eids) data[eid] = eids[eid];
 

package/modules/improvedigitalBidAdapter.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.5.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) {

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/intersectionRtdProvider.js

@@ -0,0 +1,114 @@
+import {submodule} from '../src/hook.js';
+import {isFn, logError} from '../src/utils.js';
+import {config} from '../src/config.js';
+import {getGlobal} from '../src/prebidGlobal.js';
+import includes from 'core-js-pure/features/array/includes.js';
+import '../src/adapterManager.js';
+let observerAvailable = true;
+function getIntersectionData(requestBidsObject, onDone, providerConfig, userConsent) {
+  const intersectionMap = {};
+  const placeholdersMap = {};
+  let done = false;
+  if (!observerAvailable) return complete();
+  const observer = new IntersectionObserver(observerCallback, {threshold: 0.5});
+  const adUnitCodes = requestBidsObject.adUnitCodes || [];
+  const auctionDelay = config.getConfig('realTimeData.auctionDelay') || 0;
+  const waitForIt = providerConfig.waitForIt;
+  let adUnits = requestBidsObject.adUnits || getGlobal().adUnits || [];
+  if (adUnitCodes.length) {
+    adUnits = adUnits.filter(unit => includes(adUnitCodes, unit.code));
+  }
+  let checkTimeoutId;
+  findAndObservePlaceholders();
+  if (auctionDelay > 0) {
+    setTimeout(complete, auctionDelay);
+  }
+  function findAndObservePlaceholders() {
+    const observed = adUnits.filter((unit) => {
+      const code = unit.code;
+      if (placeholdersMap[code]) return true;
+      const ph = document.getElementById(code);
+      if (ph) {
+        placeholdersMap[code] = ph;
+        observer.observe(ph);
+        return true;
+      }
+    });
+    if (
+      observed.length === adUnits.length ||
+      !waitForIt ||
+      auctionDelay <= 0
+    ) {
+      return;
+    }
+    checkTimeoutId = setTimeout(findAndObservePlaceholders);
+  }
+  function observerCallback(entries) {
+    let entry = entries.pop();
+    while (entry) {
+      const target = entry.target;
+      const id = target.getAttribute('id');
+      if (id) {
+        const intersection = intersectionMap[id];
+        if (!intersection || intersection.time < entry.time) {
+          intersectionMap[id] = {
+            'boundingClientRect': cloneRect(entry.boundingClientRect),
+            'intersectionRect': cloneRect(entry.intersectionRect),
+            'rootRect': cloneRect(entry.rootRect),
+            'intersectionRatio': entry.intersectionRatio,
+            'isIntersecting': entry.isIntersecting,
+            'time': entry.time
+          };
+          if (adUnits.every(unit => !!intersectionMap[unit.code])) {
+            complete();
+          }
+        }
+      }
+      entry = entries.pop();
+    }
+  }
+  function complete() {
+    if (done) return;
+    if (checkTimeoutId) clearTimeout(checkTimeoutId);
+    done = true;
+    checkTimeoutId = null;
+    observer && observer.disconnect();
+    adUnits && adUnits.forEach((unit) => {
+      const intersection = intersectionMap[unit.code];
+      if (intersection && unit.bids) {
+        unit.bids.forEach(bid => bid.intersection = intersection);
+      }
+    });
+    onDone();
+  }
+}
+function init(moduleConfig) {
+  if (!isFn(window.IntersectionObserver)) {
+    logError('IntersectionObserver is not defined');
+    observerAvailable = false;
+  } else {
+    observerAvailable = true;
+  }
+  return observerAvailable;
+}
+function cloneRect(rect) {
+  return rect ? {
+    'left': rect.left,
+    'top': rect.top,
+    'right': rect.right,
+    'bottom': rect.bottom,
+    'width': rect.width,
+    'height': rect.height,
+    'x': rect.x,
+    'y': rect.y,
+  } : rect;
+}
+export const intersectionSubmodule = {
+  name: 'intersection',
+  getBidRequestData: getIntersectionData,
+  init: init,
+};
+function registerSubModule() {
+  submodule('realTimeData', intersectionSubmodule);
+}
+registerSubModule();

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',
@@ -77,13 +78,15 @@ function isBidRequestValid(bid) {
 function buildRequest(bidRequests, bidderRequest) {
   bidderRequest = bidderRequest || {};
   const _placementIds = [];
-  let _loginId, _customEndpoint, _userId;
+  const _adUnitCodes = [];
+  let _customEndpoint, _userId, _domainId;
   let _ivAuctionStart = bidderRequest.auctionStart || Date.now();
 
   bidRequests.forEach(function (bidRequest) {
     bidRequest.startTime = new Date().getTime();
     _placementIds.push(bidRequest.params.placementId);
-    _loginId = _loginId || bidRequest.params.loginId;
+    _adUnitCodes.push(bidRequest.adUnitCode);
+    _domainId = _domainId || bidRequest.params.domainId;
     _customEndpoint = _customEndpoint || bidRequest.params.customEndpoint;
     _customUserSync = _customUserSync || bidRequest.params.customUserSync;
     _userId = _userId || bidRequest.userId;
@@ -99,7 +102,7 @@ function buildRequest(bidRequests, bidderRequest) {
   let userIdModel = getUserIds(_userId);
   let bidParamsJson = {
     placementIds: _placementIds,
-    loginId: _loginId,
+    adUnitCodes: _adUnitCodes,
     auctionStartTime: _ivAuctionStart,
     bidVersion: CONSTANTS.PREBID_VERSION
   };
@@ -143,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 }
@@ -181,9 +186,12 @@ function handleResponse(responseObj, bidRequests) {
   const bidResponses = [];
   for (let i = 0; i < bidRequests.length; i++) {
     let bidRequest = bidRequests[i];
+    let usedPlacementId = responseObj.UseAdUnitCode === true
+      ? bidRequest.params.placementId + '_' + bidRequest.adUnitCode
+      : bidRequest.params.placementId;
 
-    if (invibes.placementBids.indexOf(bidRequest.params.placementId) > -1) {
-      logInfo('Invibes Adapter - Placement was previously bid on ' + bidRequest.params.placementId);
+    if (invibes.placementBids.indexOf(usedPlacementId) > -1) {
+      logInfo('Invibes Adapter - Placement was previously bid on ' + usedPlacementId);
       continue;
     }
 
@@ -191,21 +199,21 @@ function handleResponse(responseObj, bidRequests) {
     if (responseObj.AdPlacements != null) {
       for (let j = 0; j < responseObj.AdPlacements.length; j++) {
         let bidModel = responseObj.AdPlacements[j].BidModel;
-        if (bidModel != null && bidModel.PlacementId == bidRequest.params.placementId) {
+        if (bidModel != null && bidModel.PlacementId == usedPlacementId) {
           requestPlacement = responseObj.AdPlacements[j];
           break;
         }
       }
     } else {
       let bidModel = responseObj.BidModel;
-      if (bidModel != null && bidModel.PlacementId == bidRequest.params.placementId) {
+      if (bidModel != null && bidModel.PlacementId == usedPlacementId) {
         requestPlacement = responseObj;
       }
     }
 
-    let bid = createBid(bidRequest, requestPlacement, responseObj.MultipositionEnabled);
+    let bid = createBid(bidRequest, requestPlacement, responseObj.MultipositionEnabled, usedPlacementId);
     if (bid !== null) {
-      invibes.placementBids.push(bidRequest.params.placementId);
+      invibes.placementBids.push(usedPlacementId);
       bidResponses.push(bid);
     }
   }
@@ -213,9 +221,9 @@ function handleResponse(responseObj, bidRequests) {
   return bidResponses;
 }
 
-function createBid(bidRequest, requestPlacement, multipositionEnabled) {
+function createBid(bidRequest, requestPlacement, multipositionEnabled, usedPlacementId) {
   if (requestPlacement === null || requestPlacement.BidModel === null) {
-    logInfo('Invibes Adapter - Placement not configured for bidding ' + bidRequest.params.placementId);
+    logInfo('Invibes Adapter - Placement not configured for bidding ' + usedPlacementId);
     return null;
   }
 
@@ -274,6 +282,48 @@ function createBid(bidRequest, requestPlacement, multipositionEnabled) {
   };
 }
 
+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) {
@@ -684,7 +734,7 @@ let keywords = (function () {
   return kw;
 }());
 
-// =====================
+// ======================
 
 export function resetInvibes() {
   invibes.optIn = undefined;

package/modules/invibesBidAdapter.md

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