prebid.js 7.18.0 → 7.20.0

package/modules/taboolaBidAdapter.js

@@ -147,7 +147,7 @@ export const spec = {
       return [];
     }
 
-    return bids.map((bid, id) => getBid(bid.bidId, currency, bidResponses[id])).filter(Boolean);
+    return bidResponses.map((bidResponse) => getBid(bids, currency, bidResponse)).filter(Boolean);
   },
 };
 
@@ -204,7 +204,7 @@ function getBidResponses({body}) {
 
   const {seatbid, cur} = body;
 
-  if (!seatbid.length || !seatbid[0].bid) {
+  if (!seatbid.length || !seatbid[0].bid || !seatbid[0].bid.length) {
     return [];
   }
 
@@ -214,14 +214,14 @@ function getBidResponses({body}) {
   };
 }
 
-function getBid(requestId, currency, bidResponse) {
+function getBid(bids, currency, bidResponse) {
   if (!bidResponse) {
     return;
   }
   const {
     price: cpm, 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) {
     meta.advertiserDomains = advertiserDomains
   }
@@ -237,7 +237,7 @@ function getBid(requestId, currency, bidResponse) {
     width,
     height,
     meta,
-    netRevenue: false
+    netRevenue: true
   };
 }
 

package/modules/talkadsBidAdapter.js

@@ -63,6 +63,7 @@ export const spec = {
       cur: CURRENCY,
       timeout: poBidderRequest.timeout,
       auction_id: paValidBidRequests[0].auctionId,
+      // TODO: should this use auctionId? see #8573
       transaction_id: paValidBidRequests[0].transactionId,
       bids: laBids,
       gdpr: { applies: false, consent: false },

package/modules/teadsIdSystem.js

@@ -0,0 +1,234 @@
+/**
+ * This module adds TeadsId to the User ID module
+ * The {@link module:modules/userId} module is required
+ * @module modules/teadsIdSystem
+ * @requires module:modules/userId
+ */
+
+import {isStr, isNumber, logError, logInfo, isEmpty, timestamp} from '../src/utils.js'
+import {ajax} from '../src/ajax.js';
+import {submodule} from '../src/hook.js';
+import {getStorageManager} from '../src/storageManager.js';
+import {uspDataHandler} from '../src/adapterManager.js';
+
+const MODULE_NAME = 'teadsId';
+const GVL_ID = 132;
+const FP_TEADS_ID_COOKIE_NAME = '_tfpvi';
+const EXPIRED_COOKIE_DATE = 'Thu, 01 Jan 1970 00:00:01 GMT';
+
+export const gdprStatus = {
+  GDPR_DOESNT_APPLY: 0,
+  CMP_NOT_FOUND_OR_ERROR: 22,
+  GDPR_APPLIES_PUBLISHER: 12,
+};
+
+export const gdprReason = {
+  GDPR_DOESNT_APPLY: 0,
+  CMP_NOT_FOUND: 220,
+  GDPR_APPLIES_PUBLISHER_CLASSIC: 120,
+};
+
+export const storage = getStorageManager({gvlid: GVL_ID, moduleName: MODULE_NAME});
+
+/** @type {Submodule} */
+export const teadsIdSubmodule = {
+  /**
+     * used to link submodule with config
+     * @type {string}
+     */
+  name: MODULE_NAME,
+  /**
+     * decode the stored id value for passing to bid requests
+     * @function
+     * @param {string} value
+     * @returns {{teadsId:string}}
+     */
+  decode(value) {
+    return {teadsId: value}
+  },
+  /**
+     * performs action to obtain id and return a value in the callback's response argument
+     * @function
+     * @param {SubmoduleConfig} [submoduleConfig]
+     * @param {ConsentData} [consentData]
+     * @returns {IdResponse|undefined}
+     */
+  getId(submoduleConfig, consentData) {
+    const resp = function (callback) {
+      const url = buildAnalyticsTagUrl(submoduleConfig, consentData);
+
+      const callbacks = {
+        success: (bodyResponse, responseObj) => {
+          if (responseObj && responseObj.status === 200) {
+            if (isStr(bodyResponse) && !isEmpty(bodyResponse)) {
+              const cookiesMaxAge = getTimestampFromDays(365); // 1 year
+              const expirationCookieDate = getCookieExpirationDate(cookiesMaxAge);
+              storage.setCookie(FP_TEADS_ID_COOKIE_NAME, bodyResponse, expirationCookieDate);
+              callback(bodyResponse);
+            } else {
+              storage.setCookie(FP_TEADS_ID_COOKIE_NAME, '', EXPIRED_COOKIE_DATE);
+              callback();
+            }
+          } else {
+            logInfo(`${MODULE_NAME}: Server error while fetching ID`);
+            callback();
+          }
+        },
+        error: error => {
+          logError(`${MODULE_NAME}: ID fetch encountered an error`, error);
+          callback();
+        }
+      };
+
+      ajax(url, callbacks, undefined, {method: 'GET'});
+    };
+    return {callback: resp};
+  }
+};
+
+/**
+ * Build the full URL from the Submodule config & consentData
+ * @param submoduleConfig
+ * @param consentData
+ * @returns {string}
+ */
+export function buildAnalyticsTagUrl(submoduleConfig, consentData) {
+  const pubId = getPublisherId(submoduleConfig);
+  const teadsViewerId = getTeadsViewerId();
+  const status = getGdprStatus(consentData);
+  const gdprConsentString = getGdprConsentString(consentData);
+  const ccpaConsentString = getCcpaConsentString(uspDataHandler?.getConsentData());
+  const gdprReason = getGdprReasonFromStatus(status);
+  const params = {
+    analytics_tag_id: pubId,
+    tfpvi: teadsViewerId,
+    gdpr_consent: gdprConsentString,
+    gdpr_status: status,
+    gdpr_reason: gdprReason,
+    ccpa_consent: ccpaConsentString,
+    sv: 'prebid-v1',
+  };
+
+  const url = 'https://at.teads.tv/fpc';
+  const queryParams = new URLSearchParams();
+
+  for (const param in params) {
+    queryParams.append(param, params[param]);
+  }
+
+  return url + '?' + queryParams.toString();
+}
+
+/**
+ * Extract the Publisher ID from the Submodule config
+ * @returns {string}
+ * @param submoduleConfig
+ */
+export function getPublisherId(submoduleConfig) {
+  const pubId = submoduleConfig?.params?.pubId;
+  const prefix = 'PUB_';
+  if (isNumber(pubId)) {
+    return prefix + pubId.toString();
+  }
+  if (isStr(pubId) && parseInt(pubId)) {
+    return prefix + pubId;
+  }
+  return '';
+}
+
+/**
+ * Extract the GDPR status from the given consentData
+ * @param consentData
+ * @returns {number}
+ */
+export function getGdprStatus(consentData) {
+  const gdprApplies = consentData?.gdprApplies;
+  if (gdprApplies === true) {
+    return gdprStatus.GDPR_APPLIES_PUBLISHER;
+  } else if (gdprApplies === false) {
+    return gdprStatus.GDPR_DOESNT_APPLY;
+  } else {
+    return gdprStatus.CMP_NOT_FOUND_OR_ERROR;
+  }
+}
+
+/**
+ * Extract the GDPR consent string from the given consentData
+ * @param consentData
+ * @returns {string}
+ */
+export function getGdprConsentString(consentData) {
+  const consentString = consentData?.consentString;
+  if (isStr(consentString)) {
+    return consentString;
+  } else {
+    return '';
+  }
+}
+
+/**
+ * Map the GDPR reason from the given GDPR status
+ * @param status
+ * @returns {number}
+ */
+function getGdprReasonFromStatus(status) {
+  switch (status) {
+    case gdprStatus.GDPR_DOESNT_APPLY:
+      return gdprReason.GDPR_DOESNT_APPLY;
+    case gdprStatus.CMP_NOT_FOUND_OR_ERROR:
+      return gdprReason.CMP_NOT_FOUND;
+    case gdprStatus.GDPR_APPLIES_PUBLISHER:
+      return gdprReason.GDPR_APPLIES_PUBLISHER_CLASSIC;
+    default:
+      return -1;
+  }
+}
+
+/**
+ * Return the well formatted CCPA consent string
+ * @param ccpaConsentString
+ * @returns {string|*}
+ */
+export function getCcpaConsentString(ccpaConsentString) {
+  if (isStr(ccpaConsentString)) {
+    return ccpaConsentString;
+  } else {
+    return '';
+  }
+}
+
+/**
+ * Get the cookie expiration date string from a given Date and a max age
+ * @param {number} maxAge
+ * @returns {string}
+ */
+export function getCookieExpirationDate(maxAge) {
+  return new Date(timestamp() + maxAge).toUTCString()
+}
+
+/**
+ * Get cookie from Cookie or Local Storage
+ * @returns {string}
+ */
+function getTeadsViewerId() {
+  const teadsViewerId = readCookie()
+  if (isStr(teadsViewerId)) {
+    return teadsViewerId
+  } else {
+    return '';
+  }
+}
+
+function readCookie() {
+  return storage.cookiesAreEnabled(null) ? storage.getCookie(FP_TEADS_ID_COOKIE_NAME, null) : null;
+}
+
+/**
+ * Return a number of milliseconds from given days number
+ * @param days
+ * @returns {number}
+ */
+export function getTimestampFromDays(days) {
+  return days * 24 * 60 * 60 * 1000;
+}
+submodule('userId', teadsIdSubmodule);

package/modules/teadsIdSystem.md

@@ -0,0 +1,22 @@
+# Overview
+
+Module Name: Teads Id System
+Module Type: User Id System
+Maintainer: innov-ssp@teads.com
+
+# Description
+
+Teads user identification system. GDPR & CCPA compliant.
+
+## Example configuration for publishers:
+
+    pbjs.setConfig({
+        userSync: {
+            userIds: [{
+                name: 'teadsId',
+                params: {
+                    pubId: 1234
+                }
+            }]
+        }
+    });

package/modules/truereachBidAdapter.js

@@ -25,6 +25,7 @@ export const spec = {
 
     let siteId = deepAccess(validBidRequests[0], 'params.site_id');
 
+    // TODO: should this use auctionId? see #8573
     let url = BIDDER_URL + siteId + '?hb=1&transactionId=' + validBidRequests[0].transactionId;
 
     return {

package/modules/ttdBidAdapter.js

@@ -59,7 +59,7 @@ function getBidFloor(bid) {
 
 function getSource(validBidRequests) {
   let source = {
-    tid: validBidRequests[0].transactionId
+    tid: validBidRequests[0].auctionId
   };
   if (validBidRequests[0].schain) {
     utils.deepSetValue(source, 'ext.schain', validBidRequests[0].schain);

package/modules/userId/index.js

@@ -425,6 +425,7 @@ function processSubmoduleCallbacks(submodules, cb) {
         }
         // cache decoded value (this is copied to every adUnit bid)
         submodule.idObj = submodule.submodule.decode(idObj, submodule.config);
+        updatePPID(submodule.idObj);
       } else {
         logInfo(`${MODULE_NAME}: ${submodule.submodule.name} - request id responded with an empty value`);
       }
@@ -613,9 +614,9 @@ function idSystemInitializer({delay = GreedyPromise.timeout} = {}) {
 
 let initIdSystem;
 
-function getPPID() {
+function getPPID(eids = getUserIdsAsEids() || []) {
   // userSync.ppid should be one of the 'source' values in getUserIdsAsEids() eg pubcid.org or id5-sync.com
-  const matchingUserId = ppidSource && (getUserIdsAsEids() || []).find(userID => userID.source === ppidSource);
+  const matchingUserId = ppidSource && eids.find(userID => userID.source === ppidSource);
   if (matchingUserId && typeof deepAccess(matchingUserId, 'uids.0.id') === 'string') {
     const ppidValue = matchingUserId.uids[0].id.replace(/[\W_]/g, '');
     if (ppidValue.length >= 32 && ppidValue.length <= 150) {
@@ -642,18 +643,6 @@ export const requestBidsHook = timedAuctionHook('userId', function requestBidsHo
   ]).then(() => {
     // pass available user id data to bid adapters
     addIdDataToAdUnitBids(reqBidsConfigObj.adUnits || getGlobal().adUnits, initializedSubmodules);
-    const ppid = getPPID();
-    if (ppid) {
-      if (isGptPubadsDefined()) {
-        window.googletag.pubads().setPublisherProvidedId(ppid);
-      } else {
-        window.googletag = window.googletag || {};
-        window.googletag.cmd = window.googletag.cmd || [];
-        window.googletag.cmd.push(function() {
-          window.googletag.pubads().setPublisherProvidedId(ppid);
-        });
-      }
-    }
     uidMetrics().join(useMetrics(reqBidsConfigObj.metrics), {propagate: false, includeGroups: true});
     // calling fn allows prebid to continue processing
     fn.call(this, reqBidsConfigObj);
@@ -853,6 +842,24 @@ function populateSubmoduleId(submodule, consentData, storedConsentData, forceRef
       if (response.id) { submodule.idObj = submodule.submodule.decode(response.id, submodule.config); }
     }
   }
+  updatePPID(submodule.idObj);
+}
+
+function updatePPID(userIds = getUserIds()) {
+  if (userIds && ppidSource) {
+    const ppid = getPPID(createEidsArray(userIds));
+    if (ppid) {
+      if (isGptPubadsDefined()) {
+        window.googletag.pubads().setPublisherProvidedId(ppid);
+      } else {
+        window.googletag = window.googletag || {};
+        window.googletag.cmd = window.googletag.cmd || [];
+        window.googletag.cmd.push(function() {
+          window.googletag.pubads().setPublisherProvidedId(ppid);
+        });
+      }
+    }
+  }
 }
 
 function initSubmodules(dest, submodules, consentData, forceRefresh = false) {

package/modules/vrtcalBidAdapter.js

@@ -27,6 +27,11 @@ export const spec = {
       let ccpa = '';
       let coppa = 0;
       let tmax = 0;
+      let eids = [];
+
+      if (bidRequests[0].userIdAsEids && bidRequests[0].userIdAsEids.length > 0) {
+        eids = bidRequests[0].userIdAsEids;
+      }
 
       if (bid && bid.gdprConsent) {
         gdprApplies = bid.gdprConsent.gdprApplies ? 1 : 0;
@@ -74,7 +79,8 @@ export const spec = {
         },
         user: {
           ext: {
-            consent: gdprConsent
+            consent: gdprConsent,
+            eids: eids
           }
         }
       };

package/modules/vuukleBidAdapter.js

@@ -1,18 +1,24 @@
-import { parseSizesInput } from '../src/utils.js';
+import { parseSizesInput, deepAccess } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER } from '../src/mediaTypes.js';
+import { config } from '../src/config.js';
 
 const BIDDER_CODE = 'vuukle';
 const URL = 'https://pb.vuukle.com/adapter';
 const TIME_TO_LIVE = 360;
+const VENDOR_ID = 1004;
 
 export const spec = {
   code: BIDDER_CODE,
+  gvlid: VENDOR_ID,
+  supportedMediaTypes: [ BANNER ],
 
   isBidRequestValid: function(bid) {
     return true
   },
 
-  buildRequests: function(bidRequests) {
+  buildRequests: function(bidRequests, bidderRequest) {
+    bidderRequest = bidderRequest || {};
     const requests = bidRequests.map(function (bid) {
       const parseSized = parseSizesInput(bid.sizes);
       const arrSize = parseSized[0].split('x');
@@ -25,10 +31,27 @@ export const spec = {
         rnd: Math.random(),
         bidId: bid.bidId,
         source: 'pbjs',
+        schain: JSON.stringify(bid.schain),
+        requestId: bid.bidderRequestId,
+        tmax: bidderRequest.timeout,
+        gdpr: (bidderRequest.gdprConsent && bidderRequest.gdprConsent.gdprApplies) ? 1 : 0,
+        consentGiven: vuukleGetConsentGiven(bidderRequest.gdprConsent),
         version: '$prebid.version$',
-        v: 1,
+        v: 2,
       };
 
+      if (bidderRequest.uspConsent) {
+        params.uspConsent = bidderRequest.uspConsent;
+      }
+
+      if (config.getConfig('coppa') === true) {
+        params.coppa = 1;
+      }
+
+      if (bidderRequest.gdprConsent && bidderRequest.gdprConsent.consentString) {
+        params.consent = bidderRequest.gdprConsent.consentString;
+      }
+
       return {
         method: 'GET',
         url: URL,
@@ -65,3 +88,11 @@ export const spec = {
   },
 }
 registerBidder(spec);
+
+function vuukleGetConsentGiven(gdprConsent) {
+  let consentGiven = 0;
+  if (typeof gdprConsent !== 'undefined') {
+    consentGiven = deepAccess(gdprConsent, `vendorData.vendor.consents.${VENDOR_ID}`) ? 1 : 0;
+  }
+  return consentGiven;
+}

package/modules/yahoosspBidAdapter.js

@@ -30,6 +30,7 @@ const SUPPORTED_USER_ID_SOURCES = [
   'criteo.com',
   'crwdcntrl.net',
   'deepintent.com',
+  'epsilon.com',
   'hcn.health',
   'id5-sync.com',
   'idx.lat',
@@ -46,7 +47,6 @@ const SUPPORTED_USER_ID_SOURCES = [
   'parrable.com',
   'pubcid.org',
   'quantcast.com',
-  'quantcast.com',
   'tapad.com',
   'uidapi.com',
   'verizonmedia.com',
@@ -237,7 +237,9 @@ function generateOpenRtbObject(bidderRequest, bid) {
       device: {
         dnt: 0,
         ua: navigator.userAgent,
-        ip: deepAccess(bid, 'params.bidOverride.device.ip') || deepAccess(bid, 'params.ext.ip') || undefined
+        ip: deepAccess(bid, 'params.bidOverride.device.ip') || deepAccess(bid, 'params.ext.ip') || undefined,
+        w: window.screen.width,
+        h: window.screen.height
       },
       regs: {
         ext: {

package/modules/yandexBidAdapter.js

@@ -1,9 +1,10 @@
-import {formatQS, deepAccess} from '../src/utils.js';
+import { formatQS, deepAccess, triggerPixel } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 
 const BIDDER_CODE = 'yandex';
-const BIDDER_URL = 'https://bs-metadsp.yandex.ru/metadsp';
+const BIDDER_URL = 'https://bs.yandex.ru/metadsp';
 const DEFAULT_TTL = 180;
+const DEFAULT_CURRENCY = 'EUR';
 const SSP_ID = 10500;
 
 export const spec = {
@@ -19,9 +20,13 @@ export const spec = {
     const consentString = deepAccess(bidderRequest, 'gdprConsent.consentString');
 
     let referrer = '';
+    let domain = '';
+    let page = '';
+
     if (bidderRequest && bidderRequest.refererInfo) {
-      // TODO: is 'domain' the right value here?
-      referrer = bidderRequest.refererInfo.domain
+      referrer = bidderRequest.refererInfo.ref;
+      domain = bidderRequest.refererInfo.domain;
+      page = bidderRequest.refererInfo.page;
     }
 
     return validBidRequests.map((bidRequest) => {
@@ -30,17 +35,25 @@ export const spec = {
 
       const queryParams = {
         'imp-id': impId,
-        'target-ref': targetRef || referrer,
+        'target-ref': targetRef || domain,
         'ssp-id': SSP_ID,
       };
       if (gdprApplies !== undefined) {
         queryParams['gdpr'] = 1;
         queryParams['tcf-consent'] = consentString;
       }
+
+      const floorInfo = bidRequest.getFloor ? bidRequest.getFloor({
+        currency: DEFAULT_CURRENCY
+      }) : {};
+      const bidfloor = floorInfo.floor;
+      const bidfloorcur = floorInfo.currency;
+
       const imp = {
         id: impId,
+        bidfloor,
+        bidfloorcur,
       };
-
       const bannerParams = deepAccess(bidRequest, 'mediaTypes.banner');
       if (bannerParams) {
         const [ w, h ] = bannerParams.sizes[0];
@@ -58,7 +71,8 @@ export const spec = {
           id: bidRequest.bidId,
           imp: [imp],
           site: {
-            page: referrer,
+            ref_url: referrer,
+            page_url: page,
           },
         },
         options: {
@@ -84,7 +98,7 @@ export const spec = {
       let prBid = {
         requestId: bidRequest.bidId,
         cpm: rtbBid.price,
-        currency: cur || 'USD',
+        currency: cur || DEFAULT_CURRENCY,
         width: rtbBid.w,
         height: rtbBid.h,
         creativeId: rtbBid.adid,
@@ -102,6 +116,15 @@ export const spec = {
       return prBid;
     });
   },
+
+  onBidWon: function (bid) {
+    const nurl = bid['nurl'];
+
+    if (!nurl) {
+      return;
+    }
+    triggerPixel(nurl);
+  }
 }
 
 registerBidder(spec);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prebid.js",
-  "version": "7.18.0",
+  "version": "7.20.0",
   "description": "Header Bidding Management Library",
   "main": "src/prebid.js",
   "scripts": {
@@ -126,7 +126,7 @@
     "express": "^4.15.4",
     "fun-hooks": "^0.9.9",
     "just-clone": "^1.0.2",
-    "live-connect-js": "2.3.3"
+    "live-connect-js": "2.4.0"
   },
   "optionalDependencies": {
     "fsevents": "^2.3.2"

package/src/adapterManager.js

@@ -357,8 +357,6 @@ adapterManager.callBids = (adUnits, bidRequests, addBidResponse, doneCb, request
 
   let counter = 0;
 
-  // $.source.tid MUST be a unique UUID and also THE SAME between all PBS Requests for a given Auction
-  const sourceTid = generateUUID();
   _s2sConfigs.forEach((s2sConfig) => {
     if (s2sConfig && uniqueServerBidRequests[counter] && getS2SBidderSet(s2sConfig).has(uniqueServerBidRequests[counter].bidderCode)) {
       // s2s should get the same client side timeout as other client side requests.
@@ -374,7 +372,7 @@ adapterManager.callBids = (adUnits, bidRequests, addBidResponse, doneCb, request
       let uniqueServerRequests = serverBidRequests.filter(serverBidRequest => serverBidRequest.uniquePbsTid === uniquePbsTid);
 
       if (s2sAdapter) {
-        let s2sBidRequest = {tid: sourceTid, 'ad_units': adUnitsS2SCopy, s2sConfig, ortb2Fragments};
+        let s2sBidRequest = {'ad_units': adUnitsS2SCopy, s2sConfig, ortb2Fragments};
         if (s2sBidRequest.ad_units.length) {
           let doneCbs = uniqueServerRequests.map(bidRequest => {
             bidRequest.start = timestamp();
@@ -387,7 +385,7 @@ adapterManager.callBids = (adUnits, bidRequests, addBidResponse, doneCb, request
           // fire BID_REQUESTED event for each s2s bidRequest
           uniqueServerRequests.forEach(bidRequest => {
             // add the new sourceTid
-            events.emit(CONSTANTS.EVENTS.BID_REQUESTED, {...bidRequest, tid: sourceTid});
+            events.emit(CONSTANTS.EVENTS.BID_REQUESTED, {...bidRequest, tid: bidRequest.auctionId});
           });
 
           // make bid requests