prebid.js 8.43.0 → 8.45.0

package/modules/kargoBidAdapter.js

@@ -195,25 +195,19 @@ function buildRequests(validBidRequests, bidderRequest) {
 }
 
 function interpretResponse(response, bidRequest) {
-  let bids = response.body;
+  const bids = response.body;
   const bidResponses = [];
 
-  if (isEmpty(bids)) {
+  if (isEmpty(bids) || typeof bids !== 'object') {
     return bidResponses;
   }
 
-  if (typeof bids !== 'object') {
-    return bidResponses;
-  }
-
-  Object.entries(bids).forEach((entry) => {
-    const [bidID, adUnit] = entry;
-
+  for (const [bidID, adUnit] of Object.entries(bids)) {
     let meta = {
       mediaType: adUnit.mediaType && BIDDER.SUPPORTED_MEDIA_TYPES.includes(adUnit.mediaType) ? adUnit.mediaType : BANNER
     };
 
-    if (adUnit.metadata && adUnit.metadata.landingPageDomain) {
+    if (adUnit.metadata?.landingPageDomain) {
       meta.clickUrl = adUnit.metadata.landingPageDomain[0];
       meta.advertiserDomains = adUnit.metadata.landingPageDomain;
     }
@@ -243,7 +237,7 @@ function interpretResponse(response, bidRequest) {
     }
 
     bidResponses.push(bidResponse);
-  })
+  }
 
   return bidResponses;
 }
@@ -359,56 +353,57 @@ function getUserIds(tdidAdapter, usp, gdpr, eids, gpp) {
     crbIDs: crb.syncIds || {}
   };
 
-  // Pull Trade Desk ID from adapter
-  if (tdidAdapter) {
-    userIds.tdID = tdidAdapter;
-  }
-
-  // Pull Trade Desk ID from our storage
+  // Pull Trade Desk ID
   if (!tdidAdapter && crb.tdID) {
     userIds.tdID = crb.tdID;
+  } else if (tdidAdapter) {
+    userIds.tdID = tdidAdapter;
   }
 
+  // USP
   if (usp) {
     userIds.usp = usp;
   }
 
-  try {
-    if (gdpr) {
-      userIds['gdpr'] = {
-        consent: gdpr.consentString || '',
-        applies: !!gdpr.gdprApplies,
-      }
-    }
-  } catch (e) {
+  // GDPR
+  if (gdpr) {
+    userIds.gdpr = {
+      consent: gdpr.consentString || '',
+      applies: !!gdpr.gdprApplies,
+    };
   }
 
+  // Kargo ID
   if (crb.lexId != null) {
     userIds.kargoID = crb.lexId;
   }
 
+  // Client ID
   if (crb.clientId != null) {
     userIds.clientID = crb.clientId;
   }
 
+  // Opt Out
   if (crb.optOut != null) {
     userIds.optOut = crb.optOut;
   }
 
+  // User ID Sub-Modules (userIdAsEids)
   if (eids != null) {
     userIds.sharedIDEids = eids;
   }
 
+  // GPP
   if (gpp) {
-    const parsedGPP = {}
-    if (gpp && gpp.consentString) {
-      parsedGPP.gppString = gpp.consentString
+    const parsedGPP = {};
+    if (gpp.consentString) {
+      parsedGPP.gppString = gpp.consentString;
     }
-    if (gpp && gpp.applicableSections) {
-      parsedGPP.applicableSections = gpp.applicableSections
+    if (gpp.applicableSections) {
+      parsedGPP.applicableSections = gpp.applicableSections;
     }
     if (!isEmpty(parsedGPP)) {
-      userIds.gpp = parsedGPP
+      userIds.gpp = parsedGPP;
     }
   }
 

package/modules/konduitAnalyticsAdapter.js

@@ -4,7 +4,7 @@ import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
 import { targeting } from '../src/targeting.js';
 import { config } from '../src/config.js';
-import CONSTANTS from '../src/constants.json';
+import {EVENTS} from '../src/constants.js';
 
 const TRACKER_HOST = 'tracker.konduit.me';
 const KONDUIT_PREBID_MODULE_VERSION = '1.0.0';
@@ -12,13 +12,13 @@ const KONDUIT_PREBID_MODULE_VERSION = '1.0.0';
 const analyticsType = 'endpoint';
 
 const eventDataComposerMap = {
-  [CONSTANTS.EVENTS.AUCTION_INIT]: obtainAuctionInfo,
-  [CONSTANTS.EVENTS.AUCTION_END]: obtainAuctionInfo,
-  [CONSTANTS.EVENTS.BID_REQUESTED]: obtainBidRequestsInfo,
-  [CONSTANTS.EVENTS.BID_TIMEOUT]: obtainBidTimeoutInfo,
-  [CONSTANTS.EVENTS.BID_RESPONSE]: obtainBidResponseInfo,
-  [CONSTANTS.EVENTS.BID_WON]: obtainWinnerBidInfo,
-  [CONSTANTS.EVENTS.NO_BID]: obtainNoBidInfo,
+  [EVENTS.AUCTION_INIT]: obtainAuctionInfo,
+  [EVENTS.AUCTION_END]: obtainAuctionInfo,
+  [EVENTS.BID_REQUESTED]: obtainBidRequestsInfo,
+  [EVENTS.BID_TIMEOUT]: obtainBidTimeoutInfo,
+  [EVENTS.BID_RESPONSE]: obtainBidResponseInfo,
+  [EVENTS.BID_WON]: obtainWinnerBidInfo,
+  [EVENTS.NO_BID]: obtainNoBidInfo,
 };
 
 // This function is copy from prebid core
@@ -43,7 +43,7 @@ function buildUrl(obj) {
 
 const getWinnerBidFromAggregatedEvents = () => {
   return konduitAnalyticsAdapter.context.aggregatedEvents
-    .filter(evt => evt.eventType === CONSTANTS.EVENTS.BID_WON)[0];
+    .filter(evt => evt.eventType === EVENTS.BID_WON)[0];
 };
 
 const isWinnerBidDetected = () => {
@@ -57,7 +57,7 @@ const konduitAnalyticsAdapter = Object.assign(
   adapter({ analyticsType }),
   {
     track ({ eventType, args }) {
-      if (CONSTANTS.EVENTS.AUCTION_INIT === eventType) {
+      if (EVENTS.AUCTION_INIT === eventType) {
         konduitAnalyticsAdapter.context.aggregatedEvents.splice(0);
       }
 
@@ -68,12 +68,12 @@ const konduitAnalyticsAdapter = Object.assign(
         });
       }
 
-      if (eventType === CONSTANTS.EVENTS.AUCTION_END) {
+      if (eventType === EVENTS.AUCTION_END) {
         if (!isWinnerBidDetected() && isWinnerBidExist()) {
-          const bidWonData = eventDataComposerMap[CONSTANTS.EVENTS.BID_WON](targeting.getWinningBids()[0]);
+          const bidWonData = eventDataComposerMap[EVENTS.BID_WON](targeting.getWinningBids()[0]);
 
           konduitAnalyticsAdapter.context.aggregatedEvents.push({
-            eventType: CONSTANTS.EVENTS.BID_WON,
+            eventType: EVENTS.BID_WON,
             data: bidWonData,
           });
         }

package/modules/lassoBidAdapter.js

@@ -37,7 +37,6 @@ export const spec = {
         url: encodeURIComponent(window.location.href),
         bidderRequestId: bidRequest.bidderRequestId,
         adUnitCode: bidRequest.adUnitCode,
-        // TODO: fix auctionId leak: https://github.com/prebid/Prebid.js/issues/9781
         auctionId: bidRequest.auctionId,
         bidId: bidRequest.bidId,
         transactionId: bidRequest.ortb2Imp?.ext?.tid,
@@ -48,11 +47,20 @@ export const spec = {
         params: JSON.stringify(bidRequest.params),
         crumbs: JSON.stringify(bidRequest.crumbs),
         prebidVersion: '$prebid.version$',
-        version: 3,
+        version: 4,
         coppa: config.getConfig('coppa') == true ? 1 : 0,
         ccpa: bidderRequest.uspConsent || undefined
       }
 
+      if (
+        bidderRequest &&
+        bidderRequest.gppConsent &&
+        bidderRequest.gppConsent.gppString
+      ) {
+        payload.gpp = bidderRequest.gppConsent.gppString;
+        payload.gppSid = bidderRequest.gppConsent.applicableSections;
+      }
+
       return {
         method: 'GET',
         url: getBidRequestUrl(aimXR, bidRequest.params),
@@ -74,6 +82,7 @@ export const spec = {
 
     const bidResponse = {
       requestId: response.bidid,
+      bidId: response.bidid,
       cpm: response.bid.price,
       currency: response.cur,
       width: response.bid.w,

package/modules/limelightDigitalBidAdapter.js

@@ -169,7 +169,8 @@ function buildPlacement(bidRequest) {
       custom2: bidRequest.params.custom2,
       custom3: bidRequest.params.custom3,
       custom4: bidRequest.params.custom4,
-      custom5: bidRequest.params.custom5
+      custom5: bidRequest.params.custom5,
+      page: bidRequest.refererInfo.page
     }
   }
 }

package/modules/liveIntentAnalyticsAdapter.js

@@ -1,7 +1,7 @@
 import {ajax} from '../src/ajax.js';
 import { generateUUID, logInfo, logWarn } from '../src/utils.js';
 import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
-import CONSTANTS from '../src/constants.json';
+import { EVENTS } from '../src/constants.js';
 import adapterManager from '../src/adapterManager.js';
 import { auctionManager } from '../src/auctionManager.js';
 import { getRefererInfo } from '../src/refererDetection.js';
@@ -11,7 +11,7 @@ const URL = 'https://wba.liadm.com/analytic-events';
 const GVL_ID = 148;
 const ADAPTER_CODE = 'liveintent';
 const DEFAULT_BID_WON_TIMEOUT = 2000;
-const { EVENTS: { AUCTION_END } } = CONSTANTS;
+const { AUCTION_END } = EVENTS;
 let bidWonTimeout;
 
 function handleAuctionEnd(args) {

package/modules/livewrappedAnalyticsAdapter.js

@@ -1,7 +1,7 @@
 import { timestamp, logInfo, getWindowTop } from '../src/utils.js';
 import {ajax} from '../src/ajax.js';
 import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
-import CONSTANTS from '../src/constants.json';
+import { EVENTS, STATUS } from '../src/constants.js';
 import adapterManager from '../src/adapterManager.js';
 import { getGlobal } from '../src/prebidGlobal.js';
 
@@ -28,11 +28,11 @@ let livewrappedAnalyticsAdapter = Object.assign(adapter({EMPTYURL, ANALYTICSTYPE
     logInfo('LIVEWRAPPED_EVENT:', [eventType, args]);
 
     switch (eventType) {
-      case CONSTANTS.EVENTS.AUCTION_INIT:
+      case EVENTS.AUCTION_INIT:
         logInfo('LIVEWRAPPED_AUCTION_INIT:', args);
         cache.auctions[args.auctionId] = {bids: {}, bidAdUnits: {}};
         break;
-      case CONSTANTS.EVENTS.BID_REQUESTED:
+      case EVENTS.BID_REQUESTED:
         logInfo('LIVEWRAPPED_BID_REQUESTED:', args);
         cache.auctions[args.auctionId].timeStamp = args.start;
 
@@ -73,11 +73,11 @@ let livewrappedAnalyticsAdapter = Object.assign(adapter({EMPTYURL, ANALYTICSTYPE
         });
         logInfo(livewrappedAnalyticsAdapter.requestEvents);
         break;
-      case CONSTANTS.EVENTS.BID_RESPONSE:
+      case EVENTS.BID_RESPONSE:
         logInfo('LIVEWRAPPED_BID_RESPONSE:', args);
 
         let bidResponse = cache.auctions[args.auctionId].bids[args.requestId];
-        bidResponse.isBid = args.getStatusCode() === CONSTANTS.STATUS.GOOD;
+        bidResponse.isBid = args.getStatusCode() === STATUS.GOOD;
         bidResponse.width = args.width;
         bidResponse.height = args.height;
         bidResponse.cpm = args.cpm;
@@ -101,7 +101,7 @@ let livewrappedAnalyticsAdapter = Object.assign(adapter({EMPTYURL, ANALYTICSTYPE
             };
         }
         break;
-      case CONSTANTS.EVENTS.BIDDER_DONE:
+      case EVENTS.BIDDER_DONE:
         logInfo('LIVEWRAPPED_BIDDER_DONE:', args);
         args.bids.forEach(doneBid => {
           let bid = cache.auctions[doneBid.auctionId].bids[doneBid.bidId || doneBid.requestId];
@@ -111,7 +111,7 @@ let livewrappedAnalyticsAdapter = Object.assign(adapter({EMPTYURL, ANALYTICSTYPE
           bid.readyToSend = 1;
         });
         break;
-      case CONSTANTS.EVENTS.BID_WON:
+      case EVENTS.BID_WON:
         logInfo('LIVEWRAPPED_BID_WON:', args);
         let wonBid = cache.auctions[args.auctionId].bids[args.requestId];
         wonBid.won = true;
@@ -123,7 +123,7 @@ let livewrappedAnalyticsAdapter = Object.assign(adapter({EMPTYURL, ANALYTICSTYPE
           livewrappedAnalyticsAdapter.sendEvents();
         }
         break;
-      case CONSTANTS.EVENTS.AD_RENDER_FAILED:
+      case EVENTS.AD_RENDER_FAILED:
         logInfo('LIVEWRAPPED_AD_RENDER_FAILED:', args);
         let adRenderFailedBid = cache.auctions[args.bid.auctionId].bids[args.bid.requestId];
         adRenderFailedBid.adRenderFailed = true;
@@ -133,13 +133,13 @@ let livewrappedAnalyticsAdapter = Object.assign(adapter({EMPTYURL, ANALYTICSTYPE
           livewrappedAnalyticsAdapter.sendEvents();
         }
         break;
-      case CONSTANTS.EVENTS.BID_TIMEOUT:
+      case EVENTS.BID_TIMEOUT:
         logInfo('LIVEWRAPPED_BID_TIMEOUT:', args);
         args.forEach(timeout => {
           cache.auctions[timeout.auctionId].bids[timeout.bidId].timeout = true;
         });
         break;
-      case CONSTANTS.EVENTS.AUCTION_END:
+      case EVENTS.AUCTION_END:
         logInfo('LIVEWRAPPED_AUCTION_END:', args);
         setTimeout(() => {
           livewrappedAnalyticsAdapter.sendEvents();

package/modules/loyalBidAdapter.js

@@ -0,0 +1,190 @@
+import { logMessage, logError } from '../src/utils.js';
+import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
+
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
+import { config } from '../src/config.js';
+
+const BIDDER_CODE = 'loyal';
+const AD_URL = 'https://us-east-1.loyal.app/pbjs';
+
+function isBidResponseValid(bid) {
+  if (!bid.requestId || !bid.cpm || !bid.creativeId || !bid.ttl || !bid.currency) {
+    return false;
+  }
+
+  switch (bid.mediaType) {
+    case BANNER:
+      return Boolean(bid.width && bid.height && bid.ad);
+    case VIDEO:
+      return Boolean(bid.vastUrl || bid.vastXml);
+    case NATIVE:
+      return Boolean(bid.native && bid.native.impressionTrackers && bid.native.impressionTrackers.length);
+    default:
+      return false;
+  }
+}
+
+function getPlacementReqData(bid) {
+  const { params, bidId, mediaTypes } = bid;
+  const schain = bid.schain || {};
+  const { placementId, endpointId } = params;
+  const bidfloor = getBidFloor(bid);
+
+  const placement = {
+    bidId,
+    schain,
+    bidfloor,
+    eids: []
+  };
+
+  if (placementId) {
+    placement.placementId = placementId;
+    placement.type = 'publisher';
+  } else if (endpointId) {
+    placement.endpointId = endpointId;
+    placement.type = 'network';
+  }
+
+  if (mediaTypes && mediaTypes[BANNER]) {
+    placement.adFormat = BANNER;
+    placement.sizes = mediaTypes[BANNER].sizes;
+  } else if (mediaTypes && mediaTypes[VIDEO]) {
+    placement.adFormat = VIDEO;
+    placement.playerSize = mediaTypes[VIDEO].playerSize;
+    placement.minduration = mediaTypes[VIDEO].minduration;
+    placement.maxduration = mediaTypes[VIDEO].maxduration;
+    placement.mimes = mediaTypes[VIDEO].mimes;
+    placement.protocols = mediaTypes[VIDEO].protocols;
+    placement.startdelay = mediaTypes[VIDEO].startdelay;
+    placement.placement = mediaTypes[VIDEO].placement;
+    placement.skip = mediaTypes[VIDEO].skip;
+    placement.skipafter = mediaTypes[VIDEO].skipafter;
+    placement.minbitrate = mediaTypes[VIDEO].minbitrate;
+    placement.maxbitrate = mediaTypes[VIDEO].maxbitrate;
+    placement.delivery = mediaTypes[VIDEO].delivery;
+    placement.playbackmethod = mediaTypes[VIDEO].playbackmethod;
+    placement.api = mediaTypes[VIDEO].api;
+    placement.linearity = mediaTypes[VIDEO].linearity;
+  } else if (mediaTypes && mediaTypes[NATIVE]) {
+    placement.native = mediaTypes[NATIVE];
+    placement.adFormat = NATIVE;
+  }
+
+  return placement;
+}
+
+function getBidFloor(bid) {
+  try {
+    const bidFloor = bid.getFloor({
+      currency: 'USD',
+      mediaType: '*',
+      size: '*',
+    });
+    return bidFloor.floor;
+  } catch (err) {
+    logError(err);
+    return 0;
+  }
+}
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, VIDEO, NATIVE],
+
+  isBidRequestValid: (bid = {}) => {
+    const { params, bidId, mediaTypes } = bid;
+    let valid = Boolean(bidId && params && (params.placementId || params.endpointId));
+
+    if (mediaTypes && mediaTypes[BANNER]) {
+      valid = valid && Boolean(mediaTypes[BANNER] && mediaTypes[BANNER].sizes);
+    } else if (mediaTypes && mediaTypes[VIDEO]) {
+      valid = valid && Boolean(mediaTypes[VIDEO] && mediaTypes[VIDEO].playerSize);
+    } else if (mediaTypes && mediaTypes[NATIVE]) {
+      valid = valid && Boolean(mediaTypes[NATIVE]);
+    } else {
+      valid = false;
+    }
+    return valid;
+  },
+
+  buildRequests: (validBidRequests = [], bidderRequest = {}) => {
+    // convert Native ORTB definition to old-style prebid native definition
+    validBidRequests = convertOrtbRequestToProprietaryNative(validBidRequests);
+
+    let deviceWidth = 0;
+    let deviceHeight = 0;
+
+    let winLocation;
+    try {
+      const winTop = window.top;
+      deviceWidth = winTop.screen.width;
+      deviceHeight = winTop.screen.height;
+      winLocation = winTop.location;
+    } catch (e) {
+      logMessage(e);
+      winLocation = window.location;
+    }
+
+    const refferUrl = bidderRequest.refererInfo && bidderRequest.refererInfo.page;
+    let refferLocation;
+    try {
+      refferLocation = refferUrl && new URL(refferUrl);
+    } catch (e) {
+      logMessage(e);
+    }
+    // TODO: does the fallback make sense here?
+    let location = refferLocation || winLocation;
+    const language = (navigator && navigator.language) ? navigator.language.split('-')[0] : '';
+    const host = location.host;
+    const page = location.pathname;
+    const secure = location.protocol === 'https:' ? 1 : 0;
+    const placements = [];
+    const request = {
+      deviceWidth,
+      deviceHeight,
+      language,
+      secure,
+      host,
+      page,
+      placements,
+      coppa: config.getConfig('coppa') === true ? 1 : 0,
+      ccpa: bidderRequest.uspConsent || undefined,
+      tmax: bidderRequest.timeout
+    };
+
+    if (bidderRequest.gdprConsent?.consentString) {
+      request.gdpr = {
+        consentString: bidderRequest.gdprConsent.consentString
+      };
+    }
+
+    const len = validBidRequests.length;
+    for (let i = 0; i < len; i++) {
+      const bid = validBidRequests[i];
+      placements.push(getPlacementReqData(bid));
+    }
+
+    return {
+      method: 'POST',
+      url: AD_URL,
+      data: request
+    };
+  },
+
+  interpretResponse: (serverResponse) => {
+    let response = [];
+    for (let i = 0; i < serverResponse.body.length; i++) {
+      let resItem = serverResponse.body[i];
+      if (isBidResponseValid(resItem)) {
+        const advertiserDomains = resItem.adomain && resItem.adomain.length ? resItem.adomain : [];
+        resItem.meta = { ...resItem.meta, advertiserDomains };
+
+        response.push(resItem);
+      }
+    }
+    return response;
+  },
+};
+
+registerBidder(spec);

package/modules/loyalBidAdapter.md

@@ -0,0 +1,79 @@
+# Overview
+
+```
+Module Name: Loyal Bidder Adapter
+Module Type: Loyal Bidder Adapter
+Maintainer: hello@loyal.app
+```
+
+# Description
+
+Connects to Loyal exchange for bids.
+Loyal bid adapter supports Banner, Video (instream and outstream) and Native.
+
+# Test Parameters
+```
+    var adUnits = [
+                // Will return static test banner
+                {
+                    code: 'adunit1',
+                    mediaTypes: {
+                        banner: {
+                            sizes: [ [300, 250], [320, 50] ],
+                        }
+                    },
+                    bids: [
+                        {
+                            bidder: 'loyal',
+                            params: {
+                                placementId: 'testBanner',
+                            }
+                        }
+                    ]
+                },
+                {
+                    code: 'addunit2',
+                    mediaTypes: {
+                        video: {
+                            playerSize: [ [640, 480] ],
+                            context: 'instream',
+                            minduration: 5,
+                            maxduration: 60,
+                        }
+                    },
+                    bids: [
+                        {
+                            bidder: 'loyal',
+                            params: {
+                                placementId: 'testVideo',
+                            }
+                        }
+                    ]
+                },
+                {
+                    code: 'addunit3',
+                    mediaTypes: {
+                        native: {
+                            title: {
+                                required: true
+                            },
+                            body: {
+                                required: true
+                            },
+                            icon: {
+                                required: true,
+                                size: [64, 64]
+                            }
+                        }
+                    },
+                    bids: [
+                        {
+                            bidder: 'loyal',
+                            params: {
+                                placementId: 'testNative',
+                            }
+                        }
+                    ]
+                }
+            ];
+```