prebid.js 8.5.0 → 8.7.0

package/modules/topicsFpdModule.js

@@ -1,18 +1,22 @@
-import {logError, logWarn, mergeDeep, isEmpty, safeJSONParse, logInfo, hasDeviceAccess} from '../src/utils.js';
+import {isEmpty, logError, logWarn, mergeDeep, safeJSONParse} from '../src/utils.js';
 import {getRefererInfo} from '../src/refererDetection.js';
 import {submodule} from '../src/hook.js';
 import {GreedyPromise} from '../src/utils/promise.js';
 import {config} from '../src/config.js';
 import {getCoreStorageManager} from '../src/storageManager.js';
 import {includes} from '../src/polyfill.js';
-import {gdprDataHandler} from '../src/adapterManager.js';
+import {isActivityAllowed} from '../src/activities/rules.js';
+import {ACTIVITY_ENRICH_UFPD} from '../src/activities/activities.js';
+import {activityParams} from '../src/activities/activityParams.js';
+import {MODULE_TYPE_BIDDER} from '../src/activities/modules.js';
 
 const MODULE_NAME = 'topicsFpd';
 const DEFAULT_EXPIRATION_DAYS = 21;
-const TCF_REQUIRED_PURPOSES = ['1', '2', '3', '4'];
-let HAS_GDPR_CONSENT = true;
 let LOAD_TOPICS_INITIALISE = false;
-const HAS_DEVICE_ACCESS = hasDeviceAccess();
+
+export function reset() {
+  LOAD_TOPICS_INITIALISE = false;
+}
 
 const bidderIframeList = {
   maxTopicCaller: 2,
@@ -86,10 +90,14 @@ export function getTopicsData(name, topics, taxonomies = TAXONOMIES) {
     );
 }
 
