prebid.js 6.1.0 → 6.2.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/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);
@@ -302,6 +303,9 @@ function buildRequests(validBidRequests, bidderRequest) {
       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/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

@@ -77,12 +77,14 @@ function isBidRequestValid(bid) {
 function buildRequest(bidRequests, bidderRequest) {
   bidderRequest = bidderRequest || {};
   const _placementIds = [];
+  const _adUnitCodes = [];
   let _loginId, _customEndpoint, _userId;
   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;
     _customEndpoint = _customEndpoint || bidRequest.params.customEndpoint;
     _customUserSync = _customUserSync || bidRequest.params.customUserSync;
@@ -99,6 +101,7 @@ function buildRequest(bidRequests, bidderRequest) {
   let userIdModel = getUserIds(_userId);
   let bidParamsJson = {
     placementIds: _placementIds,
+    adUnitCodes: _adUnitCodes,
     loginId: _loginId,
     auctionStartTime: _ivAuctionStart,
     bidVersion: CONSTANTS.PREBID_VERSION
@@ -181,9 +184,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 +197,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 +219,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;
   }
 
@@ -684,7 +690,7 @@ let keywords = (function () {
   return kw;
 }());
 
-// =====================
+// ======================
 
 export function resetInvibes() {
   invibes.optIn = undefined;

package/modules/ipromBidAdapter.js

@@ -0,0 +1,79 @@
+import { logError } from '../src/utils.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+
+const BIDDER_CODE = 'iprom';
+const ENDPOINT_URL = 'https://core.iprom.net/programmatic';
+const VERSION = 'v1.0.2';
+const DEFAULT_CURRENCY = 'EUR';
+const DEFAULT_NETREVENUE = true;
+const DEFAULT_TTL = 360;
+
+export const spec = {
+  code: BIDDER_CODE,
+  isBidRequestValid: function ({ bidder, params = {} } = {}) {
+    // id parameter checks
+    if (!params.id) {
+      logError(`${bidder}: Parameter 'id' missing`);
+      return false;
+    } else if (typeof params.id !== 'string') {
+      logError(`${bidder}: Parameter 'id' needs to be a string`);
+      return false;
+    }
+    // dimension parameter checks
+    if (!params.dimension) {
+      logError(`${bidder}: Required parameter 'dimension' missing`);
+      return false;
+    } else if (typeof params.dimension !== 'string') {
+      logError(`${bidder}: Parameter 'dimension' needs to be a string`);
+      return false;
+    }
+
+    return true;
+  },
+
+  buildRequests: function (validBidRequests, bidderRequest) {
+    const payload = {
+      bids: validBidRequests,
+      referer: bidderRequest.refererInfo,
+      version: VERSION
+    };
+    const payloadString = JSON.stringify(payload);
+
+    return {
+      method: 'POST',
+      url: ENDPOINT_URL,
+      data: payloadString
+    };
+  },
+
+  interpretResponse: function (serverResponse, request) {
+    let bids = serverResponse.body;
+
+    const bidResponses = [];
+
+    bids.forEach(bid => {
+      const b = {
+        ad: bid.ad,
+        requestId: bid.requestId,
+        cpm: bid.cpm,
+        width: bid.width,
+        height: bid.height,
+        creativeId: bid.creativeId,
+        currency: bid.currency || DEFAULT_CURRENCY,
+        netRevenue: bid.netRevenue || DEFAULT_NETREVENUE,
+        ttl: bid.ttl || DEFAULT_TTL,
+        meta: {},
+      };
+
+      if (bid.aDomains && bid.aDomains.length) {
+        b.meta.advertiserDomains = bid.aDomains;
+      }
+
+      bidResponses.push(b);
+    });
+
+    return bidResponses;
+  },
+}
+
+registerBidder(spec);

package/modules/limelightDigitalBidAdapter.js

@@ -158,7 +158,8 @@ function buildPlacement(bidRequest) {
           height: size[1]
         }
       }),
-      type: bidRequest.params.adUnitType.toUpperCase()
+      type: bidRequest.params.adUnitType.toUpperCase(),
+      publisherId: bidRequest.params.publisherId
     }
   }
 }