prebid.js 5.16.0 → 5.20.0

package/modules/sspBCBidAdapter.js

@@ -1,7 +1,7 @@
 import { isArray, deepAccess, logWarn, parseUrl } from '../src/utils.js';
 import { ajax } from '../src/ajax.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
-import { BANNER } from '../src/mediaTypes.js';
+import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
 import strIncludes from 'core-js-pure/features/string/includes.js';
 
 const BIDDER_CODE = 'sspBC';
@@ -9,7 +9,7 @@ const BIDDER_URL = 'https://ssp.wp.pl/bidder/';
 const SYNC_URL = 'https://ssp.wp.pl/bidder/usersync';
 const NOTIFY_URL = 'https://ssp.wp.pl/bidder/notify';
 const TMAX = 450;
-const BIDDER_VERSION = '5.0';
+const BIDDER_VERSION = '5.2';
 const W = window;
 const { navigator } = W;
 const oneCodeDetection = {};
@@ -155,6 +155,108 @@ const mapBanner = slot => {
   }
 }
 
+/**
+ * @param {string} paramName Native parameter name
+ * @param {object} paramValue Native parameter value
+ * @returns {object} native asset object that conforms to ortb native ads spec
+ */
+const mapAsset = (paramName, paramValue) => {
+  let asset;
+  switch (paramName) {
+    case 'title':
+      asset = {
+        id: 0,
+        required: paramValue.required,
+        title: { len: paramValue.len }
+      }
+      break;
+    case 'cta':
+      asset = {
+        id: 1,
+        required: paramValue.required,
+        data: { type: 12 }
+      }
+      break;
+    case 'icon':
+      asset = {
+        id: 2,
+        required: paramValue.required,
+        img: { type: 1, w: paramValue.sizes[0], h: paramValue.sizes[1] }
+      }
+      break;
+    case 'image':
+      asset = {
+        id: 3,
+        required: paramValue.required,
+        img: { type: 3, w: paramValue.sizes[0], h: paramValue.sizes[1] }
+      }
+      break;
+    case 'body':
+      asset = {
+        id: 4,
+        required: paramValue.required,
+        data: { type: 2 }
+      }
+      break;
+    case 'sponsoredBy':
+      asset = {
+        id: 5,
+        required: paramValue.required,
+        data: { type: 1 }
+      }
+      break;
+  }
+  return asset;
+}
+
+/**
+ * @param {object} slot Ad Unit Params by Prebid
+ * @returns {object} native object that conforms to ortb native ads spec
+ */
+const mapNative = slot => {
+  const native = deepAccess(slot, 'mediaTypes.native');
+  let assets;
+  if (native) {
+    const nativeParams = Object.keys(native);
+    assets = [];
+    nativeParams.forEach(par => {
+      const newAsset = mapAsset(par, native[par]);
+      if (newAsset) { assets.push(newAsset) };
+    });
+  }
+  return assets ? { request: JSON.stringify({ native: { assets } }) } : undefined;
+}
+
+var mapVideo = slot => {
+  var video = deepAccess(slot, 'mediaTypes.video');
+  var videoParamsUsed = ['api', 'context', 'linearity', 'maxduration', 'mimes', 'protocols'];
+  var videoAssets;
+
+  if (video) {
+    var videoParams = Object.keys(video);
+    var playerSize = video.playerSize;
+    videoAssets = {}; // player width / height
+
+    if (playerSize) {
+      var maxSize = playerSize.reduce(function (prev, next) {
+        return next[0] >= prev[0] && next[1] >= prev[1] ? next : prev;
+      }, [1, 1]);
+      videoAssets.w = maxSize[0];
+      videoAssets.h = maxSize[1];
+    } // remaining supported params
+
+    videoParams.forEach(function (par) {
+      if (videoParamsUsed.indexOf(par) >= 0) {
+        videoAssets[par] = video[par];
+      }
+
+      ;
+    });
+  }
+
+  return videoAssets;
+};
+
 const mapImpression = slot => {
   const { adUnitCode, bidId, params = {}, ortb2Imp = {} } = slot;
   const { id, siteId } = params;
@@ -165,32 +267,100 @@ const mapImpression = slot => {
      send this info as ext.pbsize
   */
   const slotSize = slot.sizes.length ? slot.sizes.reduce((prev, next) => prev[0] * prev[1] <= next[0] * next[1] ? next : prev).join('x') : '1x1';
-  adSizesCalled[slotSize] = adSizesCalled[slotSize] ? adSizesCalled[slotSize] + 1 : 1;
+  adSizesCalled[slotSize] = adSizesCalled[slotSize] ? adSizesCalled[slotSize] += 1 : 1;
   ext.data = Object.assign({ pbsize: `${slotSize}_${adSizesCalled[slotSize]}` }, ext.data);
 
   const imp = {
     id: id && siteId ? id : 'bidid-' + bidId,
     banner: mapBanner(slot),
-    // native: mapNative(slot),
+    native: mapNative(slot),
+    video: mapVideo(slot),
     tagid: adUnitCode,
     ext,
   };
 
   // Check floorprices for this imp
   if (typeof slot.getFloor === 'function') {
-    let bannerFloor = 0;
-    // sspBC adapter accepts only floor per imp - check for maximum value for requested ad types and sizes
+    var bannerFloor = 0;
+    var nativeFloor = 0;
+    var videoFloor = 0; // sspBC adapter accepts only floor per imp - check for maximum value for requested ad types and sizes
+
     if (slot.sizes.length) {
-      bannerFloor = slot.sizes.reduce((prev, next) => {
-        const currentFloor = slot.getFloor({ mediaType: 'banner', size: next }).floor;
+      bannerFloor = slot.sizes.reduce(function (prev, next) {
+        var currentFloor = slot.getFloor({
+          mediaType: 'banner',
+          size: next
+        }).floor;
         return prev > currentFloor ? prev : currentFloor;
       }, 0);
     }
-    imp.bidfloor = bannerFloor;
+
+    nativeFloor = slot.getFloor({
+      mediaType: 'native'
+    });
+    videoFloor = slot.getFloor({
+      mediaType: 'video'
+    });
+    imp.bidfloor = Math.max(bannerFloor, nativeFloor, videoFloor);
   }
   return imp;
 }
 
+const isVideoAd = bid => {
+  const xmlTester = new RegExp(/^<\?xml/);
+  return bid.adm && bid.adm.match(xmlTester);
+}
+
+const isNativeAd = bid => {
+  const xmlTester = new RegExp(/^{['"]native['"]/);
+
+  return bid.adm && bid.adm.match(xmlTester);
+}
+
+const parseNative = nativeData => {
+  const result = {};
+  nativeData.assets.forEach(asset => {
+    const id = parseInt(asset.id);
+    switch (id) {
+      case 0:
+        result.title = asset.title.text;
+        break;
+      case 2:
+        result.icon = {
+          url: asset.img.url,
+          width: asset.img.w,
+          height: asset.img.h,
+        };
+        break;
+      case 3:
+        result.image = {
+          url: asset.img.url,
+          width: asset.img.w,
+          height: asset.img.h,
+        };
+        break;
+      case 4:
+        result.body = asset.data.value;
+        break;
+      case 5:
+        result.sponsoredBy = asset.data.value;
+        break;
+
+      default:
+        logWarn('Unrecognized native asset', asset);
+    }
+  });
+  result.clickUrl = nativeData.link.url;
+  result.impressionTrackers = nativeData.imptrackers;
+
+  if (isArray(nativeData.jstracker)) {
+    result.javascriptTrackers = nativeData.jstracker;
+  } else if (nativeData.jstracker) {
+    result.javascriptTrackers = [nativeData.jstracker];
+  }
+  return result;
+}
+
 const renderCreative = (site, auctionId, bid, seat, request) => {
   let gam;
 
@@ -243,6 +413,7 @@ const renderCreative = (site, auctionId, bid, seat, request) => {
   <script>
   window.rekid = ${site.id};
   window.slot = ${parseInt(site.slot, 10)};
+  window.responseTimestamp = ${Date.now()};
   window.wp_sn = "${site.sn}";
   window.mcad = JSON.parse(decodeURI(atob("${mcbase}")));
   window.gdpr = ${JSON.stringify(request.gdprConsent)};
@@ -268,7 +439,7 @@ const renderCreative = (site, auctionId, bid, seat, request) => {
 const spec = {
   code: BIDDER_CODE,
   aliases: [],
-  supportedMediaTypes: [BANNER],
+  supportedMediaTypes: [BANNER, NATIVE, VIDEO],
   isBidRequestValid(bid) {
     // as per OneCode integration, bids without params are valid
     return true;
@@ -377,15 +548,39 @@ const spec = {
               width: w,
               height: h,
               bidderCode: BIDDER_CODE,
-              mediaType: 'banner',
               meta: {
                 advertiserDomains: adomain,
                 networkName: seat,
               },
               netRevenue: true,
-              ad: renderCreative(site, response.id, serverBid, seat, bidderRequest),
             };
 
+            // mediaType and ad data for instream / native / banner
+            if (isVideoAd(serverBid)) {
+              // video
+              bid.adType = 'instream';
+              bid.mediaType = 'video';
+              bid.vastXml = serverBid.adm;
+              bid.vastContent = serverBid.adm;
+            } else if (isNativeAd(serverBid)) {
+              // native
+              bid.mediaType = 'native';
+              // check native object
+              try {
+                const nativeData = JSON.parse(serverBid.adm).native;
+                bid.native = parseNative(nativeData);
+                bid.width = 1;
+                bid.height = 1;
+              } catch (err) {
+                logWarn('Could not parse native data', serverBid.adm);
+                bid.cpm = 0;
+              }
+            } else {
+              // banner ad (default)
+              bid.mediaType = 'banner';
+              bid.ad = renderCreative(site, response.id, serverBid, seat, bidderRequest);
+            }
+
             if (bid.cpm > 0) {
               bids.push(bid);
             }

package/modules/sspBCBidAdapter.md

@@ -7,7 +7,7 @@ Maintainer: wojciech.bialy@grupawp.pl
 # Description
 
 Module that connects to Wirtualna Polska Media header bidding endpoint to fetch bids.
-Only banner format is supported.
+Supports Banner, Video (instream) and Native formats 
 Supported currencies: USD, EUR, PLN
 
 Required parameters:

package/modules/talkadsBidAdapter.js

@@ -0,0 +1,129 @@
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { NATIVE, BANNER } from '../src/mediaTypes.js';
+import * as utils from '../src/utils.js';
+import {ajax} from '../src/ajax.js';
+
+const CURRENCY = 'EUR';
+const BIDDER_CODE = 'talkads';
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [ NATIVE, BANNER ],
+  params: null,
+
+  /**
+   * Determines whether or not the given bid request is valid.
+   *
+   * @param poBid  The bid params to validate.
+   * @return boolean True if this is a valid bid, and false otherwise.
+   */
+  isBidRequestValid: (poBid) => {
+    utils.logInfo('isBidRequestValid : ', poBid);
+    if (poBid.params === undefined) {
+      utils.logError('VALIDATION FAILED : the parameters must be defined');
+      return false;
+    }
+    if (poBid.params.tag_id === undefined) {
+      utils.logError('VALIDATION FAILED : the parameter "tag_id" must be defined');
+      return false;
+    }
+    if (poBid.params.bidder_url === undefined) {
+      utils.logError('VALIDATION FAILED : the parameter "bidder_url" must be defined');
+      return false;
+    }
+    this.params = poBid.params;
+    return !!(poBid.nativeParams || poBid.sizes);
+  }, // isBidRequestValid
+
+  /**
+   * Make a server request from the list of BidRequests.
+   *
+   * @param paValidBidRequests  An array of bids
+   * @param poBidderRequest
+   * @return ServerRequest Info describing the request to the server.
+   */
+  buildRequests: (paValidBidRequests, poBidderRequest) => {
+    utils.logInfo('buildRequests : ', paValidBidRequests, poBidderRequest);
+    const laBids = paValidBidRequests.map((poBid, piId) => {
+      const loOne = { id: piId, ad_unit: poBid.adUnitCode, bid_id: poBid.bidId, type: '', size: [] };
+      if (poBid.nativeParams) {
+        loOne.type = 'native';
+      } else {
+        loOne.type = 'banner';
+        loOne.size = poBid.sizes;
+      }
+      return loOne;
+    });
+    const loServerRequest = {
+      cur: CURRENCY,
+      timeout: poBidderRequest.timeout,
+      auction_id: paValidBidRequests[0].auctionId,
+      transaction_id: paValidBidRequests[0].transactionId,
+      bids: laBids,
+      gdpr: { applies: false, consent: false },
+    };
+    if (poBidderRequest && poBidderRequest.gdprConsent) {
+      const loGdprConsent = poBidderRequest.gdprConsent;
+      if ((typeof loGdprConsent.gdprApplies === 'boolean') && loGdprConsent.gdprApplies) {
+        loServerRequest.gdpr.applies = true;
+      }
+      if ((typeof loGdprConsent.consentString === 'string') && loGdprConsent.consentString) {
+        loServerRequest.gdpr.consent = poBidderRequest.gdprConsent.consentString;
+      }
+    }
+    const lsUrl = this.params.bidder_url + '/' + this.params.tag_id;
+    return {
+      method: 'POST',
+      url: lsUrl,
+      data: JSON.stringify(loServerRequest),
+    };
+  }, // buildRequests
+
+  /**
+   * Unpack the response from the server into a list of bids.
+   *
+   * @param poServerResponse A successful response from the server.
+   * @param poPidRequest Request original server request
+   * @return An array of bids which were nested inside the server.
+   */
+  interpretResponse: (poServerResponse, poPidRequest) => {
+    utils.logInfo('interpretResponse : ', poServerResponse);
+    if (!poServerResponse.body) {
+      return [];
+    }
+    let laResponse = [];
+    if (poServerResponse.body.status !== 'ok') {
+      utils.logInfo('Error : ', poServerResponse.body.error);
+      return laResponse;
+    }
+    poServerResponse.body.bids.forEach((poResponse) => {
+      laResponse[laResponse.length] = {
+        requestId: poResponse.requestId,
+        cpm: poResponse.cpm,
+        currency: poResponse.currency,
+        width: poResponse.width,
+        height: poResponse.height,
+        ad: poResponse.ad,
+        ttl: poResponse.ttl,
+        creativeId: poResponse.creativeId,
+        netRevenue: poResponse.netRevenue,
+        pbid: poServerResponse.body.pbid,
+      };
+    });
+    return laResponse;
+  }, // interpretResponse
+
+  /**
+   * Register bidder specific code, which will execute if a bid from this bidder won the auction.
+   *
+   * @param poBid The bid that won the auction
+   */
+  onBidWon: (poBid) => {
+    utils.logInfo('onBidWon : ', poBid);
+    if (poBid.pbid) {
+      ajax(this.params.bidder_url + 'won/' + poBid.pbid);
+    }
+  }, // onBidWon
+};
+
+registerBidder(spec);

package/modules/talkadsBidAdapter.md

@@ -0,0 +1,60 @@
+# Overview
+
+```
+Module Name: TalkAds Adapter
+Module Type: Bidder Adapter
+Maintainer: technical_team@natexo.com
+```
+
+# Description
+
+Module that connects to TalkAds bidder to fetch bids.
+Both native and banner formats are supported but not at the same time.
+The only currently supported currency is EUR.
+
+This adapter requires setup and approval from the Natexo programmatic team.
+
+# Configuration
+
+
+
+
+# Test parameters
+
+## Test banner Parameters
+
+```
+    var adUnits = [
+        code: 'prebid_banner_test',
+        mediaTypes: {
+            banner: {
+                sizes: [[300, 250], [300, 600]],
+            }
+        },
+        bids: [{
+            bidder: 'talkads',
+            params: {
+                tag_id: 0,
+                bidder_url: 'https://d.natexo-programmatic.com/tad/tag/testbid',
+            },
+        }]
+    ];
+```
+
+## Test native parameters
+
+```
+    var adUnits = [
+        code: 'prebid_native_test',
+        mediaTypes: {
+            native: {}
+        },
+        bids: [{
+            bidder: 'talkads',
+            params: {
+                tag_id: 0,
+                bidder_url: 'https://d.natexo-programmatic.com/tad/tag/testbid',
+            },
+        }]
+    ];
+```

package/modules/tappxBidAdapter.js

@@ -9,7 +9,7 @@ import { Renderer } from '../src/Renderer.js';
 const BIDDER_CODE = 'tappx';
 const TTL = 360;
 const CUR = 'USD';
-const TAPPX_BIDDER_VERSION = '0.1.0921';
+const TAPPX_BIDDER_VERSION = '0.1.1004';
 const TYPE_CNN = 'prebidjs';
 const LOG_PREFIX = '[TAPPX]: ';
 const VIDEO_SUPPORT = ['instream', 'outstream'];
@@ -495,15 +495,16 @@ export function _getHostInfo(validBidRequests) {
 }
 
 function outstreamRender(bid, request) {
+  let rendererOptions = {};
+  rendererOptions = (typeof bid.params[0].video != 'undefined') ? bid.params[0].video : {};
+  rendererOptions.content = bid.vastXml;
+
   bid.renderer.push(() => {
     window.tappxOutstream.renderAd({
       sizes: [bid.width, bid.height],
       targetId: bid.adUnitCode,
       adResponse: bid.adResponse,
-      rendererOptions: {
-        content: bid.vastXml,
-        skip: (typeof bid.params[0].video.skip != 'undefined' && bid.params[0].video.skip > 0) ? bid.params[0].video.skip : 0
-      }
+      rendererOptions: rendererOptions
     });
   });
 }

package/modules/teadsBidAdapter.js

@@ -190,6 +190,8 @@ function buildRequestObject(bid) {
   const reqObj = {};
   let placementId = getValue(bid.params, 'placementId');
   let pageId = getValue(bid.params, 'pageId');
+  const impressionData = deepAccess(bid, 'ortb2Imp.ext.data');
+  const gpid = deepAccess(impressionData, 'pbadslot') || deepAccess(impressionData, 'adserver.adslot');
 
   reqObj.sizes = getSizes(bid);
   reqObj.bidId = getBidIdParameter('bidId', bid);
@@ -199,6 +201,7 @@ function buildRequestObject(bid) {
   reqObj.adUnitCode = getBidIdParameter('adUnitCode', bid);
   reqObj.auctionId = getBidIdParameter('auctionId', bid);
   reqObj.transactionId = getBidIdParameter('transactionId', bid);
+  if (gpid) { reqObj.gpid = gpid; }
   return reqObj;
 }
 

package/modules/tripleliftBidAdapter.js

@@ -1,4 +1,4 @@
-import { tryAppendQueryString, logMessage, isEmpty } from '../src/utils.js';
+import { tryAppendQueryString, logMessage, isEmpty, isStr, isPlainObject, isArray, logWarn } from '../src/utils.js';
 import { BANNER, VIDEO } from '../src/mediaTypes.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { config } from '../src/config.js';
@@ -262,19 +262,36 @@ function getPubCommonEids(bidRequest) {
 function getEids(bidRequest, type, source, rtiPartner) {
   return bidRequest
     .map(getUserId(type)) // bids -> userIds of a certain type
-    .filter((x) => !!x) // filter out null userIds
+    .filter(filterEids(type)) // filter out unqualified userIds
     .map(formatEid(source, rtiPartner)); // userIds -> eid objects
 }
 
+const filterEids = type => (userId, i, arr) => {
+  let isValidUserId =
+    !!userId && // is not null nor empty
+    (isStr(userId)
+      ? !!userId
+      : isPlainObject(userId) && // or, is object
+        !isArray(userId) && // not an array
+        !isEmpty(userId) && // is not empty
+        userId.id && // contains nested id field
+        isStr(userId.id) && // nested id field is a string
+        !!userId.id); // that is not empty
+  if (!isValidUserId && arr[0] !== undefined) {
+    logWarn(`Triplelift: invalid ${type} userId format`);
+  }
+  return isValidUserId;
+};
+
 function getUserId(type) {
-  return (bid) => (bid && bid.userId && bid.userId[type]);
+  return bid => bid && bid.userId && bid.userId[type];
 }
 
 function formatEid(source, rtiPartner) {
-  return (id) => ({
+  return (userId) => ({
     source,
     uids: [{
-      id,
+      id: userId.id ? userId.id : userId,
       ext: { rtiPartner }
     }]
   });

package/modules/trustxBidAdapter.js

@@ -315,7 +315,7 @@ function _addBidResponse(serverBid, bidRequest, bidResponses, RendererConst) {
   if (!serverBid) return;
   let errorMessage;
   if (!serverBid.auid) errorMessage = LOG_ERROR_MESS.noAuid + JSON.stringify(serverBid);
-  if (!serverBid.adm) errorMessage = LOG_ERROR_MESS.noAdm + JSON.stringify(serverBid);
+  if (!serverBid.adm && !serverBid.nurl) errorMessage = LOG_ERROR_MESS.noAdm + JSON.stringify(serverBid);
   else {
     const { bidsMap } = bidRequest;
     const bid = bidsMap[serverBid.impid];
@@ -336,11 +336,15 @@ function _addBidResponse(serverBid, bidRequest, bidResponses, RendererConst) {
         },
       };
       if (serverBid.content_type === 'video') {
-        bidResponse.vastXml = serverBid.adm;
+        if (serverBid.adm) {
+          bidResponse.vastXml = serverBid.adm;
+          bidResponse.adResponse = {
+            content: bidResponse.vastXml
+          };
+        } else if (serverBid.nurl) {
+          bidResponse.vastUrl = serverBid.nurl;
+        }
         bidResponse.mediaType = VIDEO;
-        bidResponse.adResponse = {
-          content: bidResponse.vastXml
-        };
         if (!bid.renderer && (!bid.mediaTypes || !bid.mediaTypes.video || bid.mediaTypes.video.context === 'outstream')) {
           bidResponse.renderer = createRenderer(bidResponse, {
             id: bid.bidId,
@@ -425,9 +429,10 @@ function addSegments(name, segName, segments, data, bidConfigName) {
   if (segments && segments.length) {
     data.push({
       name: name,
-      segment: segments.map((seg) => {
-        return {name: segName, value: seg};
-      })
+      segment: segments
+        .map((seg) => seg && (seg.id || seg))
+        .filter((seg) => seg && (typeof seg === 'string' || typeof seg === 'number'))
+        .map((seg) => ({ name: segName, value: seg.toString() }))
     });
   } else if (bidConfigName) {
     const configData = config.getConfig('ortb2.user.data');
@@ -441,9 +446,10 @@ function addSegments(name, segName, segments, data, bidConfigName) {
     if (segData && segData.length) {
       data.push({
         name: name,
-        segment: segData.map((seg) => {
-          return {name: segName, value: seg};
-        })
+        segment: segData
+          .map((seg) => seg && (seg.id || seg))
+          .filter((seg) => seg && (typeof seg === 'string' || typeof seg === 'number'))
+          .map((seg) => ({ name: segName, value: seg.toString() }))
       });
     }
   }

package/modules/undertoneBidAdapter.js

@@ -85,13 +85,17 @@ export const spec = {
     const vw = Math.max(document.documentElement.clientWidth, window.innerWidth || 0);
     const vh = Math.max(document.documentElement.clientHeight, window.innerHeight || 0);
     const pageSizeArray = vw == 0 || vh == 0 ? null : [vw, vh];
+    const commons = {
+      'adapterVersion': '$prebid.version$',
+      'uids': validBidRequests[0].userId,
+      'pageSize': pageSizeArray
+    };
+    if (validBidRequests[0].schain) {
+      commons.schain = validBidRequests[0].schain;
+    }
     const payload = {
       'x-ut-hb-params': [],
-      'commons': {
-        'adapterVersion': '$prebid.version$',
-        'uids': validBidRequests[0].userId,
-        'pageSize': pageSizeArray
-      }
+      'commons': commons
     };
     const referer = bidderRequest.refererInfo.referer;
     const hostname = parseUrl(referer).hostname;

package/modules/undertoneBidAdapter.md

@@ -1,9 +1,13 @@
 # Overview
 
 ```
-Module Name: Example Bidder Adapter
+Module Name: Undertone Bidder Adapter
 Module Type: Bidder Adapter
 Maintainer: RampProgrammatic@perion.com
+gdpr_supported: true
+usp_supported: true
+schain_supported: true
+media_types: video, native
 ```
 # Description