prebid.js 7.25.0 → 7.27.0

package/modules/redtramBidAdapter.js

@@ -0,0 +1,155 @@
+import {
+  isFn,
+  isStr,
+  deepAccess,
+  getWindowTop,
+  triggerPixel
+} from '../src/utils.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER } from '../src/mediaTypes.js';
+import { config } from '../src/config.js';
+
+const BIDDER_CODE = 'redtram';
+const AD_URL = 'https://prebid.redtram.com/pbjs';
+const SYNC_URL = 'https://prebid.redtram.com/sync';
+
+function isBidResponseValid(bid) {
+  if (!bid.requestId || !bid.cpm || !bid.creativeId ||
+    !bid.ttl || !bid.currency || !bid.meta) {
+    return false;
+  }
+
+  switch (bid.mediaType) {
+    case BANNER:
+      return Boolean(bid.width && bid.height && bid.ad);
+    default:
+      return false;
+  }
+}
+
+function getBidFloor(bid) {
+  if (!isFn(bid.getFloor)) {
+    return deepAccess(bid, 'params.bidFloor', 0);
+  }
+
+  try {
+    const bidFloor = bid.getFloor({
+      currency: 'USD',
+      mediaType: '*',
+      size: '*',
+    });
+    return bidFloor.floor;
+  } catch (_) {
+    return 0
+  }
+}
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER],
+
+  isBidRequestValid: (bid) => {
+    return Boolean(bid.bidId && bid.params && bid.params.placementId);
+  },
+
+  buildRequests: (validBidRequests = [], bidderRequest) => {
+    const winTop = getWindowTop();
+    const location = winTop.location;
+    const placements = [];
+
+    const request = {
+      deviceWidth: winTop.screen.width,
+      deviceHeight: winTop.screen.height,
+      language: (navigator && navigator.language) ? navigator.language.split('-')[0] : '',
+      host: location.host,
+      page: location.pathname,
+      placements: placements
+    };
+
+    if (bidderRequest) {
+      if (bidderRequest.uspConsent) {
+        request.ccpa = bidderRequest.uspConsent;
+      }
+      if (bidderRequest.gdprConsent) {
+        request.gdpr = bidderRequest.gdprConsent;
+      }
+    }
+
+    const len = validBidRequests.length;
+    for (let i = 0; i < len; i++) {
+      const bid = validBidRequests[i];
+      const placement = {
+        placementId: bid.params.placementId,
+        bidId: bid.bidId,
+        schain: bid.schain || {},
+        bidfloor: getBidFloor(bid)
+      };
+
+      if (typeof bid.userId !== 'undefined') {
+        placement.userId = bid.userId;
+      }
+
+      const mediaType = bid.mediaTypes;
+
+      if (mediaType && mediaType[BANNER] && mediaType[BANNER].sizes) {
+        placement.sizes = mediaType[BANNER].sizes;
+        placement.adFormat = BANNER;
+      }
+
+      placements.push(placement);
+    }
+
+    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;
+  },
+
+  getUserSyncs: (syncOptions, serverResponses, gdprConsent, uspConsent) => {
+    let syncType = syncOptions.iframeEnabled ? 'iframe' : 'image';
+    let syncUrl = SYNC_URL + `/${syncType}?pbjs=1`;
+    if (gdprConsent && gdprConsent.consentString) {
+      if (typeof gdprConsent.gdprApplies === 'boolean') {
+        syncUrl += `&gdpr=${Number(gdprConsent.gdprApplies)}&gdpr_consent=${gdprConsent.consentString}`;
+      } else {
+        syncUrl += `&gdpr=0&gdpr_consent=${gdprConsent.consentString}`;
+      }
+    }
+    if (uspConsent && uspConsent.consentString) {
+      syncUrl += `&ccpa_consent=${uspConsent.consentString}`;
+    }
+
+    const coppa = config.getConfig('coppa') ? 1 : 0;
+    syncUrl += `&coppa=${coppa}`;
+
+    return [{
+      type: syncType,
+      url: syncUrl
+    }];
+  },
+
+  onBidWon: (bid) => {
+    const cpm = deepAccess(bid, 'adserverTargeting.hb_pb') || '';
+    if (isStr(bid.nurl) && bid.nurl !== '') {
+      bid.nurl = bid.nurl.replace(/\${AUCTION_PRICE}/, cpm);
+      triggerPixel(bid.nurl);
+    }
+  }
+};
+
+registerBidder(spec);

