prebid.js 5.19.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/gptPreAuction.js

@@ -55,15 +55,16 @@ export const appendPbAdSlot = adUnit => {
   const context = adUnit.ortb2Imp.ext.data;
   const { customPbAdSlot } = _currentConfig;
 
-  if (customPbAdSlot) {
-    context.pbadslot = customPbAdSlot(adUnit.code, deepAccess(context, 'adserver.adslot'));
+  // use context.pbAdSlot if set (if someone set it already, it will take precedence over others)
+  if (context.pbadslot) {
     return;
   }
 
-  // use context.pbAdSlot if set
-  if (context.pbadslot) {
+  if (customPbAdSlot) {
+    context.pbadslot = customPbAdSlot(adUnit.code, deepAccess(context, 'adserver.adslot'));
     return;
   }
+
   // use data attribute 'data-adslotid' if set
   try {
     const adUnitCodeDiv = document.getElementById(adUnit.code);
@@ -78,12 +79,17 @@ export const appendPbAdSlot = adUnit => {
     return;
   }
   context.pbadslot = adUnit.code;
+  return true;
 };
 
 export const makeBidRequestsHook = (fn, adUnits, ...args) => {
   appendGptSlots(adUnits);
   adUnits.forEach(adUnit => {
-    appendPbAdSlot(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;
+    }
   });
   return fn.call(this, adUnits, ...args);
 };

package/modules/gridBidAdapter.js

@@ -29,6 +29,7 @@ let hasSynced = false;
 
 export const spec = {
   code: BIDDER_CODE,
+  aliases: ['playwire', 'adlivetech'],
   supportedMediaTypes: [ BANNER, VIDEO ],
   /**
    * Determines whether or not the given bid request is valid.

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/id5IdSystem.md

@@ -1,14 +1,14 @@
 # ID5 Universal ID
 
-The ID5 Universal ID is a shared, neutral identifier that publishers and ad tech platforms can use to recognise users even in environments where 3rd party cookies are not available. The ID5 Universal ID is designed to respect users' privacy choices and publishers’ preferences throughout the advertising value chain. For more information about the ID5 Universal ID and detailed integration docs, please visit [our documentation](https://support.id5.io/portal/en/kb/articles/prebid-js-user-id-module). We also recommend that you sign up for our [release notes](https://id5.io/universal-id/release-notes) to stay up-to-date with any changes to the implementation of the ID5 Universal ID in Prebid.
+The ID5 ID is a shared, neutral identifier that publishers and ad tech platforms can use to recognise users even in environments where 3rd party cookies are not available. The ID5 ID is designed to respect users' privacy choices and publishers’ preferences throughout the advertising value chain. For more information about the ID5 ID and detailed integration docs, please visit [our documentation](https://support.id5.io/portal/en/kb/articles/prebid-js-user-id-module).
 
-## ID5 Universal ID Registration
+## ID5 ID Registration
 
-The ID5 Universal ID is free to use, but requires a simple registration with ID5. Please visit [id5.io/universal-id](https://id5.io/universal-id) to sign up and request your ID5 Partner Number to get started.
+The ID5 ID is free to use, but requires a simple registration with ID5. Please visit [our website](https://id5.io/solutions/#publishers) to sign up and request your ID5 Partner Number to get started.
 
-The ID5 privacy policy is at [https://www.id5.io/platform-privacy-policy](https://www.id5.io/platform-privacy-policy).
+The ID5 privacy policy is at [https://id5.io/platform-privacy-policy](https://id5.io/platform-privacy-policy).
 
-## ID5 Universal ID Configuration
+## ID5 ID Configuration
 
 First, make sure to add the ID5 submodule to your Prebid.js package with:
 
@@ -46,7 +46,7 @@ pbjs.setConfig({
 | Param under userSync.userIds[] | Scope | Type | Description | Example |
 | --- | --- | --- | --- | --- |
 | name | Required | String | The name of this module: `"id5Id"` | `"id5Id"` |
-| params | Required | Object | Details for the ID5 Universal ID. | |
+| params | Required | Object | Details for the ID5 ID. | |
 | params.partner | Required | Number | This is the ID5 Partner Number obtained from registering with ID5. | `173` |
 | params.pd | Optional | String | Partner-supplied data used for linking ID5 IDs across domains. See [our documentation](https://support.id5.io/portal/en/kb/articles/passing-partner-data-to-id5) for details on generating the string. Omit the parameter or leave as an empty string if no data to supply | `"MT1iNTBjY..."` |
 | params.provider | Optional | String | An identifier provided by ID5 to technology partners who manage Prebid setups on behalf of publishers. Reach out to [ID5](mailto:prebid@id5.io) if you have questions about this parameter  | `pubmatic-identity-hub` |

package/modules/imRtdProvider.js

@@ -37,6 +37,34 @@ function setImDataInCookie(value) {
   );
 }
 
+/**
+* @param {string} bidderName
+*/
+export function getBidderFunction(bidderName) {
+  const biddersFunction = {
+    ix: function (bid, data) {
+      if (data.im_segments && data.im_segments.length) {
+        config.setConfig({
+          ix: {firstPartyData: {im_segments: data.im_segments}},
+        });
+      }
+      return bid
+    },
+    pubmatic: function (bid, data) {
+      if (data.im_segments && data.im_segments.length) {
+        const dctr = deepAccess(bid, 'params.dctr');
+        deepSetValue(
+          bid,
+          'params.dctr',
+          `${dctr ? dctr + '|' : ''}im_segments=${data.im_segments.join(',')}`
+        );
+      }
+      return bid
+    }
+  }
+  return biddersFunction[bidderName] || null;
+}
+
 export function getCustomBidderFunction(config, bidder) {
   const overwriteFn = deepAccess(config, `params.overwrites.${bidder}`)
 
@@ -73,9 +101,12 @@ export function setRealTimeData(bidConfig, moduleConfig, data) {
 
   adUnits.forEach(adUnit => {
     adUnit.bids.forEach(bid => {
+      const bidderFunction = getBidderFunction(bid.bidder);
       const overwriteFunction = getCustomBidderFunction(moduleConfig, bid.bidder);
       if (overwriteFunction) {
         overwriteFunction(bid, data, utils, config);
+      } else if (bidderFunction) {
+        bidderFunction(bid, data);
       }
     })
   });

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);