prebid.js 8.7.0 → 8.8.0

package/integrationExamples/topics/topics-server.js

@@ -0,0 +1,72 @@
+// This is an example of a server-side endpoint that is utilizing the Topics API header functionality.
+// Note: This test endpoint requires the following to run: node.js, npm, express, cors, body-parser
+
+const bodyParser = require('body-parser');
+const cors = require('cors');
+const express = require('express');
+
+const port = process.env.PORT || 3000;
+
+const app = express();
+app.use(cors());
+app.use(
+  bodyParser.urlencoded({
+    extended: true,
+  })
+);
+app.use(bodyParser.json());
+app.use(express.static('public'));
+app.set('port', port);
+
+const listener = app.listen(port, () => {
+  const host =
+    listener.address().address === '::'
+      ? 'http://localhost'
+      : 'http://' + listener.address().address;
+  // eslint-disable-next-line no-console
+  console.log(
+    `${__filename} is listening on ${host}:${listener.address().port}\n`
+  );
+});
+
+app.get('*', (req, res) => {
+  res.setHeader('Observe-Browsing-Topics', '?1');
+
+  const resData = {
+    segment: {
+      domain: req.hostname,
+      topics: generateTopicArrayFromHeader(req.headers['sec-browsing-topics']),
+      bidder: req.query['bidder'],
+    },
+    date: Date.now(),
+  };
+
+  res.json(resData);
+});
+
+const generateTopicArrayFromHeader = (topicString) => {
+  const result = [];
+  const topicArray = topicString.split(', ');
+  if (topicArray.length > 1) {
+    topicArray.pop();
+    topicArray.map((topic) => {
+      const topicId = topic.split(';')[0];
+      const versionsString = topic.split(';')[1].split('=')[1];
+      const [config, taxonomy, model] = versionsString.split(':');
+      const numTopicsWithSameVersions = topicId
+        .substring(1, topicId.length - 1)
+        .split(' ');
+
+      numTopicsWithSameVersions.map((tpId) => {
+        result.push({
+          topic: tpId,
+          version: versionsString,
+          configVersion: config,
+          taxonomyVersion: taxonomy,
+          modelVersion: model,
+        });
+      });
+    });
+  }
+  return result;
+};

package/modules/.submodules.json

@@ -46,7 +46,8 @@
       "zeotapIdPlusIdSystem",
       "adqueryIdSystem",
       "gravitoIdSystem",
-      "freepassIdSystem"
+      "freepassIdSystem",
+      "operaadsIdSystem"
     ],
     "adpod": [
       "freeWheelAdserverVideo",

package/modules/a1MediaRtdProvider.js

@@ -8,7 +8,7 @@ const REAL_TIME_MODULE = 'realTimeData';
 const MODULE_NAME = 'a1Media';
 const SCRIPT_URL = 'https://linkback.contentsfeed.com/src';
 export const A1_SEG_KEY = '__a1tg';
-export const A1_AUD_KEY = 'a1gid';
+export const A1_AUD_KEY = 'a1_gid';
 
 export const storage = getStorageManager({moduleType: MODULE_TYPE_RTD, moduleName: MODULE_NAME});
 

package/modules/admaticBidAdapter.js

@@ -195,6 +195,11 @@ function buildRequestObject(bid) {
     reqObj.type = 'video';
     reqObj.mediatype = bid.mediaTypes.video;
   }
+
+  if (deepAccess(bid, 'ortb2Imp.ext')) {
+    reqObj.ext = bid.ortb2Imp.ext;
+  }
+
   reqObj.id = getBidIdParameter('bidId', bid);
 
   enrichSlotWithFloors(reqObj, bid);

package/modules/adqueryBidAdapter.js

@@ -1,7 +1,6 @@
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER} from '../src/mediaTypes.js';
-import { logInfo, buildUrl, triggerPixel, parseSizesInput } from '../src/utils.js';
-import { getStorageManager } from '../src/storageManager.js';
+import {buildUrl, logInfo, parseSizesInput, triggerPixel} from '../src/utils.js';
 
 const ADQUERY_GVLID = 902;
 const ADQUERY_BIDDER_CODE = 'adquery';
