prebid.js 7.33.0 → 7.35.0

package/modules/sonobiBidAdapter.js

@@ -295,22 +295,29 @@ function _findBidderRequest(bidderRequests, bidId) {
   }
 }
 
+// This function takes all the possible sizes.
+// returns string csv.
 function _validateSize(bid) {
-  if (deepAccess(bid, 'mediaTypes.video')) {
-    return ''; // Video bids arent allowed to override sizes via the trinity request
+  let size = [];
+  if (deepAccess(bid, 'mediaTypes.video.playerSize')) {
+    size.push(deepAccess(bid, 'mediaTypes.video.playerSize'))
   }
-
-  if (bid.params.sizes) {
-    return parseSizesInput(bid.params.sizes).join(',');
+  if (deepAccess(bid, 'mediaTypes.video.sizes')) {
+    size.push(deepAccess(bid, 'mediaTypes.video.sizes'))
+  }
+  if (deepAccess(bid, 'params.sizes')) {
+    size.push(deepAccess(bid, 'params.sizes'));
   }
   if (deepAccess(bid, 'mediaTypes.banner.sizes')) {
-    return parseSizesInput(deepAccess(bid, 'mediaTypes.banner.sizes')).join(',');
+    size.push(deepAccess(bid, 'mediaTypes.banner.sizes'))
   }
-
-  // Handle deprecated sizes definition
-  if (bid.sizes) {
-    return parseSizesInput(bid.sizes).join(',');
+  if (deepAccess(bid, 'sizes')) {
+    size.push(deepAccess(bid, 'sizes'))
   }
+  // Pass the 2d sizes array into parseSizeInput to flatten it into an array of x separated sizes.
+  // Then throw it into Set to uniquify it.
+  // Then spread it to an array again. Then join it into a csv of sizes.
+  return [...new Set(parseSizesInput(...size))].join(',');
 }
 
 function _validateSlot(bid) {

package/modules/taboolaBidAdapter.js

@@ -279,7 +279,7 @@ function getBid(bids, currency, bidResponse) {
     return;
   }
   const {
-    price: cpm, crid: creativeId, adm: ad, w: width, h: height, exp: ttl, adomain: advertiserDomains, meta = {}
+    price: cpm, nurl, crid: creativeId, adm: ad, w: width, h: height, exp: ttl, adomain: advertiserDomains, meta = {}
   } = bidResponse;
   let requestId = bids[bidResponse.impid - 1].bidId;
   if (advertiserDomains && advertiserDomains.length > 0) {
@@ -297,6 +297,7 @@ function getBid(bids, currency, bidResponse) {
     width,
     height,
     meta,
+    nurl,
     netRevenue: true
   };
 }

package/modules/tripleliftBidAdapter.js

@@ -154,6 +154,10 @@ function _buildPostBody(bidRequests, bidderRequest) {
   if (!isEmpty(ext)) {
     data.ext = ext;
   }
+
+  if (bidderRequest?.ortb2?.regs?.gpp) {
+    data.regs = Object.assign({}, bidderRequest.ortb2.regs);
+  }
   return data;
 }
 

package/modules/vidazooBidAdapter.js

@@ -1,8 +1,9 @@
-import { _each, deepAccess, parseSizesInput, parseUrl, uniques, isFn } from '../src/utils.js';
-import { registerBidder } from '../src/adapters/bidderFactory.js';
-import { BANNER, VIDEO } from '../src/mediaTypes.js';
-import { getStorageManager } from '../src/storageManager.js';
-import { bidderSettings } from '../src/bidderSettings.js';
+import {_each, deepAccess, parseSizesInput, parseUrl, uniques, isFn} from '../src/utils.js';
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+import {BANNER, VIDEO} from '../src/mediaTypes.js';
+import {getStorageManager} from '../src/storageManager.js';
+import {bidderSettings} from '../src/bidderSettings.js';
+import { config } from '../src/config.js';
 
 const GVLID = 744;
 const DEFAULT_SUB_DOMAIN = 'prebid';
@@ -26,11 +27,11 @@ export const SUPPORTED_ID_SYSTEMS = {
   'tdid': 1,
   'pubProvidedId': 1
 };
-const storage = getStorageManager({ gvlid: GVLID, bidderCode: BIDDER_CODE });
+const storage = getStorageManager({gvlid: GVLID, bidderCode: BIDDER_CODE});
 
 function getTopWindowQueryParams() {
   try {
-    const parsedUrl = parseUrl(window.top.document.URL, { decodeSearchAsString: true });
+    const parsedUrl = parseUrl(window.top.document.URL, {decodeSearchAsString: true});
     return parsedUrl.search;
   } catch (e) {
     return '';
@@ -58,10 +59,23 @@ function isBidRequestValid(bid) {
   return !!(extractCID(params) && extractPID(params));
 }
 
-function buildRequest(bid, topWindowUrl, sizes, bidderRequest) {
-  const { params, bidId, userId, adUnitCode, schain, mediaTypes } = bid;
-  const { ext } = params;
-  let { bidFloor } = params;
+function buildRequest(bid, topWindowUrl, sizes, bidderRequest, bidderTimeout) {
+  const {
+    params,
+    bidId,
+    userId,
+    adUnitCode,
+    schain,
+    mediaTypes,
+    auctionId,
+    transactionId,
+    bidderRequestId,
+    bidRequestsCount,
+    bidderRequestsCount,
+    bidderWinsCount
+  } = bid;
+  const {ext} = params;
+  let {bidFloor} = params;
   const hashUrl = hashCode(topWindowUrl);
   const dealId = getNextDealId(hashUrl);
   const uniqueDealId = getUniqueDealId(hashUrl);
@@ -110,7 +124,14 @@ function buildRequest(bid, topWindowUrl, sizes, bidderRequest) {
     isStorageAllowed: isStorageAllowed,
     gpid: gpid,
     cat: cat,
-    pagecat: pagecat
+    pagecat: pagecat,
+    auctionId: auctionId,
+    transactionId: transactionId,
+    bidderRequestId: bidderRequestId,
+    bidRequestsCount: bidRequestsCount,
+    bidderRequestsCount: bidderRequestsCount,
+    bidderWinsCount: bidderWinsCount,
+    bidderTimeout: bidderTimeout
   };
 
   appendUserIdsToRequestPayload(data, userId);
@@ -127,6 +148,14 @@ function buildRequest(bid, topWindowUrl, sizes, bidderRequest) {
     data.usPrivacy = bidderRequest.uspConsent;
   }
 
+  if (bidderRequest.gppConsent) {
+    data.gppString = bidderRequest.gppConsent.gppString;
+    data.gppSid = bidderRequest.gppConsent.applicableSections;
+  } else if (bidderRequest.ortb2?.regs?.gpp) {
+    data.gppString = bidderRequest.ortb2.regs.gpp;
+    data.gppSid = bidderRequest.ortb2.regs.gpp_sid;
+  }
+
   const dto = {
     method: 'POST',
     url: `${createDomain(subDomain)}/prebid/multi/${cId}`,
@@ -169,10 +198,11 @@ function appendUserIdsToRequestPayload(payloadRef, userIds) {
 function buildRequests(validBidRequests, bidderRequest) {
   // TODO: does the fallback make sense here?
   const topWindowUrl = bidderRequest.refererInfo.page || bidderRequest.refererInfo.topmostLocation;
+  const bidderTimeout = config.getConfig('bidderTimeout');
   const requests = [];
   validBidRequests.forEach(validBidRequest => {
     const sizes = parseSizesInput(validBidRequest.sizes);
-    const request = buildRequest(validBidRequest, topWindowUrl, sizes, bidderRequest);
+    const request = buildRequest(validBidRequest, topWindowUrl, sizes, bidderRequest, bidderTimeout);
     requests.push(request);
   });
   return requests;
@@ -182,14 +212,14 @@ function interpretResponse(serverResponse, request) {
   if (!serverResponse || !serverResponse.body) {
     return [];
   }
-  const { bidId } = request.data;
-  const { results } = serverResponse.body;
+  const {bidId} = request.data;
+  const {results} = serverResponse.body;
 
   let output = [];
 
   try {
     results.forEach(result => {
-      const { creativeId, ad, price, exp, width, height, currency, advertiserDomains, mediaType = BANNER } = result;
+      const {creativeId, ad, price, exp, width, height, currency, advertiserDomains, mediaType = BANNER} = result;
       if (!ad || !price) {
         return;
       }
@@ -228,8 +258,8 @@ function interpretResponse(serverResponse, request) {
 
 function getUserSyncs(syncOptions, responses, gdprConsent = {}, uspConsent = '') {
   let syncs = [];
-  const { iframeEnabled, pixelEnabled } = syncOptions;
-  const { gdprApplies, consentString = '' } = gdprConsent;
+  const {iframeEnabled, pixelEnabled} = syncOptions;
+  const {gdprApplies, consentString = ''} = gdprConsent;
 
   const cidArr = responses.filter(resp => deepAccess(resp, 'body.cid')).map(resp => resp.body.cid).filter(uniques);
   const params = `?cid=${encodeURIComponent(cidArr.join(','))}&gdpr=${gdprApplies ? 1 : 0}&gdpr_consent=${encodeURIComponent(consentString || '')}&us_privacy=${encodeURIComponent(uspConsent || '')}`
@@ -253,7 +283,9 @@ export function hashCode(s, prefix = '_') {
   let h = 0
   let i = 0;
   if (l > 0) {
-    while (i < l) { h = (h << 5) - h + s.charCodeAt(i++) | 0; }
+    while (i < l) {
+      h = (h << 5) - h + s.charCodeAt(i++) | 0;
+    }
   }
   return prefix + h;
 }
@@ -310,7 +342,8 @@ export function getCacheOpt() {
 export function getStorageItem(key) {
   try {
     return tryParseJSON(storage.getDataFromLocalStorage(key));
-  } catch (e) { }
+  } catch (e) {
+  }
 
   return null;
 }
@@ -318,9 +351,10 @@ export function getStorageItem(key) {
 export function setStorageItem(key, value, timestamp) {
   try {
     const created = timestamp || Date.now();
-    const data = JSON.stringify({ value, created });
+    const data = JSON.stringify({value, created});
     storage.setDataInLocalStorage(key, data);
-  } catch (e) { }
+  } catch (e) {
+  }
 }
 
 export function tryParseJSON(value) {

package/modules/zeta_global_sspBidAdapter.js

@@ -90,6 +90,21 @@ export const spec = {
       if (!impData.banner && !impData.video) {
         impData.banner = buildBanner(request);
       }
+
+      if (typeof request.getFloor === 'function') {
+        const floorInfo = request.getFloor({
+          currency: 'USD',
+          mediaType: impData.video ? 'video' : 'banner',
+          size: [ impData.video ? impData.video.w : impData.banner.w, impData.video ? impData.video.h : impData.banner.h ]
+        });
+        if (floorInfo && floorInfo.floor) {
+          impData.bidfloor = floorInfo.floor;
+        }
+      }
+      if (!impData.bidfloor && params.bidfloor) {
+        impData.bidfloor = params.bidfloor;
+      }
+
       return impData;
     });
 

package/modules/zeusPrimeRtdProvider.js

@@ -1,328 +1,8 @@
-/**
- * This module adds Zeus Insights For Publishers (ZIP) provider to the real time data module
- * The {@link module:modules/realTimeData} module is required
- *
- * This module will request the article topics for the current page and add them as page keyvalues
- * for the ad requests.
- *
- * @module modules/zeusInsightsForPublishersRtdProvider
- * @requires module:modules/realTimeData
- */
-
-import { logInfo, logError, logWarn, logMessage } from '../src/utils.js'
+import { logWarn } from '../src/utils.js'
 import { submodule } from '../src/hook.js'
-import { ajaxBuilder } from '../src/ajax.js'
-
-class Logger {
-  get showDebug() {
-    if (this._showDebug === true || this._showDebug === false) {
-      return this._showDebug
-    }
-
-    return window.zeusPrime?.debug || false
-  }
-  set showDebug(shouldShow) {
-    this._showDebug = shouldShow
-  }
-
-  get error() {
-    return logError.bind(this, 'zeusPrimeRtdProvider: ')
-  }
-  get warn() {
-    return logWarn.bind(this, 'zeusPrimeRtdProvider: ')
-  }
-  get info() {
-    return logInfo.bind(this, 'zeusPrimeRtdProvider: ')
-  }
-  get debug() {
-    if (this.showDebug) {
-      return logMessage.bind(this, 'zeusPrimeRtdProvider: ')
-    }
-
-    return () => {}
-  }
-}
-
-var logger = new Logger()
-
-function loadCommandQueue() {
-  window.zeusPrime = window.zeusPrime || { cmd: [] }
-  const queue = [...window.zeusPrime.cmd]
-
-  window.zeusPrime.cmd = []
-  window.zeusPrime.cmd.push = (callback) => {
-    callback(window.zeusPrime)
-  }
-
-  queue.forEach((callback) => callback(window.zeusPrime))
-}
-
-function markStatusComplete(key) {
-  const status = window?.zeusPrime?.status
-  if (status) {
-    status[key] = true
-  }
-}
-
-function createStatus() {
-  if (window.zeusPrime && !window.zeusPrime.status) {
-    Object.defineProperty(window.zeusPrime, 'status', {
-      enumerable: false,
-      value: {
-        initComplete: false,
-        primeKeyValueSet: false,
-        insightsReqSent: false,
-        insightsReqReceived: false,
-        insightsKeyValueSet: false,
-        scriptComplete: false,
-      },
-    })
-  }
-}
-
-function loadPrimeQueryParams() {
-  try {
-    const params = new URLSearchParams(window.location.search)
-    params.forEach((paramValue, paramKey) => {
-      if (!paramKey.startsWith('zeus_prime_')) {
-        return
-      }
-
-      let key = paramKey.replace('zeus_prime_', '')
-      let value = paramValue.toLowerCase()
-
-      if (value === 'true' || value === '1') {
-        value = true
-      } else if (value === 'false' || value === '0') {
-        value = false
-      }
-
-      window.zeusPrime[key] = value
-    })
-  } catch (_) {}
-}
-
-const DEFAULT_API = 'https://insights.zeustechnology.com'
-
-function init(gamId = null, options = {}) {
-  window.zeusPrime = window.zeusPrime || { cmd: [] }
-
-  window.zeusPrime.gamId = gamId || options.gamId || window.zeusPrime.gamId || undefined
-  window.zeusPrime.api = DEFAULT_API
-  window.zeusPrime.hostname = options.hostname || window.location?.hostname || ''
-  window.zeusPrime.pathname = options.pathname || window.location?.pathname || ''
-  window.zeusPrime.pageUrl = `${window.zeusPrime.hostname}${window.zeusPrime.pathname}`
-  window.zeusPrime.pageHash = options.pageHash || null
-  window.zeusPrime.debug = window.zeusPrime.debug || options.debug === true || false
-  window.zeusPrime.disabled = window.zeusPrime.disabled || options.disabled === true || false
-
-  loadPrimeQueryParams()
-
-  logger.showDebug = window.zeusPrime.debug
-
-  createStatus()
-  markStatusComplete('initComplete')
-}
-
-function setTargeting() {
-  const { gamId, hostname } = window.zeusPrime
-
-  if (typeof gamId !== 'string') {
-    throw new Error(`window.zeusPrime.gamId must be a string. Received: ${String(gamId)}`)
-  }
-
-  addKeyValueToGoogletag(`zeus_${gamId}`, hostname)
-  logger.debug(`Setting zeus_${gamId}=${hostname}`)
-  markStatusComplete('primeKeyValueSet')
-}
 
-function setPrimeAsDisabled() {
-  addKeyValueToGoogletag('zeus_prime', 'false')
-  logger.debug('Disabling prime; Setting key-value zeus_prime to false')
-}
-
-function addKeyValueToGoogletag(key, value) {
-  window.googletag = window.googletag || { cmd: [] }
-  window.googletag.cmd.push(function () {
-    window.googletag.pubads().setTargeting(key, value)
-  })
-}
-
-function isInsightsPage(pathname = '') {
-  const NOT_SECTIONS = [
-    {
-      test: /\/search/,
-      type: 'search',
-    },
-    {
-      test: /\/author/,
-      type: 'author',
-    },
-    {
-      test: /\/event/,
-      type: 'event',
-    },
-    {
-      test: /\/homepage/,
-      type: 'front',
-    },
-    {
-      test: /^\/?$/,
-      type: 'front',
-    },
-  ]
-
-  const typeObj = NOT_SECTIONS.find((pg) => pathname.match(pg.test))
-  return typeObj === undefined
-}
-
-async function getUrlHash(canonical) {
-  try {
-    const buf = await window.crypto.subtle.digest(
-      'SHA-1',
-      new TextEncoder('utf-8').encode(canonical)
-    )
-    const hashed = Array.prototype.map
-      .call(new Uint8Array(buf), (x) => `00${x.toString(16)}`.slice(-2))
-      .join('')
-
-    return hashed
-  } catch (e) {
-    logger.error('Failed to load hash', e.message)
-    logger.debug('Exception', e)
-    return ''
-  }
-}
-
-async function sendPrebidRequest(url) {
-  return new Promise((resolve, reject) => {
-    const ajax = ajaxBuilder()
-    ajax(url, {
-      success: (responseText, response) => {
-        resolve({
-          ...response,
-          status: response.status,
-          json: () => JSON.parse(responseText),
-        })
-      },
-
-      error: (responseText, response) => {
-        if (!response.status) {
-          reject(response)
-        }
-
-        let json = responseText
-        if (responseText) {
-          try {
-            json = JSON.parse(responseText)
-          } catch (_) {
-            json = null
-          }
-        }
-
-        resolve({
-          status: response.status,
-          json: () => json || null,
-          responseValue: json,
-        })
-      },
-    })
-  })
-}
-
-async function requestTopics() {
-  const { api, hostname, pageUrl } = window.zeusPrime
-
-  if (!window.zeusPrime.pageHash) {
-    window.zeusPrime.pageHash = await getUrlHash(pageUrl)
-  }
-
-  const pageHash = window.zeusPrime.pageHash
-  const zeusInsightsUrl = `${api}/${hostname}/${pageHash}?article_location=${pageUrl}`
-
-  logger.debug('Requesting topics', zeusInsightsUrl)
-  try {
-    markStatusComplete('insightsReqSent')
-    const response = await sendPrebidRequest(zeusInsightsUrl)
-    if (response.status === 200) {
-      logger.debug('topics found')
-      markStatusComplete('insightsReqReceived')
-      return await response.json()
-    } else if (
-      response.status === 204 ||
-      response.status < 200 ||
-      (response.status >= 300 && response.status <= 399)
-    ) {
-      logger.debug('no topics found')
-      markStatusComplete('insightsReqReceived')
-      return null
-    } else {
-      logger.error(`Topics request returned error: ${response.status}`)
-      markStatusComplete('insightsReqReceived')
-      return null
-    }
-  } catch (e) {
-    logger.error('failed to request topics', e)
-    return null
-  }
-}
-
-function setTopicsTargeting(topics = []) {
-  if (topics.length === 0) {
-    return
-  }
-
-  window.googletag = window.googletag || { cmd: [] }
-  window.googletag.cmd.push(function () {
-    window.googletag.pubads().setTargeting('zeus_insights', topics)
-  })
-
-  markStatusComplete('insightsKeyValueSet')
-}
-
-async function startTopicsRequest() {
-  if (isInsightsPage(window.zeusPrime.pathname)) {
-    const response = await requestTopics()
-    if (response) {
-      setTopicsTargeting(response?.topics)
-    }
-  } else {
-    logger.debug('This page is not eligible for topics, request will be skipped')
-  }
-}
-
-async function run(gamId, options = {}) {
-  logger.showDebug = options.debug || false
-
-  try {
-    init(gamId, options)
-    loadCommandQueue()
-
-    if (window.zeusPrime.disabled) {
-      setPrimeAsDisabled()
-    } else {
-      setTargeting()
-      await startTopicsRequest()
-    }
-  } catch (e) {
-    logger.error('Failed to run.', e.message || e)
-  } finally {
-    markStatusComplete('scriptComplete')
-  }
-}
-
-/**
- * @preserve
- * Initializes the ZeusPrime RTD Submodule. The config provides the GamID for this
- * site that is used to configure Prime.
- * @param {object} config The Prebid configuration for this module.
- * @param {object} config.params The parameters for this module.
- * @param {string} config.params.gamId The Gam ID (or Network Code) in GAM for this site.
- */
-function initModule(config) {
-  const { params } = config || {}
-  const { gamId, ...rest } = params || {}
-  run(gamId, rest)
+function initModule() {
+  logWarn('Zeus Prime has been deprecated. This module will be removed in Prebid 8.')
 }
 
 /**

package/modules/zeusPrimeRtdProvider.md

@@ -1,5 +1,8 @@
 # Overview
 
+# NOTE: ZEUS PRIME HAS BEEN DEPRECATED!
+# THIS MODULE WILL BE REMOVED IN PREBID 8.
+
 Module Name: Zeus Prime RTD Provider
 Module Type: Rtd Provider
 Maintainer: support@zeustechnology.com

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prebid.js",
-  "version": "7.33.0",
+  "version": "7.35.0",
   "description": "Header Bidding Management Library",
   "main": "src/prebid.js",
   "scripts": {

package/src/adloader.js

@@ -21,7 +21,8 @@ const _approvedLoadExternalJSList = [
   'medianet',
   'improvedigital',
   'aaxBlockmeter',
-  'confiant'
+  'confiant',
+  'arcspan'
 ]
 
 /**

package/src/auction.js

@@ -93,6 +93,7 @@ import CONSTANTS from './constants.json';
 import {GreedyPromise} from './utils/promise.js';
 import {useMetrics} from './utils/perfMetrics.js';
 import {createBid} from './bidfactory.js';
+import {adjustCpm} from './utils/cpm.js';
 
 const { syncUsers } = userSync;
 
@@ -971,17 +972,7 @@ function setKeys(keyValues, bidderSettings, custBidObj, bidReq) {
 }
 
 export function adjustBids(bid) {
-  let code = bid.bidderCode;
-  let bidPriceAdjusted = bid.cpm;
-  const bidCpmAdjustment = bidderSettings.get(code || null, 'bidCpmAdjustment');
-
-  if (bidCpmAdjustment && typeof bidCpmAdjustment === 'function') {
-    try {
-      bidPriceAdjusted = bidCpmAdjustment(bid.cpm, Object.assign({}, bid));
-    } catch (e) {
-      logError('Error during bid adjustment', 'bidmanager.js', e);
-    }
-  }
+  let bidPriceAdjusted = adjustCpm(bid.cpm, bid);
 
   if (bidPriceAdjusted >= 0) {
     bid.cpm = bidPriceAdjusted;

package/src/prebid.js

@@ -915,6 +915,14 @@ $$PREBID_GLOBAL$$.aliasBidder = function (bidderCode, alias, options) {
   }
 };
 
+/**
+ * @alias module:pbjs.aliasRegistry
+ */
+$$PREBID_GLOBAL$$.aliasRegistry = adapterManager.aliasRegistry;
+config.getConfig('aliasRegistry', config => {
+  if (config.aliasRegistry === 'private') delete $$PREBID_GLOBAL$$.aliasRegistry;
+});
+
 /**
  * The bid response object returned by an external bidder adapter during the auction.
  * @typedef {Object} AdapterBidResponse

package/src/utils/cpm.js

@@ -0,0 +1,17 @@
+import {auctionManager} from '../auctionManager.js';
+import {bidderSettings} from '../bidderSettings.js';
+import {logError} from '../utils.js';
+
+export function adjustCpm(cpm, bidResponse, bidRequest, {index = auctionManager.index, bs = bidderSettings} = {}) {
+  bidRequest = bidRequest || index.getBidRequest(bidResponse);
+  const bidCpmAdjustment = bs.get(bidResponse?.bidderCode || bidRequest?.bidder, 'bidCpmAdjustment');
+
+  if (bidCpmAdjustment && typeof bidCpmAdjustment === 'function') {
+    try {
+      return bidCpmAdjustment(cpm, Object.assign({}, bidResponse), bidRequest);
+    } catch (e) {
+      logError('Error during bid adjustment', e);
+    }
+  }
+  return cpm;
+}