prebid.js 5.16.0 → 5.20.0

package/modules/publinkIdSystem.js

@@ -19,7 +19,7 @@ const PUBLINK_S2S_COOKIE = '_publink_srv';
 export const storage = getStorageManager(GVLID);
 
 function isHex(s) {
-  return (typeof s === 'string' && /^[A-F0-9]+$/i.test(s));
+  return /^[A-F0-9]+$/i.test(s);
 }
 
 function publinkIdUrl(params, consentData) {
@@ -29,11 +29,16 @@ function publinkIdUrl(params, consentData) {
     mpn: 'Prebid.js',
     mpv: '$prebid.version$',
   };
+
   if (consentData) {
     url.search.gdpr = (consentData.gdprApplies) ? 1 : 0;
     url.search.gdpr_consent = consentData.consentString;
   }
 
+  if (params.site_id) { url.search.sid = params.site_id; }
+
+  if (params.api_key) { url.search.apikey = params.api_key; }
+
   const usPrivacyString = uspDataHandler.getConsentData();
   if (usPrivacyString && typeof usPrivacyString === 'string') {
     url.search.us_privacy = usPrivacyString;
@@ -76,13 +81,18 @@ function getlocalValue() {
     }
 
     if (typeof value === 'string') {
-      try {
-        const obj = JSON.parse(value);
-        if (obj && obj.exp && obj.exp > Date.now()) {
-          return obj.publink;
+      // if it's a json object parse it and return the publink value, otherwise assume the value is the id
+      if (value.charAt(0) === '{') {
+        try {
+          const obj = JSON.parse(value);
+          if (obj) {
+            return obj.publink;
+          }
+        } catch (e) {
+          logError(e);
         }
-      } catch (e) {
-        logError(e);
+      } else {
+        return value;
       }
     }
   }

package/modules/publinkIdSystem.md

@@ -7,7 +7,10 @@ Publink user id module
 | Param Name | Required | Type | Description | Example |
 | --- | --- | --- | --- | --- |
 | name | Yes | String | module identifier | `"publinkId"` |
-| params.e | Yes | String | hashed email address | `"e80b5017098950fc58aad83c8c14978e"` |
+| params.e | Yes | String | hashed email address | `"7D320454942620664D96EF78ED4E3A2A"` |
+| params.api_key | Yes | String | api key for access | `"7ab62359-bdc0-4095-b573-ef474fb55d24"` |
+| params.site_id | Yes | String | site identifier | `"123456"` |
+
 
 ### Example configuration for Publink
 ```
@@ -20,7 +23,9 @@ pbjs.setConfig({
                    type: "html5"
                },
                params: {
-                   e: "e80b5017098950fc58aad83c8c14978e", // example hashed email (md5)
+                   e: "7D320454942620664D96EF78ED4E3A2A",           // example hashed email (md5)
+                   site_id: "123456",                               // provided by Epsilon
+                   api_key: "7ab62359-bdc0-4095-b573-ef474fb55d2"   // provided by Epsilon
                }
            }],
        }

package/modules/pubmaticBidAdapter.js

@@ -17,6 +17,7 @@ const DEFAULT_HEIGHT = 0;
 const PREBID_NATIVE_HELP_LINK = 'http://prebid.org/dev-docs/show-native-ads.html';
 const PUBLICATION = 'pubmatic'; // Your publication on Blue Billywig, potentially with environment (e.g. publication.bbvms.com or publication.test.bbvms.com)
 const RENDERER_URL = 'https://pubmatic.bbvms.com/r/'.concat('$RENDERER', '.js'); // URL of the renderer application
+const MSG_VIDEO_PLACEMENT_MISSING = 'Video.Placement param missing';
 const CUSTOM_PARAMS = {
   'kadpageurl': '', // Custom page url
   'gender': '', // User gender
@@ -537,12 +538,20 @@ function _createBannerRequest(bid) {
   return bannerObj;
 }
 
+export function checkVideoPlacement(videoData, adUnitCode) {
+  // Check for video.placement property. If property is missing display log message.
+  if (!deepAccess(videoData, 'placement')) {
+    logWarn(MSG_VIDEO_PLACEMENT_MISSING + ' for ' + adUnitCode);
+  };
+}
+
 function _createVideoRequest(bid) {
   var videoData = mergeDeep(deepAccess(bid.mediaTypes, 'video'), bid.params.video);
   var videoObj;
 
   if (videoData !== UNDEFINED) {
     videoObj = {};
+    checkVideoPlacement(videoData, bid.adUnitCode);
     for (var key in VIDEO_CUSTOM_PARAMS) {
       if (videoData.hasOwnProperty(key)) {
         videoObj[key] = _checkParamDataType(key, videoData[key], VIDEO_CUSTOM_PARAMS[key]);
@@ -605,7 +614,7 @@ function _addDealCustomTargetings(imp, bid) {
   }
 }
 
-function _addJWPlayerSegmentData(imp, bid) {
+function _addJWPlayerSegmentData(imp, bid, isS2S) {
   var jwSegData = (bid.rtd && bid.rtd.jwplayer && bid.rtd.jwplayer.targeting) || undefined;
   var jwPlayerData = '';
   const jwMark = 'jw-';
@@ -619,10 +628,15 @@ function _addJWPlayerSegmentData(imp, bid) {
   for (var i = 0; i < maxLength; i++) {
     jwPlayerData += '|' + jwMark + jwSegData.segments[i] + '=1';
   }
-  const ext = imp.ext;
-  (ext && ext.key_val === undefined)
-    ? ext.key_val = jwPlayerData
-    : ext.key_val += '|' + jwPlayerData;
+
+  var ext;
+
+  if (isS2S) {
+    (imp.dctr === undefined || imp.dctr.length == 0) ? imp.dctr = jwPlayerData : imp.dctr += '|' + jwPlayerData;
+  } else {
+    ext = imp.ext;
+    ext && ext.key_val === undefined ? ext.key_val = jwPlayerData : ext.key_val += '|' + jwPlayerData;
+  }
 }
 
 function _createImpressionObject(bid, conf) {
@@ -1322,7 +1336,9 @@ export const spec = {
    * @param {Boolean} isOpenRtb boolean to check openrtb2 protocol
    * @return {Object} params bid params
    */
-  transformBidParams: function (params, isOpenRtb) {
+
+  transformBidParams: function (params, isOpenRtb, adUnit, bidRequests) {
+    _addJWPlayerSegmentData(params, adUnit.bids[0], true);
     return convertTypes({
       'publisherId': 'string',
       'adSlot': 'string'

package/modules/pubmaticBidAdapter.md

@@ -25,7 +25,7 @@ var adUnits = [
       bidder: 'pubmatic',
       params: {
         publisherId: '156209',               // required, must be a string, not an integer or other js type.
-        oustreamAU: 'renderer_test_pubmatic',   // required if mediaTypes-> video-> context is 'outstream' and optional if renderer is defined in adUnits or in mediaType video. This value can be get by BlueBillyWig Team.
+        outstreamAU: 'renderer_test_pubmatic',   // required if mediaTypes-> video-> context is 'outstream' and optional if renderer is defined in adUnits or in mediaType video. This value can be get by BlueBillyWig Team.
         adSlot: 'pubmatic_test2',            // optional, must be a string, not an integer or other js type.
         pmzoneid: 'zone1, zone11',           // optional
         lat: '40.712775',                    // optional

package/modules/relaidoBidAdapter.js

@@ -6,7 +6,7 @@ import { getStorageManager } from '../src/storageManager.js';
 
 const BIDDER_CODE = 'relaido';
 const BIDDER_DOMAIN = 'api.relaido.jp';
-const ADAPTER_VERSION = '1.0.5';
+const ADAPTER_VERSION = '1.0.6';
 const DEFAULT_TTL = 300;
 const UUID_KEY = 'relaido_uuid';
 
@@ -68,9 +68,15 @@ function buildRequests(validBidRequests, bidderRequest) {
       media_type: mediaType,
       uuid: uuid,
       width: width,
-      height: height
+      height: height,
+      pv: '$prebid.version$'
     };
 
+    const imuid = deepAccess(bidRequest, 'userId.imuid');
+    if (imuid) {
+      payload.imuid = imuid;
+    }
+
     // It may not be encoded, so add it at the end of the payload
     payload.ref = bidderRequest.refererInfo.referer;
 

package/modules/rtdModule/index.js

@@ -42,10 +42,10 @@
  * @function?
  * @summary modify bid request data
  * @name RtdSubmodule#getBidRequestData
- * @param {SubmoduleConfig} config
- * @param {UserConsentData} userConsent
  * @param {Object} reqBidsConfigObj
  * @param {function} callback
+ * @param {SubmoduleConfig} config
+ * @param {UserConsentData} userConsent
  */
 
 /**

package/modules/sharethroughBidAdapter.js

@@ -3,9 +3,8 @@ import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { config } from '../src/config.js';
 import { BANNER, VIDEO } from '../src/mediaTypes.js';
 import { createEidsArray } from './userId/eids.js';
-import find from 'core-js-pure/features/array/find.js';
 
-const VERSION = '4.0.0';
+const VERSION = '4.0.1';
 const BIDDER_CODE = 'sharethrough';
 const SUPPLY_ID = 'WYu2BXv1';
 
@@ -141,16 +140,16 @@ export const sharethroughAdapterSpec = {
       };
     }).filter(imp => !!imp);
 
-    return {
-      method: 'POST',
-      url: STR_ENDPOINT,
-      data: {
-        ...req,
-        imp: imps,
-      },
-      bidRequests,
-      bidderRequest,
-    };
+    return imps.map(impression => {
+      return {
+        method: 'POST',
+        url: STR_ENDPOINT,
+        data: {
+          ...req,
+          imp: [impression],
+        },
+      };
+    });
   },
 
   interpretResponse: ({ body }, req) => {
@@ -159,8 +158,6 @@ export const sharethroughAdapterSpec = {
     }
 
     return body.seatbid[0].bid.map(bid => {
-      const request = matchRequest(bid.impid, req);
-
       const response = {
         requestId: bid.impid,
         width: +bid.w,
@@ -168,7 +165,7 @@ export const sharethroughAdapterSpec = {
         cpm: +bid.price,
         creativeId: bid.crid,
         dealId: bid.dealid || null,
-        mediaType: request.mediaTypes && request.mediaTypes.video ? VIDEO : BANNER,
+        mediaType: req.data.imp[0].video ? VIDEO : BANNER,
         currency: body.cur || 'USD',
         netRevenue: true,
         ttl: 360,
@@ -270,10 +267,6 @@ function getProtocol() {
   return window.location.protocol;
 }
 
-function matchRequest(id, request) {
-  return find(request.bidRequests, bid => bid.bidId === id);
-}
-
 // stub for ?? operator
 function nullish(input, def) {
   return input === null || input === undefined ? def : input;

package/modules/slimcutBidAdapter.js

@@ -0,0 +1,121 @@
+import { getValue, parseSizesInput, getBidIdParameter } from '../src/utils.js';
+import {
+  registerBidder
+} from '../src/adapters/bidderFactory.js';
+import {
+  ajax
+} from '../src/ajax.js';
+const BIDDER_CODE = 'slimcut';
+const ENDPOINT_URL = 'https://sb.freeskreen.com/pbr';
+export const spec = {
+  code: BIDDER_CODE,
+  aliases: ['scm'],
+  supportedMediaTypes: ['video', 'banner'],
+  /**
+     * Determines whether or not the given bid request is valid.
+     *
+     * @param {BidRequest} bid The bid params to validate.
+     * @return boolean True if this is a valid bid, and false otherwise.
+     */
+  isBidRequestValid: function(bid) {
+    let isValid = false;
+    if (typeof bid.params !== 'undefined' && !isNaN(parseInt(getValue(bid.params, 'placementId'))) && parseInt(getValue(bid.params, 'placementId')) > 0) {
+      isValid = true;
+    }
+    return isValid;
+  },
+  /**
+     * Make a server request from the list of BidRequests.
+     *
+     * @param {validBidRequests[]} an array of bids
+     * @return ServerRequest Info describing the request to the server.
+     */
+  buildRequests: function(validBidRequests, bidderRequest) {
+    const bids = validBidRequests.map(buildRequestObject);
+    const payload = {
+      referrer: getReferrerInfo(bidderRequest),
+      data: bids,
+      deviceWidth: screen.width
+    };
+    let gdpr = bidderRequest.gdprConsent;
+    if (bidderRequest && gdpr) {
+      let isCmp = (typeof gdpr.gdprApplies === 'boolean')
+      let isConsentString = (typeof gdpr.consentString === 'string')
+      payload.gdpr_iab = {
+        consent: isConsentString ? gdpr.consentString : '',
+        status: isCmp ? gdpr.gdprApplies : -1
+      };
+    }
+    const payloadString = JSON.stringify(payload);
+    return {
+      method: 'POST',
+      url: ENDPOINT_URL,
+      data: payloadString,
+    };
+  },
+  /**
+     * Unpack the response from the server into a list of bids.
+     *
+     * @param {*} serverResponse A successful response from the server.
+     * @return {Bid[]} An array of bids which were nested inside the server.
+     */
+  interpretResponse: function(serverResponse, request) {
+    const bidResponses = [];
+    serverResponse = serverResponse.body;
+    if (serverResponse.responses) {
+      serverResponse.responses.forEach(function(bid) {
+        const bidResponse = {
+          cpm: bid.cpm,
+          width: bid.width,
+          height: bid.height,
+          currency: bid.currency,
+          netRevenue: bid.netRevenue,
+          ttl: bid.ttl,
+          ad: bid.ad,
+          requestId: bid.requestId,
+          creativeId: bid.creativeId,
+          transactionId: bid.tranactionId,
+          winUrl: bid.winUrl,
+          meta: {
+            advertiserDomains: bid.adomain || []
+          }
+        };
+        bidResponses.push(bidResponse);
+      });
+    }
+    return bidResponses;
+  },
+  getUserSyncs: function(syncOptions, serverResponses) {
+    if (syncOptions.iframeEnabled) {
+      return [{
+        type: 'iframe',
+        url: 'https://sb.freeskreen.com/async_usersync.html'
+      }];
+    }
+    return [];
+  },
+  onBidWon: function(bid) {
+    ajax(bid.winUrl + bid.cpm, null);
+  }
+}
+function buildRequestObject(bid) {
+  const reqObj = {};
+  let placementId = getValue(bid.params, 'placementId');
+  reqObj.sizes = parseSizesInput(bid.sizes);
+  reqObj.bidId = getBidIdParameter('bidId', bid);
+  reqObj.bidderRequestId = getBidIdParameter('bidderRequestId', bid);
+  reqObj.placementId = parseInt(placementId);
+  reqObj.adUnitCode = getBidIdParameter('adUnitCode', bid);
+  reqObj.auctionId = getBidIdParameter('auctionId', bid);
+  reqObj.transactionId = getBidIdParameter('transactionId', bid);
+  return reqObj;
+}
+function getReferrerInfo(bidderRequest) {
+  let ref = window.location.href;
+  if (bidderRequest && bidderRequest.refererInfo && bidderRequest.refererInfo.referer) {
+    ref = bidderRequest.refererInfo.referer;
+  }
+  return ref;
+}
+
+registerBidder(spec);

package/modules/sonobiBidAdapter.js

@@ -83,8 +83,15 @@ export const spec = {
       'lib_name': 'prebid',
       'lib_v': '$prebid.version$',
       'us': 0,
+
     };
 
+    const fpd = config.getConfig('ortb2');
+
+    if (fpd) {
+      payload.fpd = JSON.stringify(fpd);
+    }
+
     if (config.getConfig('userSync') && config.getConfig('userSync').syncsPerBidder) {
       payload.us = config.getConfig('userSync').syncsPerBidder;
     }

package/modules/sortableBidAdapter.js

@@ -227,6 +227,7 @@ export const spec = {
           rv.ext[partner] = params;
         });
       }
+      rv.ext.gpid = deepAccess(bid, 'ortb2Imp.ext.data.pbadslot');
       return rv;
     });
     const gdprConsent = bidderRequest && bidderRequest.gdprConsent;

package/modules/spotxBidAdapter.js

@@ -1,4 +1,4 @@
-import { logError, deepAccess, isArray, getBidIdParameter, getDNT, deepSetValue, isEmpty, _each, logMessage, logWarn, isBoolean, isNumber, isPlainObject } from '../src/utils.js';
+import { logError, deepAccess, isArray, getBidIdParameter, getDNT, deepSetValue, isEmpty, _each, logMessage, logWarn, isBoolean, isNumber, isPlainObject, isFn } from '../src/utils.js';
 import { config } from '../src/config.js';
 import { Renderer } from '../src/Renderer.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
@@ -163,6 +163,20 @@ export const spec = {
         }
       };
 
+      if (isFn(bid.getFloor)) {
+        let floorInfo = bid.getFloor({
+          currency: 'USD',
+          mediaType: 'video',
+          size: '*'
+        });
+
+        if (floorInfo.currency === 'USD') {
+          spotxReq.bidfloor = floorInfo.floor;
+        }
+      } else if (getBidIdParameter('price_floor', bid.params) != '') {
+        spotxReq.bidfloor = getBidIdParameter('price_floor', bid.params);
+      }
+
       if (getBidIdParameter('start_delay', bid.params) != '') {
         spotxReq.video.startdelay = 0 + Boolean(getBidIdParameter('start_delay', bid.params));
       }