package/modules/redtramBidAdapter.md

@@ -0,0 +1,33 @@
+# Overview
+
+```
+Module Name: redtram Bidder Adapter
+Module Type: redtram Bidder Adapter
+Maintainer: support@redtram.com
+```
+
+# Description
+
+Module that connects to redtram demand sources
+
+# Test Parameters
+```
+    var adUnits = [
+        {
+            code: 'div-prebid',
+            mediaTypes:{
+                banner: {
+                    sizes: [[300, 250]],
+                }
+            },
+            bids:[
+                {
+                    bidder: 'redtram',
+                    params: {
+                        placementId: '23611' //test, please replace after test 
+                    }
+                }
+            ]
+        },
+    ];
+```

package/modules/riseBidAdapter.js

@@ -309,6 +309,16 @@ function generateBidParameters(bid, bidderRequest) {
     bidObject.placementId = placementId;
   }
 
+  const mimes = deepAccess(bid, `mediaTypes.${mediaType}.mimes`);
+  if (mimes) {
+    bidObject.mimes = mimes;
+  }
+
+  const api = deepAccess(bid, `mediaTypes.${mediaType}.api`);
+  if (api) {
+    bidObject.api = api;
+  }
+
   if (mediaType === VIDEO) {
     const playbackMethod = deepAccess(bid, `mediaTypes.video.playbackmethod`);
     let playbackMethodValue;
@@ -349,6 +359,11 @@ function generateBidParameters(bid, bidderRequest) {
     if (linearity) {
       bidObject.linearity = linearity;
     }
+
+    const protocols = deepAccess(bid, `mediaTypes.video.protocols`);
+    if (protocols) {
+      bidObject.protocols = protocols;
+    }
   }
 
   return bidObject;

package/modules/riseBidAdapter.md

@@ -20,7 +20,7 @@ The adapter supports Video(instream).
 
 | Name | Scope | Type | Description | Example
 | ---- | ----- | ---- | ----------- | -------
-| `org` | required | String |  Rise publisher Id provided by your Rise representative  | "56f91cd4d3e3660002000033"
+| `org` | required | String |  Rise publisher Id provided by your Rise representative  | "1234567890abcdef12345678"
 | `floorPrice` | optional | Number |  Minimum price in USD. Misuse of this parameter can impact revenue | 2.00
 | `placementId` | optional | String |  A unique placement identifier  | "12345678"
 | `testMode` | optional | Boolean |  This activates the test mode  | false
@@ -41,10 +41,10 @@ var adUnits = [
         bids: [{
           bidder: 'rise',
           params: {
-            org: '56f91cd4d3e3660002000033', // Required
+            org: '1234567890abcdef12345678', // Required
             floorPrice: 2.00, // Optional
             placementId: '12345678', // Optional
-            testMode: false // Optional,
+            testMode: false, // Optional,
             rtbDomain: "www.test.com" //Optional
           }
         }]

package/modules/rtbhouseBidAdapter.js

@@ -1,13 +1,15 @@
-import {deepAccess, isArray, logError} from '../src/utils.js';
+import {deepAccess, mergeDeep, isArray, logError, logInfo} from '../src/utils.js';
 import { getOrigin } from '../libraries/getOrigin/index.js';
 import {BANNER, NATIVE} from '../src/mediaTypes.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {includes} from '../src/polyfill.js';
 import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
+import { config } from '../src/config.js';
 
 const BIDDER_CODE = 'rtbhouse';
 const REGIONS = ['prebid-eu', 'prebid-us', 'prebid-asia'];
 const ENDPOINT_URL = 'creativecdn.com/bidder/prebid/bids';
+const FLEDGE_ENDPOINT_URL = 'creativecdn.com/bidder/prebidfledge/bids';
 const DEFAULT_CURRENCY_ARR = ['USD']; // NOTE - USD is the only supported currency right now; Hardcoded for bids
 const SUPPORTED_MEDIA_TYPES = [BANNER, NATIVE];
 const TTL = 55;
@@ -50,12 +52,13 @@ export const spec = {
 
     const request = {
       id: validBidRequests[0].auctionId,
-      imp: validBidRequests.map(slot => mapImpression(slot)),
+      imp: validBidRequests.map(slot => mapImpression(slot, bidderRequest)),
       site: mapSite(validBidRequests, bidderRequest),
       cur: DEFAULT_CURRENCY_ARR,
       test: validBidRequests[0].params.test || 0,
       source: mapSource(validBidRequests[0]),
     };
+
     if (bidderRequest && bidderRequest.gdprConsent && bidderRequest.gdprConsent.gdprApplies) {
       const consentStr = (bidderRequest.gdprConsent.consentString)
         ? bidderRequest.gdprConsent.consentString.replace(/\+/g, '-').replace(/\//g, '_').replace(/=+$/, '') : '';
@@ -81,37 +84,32 @@ export const spec = {
       }
     }
 
-    const ortb2Params = bidderRequest && bidderRequest.ortb2;
-    if (ortb2Params?.user) {
-      request.user = {
-        ...request.user,
-        ...(ortb2Params.user.data && {
-          data: { ...request.user?.data, ...ortb2Params.user.data },
-        }),
-        ...(ortb2Params.user.ext && {
-          ext: { ...request.user?.ext, ...ortb2Params.user.ext },
-        }),
-      };
+    const ortb2Params = bidderRequest?.ortb2 || {};
+    if (ortb2Params.site) {
+      mergeDeep(request, { site: ortb2Params.site });
+    }
+    if (ortb2Params.user) {
+      mergeDeep(request, { user: ortb2Params.user });
+    }
+    if (ortb2Params.device) {
+      mergeDeep(request, { device: ortb2Params.device });
     }
-    if (ortb2Params?.site) {
-      request.site = {
-        ...request.site,
-        ...(ortb2Params.site.content && {
-          content: { ...request.site?.content, ...ortb2Params.site.content },
-        }),
-        ...(ortb2Params.site.ext && {
-          ext: { ...request.site?.ext, ...ortb2Params.site.ext },
-        }),
-      };
+
+    let computedEndpointUrl = ENDPOINT_URL;
+
+    const fledgeConfig = config.getConfig('fledgeConfig');
+    if (bidderRequest.fledgeEnabled && fledgeConfig) {
+      mergeDeep(request, { ext: { fledge_config: fledgeConfig } });
+      computedEndpointUrl = FLEDGE_ENDPOINT_URL;
     }
 
     return {
       method: 'POST',
-      url: 'https://' + validBidRequests[0].params.region + '.' + ENDPOINT_URL,
+      url: 'https://' + validBidRequests[0].params.region + '.' + computedEndpointUrl,
       data: JSON.stringify(request)
     };
   },
-  interpretResponse: function (serverResponse, originalRequest) {
+  interpretOrtbResponse: function (serverResponse, originalRequest) {
     const responseBody = serverResponse.body;
     if (!isArray(responseBody)) {
       return [];
@@ -119,17 +117,72 @@ export const spec = {
 
     const bids = [];
     responseBody.forEach(serverBid => {
-      if (serverBid.price === 0) {
+      if (!serverBid.price) { // price may exist and is === 0 or there's no price prop at all (fledge req case)
         return;
       }
+
+      let interpretedBid;
+
       // try...catch would be risky cause JSON.parse throws SyntaxError
       if (serverBid.adm.indexOf('{') === 0) {
-        bids.push(interpretNativeBid(serverBid));
+        interpretedBid = interpretNativeBid(serverBid);
       } else {
-        bids.push(interpretBannerBid(serverBid));
+        interpretedBid = interpretBannerBid(serverBid);
       }
+      if (serverBid.ext) interpretedBid.ext = serverBid.ext;
+
+      bids.push(interpretedBid);
     });
     return bids;
+  },
+  interpretResponse: function (serverResponse, originalRequest) {
+    let bids;
+
+    const responseBody = serverResponse.body;
+    let fledgeAuctionConfigs = null;
+
+    if (responseBody.bidid && isArray(responseBody?.ext?.igbid)) {
+      // we have fledge response
+      // mimic the original response ([{},...])
+      bids = this.interpretOrtbResponse({ body: responseBody.seatbid[0]?.bid }, originalRequest);
+
+      const seller = responseBody.ext.seller;
+      const decisionLogicUrl = responseBody.ext.decisionLogicUrl;
+      const sellerTimeout = 'sellerTimeout' in responseBody.ext ? { sellerTimeout: responseBody.ext.sellerTimeout } : {};
+      responseBody.ext.igbid.forEach((igbid) => {
+        const perBuyerSignals = {};
+        igbid.igbuyer.forEach(buyerItem => {
+          perBuyerSignals[buyerItem.igdomain] = buyerItem.buyersignal
+        });
+        fledgeAuctionConfigs = fledgeAuctionConfigs || {};
+        fledgeAuctionConfigs[igbid.impid] = mergeDeep(
+          {
+            seller,
+            decisionLogicUrl,
+            interestGroupBuyers: Object.keys(perBuyerSignals),
+            perBuyerSignals,
+          },
+          sellerTimeout
+        );
+      });
+    } else {
+      bids = this.interpretOrtbResponse(serverResponse, originalRequest);
+    }
+
+    if (fledgeAuctionConfigs) {
+      fledgeAuctionConfigs = Object.entries(fledgeAuctionConfigs).map(([bidId, cfg]) => {
+        return Object.assign({
+          bidId,
+          auctionSignals: {}
+        }, cfg);
+      });
+      logInfo('Response with FLEDGE:', { bids, fledgeAuctionConfigs });
+      return {
+        bids,
+        fledgeAuctionConfigs,
+      }
+    }
+    return bids;
   }
 };
 registerBidder(spec);
@@ -154,7 +207,7 @@ function applyFloor(slot) {
  * @param {object} slot Ad Unit Params by Prebid
  * @returns {object} Imp by OpenRTB 2.5 §3.2.4
  */
-function mapImpression(slot) {
+function mapImpression(slot, bidderRequest) {
   const imp = {
     id: slot.bidId,
     banner: mapBanner(slot),
@@ -167,6 +220,14 @@ function mapImpression(slot) {
     imp.bidfloor = bidfloor;
   }
 
+  if (bidderRequest.fledgeEnabled) {
+    imp.ext = imp.ext || {};
+    imp.ext.ae = slot?.ortb2Imp?.ext?.ae
+  } else {
+    if (imp.ext?.ae) {
+      delete imp.ext.ae;
+    }
+  }
   return imp;
 }
 

package/modules/rubiconBidAdapter.js

@@ -134,7 +134,8 @@ var sizeMap = {
   574: '620x891',
   576: '610x877',
   578: '980x552',
-  580: '505x656'
+  580: '505x656',
+  622: '192x160'
 };
 _each(sizeMap, (item, key) => sizeMap[item] = key);
 

package/modules/seedtagBidAdapter.js

@@ -1,19 +1,18 @@
 import { isArray, _map, triggerPixel } from '../src/utils.js';
-import { registerBidder } from '../src/adapters/bidderFactory.js'
-import { VIDEO, BANNER } from '../src/mediaTypes.js'
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { VIDEO, BANNER } from '../src/mediaTypes.js';
 import { config } from '../src/config.js';
 
 const BIDDER_CODE = 'seedtag';
 const SEEDTAG_ALIAS = 'st';
 const SEEDTAG_SSP_ENDPOINT = 'https://s.seedtag.com/c/hb/bid';
 const SEEDTAG_SSP_ONTIMEOUT_ENDPOINT = 'https://s.seedtag.com/se/hb/timeout';
-const ALLOWED_PLACEMENTS = {
-  inImage: true,
-  inScreen: true,
-  inArticle: true,
-  banner: true,
-  video: true
-}
+const ALLOWED_DISPLAY_PLACEMENTS = [
+  'inScreen',
+  'inImage',
+  'inArticle',
+  'inBanner',
+];
 
 // Global Vendor List Id
 // https://iabeurope.eu/vendor-list-tcf-v2-0/
@@ -21,27 +20,33 @@ const GVLID = 157;
 
 const mediaTypesMap = {
   [BANNER]: 'display',
-  [VIDEO]: 'video'
+  [VIDEO]: 'video',
 };
 
 const deviceConnection = {
   FIXED: 'fixed',
   MOBILE: 'mobile',
-  UNKNOWN: 'unknown'
+  UNKNOWN: 'unknown',
 };
 
 const getConnectionType = () => {
-  const connection = navigator.connection || navigator.mozConnection || navigator.webkitConnection || {}
+  const connection =
+    navigator.connection ||
+    navigator.mozConnection ||
+    navigator.webkitConnection ||
+    {};
   switch (connection.type || connection.effectiveType) {
     case 'wifi':
     case 'ethernet':
-      return deviceConnection.FIXED
+      return deviceConnection.FIXED;
     case 'cellular':
     case 'wimax':
-      return deviceConnection.MOBILE
+      return deviceConnection.MOBILE;
     default:
-      const isMobile = /iPad|iPhone|iPod/.test(navigator.userAgent) || /android/i.test(navigator.userAgent)
-      return isMobile ? deviceConnection.UNKNOWN : deviceConnection.FIXED
+      const isMobile =
+        /iPad|iPhone|iPod/.test(navigator.userAgent) ||
+        /android/i.test(navigator.userAgent);
+      return isMobile ? deviceConnection.UNKNOWN : deviceConnection.FIXED;
   }
 };
 
@@ -52,24 +57,32 @@ function mapMediaType(seedtagMediaType) {
 }
 
 function hasVideoMediaType(bid) {
-  return (!!bid.mediaTypes && !!bid.mediaTypes.video) || (!!bid.params && !!bid.params.video)
+  return !!bid.mediaTypes && !!bid.mediaTypes.video;
 }
 
-function hasMandatoryParams(params) {
+function hasMandatoryDisplayParams(bid) {
+  const p = bid.params;
   return (
-    !!params.publisherId &&
-    !!params.adUnitId &&
-    !!params.placement &&
-    !!ALLOWED_PLACEMENTS[params.placement]
+    !!p.publisherId &&
+    !!p.adUnitId &&
+    ALLOWED_DISPLAY_PLACEMENTS.indexOf(p.placement) > -1
   );
 }
 
 function hasMandatoryVideoParams(bid) {
-  const videoParams = getVideoParams(bid)
+  const videoParams = getVideoParams(bid);
 
-  return hasVideoMediaType(bid) && !!videoParams.playerSize &&
+  return (
+    !!bid.params.publisherId &&
+    !!bid.params.adUnitId &&
+    hasVideoMediaType(bid) &&
+    !!videoParams.playerSize &&
     isArray(videoParams.playerSize) &&
-    videoParams.playerSize.length > 0;
+    videoParams.playerSize.length > 0 &&
+    // only instream is supported for video
+    videoParams.context === 'instream' &&
+    bid.params.placement === 'inStream'
+  );
 }
 
 function buildBidRequest(validBidRequest) {
@@ -89,15 +102,11 @@ function buildBidRequest(validBidRequest) {
     adUnitId: params.adUnitId,
     adUnitCode: validBidRequest.adUnitCode,
     placement: params.placement,
-    requestCount: validBidRequest.bidderRequestsCount || 1 // FIXME : in unit test the parameter bidderRequestsCount is undefined
+    requestCount: validBidRequest.bidderRequestsCount || 1, // FIXME : in unit test the parameter bidderRequestsCount is undefined
   };
 
-  if (params.adPosition) {
-    bidRequest.adPosition = params.adPosition;
-  }
-
   if (hasVideoMediaType(validBidRequest)) {
-    bidRequest.videoParams = getVideoParams(validBidRequest)
+    bidRequest.videoParams = getVideoParams(validBidRequest);
   }
 
   return bidRequest;
@@ -113,13 +122,7 @@ function getVideoParams(validBidRequest) {
     videoParams.h = videoParams.playerSize[0][1];
   }
 
-  const bidderVideoParams = (validBidRequest.params && validBidRequest.params.video) || {}
-  // override video params from seedtag bidder params
-  Object.keys(bidderVideoParams).forEach(key => {
-    videoParams[key] = validBidRequest.params.video[key]
-  })
-
-  return videoParams
+  return videoParams;
 }
 
 function buildBidResponse(seedtagBid) {
@@ -136,8 +139,11 @@ function buildBidResponse(seedtagBid) {
     ttl: seedtagBid.ttl,
     nurl: seedtagBid.nurl,
     meta: {
-      advertiserDomains: seedtagBid && seedtagBid.adomain && seedtagBid.adomain.length > 0 ? seedtagBid.adomain : []
-    }
+      advertiserDomains:
+        seedtagBid && seedtagBid.adomain && seedtagBid.adomain.length > 0
+          ? seedtagBid.adomain
+          : [],
+    },
   };
 
   if (mediaType === VIDEO) {
@@ -181,16 +187,21 @@ function ttfb() {
 export function getTimeoutUrl(data) {
   let queryParams = '';
   if (
-    isArray(data) && data[0] &&
-    isArray(data[0].params) && data[0].params[0]
+    isArray(data) &&
+    data[0] &&
+    isArray(data[0].params) &&
+    data[0].params[0]
   ) {
     const params = data[0].params[0];
-    const timeout = data[0].timeout
+    const timeout = data[0].timeout;
 
     queryParams =
-      '?publisherToken=' + params.publisherId +
-      '&adUnitId=' + params.adUnitId +
-      '&timeout=' + timeout;
+      '?publisherToken=' +
+      params.publisherId +
+      '&adUnitId=' +
+      params.adUnitId +
+      '&timeout=' +
+      timeout;
   }
   return SEEDTAG_SSP_ONTIMEOUT_ENDPOINT + queryParams;
 }
@@ -208,8 +219,8 @@ export const spec = {
    */
   isBidRequestValid(bid) {
     return hasVideoMediaType(bid)
-      ? hasMandatoryParams(bid.params) && hasMandatoryVideoParams(bid)
-      : hasMandatoryParams(bid.params);
+      ? hasMandatoryVideoParams(bid)
+      : hasMandatoryDisplayParams(bid);
   },
 
   /**
@@ -237,24 +248,24 @@ export const spec = {
       payload['cd'] = bidderRequest.gdprConsent.consentString;
     }
     if (bidderRequest.uspConsent) {
-      payload['uspConsent'] = bidderRequest.uspConsent
+      payload['uspConsent'] = bidderRequest.uspConsent;
     }
 
     if (validBidRequests[0].schain) {
       payload.schain = validBidRequests[0].schain;
     }
 
-    let coppa = config.getConfig('coppa')
+    let coppa = config.getConfig('coppa');
     if (coppa) {
-      payload.coppa = coppa
+      payload.coppa = coppa;
     }
 
-    const payloadString = JSON.stringify(payload)
+    const payloadString = JSON.stringify(payload);
     return {
       method: 'POST',
       url: SEEDTAG_SSP_ENDPOINT,
-      data: payloadString
-    }
+      data: payloadString,
+    };
   },
 
   /**
@@ -308,6 +319,6 @@ export const spec = {
     if (bid && bid.nurl) {
       triggerPixel(bid.nurl);
     }
-  }
-}
+  },
+};
 registerBidder(spec);