@@ -11,7 +10,6 @@ const ADQUERY_USER_SYNC_DOMAIN = ADQUERY_BIDDER_DOMAIN_PROTOCOL + '://' + ADQUER
 const ADQUERY_DEFAULT_CURRENCY = 'PLN';
 const ADQUERY_NET_REVENUE = true;
 const ADQUERY_TTL = 360;
-const storage = getStorageManager({bidderCode: ADQUERY_BIDDER_CODE});
 
 /** @type {BidderSpec} */
 export const spec = {
@@ -55,10 +53,6 @@ export const spec = {
    * @return {Bid[]}
    */
   interpretResponse: (response, request) => {
-    logInfo(request);
-    logInfo(response);
-
-    let qid = null;
     const res = response && response.body && response.body.data;
     let bidResponses = [];
 
@@ -87,17 +81,6 @@ export const spec = {
     bidResponses.push(bidResponse);
     logInfo('bidResponses', bidResponses);
 
-    if (res && res.qid) {
-      if (storage.getDataFromLocalStorage('qid')) {
-        qid = storage.getDataFromLocalStorage('qid');
-        if (qid && qid.includes('%7B%22')) {
-          storage.setDataInLocalStorage('qid', res.qid);
-        }
-      } else {
-        storage.setDataInLocalStorage('qid', res.qid);
-      }
-    }
-
     return bidResponses;
   },
 
@@ -189,8 +172,28 @@ export const spec = {
   }
 
 };
+
 function buildRequest(validBidRequests, bidderRequest) {
   let bid = validBidRequests;
+  logInfo('buildRequest: ', bid);
+
+  let userId = null;
+  if (window.qid) {
+    userId = window.qid;
+  }
+
+  if (bid.userId && bid.userId.qid) {
+    userId = bid.userId.qid
+  }
+
+  if (!userId) {
+    // onetime User ID
+    const randomValues = Array.from(window.crypto.getRandomValues(new Uint32Array(4)));
+    userId = randomValues.map(it => it.toString(36)).join().substring(20);
+
+    window.qid = userId;
+  }
+
   let pageUrl = '';
   if (bidderRequest && bidderRequest.refererInfo) {
     pageUrl = bidderRequest.refererInfo.page || '';
@@ -199,11 +202,10 @@ function buildRequest(validBidRequests, bidderRequest) {
   return {
     v: '$prebid.version$',
     placementCode: bid.params.placementId,
-    // TODO: fix auctionId leak: https://github.com/prebid/Prebid.js/issues/9781
-    auctionId: bid.auctionId,
+    auctionId: null,
     type: bid.params.type,
     adUnitCode: bid.adUnitCode,
-    bidQid: storage.getDataFromLocalStorage('qid') || null,
+    bidQid: userId,
     bidId: bid.bidId,
     bidder: bid.bidder,
     bidPageUrl: pageUrl,

package/modules/adqueryIdSystem.js

@@ -8,7 +8,7 @@
 import {ajax} from '../src/ajax.js';
 import {getStorageManager} from '../src/storageManager.js';
 import {submodule} from '../src/hook.js';
-import { isFn, isStr, isPlainObject, logError } from '../src/utils.js';
+import {isFn, isPlainObject, isStr, logError, logInfo} from '../src/utils.js';
 import {MODULE_TYPE_UID} from '../src/activities/modules.js';
 
 const MODULE_NAME = 'qid';
@@ -51,11 +51,7 @@ export const adqueryIdSubmodule = {
    * @returns {{qid:Object}}
    */
   decode(value) {
-    let qid = storage.getDataFromLocalStorage('qid');
-    if (isStr(qid)) {
-      return {qid: qid};
-    }
-    return (value && typeof value['qid'] === 'string') ? { 'qid': value['qid'] } : undefined;
+    return {qid: value}
   },
   /**
    * performs action to obtain id and return a value in the callback's response argument
@@ -64,38 +60,57 @@ export const adqueryIdSubmodule = {
    * @returns {IdResponse|undefined}
    */
   getId(config) {
+    logInfo('adqueryIdSubmodule getId');
     if (!isPlainObject(config.params)) {
       config.params = {};
     }
-    const url = paramOrDefault(config.params.url,
+
+    const url = paramOrDefault(
+      config.params.url,
       `https://bidder.adquery.io/prebid/qid`,
-      config.params.urlArg);
+      config.params.urlArg
+    );
 
     const resp = function (callback) {
-      let qid = storage.getDataFromLocalStorage('qid');
-      if (isStr(qid)) {
-        const responseObj = {qid: qid};
-        callback(responseObj);
-      } else {
-        const callbacks = {
-          success: response => {
-            let responseObj;
-            if (response) {
-              try {
-                responseObj = JSON.parse(response);
-              } catch (error) {
-                logError(error);
-              }
+      let qid = window.qid;
+
+      if (!qid) {
+        const ramdomValues = window.crypto.getRandomValues(new Uint32Array(4));
+        qid = (ramdomValues[0].toString(36) +
+          ramdomValues[1].toString(36) +
+          ramdomValues[2].toString(36) +
+          ramdomValues[3].toString(36))
+          .substring(0, 20);
+
+        const randomValues = Array.from(window.crypto.getRandomValues(new Uint32Array(4)));
+        qid = randomValues.map(it => it.toString(36)).join().substring(20);
+        logInfo('adqueryIdSubmodule ID QID GENERTAED:', qid);
+      }
+      logInfo('adqueryIdSubmodule ID QID:', qid);
+
+      const callbacks = {
+        success: response => {
+          let responseObj;
+          if (response) {
+            try {
+              responseObj = JSON.parse(response);
+            } catch (error) {
+              logError(error);
             }
-            callback(responseObj);
-          },
-          error: error => {
-            logError(`${MODULE_NAME}: ID fetch encountered an error`, error);
-            callback();
           }
-        };
-        ajax(url, callbacks, undefined, {method: 'GET'});
-      }
+          if (responseObj.qid) {
+            let myQid = responseObj.qid;
+            storage.setDataInLocalStorage('qid', myQid);
+            return callback(myQid);
+          }
+          callback();
+        },
+        error: error => {
+          logError(`${MODULE_NAME}: ID fetch encountered an error`, error);
+          callback();
+        }
+      };
+      ajax(url + '?qid=' + qid, callbacks, undefined, {method: 'GET'});
     };
     return {callback: resp};
   },

package/modules/adrelevantisBidAdapter.js

@@ -597,6 +597,8 @@ function parseMediaType(rtbBid) {
   const adType = rtbBid.ad_type;
   if (adType === VIDEO) {
     return VIDEO;
+  } else if (adType === NATIVE) {
+    return NATIVE;
   } else {
     return BANNER;
   }

package/modules/bidViewability.js

@@ -67,6 +67,8 @@ export let logWinningBidNotFound = (slot) => {
 
 export let impressionViewableHandler = (globalModuleConfig, slot, event) => {
   let respectiveBid = getMatchingWinningBidForGPTSlot(globalModuleConfig, slot);
+  let respectiveDeferredAdUnit = getGlobal().adUnits.find(adUnit => adUnit.deferBilling && respectiveBid.adUnitCode === adUnit.code);
+
   if (respectiveBid === null) {
     logWinningBidNotFound(slot);
   } else {
@@ -74,6 +76,11 @@ export let impressionViewableHandler = (globalModuleConfig, slot, event) => {
     fireViewabilityPixels(globalModuleConfig, respectiveBid);
     // trigger respective bidder's onBidViewable handler
     adapterManager.callBidViewableBidder(respectiveBid.adapterCode || respectiveBid.bidder, respectiveBid);
+
+    if (respectiveDeferredAdUnit) {
+      adapterManager.callBidBillableBidder(respectiveBid);
+    }
+
     // emit the BID_VIEWABLE event with bid details, this event can be consumed by bidders and analytics pixels
     events.emit(CONSTANTS.EVENTS.BID_VIEWABLE, respectiveBid);
   }

package/modules/bidViewability.md

@@ -2,19 +2,20 @@
 
 Module Name: bidViewability
 
-Purpose: Track when a bid is viewable
+Purpose: Track when a bid is viewable (and also ready for billing)
 
 Maintainer: harshad.mane@pubmatic.com
 
 # Description
-- This module, when included, will trigger a BID_VIEWABLE event which can be consumed by Analytics adapters, bidders will need to implement `onBidViewable` method to capture this event
-- Bidderes can check if this module is part of the final build and whether it is enabled or not by accessing ```pbjs.getConfig('bidViewability')```
+- This module, when included, will trigger a BID_VIEWABLE event which can be consumed by Analytics adapters, bidders will need to implement the `onBidViewable` method to capture this event
+- Bidders can check if this module is part of the final build and whether it is enabled or not by accessing ```pbjs.getConfig('bidViewability')```
 - GPT API is used to find when a bid is viewable, https://developers.google.com/publisher-tag/reference#googletag.events.impressionviewableevent . This event is fired when an impression becomes viewable, according to the Active View criteria.
 Refer: https://support.google.com/admanager/answer/4524488
-- The module does not work with adserver other than GAM with GPT integration
+- This module does not work with any adserver's other than GAM with GPT integration
 - Logic used to find a matching pbjs-bid for a GPT slot is ``` (slot.getAdUnitPath() === bid.adUnitCode || slot.getSlotElementId() === bid.adUnitCode) ``` this logic can be changed by using param ```customMatchFunction```
-- When a rendered PBJS bid is viewable the module will trigger BID_VIEWABLE event, which can be consumed by bidders and analytics adapters
-- For the viewable bid if ```bid.vurls type array``` param is and module config ``` firePixels: true ``` is set then the URLs mentioned in bid.vurls will be executed. Please note that GDPR and USP related parameters will be added to the given URLs
+- When a rendered PBJS bid is viewable the module will trigger a BID_VIEWABLE event, which can be consumed by bidders and analytics adapters
+- If the viewable bid contains a ```vurls``` param containing URL's and the Bid Viewability module is configured with ``` firePixels: true ``` then the URLs mentioned in bid.vurls will be called. Please note that GDPR and USP related parameters will be added to the given URLs
+- This module is also compatible with Prebid core's billing deferral logic, this means that bids linked to an ad unit marked with `deferBilling: true` will trigger a bid adapter's `onBidBillable` function (if present) indicating an ad slot was viewed and also billing ready (if it were deferred).
 
 # Params
 - enabled [required] [type: boolean, default: false], when set to true, the module will emit BID_VIEWABLE when applicable
@@ -44,6 +45,6 @@ Refer: https://support.google.com/admanager/answer/4524488
 ```
 
 # Please Note:
-- Doesn't seems to work with Instream Video, https://docs.prebid.org/dev-docs/examples/instream-banner-mix.html as GPT's impressionViewable event is not triggered for instream-video-creative
-- Works with Banner, Outsteam, Native creatives
+- This module doesn't seem to work with Instream Video, https://docs.prebid.org/dev-docs/examples/instream-banner-mix.html as GPT's impressionViewable event is not triggered for instream-video-creative
+- Works with Banner, Outsteam and Native creatives
 

package/modules/brandmetricsRtdProvider.js

@@ -21,13 +21,14 @@ let billableEventsInitialized = false
 
 function init (config, userConsent) {
   const hasConsent = checkConsent(userConsent)
+  const initialize = hasConsent !== false
 
-  if (hasConsent) {
+  if (initialize) {
     const moduleConfig = getMergedConfig(config)
     initializeBrandmetrics(moduleConfig.params.scriptId)
     initializeBillableEvents()
   }
-  return hasConsent
+  return initialize
 }
 
 /**
@@ -36,33 +37,35 @@ function init (config, userConsent) {
  * @returns {boolean}
  */
 function checkConsent (userConsent) {
-  let consent = false
-
-  if (userConsent && userConsent.gdpr && userConsent.gdpr.gdprApplies) {
-    const gdpr = userConsent.gdpr
-
-    if (gdpr.vendorData) {
-      const vendor = gdpr.vendorData.vendor
-      const purpose = gdpr.vendorData.purpose
-
-      let vendorConsent = false
-      if (vendor.consents) {
-        vendorConsent = vendor.consents[GVL_ID]
+  let consent
+
+  if (userConsent) {
+    if (userConsent.gdpr && userConsent.gdpr.gdprApplies) {
+      const gdpr = userConsent.gdpr
+
+      if (gdpr.vendorData) {
+        const vendor = gdpr.vendorData.vendor
+        const purpose = gdpr.vendorData.purpose
+
+        let vendorConsent = false
+        if (vendor.consents) {
+          vendorConsent = vendor.consents[GVL_ID]
+        }
+
+        if (vendor.legitimateInterests) {
+          vendorConsent = vendorConsent || vendor.legitimateInterests[GVL_ID]
+        }
+
+        const purposes = TCF_PURPOSES.map(id => {
+          return (purpose.consents && purpose.consents[id]) || (purpose.legitimateInterests && purpose.legitimateInterests[id])
+        })
+        const purposesValid = purposes.filter(p => p === true).length === TCF_PURPOSES.length
+        consent = vendorConsent && purposesValid
       }
-
-      if (vendor.legitimateInterests) {
-        vendorConsent = vendorConsent || vendor.legitimateInterests[GVL_ID]
-      }
-
-      const purposes = TCF_PURPOSES.map(id => {
-        return (purpose.consents && purpose.consents[id]) || (purpose.legitimateInterests && purpose.legitimateInterests[id])
-      })
-      const purposesValid = purposes.filter(p => p === true).length === TCF_PURPOSES.length
-      consent = vendorConsent && purposesValid
+    } else if (userConsent.usp) {
+      const usp = userConsent.usp
+      consent = usp[1] !== 'N' && usp[2] !== 'Y'
     }
-  } else if (userConsent.usp) {
-    const usp = userConsent.usp
-    consent = usp[1] !== 'N' && usp[2] !== 'Y'
   }
 
   return consent

package/modules/criteoBidAdapter.js

@@ -3,7 +3,6 @@ import { loadExternalScript } from '../src/adloader.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { config } from '../src/config.js';
 import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
-import { find } from '../src/polyfill.js';
 import { verify } from 'criteo-direct-rsa-validate/build/verify.js'; // ref#2
 import { getStorageManager } from '../src/storageManager.js';
 import { getRefererInfo } from '../src/refererDetection.js';
@@ -29,7 +28,7 @@ const LOG_PREFIX = 'Criteo: ';
   Unminified source code can be found in the privately shared repo: https://github.com/Prebid-org/prebid-js-external-js-criteo/blob/master/dist/prod.js
 */
 const FAST_BID_VERSION_PLACEHOLDER = '%FAST_BID_VERSION%';
-export const FAST_BID_VERSION_CURRENT = 136;
+export const FAST_BID_VERSION_CURRENT = 139;
 const FAST_BID_VERSION_LATEST = 'latest';
 const FAST_BID_VERSION_NONE = 'none';
 const PUBLISHER_TAG_URL_TEMPLATE = 'https://static.criteo.net/js/ld/publishertag.prebid' + FAST_BID_VERSION_PLACEHOLDER + '.js';
@@ -219,51 +218,53 @@ export const spec = {
 
     if (body && body.slots && isArray(body.slots)) {
       body.slots.forEach(slot => {
-        const bidRequest = find(request.bidRequests, b => b.adUnitCode === slot.impid && (!b.params.zoneId || parseInt(b.params.zoneId) === slot.zoneid));
-        const bidId = bidRequest.bidId;
-        const bid = {
-          requestId: bidId,
-          cpm: slot.cpm,
-          currency: slot.currency,
-          netRevenue: true,
-          ttl: slot.ttl || 60,
-          creativeId: slot.creativecode,
-          width: slot.width,
-          height: slot.height,
-          dealId: slot.deal,
-        };
-        if (body.ext?.paf?.transmission && slot.ext?.paf?.content_id) {
-          const pafResponseMeta = {
-            content_id: slot.ext.paf.content_id,
-            transmission: response.ext.paf.transmission
+        const bidRequest = getAssociatedBidRequest(request.bidRequests, slot);
+        if (bidRequest) {
+          const bidId = bidRequest.bidId;
+          const bid = {
+            requestId: bidId,
+            cpm: slot.cpm,
+            currency: slot.currency,
+            netRevenue: true,
+            ttl: slot.ttl || 60,
+            creativeId: slot.creativecode,
+            width: slot.width,
+            height: slot.height,
+            dealId: slot.deal,
           };
-          bid.meta = Object.assign({}, bid.meta, { paf: pafResponseMeta });
-        }
-        if (slot.adomain) {
-          bid.meta = Object.assign({}, bid.meta, { advertiserDomains: [slot.adomain].flat() });
-        }
-        if (slot.ext?.meta?.networkName) {
-          bid.meta = Object.assign({}, bid.meta, { networkName: slot.ext.meta.networkName })
-        }
-        if (slot.native) {
-          if (bidRequest.params.nativeCallback) {
-            bid.ad = createNativeAd(bidId, slot.native, bidRequest.params.nativeCallback);
-          } else {
-            bid.native = createPrebidNativeAd(slot.native);
-            bid.mediaType = NATIVE;
+          if (body.ext?.paf?.transmission && slot.ext?.paf?.content_id) {
+            const pafResponseMeta = {
+              content_id: slot.ext.paf.content_id,
+              transmission: response.ext.paf.transmission
+            };
+            bid.meta = Object.assign({}, bid.meta, { paf: pafResponseMeta });
           }
-        } else if (slot.video) {
-          bid.vastUrl = slot.displayurl;
-          bid.mediaType = VIDEO;
-          const context = deepAccess(bidRequest, 'mediaTypes.video.context');
-          // if outstream video, add a default render for it.
-          if (context === OUTSTREAM) {
-            bid.renderer = createOutstreamVideoRenderer(slot);
+          if (slot.adomain) {
+            bid.meta = Object.assign({}, bid.meta, { advertiserDomains: [slot.adomain].flat() });
           }
-        } else {
-          bid.ad = slot.creative;
+          if (slot.ext?.meta?.networkName) {
+            bid.meta = Object.assign({}, bid.meta, { networkName: slot.ext.meta.networkName })
+          }
+          if (slot.native) {
+            if (bidRequest.params.nativeCallback) {
+              bid.ad = createNativeAd(bidId, slot.native, bidRequest.params.nativeCallback);
+            } else {
+              bid.native = createPrebidNativeAd(slot.native);
+              bid.mediaType = NATIVE;
+            }
+          } else if (slot.video) {
+            bid.vastUrl = slot.displayurl;
+            bid.mediaType = VIDEO;
+            const context = deepAccess(bidRequest, 'mediaTypes.video.context');
+            // if outstream video, add a default render for it.
+            if (context === OUTSTREAM) {
+              bid.renderer = createOutstreamVideoRenderer(slot);
+            }
+          } else {
+            bid.ad = slot.creative;
+          }
+          bids.push(bid);
         }
-        bids.push(bid);
       });
     }
 
@@ -462,6 +463,7 @@ function buildCdbRequest(context, bidRequests, bidderRequest) {
       networkId = bidRequest.params.networkId || networkId;
       schain = bidRequest.schain || schain;
       const slot = {
+        slotid: bidRequest.bidId,
         impid: bidRequest.adUnitCode,
         transactionid: bidRequest.ortb2Imp?.ext?.tid
       };
@@ -786,6 +788,27 @@ function createOutstreamVideoRenderer(slot) {
   return renderer;
 }
 
+function getAssociatedBidRequest(bidRequests, slot) {
+  for (const request of bidRequests) {
+    if (request.adUnitCode === slot.impid) {
+      if (request.params.zoneId && parseInt(request.params.zoneId) === slot.zoneid) {
+        return request;
+      } else if (slot.native) {
+        if (request.mediaTypes?.native || request.nativeParams) {
+          return request;
+        }
+      } else if (slot.video) {
+        if (request.mediaTypes?.video) {
+          return request;
+        }
+      } else if (request.mediaTypes?.banner || request.sizes) {
+        return request;
+      }
+    }
+  }
+  return undefined;
+}
+
 export function tryGetCriteoFastBid() {
   // begin ref#1
   try {