prebid.js 6.1.0 → 6.5.0

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.6';
+const ADAPTER_VERSION = '1.0.7';
 const DEFAULT_TTL = 300;
 const UUID_KEY = 'relaido_uuid';
 
@@ -31,14 +31,14 @@ function isBidRequestValid(bid) {
 }
 
 function buildRequests(validBidRequests, bidderRequest) {
-  let bidRequests = [];
+  const bids = [];
+  let imuid = null;
+  let bidDomain = null;
+  let bidder = null;
+  let count = null;
 
   for (let i = 0; i < validBidRequests.length; i++) {
     const bidRequest = validBidRequests[i];
-    const placementId = getBidIdParameter('placementId', bidRequest.params);
-    const bidDomain = bidRequest.params.domain || BIDDER_DOMAIN;
-    const bidUrl = `https://${bidDomain}/bid/v1/prebid/${placementId}`;
-    const uuid = getUuid();
     let mediaType = '';
     let width = 0;
     let height = 0;
@@ -55,46 +55,63 @@ function buildRequests(validBidRequests, bidderRequest) {
       mediaType = BANNER;
     }
 
-    let payload = {
-      version: ADAPTER_VERSION,
-      timeout_ms: bidderRequest.timeout,
-      ad_unit_code: bidRequest.adUnitCode,
-      auction_id: bidRequest.auctionId,
-      bidder: bidRequest.bidder,
-      bidder_request_id: bidRequest.bidderRequestId,
-      bid_requests_count: bidRequest.bidRequestsCount,
-      bid_id: bidRequest.bidId,
-      transaction_id: bidRequest.transactionId,
-      media_type: mediaType,
-      uuid: uuid,
-      width: width,
-      height: height,
-      pv: '$prebid.version$'
-    };
+    if (!imuid) {
+      const pickImuid = deepAccess(bidRequest, 'userId.imuid');
+      if (pickImuid) {
+        imuid = pickImuid;
+      }
+    }
+
+    if (!bidDomain) {
+      bidDomain = bidRequest.params.domain;
+    }
+
+    if (!bidder) {
+      bidder = bidRequest.bidder
+    }
+
+    if (!bidder) {
+      bidder = bidRequest.bidder
+    }
 
-    const imuid = deepAccess(bidRequest, 'userId.imuid');
-    if (imuid) {
-      payload.imuid = imuid;
+    if (!count) {
+      count = bidRequest.bidRequestsCount;
     }
 
-    // It may not be encoded, so add it at the end of the payload
-    payload.ref = bidderRequest.refererInfo.referer;
-
-    bidRequests.push({
-      method: 'GET',
-      url: bidUrl,
-      data: payload,
-      options: {
-        withCredentials: true
-      },
-      bidId: bidRequest.bidId,
+    bids.push({
+      bid_id: bidRequest.bidId,
+      placement_id: getBidIdParameter('placementId', bidRequest.params),
+      transaction_id: bidRequest.transactionId,
+      bidder_request_id: bidRequest.bidderRequestId,
+      ad_unit_code: bidRequest.adUnitCode,
+      auction_id: bidRequest.auctionId,
       player: bidRequest.params.player,
-      width: payload.width,
-      height: payload.height,
-      mediaType: payload.media_type
+      width: width,
+      height: height,
+      media_type: mediaType
     });
   }
-  return bidRequests;
+
+  const data = JSON.stringify({
+    version: ADAPTER_VERSION,
+    bids: bids,
+    timeout_ms: bidderRequest.timeout,
+    bidder: bidder,
+    bid_requests_count: count,
+    uuid: getUuid(),
+    pv: '$prebid.version$',
+    imuid: imuid,
+    ref: bidderRequest.refererInfo.referer
+  })
+
+  return {
+    method: 'POST',
+    url: `https://${bidDomain || BIDDER_DOMAIN}/bid/v1/sprebid`,
+    options: {
+      withCredentials: true
+    },
+    data: data
+  };
 }
 
 function interpretResponse(serverResponse, bidRequest) {
@@ -105,34 +122,38 @@ function interpretResponse(serverResponse, bidRequest) {
   }
 
   const playerUrl = bidRequest.player || body.playerUrl;
-  const mediaType = bidRequest.mediaType || VIDEO;
-
-  let bidResponse = {
-    requestId: bidRequest.bidId,
-    width: bidRequest.width,
-    height: bidRequest.height,
-    cpm: body.price,
-    currency: body.currency,
-    creativeId: body.creativeId,
-    dealId: body.dealId || '',
-    ttl: body.ttl || DEFAULT_TTL,
-    netRevenue: true,
-    mediaType: mediaType,
-    meta: {
-      advertiserDomains: body.adomain || [],
-      mediaType: VIDEO
+
+  for (const res of body.ads) {
+    let bidResponse = {
+      requestId: res.bidId,
+      width: res.width,
+      height: res.height,
+      cpm: res.price,
+      currency: res.currency,
+      creativeId: res.creativeId,
+      dealId: body.dealId || '',
+      ttl: body.ttl || DEFAULT_TTL,
+      netRevenue: true,
+      mediaType: res.mediaType || VIDEO,
+      meta: {
+        advertiserDomains: res.adomain || [],
+        mediaType: VIDEO
+      }
+    };
+
+    if (bidResponse.mediaType === VIDEO) {
+      bidResponse.vastXml = res.vast;
+      bidResponse.renderer = newRenderer(res.bidId, playerUrl);
+    } else {
+      const playerTag = createPlayerTag(playerUrl);
+      const renderTag = createRenderTag(res.width, res.height, res.vast);
+      bidResponse.ad = `<div id="rop-prebid">${playerTag}${renderTag}</div>`;
     }
-  };
-  if (mediaType === VIDEO) {
-    bidResponse.vastXml = body.vast;
-    bidResponse.renderer = newRenderer(bidRequest.bidId, playerUrl);
-  } else {
-    const playerTag = createPlayerTag(playerUrl);
-    const renderTag = createRenderTag(bidRequest.width, bidRequest.height, body.vast);
-    bidResponse.ad = `<div id="rop-prebid">${playerTag}${renderTag}</div>`;
+    bidResponses.push(bidResponse);
   }
-  bidResponses.push(bidResponse);
 
+  // eslint-disable-next-line no-console
+  console.log(JSON.stringify(bidResponses));
   return bidResponses;
 }
 

package/modules/richaudienceBidAdapter.js

@@ -58,11 +58,10 @@ export const spec = {
       REFERER = (typeof bidderRequest.refererInfo.referer != 'undefined' ? encodeURIComponent(bidderRequest.refererInfo.referer) : null)
 
       payload.gdpr_consent = '';
-      payload.gdpr = null;
+      payload.gdpr = bidderRequest.gdprConsent.gdprApplies;
 
       if (bidderRequest && bidderRequest.gdprConsent) {
         payload.gdpr_consent = bidderRequest.gdprConsent.consentString;
-        payload.gdpr = bidderRequest.gdprConsent.gdprApplies;
       }
 
       var payloadString = JSON.stringify(payload);
@@ -296,7 +295,7 @@ function raiGetFloor(bid, config) {
     } else if (typeof bid.getFloor == 'function') {
       let floorSpec = bid.getFloor({
         currency: config.getConfig('currency.adServerCurrency'),
-        mediaType: bid.mediaType.banner ? 'banner' : 'video',
+        mediaType: typeof bid.mediaTypes['banner'] == 'object' ? 'banner' : 'video',
         size: '*'
       })
 

package/modules/rtdModule/index.js

@@ -98,6 +98,15 @@
  * @param {UserConsentData} userConsent
  */
 
+/**
+ * @function?
+ * @summary on bid requested event
+ * @name RtdSubmodule#onBidRequestEvent
+ * @param {Object} data
+ * @param {SubmoduleConfig} config
+ * @param {UserConsentData} userConsent
+ */
+
 /**
  * @interface ModuleConfig
  */
@@ -143,7 +152,7 @@
 
 import {config} from '../../src/config.js';
 import {module} from '../../src/hook.js';
-import { logError, logWarn } from '../../src/utils.js';
+import {logError, logWarn} from '../../src/utils.js';
 import events from '../../src/events.js';
 import CONSTANTS from '../../src/constants.json';
 import {gdprDataHandler, uspDataHandler} from '../../src/adapterManager.js';
@@ -164,13 +173,50 @@ let _dataProviders = [];
 let _userConsent;
 
 /**
- * enable submodule in User ID
+ * Register a RTD submodule.
+ *
  * @param {RtdSubmodule} submodule
+ * @returns {function()} a de-registration function that will unregister the module when called.
  */
 export function attachRealTimeDataProvider(submodule) {
   registeredSubModules.push(submodule);
+  return function detach() {
+    const idx = registeredSubModules.indexOf(submodule)
+    if (idx >= 0) {
+      registeredSubModules.splice(idx, 1);
+      initSubModules();
+    }
+  }
 }
 
+/**
+ * call each sub module event function by config order
+ */
+const setEventsListeners = (function () {
+  let registered = false;
+  return function setEventsListeners() {
+    if (!registered) {
+      Object.entries({
+        [CONSTANTS.EVENTS.AUCTION_INIT]: 'onAuctionInitEvent',
+        [CONSTANTS.EVENTS.AUCTION_END]: 'onAuctionEndEvent',
+        [CONSTANTS.EVENTS.BID_RESPONSE]: 'onBidResponseEvent',
+        [CONSTANTS.EVENTS.BID_REQUESTED]: 'onBidRequestEvent'
+      }).forEach(([ev, handler]) => {
+        events.on(ev, (args) => {
+          subModules.forEach(sm => {
+            try {
+              sm[handler] && sm[handler](args, sm.config, _userConsent)
+            } catch (e) {
+              logError(`RTD provider '${sm.name}': error in '${handler}':`, e);
+            }
+          });
+        })
+      });
+      registered = true;
+    }
+  }
+})();
+
 export function init(config) {
   const confListener = config.getConfig(MODULE_NAME, ({realTimeData}) => {
     if (!realTimeData.dataProviders) {
@@ -211,22 +257,6 @@ function initSubModules() {
   subModules = subModulesByOrder;
 }
 
-/**
- * call each sub module event function by config order
- */
-function setEventsListeners() {
-  events.on(CONSTANTS.EVENTS.AUCTION_INIT, (args) => {
-    subModules.forEach(sm => { sm.onAuctionInitEvent && sm.onAuctionInitEvent(args, sm.config, _userConsent) })
-  });
-  events.on(CONSTANTS.EVENTS.AUCTION_END, (args) => {
-    getAdUnitTargeting(args);
-    subModules.forEach(sm => { sm.onAuctionEndEvent && sm.onAuctionEndEvent(args, sm.config, _userConsent) })
-  });
-  events.on(CONSTANTS.EVENTS.BID_RESPONSE, (args) => {
-    subModules.forEach(sm => { sm.onBidResponseEvent && sm.onBidResponseEvent(args, sm.config, _userConsent) })
-  });
-}
-
 /**
  * loop through configured data providers If the data provider has registered getBidRequestData,
  * call it, providing reqBidsConfigObj, consent data and module params

package/modules/rubiconBidAdapter.js

@@ -1,4 +1,4 @@
-import { mergeDeep, _each, logError, deepAccess, deepSetValue, isStr, isNumber, logWarn, convertTypes, isArray, parseSizesInput, logMessage } from '../src/utils.js';
+import { mergeDeep, _each, logError, deepAccess, deepSetValue, isStr, isNumber, logWarn, convertTypes, isArray, parseSizesInput, logMessage, formatQS } from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {config} from '../src/config.js';
 import {BANNER, VIDEO} from '../src/mediaTypes.js';
@@ -765,21 +765,23 @@ export const spec = {
   getUserSyncs: function (syncOptions, responses, gdprConsent, uspConsent) {
     if (!hasSynced && syncOptions.iframeEnabled) {
       // data is only assigned if params are available to pass to syncEndpoint
-      let params = '';
+      let params = {};
 
-      if (gdprConsent && typeof gdprConsent.consentString === 'string') {
-        // add 'gdpr' only if 'gdprApplies' is defined
+      if (gdprConsent) {
         if (typeof gdprConsent.gdprApplies === 'boolean') {
-          params += `?gdpr=${Number(gdprConsent.gdprApplies)}&gdpr_consent=${gdprConsent.consentString}`;
-        } else {
-          params += `?gdpr_consent=${gdprConsent.consentString}`;
+          params['gdpr'] = Number(gdprConsent.gdprApplies);
+        }
+        if (typeof gdprConsent.consentString === 'string') {
+          params['gdpr_consent'] = gdprConsent.consentString;
         }
       }
 
       if (uspConsent) {
-        params += `${params ? '&' : '?'}us_privacy=${encodeURIComponent(uspConsent)}`;
+        params['us_privacy'] = encodeURIComponent(uspConsent);
       }
 
+      params = Object.keys(params).length ? `?${formatQS(params)}` : '';
+
       hasSynced = true;
       return {
         type: 'iframe',
@@ -992,6 +994,8 @@ function applyFPD(bidRequest, mediaType, data) {
 
   let fpd = mergeDeep({}, config.getConfig('ortb2') || {}, BID_FPD);
   let impData = deepAccess(bidRequest.ortb2Imp, 'ext.data') || {};
+
+  const gpid = deepAccess(bidRequest, 'ortb2Imp.ext.gpid');
   const SEGTAX = {user: [4], site: [1, 2, 5, 6]};
   const MAP = {user: 'tg_v.', site: 'tg_i.', adserver: 'tg_i.dfp_ad_unit_code', pbadslot: 'tg_i.pbadslot', keywords: 'kw'};
   const validate = function(prop, key, parentName) {
@@ -1020,16 +1024,6 @@ function applyFPD(bidRequest, mediaType, data) {
     data[loc] = (data[loc]) ? data[loc].concat(',', val) : val;
   }
 
-  Object.keys(impData).forEach((key) => {
-    if (key === 'adserver') {
-      ['name', 'adslot'].forEach(prop => {
-        if (impData[key][prop]) impData[key][prop] = impData[key][prop].toString().replace(/^\/+/, '');
-      });
-    } else if (key === 'pbadslot') {
-      impData[key] = impData[key].toString().replace(/^\/+/, '');
-    }
-  });
-
   if (mediaType === BANNER) {
     ['site', 'user'].forEach(name => {
       Object.keys(fpd[name]).forEach((key) => {
@@ -1045,12 +1039,30 @@ function applyFPD(bidRequest, mediaType, data) {
       });
     });
     Object.keys(impData).forEach((key) => {
-      (key === 'adserver') ? addBannerData(impData[key].adslot, name, key) : addBannerData(impData[key], 'site', key);
+      if (key !== 'adserver') {
+        addBannerData(impData[key], 'site', key);
+      } else if (impData[key].name === 'gam') {
+        addBannerData(impData[key].adslot, name, key)
+      }
     });
+
+    // add in gpid
+    if (gpid) {
+      data['p_gpid'] = gpid;
+    }
+
+    // only send one of pbadslot or dfp adunit code (prefer pbadslot)
+    if (data['tg_i.pbadslot']) {
+      delete data['tg_i.dfp_ad_unit_code'];
+    }
   } else {
     if (Object.keys(impData).length) {
       mergeDeep(data.imp[0].ext, {data: impData});
     }
+    // add in gpid
+    if (gpid) {
+      data.imp[0].ext.gpid = gpid;
+    }
 
     mergeDeep(data, fpd);
   }

package/modules/sharedIdSystem.js

@@ -11,7 +11,7 @@ import { coppaDataHandler } from '../src/adapterManager.js';
 import {getStorageManager} from '../src/storageManager.js';
 
 const GVLID = 887;
-const storage = getStorageManager(GVLID, 'pubCommonId');
+export const storage = getStorageManager(GVLID, 'pubCommonId');
 const COOKIE = 'cookie';
 const LOCAL_STORAGE = 'html5';
 const OPTOUT_NAME = '_pubcid_optout';
@@ -171,7 +171,33 @@ export const sharedIdSystemSubmodule = {
         return {id: storedId};
       }
     }
+  },
+
+  domainOverride: function () {
+    const domainElements = document.domain.split('.');
+    const cookieName = `_gd${Date.now()}`;
+    for (let i = 0, topDomain, testCookie; i < domainElements.length; i++) {
+      const nextDomain = domainElements.slice(i).join('.');
+
+      // write test cookie
+      storage.setCookie(cookieName, '1', undefined, undefined, nextDomain);
+
+      // read test cookie to verify domain was valid
+      testCookie = storage.getCookie(cookieName);
+
+      // delete test cookie
+      storage.setCookie(cookieName, '', 'Thu, 01 Jan 1970 00:00:01 GMT', undefined, nextDomain);
+
+      if (testCookie === '1') {
+        // cookie was written successfully using test domain so the topDomain is updated
+        topDomain = nextDomain;
+      } else {
+        // cookie failed to write using test domain so exit by returning the topDomain
+        return topDomain;
+      }
+    }
   }
+
 };
 
 submodule('userId', sharedIdSystemSubmodule);

package/modules/smaatoBidAdapter.js

@@ -5,7 +5,7 @@ import {ADPOD, BANNER, VIDEO} from '../src/mediaTypes.js';
 
 const BIDDER_CODE = 'smaato';
 const SMAATO_ENDPOINT = 'https://prebid.ad.smaato.net/oapi/prebid';
-const SMAATO_CLIENT = 'prebid_js_$prebid.version$_1.5'
+const SMAATO_CLIENT = 'prebid_js_$prebid.version$_1.6'
 const CURRENCY = 'USD';
 
 const buildOpenRtbBidRequest = (bidRequest, bidderRequest) => {
@@ -304,6 +304,7 @@ function createBannerImp(bidRequest) {
       id: bidRequest.bidId,
       tagid: deepAccess(bidRequest, 'params.adspaceId'),
       bidfloor: getBidFloor(bidRequest, BANNER, adUnitSizes),
+      instl: deepAccess(bidRequest.ortb2Imp, 'instl'),
       banner: {
         w: sizes[0].w,
         h: sizes[0].h,
@@ -319,6 +320,7 @@ function createVideoImp(bidRequest, videoMediaType) {
       id: bidRequest.bidId,
       tagid: deepAccess(bidRequest, 'params.adspaceId'),
       bidfloor: getBidFloor(bidRequest, VIDEO, videoMediaType.playerSize),
+      instl: deepAccess(bidRequest.ortb2Imp, 'instl'),
       video: {
         mimes: videoMediaType.mimes,
         minduration: videoMediaType.minduration,
@@ -346,6 +348,7 @@ function createAdPodImp(bidRequest, videoMediaType) {
     id: bidRequest.bidId,
     tagid: tagid,
     bidfloor: getBidFloor(bidRequest, VIDEO, videoMediaType.playerSize),
+    instl: deepAccess(bidRequest.ortb2Imp, 'instl'),
     video: {
       w: videoMediaType.playerSize[0][0],
       h: videoMediaType.playerSize[0][1],

package/modules/smartxBidAdapter.js

@@ -161,11 +161,20 @@ export const spec = {
           domain: domain,
           publisher: {
             id: publisherId
+          },
+          content: {
+            ext: {
+              prebid: {
+                name: 'pbjs',
+                version: '$prebid.version$'
+              }
+            }
           }
         },
         device: device,
         at: at,
-        cur: cur
+        cur: cur,
+        ext: {}
       };
 
       const userExt = {};
@@ -194,6 +203,8 @@ export const spec = {
         };
       }
 
+      //     requestPayload.user.ext.ver = pbjs.version;
+
       // Targeting
       if (getBidIdParameter('data', bid.params.user)) {
         var targetingarr = [];
@@ -336,6 +347,7 @@ function createOutstreamConfig(bid) {
   let confTitle = getBidIdParameter('title', bid.renderer.config.outstream_options);
   let confSkipOffset = getBidIdParameter('skipOffset', bid.renderer.config.outstream_options);
   let confDesiredBitrate = getBidIdParameter('desiredBitrate', bid.renderer.config.outstream_options);
+  let confVisibilityThreshold = getBidIdParameter('visibilityThreshold', bid.renderer.config.outstream_options);
   let elementId = getBidIdParameter('slot', bid.renderer.config.outstream_options) || bid.adUnitCode;
 
   logMessage('[SMARTX][renderer] Handle SmartX outstream renderer');
@@ -384,6 +396,10 @@ function createOutstreamConfig(bid) {
     smartPlayObj.desiredBitrate = confDesiredBitrate;
   }
 
+  if (confVisibilityThreshold) {
+    smartPlayObj.visibilityThreshold = confVisibilityThreshold;
+  }
+
   smartPlayObj.adResponse = bid.vastContent;
 
   const divID = '[id="' + elementId + '"]';

package/modules/tappxBidAdapter.js

@@ -7,9 +7,10 @@ import { config } from '../src/config.js';
 import { Renderer } from '../src/Renderer.js';
 
 const BIDDER_CODE = 'tappx';
+const GVLID_CODE = 628;
 const TTL = 360;
 const CUR = 'USD';
-const TAPPX_BIDDER_VERSION = '0.1.1004';
+const TAPPX_BIDDER_VERSION = '0.1.1005';
 const TYPE_CNN = 'prebidjs';
 const LOG_PREFIX = '[TAPPX]: ';
 const VIDEO_SUPPORT = ['instream', 'outstream'];
@@ -42,6 +43,7 @@ var hostDomain;
 
 export const spec = {
   code: BIDDER_CODE,
+  gvlid: GVLID_CODE,
   supportedMediaTypes: [BANNER, VIDEO],
 
   /**