+function isTopicsSupported(doc = document) {
+  return 'browsingTopics' in doc && doc.featurePolicy.allowsFeature('browsing-topics')
+}
+
 export function getTopics(doc = document) {
   let topics = null;
   try {
-    if ('browsingTopics' in doc && doc.featurePolicy.allowsFeature('browsing-topics')) {
+    if (isTopicsSupported(doc)) {
       topics = GreedyPromise.resolve(doc.browsingTopics());
     }
   } catch (e) {
@@ -126,19 +134,16 @@ export function processFpd(config, {global}, {data = topicsData} = {}) {
  */
 export function getCachedTopics() {
   let cachedTopicData = [];
-  if (!HAS_GDPR_CONSENT || !HAS_DEVICE_ACCESS) {
-    return cachedTopicData;
-  }
   const topics = config.getConfig('userSync.topics') || bidderIframeList;
   const bidderList = topics.bidders || [];
   let storedSegments = new Map(safeJSONParse(coreStorage.getDataFromLocalStorage(topicStorageName)));
   storedSegments && storedSegments.forEach((value, cachedBidder) => {
     // Check bidder exist in config for cached bidder data and then only retrieve the cached data
-    let bidderConfigObj = bidderList.find(({bidder}) => cachedBidder == bidder)
-    if (bidderConfigObj) {
+    let bidderConfigObj = bidderList.find(({bidder}) => cachedBidder === bidder)
+    if (bidderConfigObj && isActivityAllowed(ACTIVITY_ENRICH_UFPD, activityParams(MODULE_TYPE_BIDDER, cachedBidder))) {
       if (!isCachedDataExpired(value[lastUpdated], bidderConfigObj?.expiry || DEFAULT_EXPIRATION_DAYS)) {
         Object.keys(value).forEach((segData) => {
-          segData != lastUpdated && cachedTopicData.push(value[segData]);
+          segData !== lastUpdated && cachedTopicData.push(value[segData]);
         })
       } else {
         // delete the specific bidder map from the store and store the updated maps
@@ -204,55 +209,23 @@ function listenMessagesFromTopicIframe() {
   window.addEventListener('message', receiveMessage, false);
 }
 
-function checkTCFv2(vendorData, requiredPurposes = TCF_REQUIRED_PURPOSES) {
-  const {gdprApplies, purpose} = vendorData;
-  if (!gdprApplies || !purpose) {
-    return true;
-  }
-  return requiredPurposes.map((purposeNo) => {
-    const purposeConsent = purpose.consents ? purpose.consents[purposeNo] : false;
-    if (purposeConsent) {
-      return true;
-    }
-    return false;
-  }).reduce((a, b) => a && b, true);
-}
-
-export function hasGDPRConsent() {
-  // Check for GDPR consent for purpose 1,2,3,4 and return false if consent has not been given
-  const gdprConsent = gdprDataHandler.getConsentData();
-  const hasGdpr = (gdprConsent && typeof gdprConsent.gdprApplies === 'boolean' && gdprConsent.gdprApplies) ? 1 : 0;
-  const gdprConsentString = hasGdpr ? gdprConsent.consentString : '';
-  if (hasGdpr) {
-    if ((!gdprConsentString || gdprConsentString === '') || !gdprConsent.vendorData) {
-      return false;
-    }
-    return checkTCFv2(gdprConsent.vendorData);
-  }
-  return true;
-}
-
 /**
  * function to load the iframes of the bidder to load the topics data
  */
-function loadTopicsForBidders() {
-  HAS_GDPR_CONSENT = hasGDPRConsent();
-  if (!HAS_GDPR_CONSENT || !HAS_DEVICE_ACCESS) {
-    logInfo('Topics Module : Consent string is required to fetch the topics from third party domains.');
-    return;
-  }
+export function loadTopicsForBidders(doc = document) {
+  if (!isTopicsSupported(doc)) return;
   const topics = config.getConfig('userSync.topics') || bidderIframeList;
   if (topics) {
     listenMessagesFromTopicIframe();
     const randomBidders = getRandomBidders(topics.bidders || [], topics.maxTopicCaller || 1)
     randomBidders && randomBidders.forEach(({ bidder, iframeURL }) => {
       if (bidder && iframeURL) {
-        let ifrm = document.createElement('iframe');
+        let ifrm = doc.createElement('iframe');
         ifrm.name = 'ifrm_'.concat(bidder);
         ifrm.src = ''.concat(iframeURL, '?bidder=').concat(bidder);
         ifrm.style.display = 'none';
         setLoadedIframeURL(new URL(iframeURL).origin);
-        iframeURL && window.document.documentElement.appendChild(ifrm);
+        iframeURL && doc.documentElement.appendChild(ifrm);
       }
     })
   } else {

package/modules/undertoneBidAdapter.md

@@ -23,7 +23,7 @@ Module that connects to Undertone's demand sources
            {
              bidder: "undertone",
              params: {
-               placementId: '10433394',
+               placementId: 1234,
                publisherId: 12345
                }
            }

package/modules/userId/eids.md

@@ -272,6 +272,13 @@ userIdAsEids = [
             id: 'some-random-id-value',
             atype: 3
         }]
+    },
+    {
+        source: 'euid.eu',
+        uids: [{
+            id: 'some-random-id-value',
+            atype: 3
+        }]
     }
 ]
 ```

package/modules/viantOrtbBidAdapter.js

@@ -0,0 +1,113 @@
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+import {BANNER, NATIVE, VIDEO} from '../src/mediaTypes.js';
+import * as utils from '../src/utils.js';
+import {ortbConverter} from '../libraries/ortbConverter/converter.js'
+import {deepAccess, getBidIdParameter, logError} from '../src/utils.js';
+
+const BIDDER_CODE = 'viant';
+const ENDPOINT = 'https://bidders-us-east-1.adelphic.net/d/rtb/v25/prebid/bidder_test'
+
+const DEFAULT_BID_TTL = 300;
+const DEFAULT_CURRENCY = 'USD';
+const DEFAULT_NET_REVENUE = true;
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, VIDEO, NATIVE],
+
+  isBidRequestValid: function (bid) {
+    if (bid && typeof bid.params !== 'object') {
+      logError(BIDDER_CODE + ': params is not defined or is incorrect in the bidder settings.');
+      return false;
+    }
+    if (!getBidIdParameter('publisherId', bid.params)) {
+      logError(BIDDER_CODE + ': publisherId is not present in bidder params.');
+      return false;
+    }
+    const mediaTypesBanner = deepAccess(bid, 'mediaTypes.banner');
+    const mediaTypesVideo = deepAccess(bid, 'mediaTypes.video');
+    const mediaTypesNative = deepAccess(bid, 'mediaTypes.native');
+    if (!mediaTypesBanner && !mediaTypesVideo && !mediaTypesNative) {
+      utils.logWarn(BIDDER_CODE + ': one of mediaTypes.banner or mediaTypes.video or mediaTypes.native must be passed');
+      return false;
+    }
+    return true;
+  },
+
+  buildRequests,
+
+  interpretResponse(response, request) {
+    if (!response.body) {
+      response.body = {nbr: 0};
+    }
+    const bids = converter.fromORTB({request: request.data, response: response.body}).bids;
+    return bids;
+  },
+
+  /**
+   * Register bidder specific code, which will execute if a bid from this bidder won the auction
+   * @param {Bid} bid The bid that won the auction
+   */
+  onBidWon: function (bid) {
+    if (bid.burl) {
+      utils.triggerPixel(bid.burl);
+    } else if (bid.nurl) {
+      utils.triggerPixel(bid.nurl);
+    }
+  }
+}
+
+function buildRequests(bids, bidderRequest) {
+  let videoBids = bids.filter(bid => isVideoBid(bid));
+  let bannerBids = bids.filter(bid => isBannerBid(bid));
+  let nativeBids = bids.filter(bid => isNativeBid(bid));
+  let requests = bannerBids.length ? [createRequest(bannerBids, bidderRequest, BANNER)] : [];
+  videoBids.forEach(bid => {
+    requests.push(createRequest([bid], bidderRequest, VIDEO));
+  });
+  nativeBids.forEach(bid => {
+    requests.push(createRequest([bid], bidderRequest, NATIVE));
+  });
+  return requests;
+}
+
+function createRequest(bidRequests, bidderRequest, mediaType) {
+  const data = converter.toORTB({bidRequests, bidderRequest, context: {mediaType}});
+  if (bidderRequest.gdprConsent && typeof bidderRequest.gdprConsent.gdprApplies === 'boolean') {
+    if (!data.regs) data.regs = {};
+    if (!data.regs.ext) data.regs.ext = {};
+    data.regs.ext.gdpr = bidderRequest.gdprConsent.gdprApplies ? 1 : 0;
+  }
+  if (bidderRequest.uspConsent) {
+    if (!data.regs) data.regs = {};
+    if (!data.regs.ext) data.regs.ext = {};
+    data.regs.ext.us_privacy = bidderRequest.uspConsent;
+  }
+  return {
+    method: 'POST',
+    url: ENDPOINT,
+    data: data
+  }
+}
+
+function isVideoBid(bid) {
+  return deepAccess(bid, 'mediaTypes.video');
+}
+
+function isBannerBid(bid) {
+  return deepAccess(bid, 'mediaTypes.banner');
+}
+
+function isNativeBid(bid) {
+  return deepAccess(bid, 'mediaTypes.native');
+}
+
+const converter = ortbConverter({
+  context: {
+    netRevenue: DEFAULT_NET_REVENUE,
+    ttl: DEFAULT_BID_TTL,
+    currency: DEFAULT_CURRENCY
+  }
+});
+
+registerBidder(spec);

package/modules/viantOrtbBidAdapter.md

@@ -0,0 +1,54 @@
+# Overview
+
+Module Name: VIANT Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: dist-runtime@viantinc.com
+
+# Description
+
+An adapter to get a bid from VIANT DSP.
+
+# Test Parameters
+```javascript
+    var adUnits = [            // Banner adUnit with only required parameters
+        {
+            code: 'test-div-minimal',
+            mediaTypes: {
+                banner: {
+                    sizes: [[728, 90]]
+                }
+            },
+            bids: [
+                {
+                    bidder: 'viant',
+                    params: {
+                        supplySourceId: 'supplier',
+                        publisherId: '464'
+                    }
+                }
+            ]
+        },
+        {
+            code: 'test-div-minimal-video',
+            mediaTypes: {
+                video: {
+                    playerSize: [640, 480],
+                    context: 'outstream'
+                }
+            },
+            bids: [
+                {
+                    bidder: 'viant',
+                    params: {
+                        supplySourceId: 'supplier',
+                        publisherId: '464' // required
+                    }
+                }
+            ]
+        }    
+    ];
+```
+
+Where:
+
+* placementId - Placement ID of the ad unit (required)

package/modules/vidazooBidAdapter.js

@@ -320,13 +320,20 @@ function interpretResponse(serverResponse, request) {
   }
 }
 
-function getUserSyncs(syncOptions, responses, gdprConsent = {}, uspConsent = '') {
+function getUserSyncs(syncOptions, responses, gdprConsent = {}, uspConsent = '', gppConsent = {}) {
   let syncs = [];
   const {iframeEnabled, pixelEnabled} = syncOptions;
   const {gdprApplies, consentString = ''} = gdprConsent;
+  const {gppString, applicableSections} = gppConsent;
 
   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 || '')}`
+  let params = `?cid=${encodeURIComponent(cidArr.join(','))}&gdpr=${gdprApplies ? 1 : 0}&gdpr_consent=${encodeURIComponent(consentString || '')}&us_privacy=${encodeURIComponent(uspConsent || '')}`;
+
+  if (gppString && applicableSections?.length) {
+    params += '&gpp=' + encodeURIComponent(gppString);
+    params += '&gpp_sid=' + encodeURIComponent(applicableSections.join(','));
+  }
+
   if (iframeEnabled) {
     syncs.push({
       type: 'iframe',

package/modules/videojsVideoProvider.js

@@ -201,8 +201,15 @@ export function VideojsProvider(providerConfig, vjs_, adState_, timeState_, call
       return;
     }
 
-    player.ima.changeAdTag(adTagUrl);
-    player.ima.requestAds();
+    // The VideoJS IMA plugin version 1.11.0 will throw when the ad is empty.
+    try {
+      player.ima.changeAdTag(adTagUrl);
+      player.ima.requestAds();
+    } catch (e) {
+      /*
+      Handling is not required; ad errors are emitted automatically by video.js
+       */
+    }
   }
 
   function onEvent(type, callback, payload) {

package/package.json

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