prebid.js 6.26.0 → 6.29.0

package/modules/taboolaBidAdapter.js

@@ -0,0 +1,265 @@
+'use strict';
+
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+import {BANNER} from '../src/mediaTypes.js';
+import {config} from '../src/config.js';
+import {getWindowSelf, getWindowTop} from '../src/utils.js'
+import {getStorageManager} from '../src/storageManager.js';
+
+const BIDDER_CODE = 'taboola';
+const GVLID = 42;
+const CURRENCY = 'USD';
+export const END_POINT_URL = 'https://hb.bidder.taboola.com/TaboolaHBOpenRTBRequestHandlerServlet';
+const USER_ID = 'user-id';
+const STORAGE_KEY = `taboola global:${USER_ID}`;
+const COOKIE_KEY = 'trc_cookie_storage';
+
+/**
+ *  extract User Id by that order:
+ * 1. local storage
+ * 2. first party cookie
+ * 3. rendered trc
+ * 4. new user set it to 0
+ */
+export const userData = {
+  storageManager: getStorageManager({gvlid: GVLID, bidderCode: BIDDER_CODE}),
+  getUserId: () => {
+    const {getFromLocalStorage, getFromCookie, getFromTRC} = userData;
+
+    try {
+      return getFromLocalStorage() || getFromCookie() || getFromTRC();
+    } catch (ex) {
+      return 0;
+    }
+  },
+  getFromCookie() {
+    const {cookiesAreEnabled, getCookie} = userData.storageManager;
+    if (cookiesAreEnabled()) {
+      const cookieData = getCookie(COOKIE_KEY);
+      const userId = userData.getCookieDataByKey(cookieData, USER_ID);
+      if (userId) {
+        return userId;
+      }
+    }
+  },
+  getCookieDataByKey(cookieData, key) {
+    const [, value = ''] = cookieData.split(`${key}=`)
+    return value;
+  },
+  getFromLocalStorage() {
+    const {hasLocalStorage, localStorageIsEnabled, getDataFromLocalStorage} = userData.storageManager;
+
+    if (hasLocalStorage() && localStorageIsEnabled()) {
+      return getDataFromLocalStorage(STORAGE_KEY);
+    }
+  },
+  getFromTRC() {
+    return window.TRC ? window.TRC.user_id : 0;
+  }
+}
+
+export const internal = {
+  getPageUrl: (refererInfo = {}) => {
+    if (refererInfo.canonicalUrl) {
+      return refererInfo.canonicalUrl;
+    }
+
+    if (config.getConfig('pageUrl')) {
+      return config.getConfig('pageUrl');
+    }
+
+    try {
+      return getWindowTop().location.href;
+    } catch (e) {
+      return getWindowSelf().location.href;
+    }
+  },
+  getReferrer: (refererInfo = {}) => {
+    if (refererInfo.referer) {
+      return refererInfo.referer;
+    }
+
+    try {
+      return getWindowTop().document.referrer;
+    } catch (e) {
+      return getWindowSelf().document.referrer;
+    }
+  }
+}
+
+export const spec = {
+  supportedMediaTypes: [BANNER],
+  gvlid: GVLID,
+  code: BIDDER_CODE,
+  isBidRequestValid: (bidRequest) => {
+    return !!(bidRequest.sizes &&
+              bidRequest.params &&
+              bidRequest.params.publisherId &&
+              bidRequest.params.tagId);
+  },
+  buildRequests: (validBidRequests, bidderRequest) => {
+    const [bidRequest] = validBidRequests;
+    const {refererInfo, gdprConsent = {}, uspConsent} = bidderRequest;
+    const {publisherId} = bidRequest.params;
+    const site = getSiteProperties(bidRequest.params, refererInfo);
+    const device = {ua: navigator.userAgent};
+    const imps = getImps(validBidRequests);
+    const user = {
+      buyeruid: userData.getUserId(gdprConsent, uspConsent),
+      ext: {}
+    };
+    const regs = {
+      coppa: 0,
+      ext: {}
+    };
+
+    if (gdprConsent.gdprApplies) {
+      user.ext.consent = bidderRequest.gdprConsent.consentString;
+      regs.ext.gdpr = 1;
+    }
+
+    if (uspConsent) {
+      regs.ext.us_privacy = uspConsent;
+    }
+
+    if (config.getConfig('coppa')) {
+      regs.coppa = 1
+    }
+
+    const ortb2 = config.getConfig('ortb2') || {
+      badv: [],
+      bcat: []
+    };
+
+    const request = {
+      id: bidderRequest.auctionId,
+      imp: imps,
+      site,
+      device,
+      source: {fd: 1},
+      tmax: bidderRequest.timeout,
+      bcat: ortb2.bcat,
+      badv: ortb2.badv,
+      user,
+      regs
+    };
+
+    const url = [END_POINT_URL, publisherId].join('/');
+
+    return {
+      url,
+      method: 'POST',
+      data: JSON.stringify(request),
+      bids: validBidRequests,
+      options: {
+        withCredentials: false
+      },
+    };
+  },
+  interpretResponse: (serverResponse, {bids}) => {
+    if (!bids) {
+      return [];
+    }
+
+    const {bidResponses, cur: currency} = getBidResponses(serverResponse);
+
+    if (!bidResponses) {
+      return [];
+    }
+
+    return bids.map((bid, id) => getBid(bid.bidId, currency, bidResponses[id])).filter(Boolean);
+  },
+};
+
+function getSiteProperties({publisherId, bcat = []}, refererInfo) {
+  const {getPageUrl, getReferrer} = internal;
+  return {
+    id: publisherId,
+    name: publisherId,
+    domain: window.location.host,
+    page: getPageUrl(refererInfo),
+    ref: getReferrer(refererInfo),
+    publisher: {
+      id: publisherId
+    },
+    content: {
+      language: navigator.language
+    }
+  }
+}
+
+function getImps(validBidRequests) {
+  return validBidRequests.map((bid, id) => {
+    const {tagId, bidfloor = null, bidfloorcur = CURRENCY} = bid.params;
+
+    return {
+      id: id + 1,
+      banner: getBanners(bid),
+      tagid: tagId,
+      bidfloor,
+      bidfloorcur,
+    };
+  });
+}
+
+function getBanners(bid) {
+  return getSizes(bid.sizes);
+}
+
+function getSizes(sizes) {
+  return {
+    format: sizes.map(size => {
+      return {
+        w: size[0],
+        h: size[1]
+      }
+    })
+  }
+}
+
+function getBidResponses({body}) {
+  if (!body) {
+    return [];
+  }
+
+  const {seatbid, cur} = body;
+
+  if (!seatbid.length || !seatbid[0].bid) {
+    return [];
+  }
+
+  return {
+    bidResponses: seatbid[0].bid,
+    cur
+  };
+}
+
+function getBid(requestId, currency, bidResponse) {
+  if (!bidResponse) {
+    return;
+  }
+
+  const {
+    price: cpm, crid: creativeId, adm: ad, w: width, h: height, adomain: advertiserDomains, meta = {}
+  } = bidResponse;
+
+  if (advertiserDomains && advertiserDomains.length > 0) {
+    meta.advertiserDomains = advertiserDomains
+  }
+
+  return {
+    requestId,
+    ttl: 360,
+    mediaType: BANNER,
+    cpm,
+    creativeId,
+    currency,
+    ad,
+    width,
+    height,
+    meta,
+    netRevenue: false
+  };
+}
+
+registerBidder(spec);

package/modules/taboolaBidAdapter.md

@@ -0,0 +1,49 @@
+# Overview
+
+```
+Module Name: Taboola Adapter
+Module Type: Bidder Adapter
+Maintainer: prebid@taboola.com
+```
+
+# Description
+
+Module that connects to Taboola bidder to fetch bids.
+- Supports `display` format
+- Uses `OpenRTB` standard
+
+The Taboola Bidding adapter requires setup before beginning. Please contact us on prebid@taboola.com
+
+# Test Display Parameters
+``` javascript
+ var adUnits = [{
+  code: 'your-unit-container-id',
+  mediaTypes: {
+    banner: {
+      sizes: [[300, 250], [300,600]]
+    }
+  },
+  bids: [{
+    bidder: 'taboola',
+    params: {
+      tagId: 'tester-placement', // Placement Name
+      publisherId: 'tester-pub', // your-publisher-id
+      bidfloor: 0.25, // Optional - default is null
+      bcat: ['IAB1-1'], // Optional - default is []
+      badv: ['example.com']  // Optional - default is []
+    }
+  }]
+}];
+```
+
+# Parameters
+
+| Name           | Scope    | Description                                             | Example                    | Type         |
+|----------------|----------|---------------------------------------------------------|----------------------------|--------------|
+| `tagId`        | required | Tag ID / Placement Name <br>(as provided by Taboola)    | `'Below The Article'`      | `String`     |
+| `publisherId`  | required | Alphabetic Publisher ID <br>(as provided by Taboola)    | `'acme-publishing'`        | `String`     |
+| `bcat`         | optional | List of blocked advertiser categories (IAB)             | `['IAB1-1']`               | `Array`      |
+| `badv`         | optional | Blocked Advertiser Domains                              | `'example.com'`            | `String Url` |
+| `bidfloor`     | optional | CPM bid floor                                           | `0.25`                     | `Integer`    |
+
+

package/modules/telariaBidAdapter.js

@@ -9,10 +9,10 @@ const EVENTS_ENDPOINT = `events.${DOMAIN}/diag`;
 
 export const spec = {
   code: BIDDER_CODE,
-  gvlid: 52,
+  gvlid: 202,
   aliases: [
-    { code: 'tremor', gvlid: 52 },
-    { code: 'tremorvideo', gvlid: 52 }
+    { code: 'tremor', gvlid: 202 },
+    { code: 'tremorvideo', gvlid: 202 }
   ],
   supportedMediaTypes: [VIDEO],
   /**

package/modules/userId/eids.js

@@ -151,15 +151,25 @@ export const USER_IDS_CONFIG = {
 
   // merkleId
   'merkleId': {
-    source: 'merkleinc.com',
     atype: 3,
+    getSource: function(data) {
+      if (data?.ext?.ssp) {
+        return `${data.ext.ssp}.merkleinc.com`
+      }
+      return 'merkleinc.com'
+    },
     getValue: function(data) {
       return data.id;
     },
     getUidExt: function(data) {
-      return (data && data.keyID) ? {
-        keyID: data.keyID
-      } : undefined;
+      if (data.keyID) {
+        return {
+          keyID: data.keyID
+        }
+      }
+      if (data.ext) {
+        return data.ext;
+      }
     }
   },
 
@@ -327,7 +337,8 @@ function createEidObject(userIdData, subModuleKey) {
   const conf = USER_IDS_CONFIG[subModuleKey];
   if (conf && userIdData) {
     let eid = {};
-    eid.source = conf['source'];
+    eid.source = isFn(conf['getSource']) ? conf['getSource'](userIdData) : conf['source'];
+
     const value = isFn(conf['getValue']) ? conf['getValue'](userIdData) : userIdData;
     if (isStr(value)) {
       const uid = { id: value, atype: conf['atype'] };
@@ -357,10 +368,19 @@ function createEidObject(userIdData, subModuleKey) {
 // if any adapter does not want any particular userId to be passed then adapter can use Array.filter(e => e.source != 'tdid')
 export function createEidsArray(bidRequestUserId) {
   let eids = [];
+
   for (const subModuleKey in bidRequestUserId) {
     if (bidRequestUserId.hasOwnProperty(subModuleKey)) {
       if (subModuleKey === 'pubProvidedId') {
         eids = eids.concat(bidRequestUserId['pubProvidedId']);
+      } else if (Array.isArray(bidRequestUserId[subModuleKey])) {
+        bidRequestUserId[subModuleKey].forEach((config, index, arr) => {
+          const eid = createEidObject(config, subModuleKey);
+
+          if (eid) {
+            eids.push(eid);
+          }
+        })
       } else {
         const eid = createEidObject(bidRequestUserId[subModuleKey], subModuleKey);
         if (eid) {

package/modules/zeta_global_sspBidAdapter.js

@@ -99,7 +99,7 @@ export const spec = {
       user: params.user ? params.user : {},
       app: params.app ? params.app : {},
       ext: {
-        tags: {...params.tags, shortname: params.shortname},
+        tags: params.tags ? params.tags : {},
         sid: params.sid ? params.sid : undefined
       }
     };
@@ -126,9 +126,10 @@ export const spec = {
     }
 
     provideEids(request, payload);
+    const url = params.shortname ? ENDPOINT_URL.concat('?shortname=', params.shortname) : ENDPOINT_URL;
     return {
       method: 'POST',
-      url: ENDPOINT_URL,
+      url: url,
       data: JSON.stringify(payload),
     };
   },

package/package.json

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

package/src/AnalyticsAdapter.js

@@ -3,6 +3,10 @@ import { ajax } from './ajax.js';
 import { logMessage, _each } from './utils.js';
 import * as events from './events.js'
 
+export const _internal = {
+  ajax
+};
+
 const {
   EVENTS: {
     AUCTION_INIT,
@@ -61,7 +65,7 @@ export default function AnalyticsAdapter({ url, analyticsType, global, handler }
   }
 
   function _callEndpoint({ eventType, args, callback }) {
-    ajax(url, callback, JSON.stringify({ eventType, args }));
+    _internal.ajax(url, callback, JSON.stringify({ eventType, args }));
   }
 
   function _enqueue({ eventType, args }) {

package/src/adloader.js

@@ -10,7 +10,12 @@ const _approvedLoadExternalJSList = [
   'adagio',
   'browsi',
   'brandmetrics',
-  'justtag'
+  'justtag',
+  'akamaidap',
+  'ftrackId',
+  'inskin',
+  'hadron',
+  'medianet'
 ]
 
 /**

package/src/storageManager.js

@@ -48,7 +48,7 @@ export function newStorageManager({gvlid, moduleName, bidderCode, moduleType} =
       let hookDetails = {
         hasEnforcementHook: false
       }
-      validateStorageEnforcement(gvlid, bidderCode || moduleName, hookDetails, function(result) {
+      validateStorageEnforcement(gvlid, bidderCode || moduleName, moduleType, hookDetails, function(result) {
         if (result && result.hasEnforcementHook) {
           value = cb(result);
         } else {
@@ -303,7 +303,7 @@ export function newStorageManager({gvlid, moduleName, bidderCode, moduleType} =
 /**
  * This hook validates the storage enforcement if gdprEnforcement module is included
  */
-export const validateStorageEnforcement = hook('async', function(gvlid, moduleName, hookDetails, callback) {
+export const validateStorageEnforcement = hook('async', function(gvlid, moduleName, moduleType, hookDetails, callback) {
   callback(hookDetails);
 }, 'validateStorageEnforcement');
 
@@ -322,12 +322,13 @@ export function getCoreStorageManager(moduleName) {
  * @param {Number=} gvlid? Vendor id - required for proper GDPR integration
  * @param {string=} bidderCode? - required for bid adapters
  * @param {string=} moduleName? module name
+ * @param {string=} moduleType? module type
  */
-export function getStorageManager({gvlid, moduleName, bidderCode} = {}) {
+export function getStorageManager({gvlid, moduleName, bidderCode, moduleType} = {}) {
   if (arguments.length > 1 || (arguments.length > 0 && !isPlainObject(arguments[0]))) {
     throw new Error('Invalid invocation for getStorageManager')
   }
-  return newStorageManager({gvlid, moduleName, bidderCode});
+  return newStorageManager({gvlid, moduleName, bidderCode, moduleType});
 }
 
 export function resetData() {

package/test/mocks/analyticsStub.js

@@ -0,0 +1,13 @@
+import {_internal} from '../../src/AnalyticsAdapter.js';
+
+before(() => {
+  // stub out analytics networking to avoid random events polluting the global xhr mock
+  disableAjaxForAnalytics();
+})
+
+export function disableAjaxForAnalytics() {
+  sinon.stub(_internal, 'ajax').callsFake(() => null);
+}
+export function enableAjaxForAnalytics() {
+  _internal.ajax.restore();
+}

package/test/mocks/xhr.js

@@ -1,3 +1,4 @@
+import {getUniqueIdentifierStr} from '../../src/utils.js';
 
 export let server = sinon.createFakeServer();
 export let xhr = global.XMLHttpRequest;
@@ -7,3 +8,24 @@ beforeEach(function() {
   server = sinon.createFakeServer();
   xhr = global.XMLHttpRequest;
 });
+
+const bid = getUniqueIdentifierStr().substring(4);
+let fid = 0;
+
+/* eslint-disable */
+afterEach(function () {
+  if (this?.currentTest?.state === 'failed') {
+    const prepend = (() => {
+      const preamble = `[Failure ${bid}-${fid++}]`;
+      return (s) => s.split('\n').map(s => `${preamble} ${s}`).join('\n');
+    })();
+
+
+    console.log(prepend(`XHR mock state after failure (for test '${this.currentTest.fullTitle()}'): ${server.requests.length} requests`))
+    server.requests.forEach((req, i) => {
+      console.log(prepend(`Request #${i}:`));
+      console.log(prepend(JSON.stringify(req, null, 2)));
+    })
+  }
+});
+/* eslint-enable */

package/test/spec/AnalyticsAdapter_spec.js

@@ -2,6 +2,7 @@ import { expect } from 'chai';
 import * as events from 'src/events.js';
 import CONSTANTS from 'src/constants.json';
 import { server } from 'test/mocks/xhr.js';
+import {disableAjaxForAnalytics, enableAjaxForAnalytics} from '../mocks/analyticsStub.js';
 
 const REQUEST_BIDS = CONSTANTS.EVENTS.REQUEST_BIDS;
 const BID_REQUESTED = CONSTANTS.EVENTS.BID_REQUESTED;
@@ -25,6 +26,9 @@ FEATURE: Analytics Adapters API
     AND an  \`example\` instance of \`AnalyticsAdapter\`\n`, () => {
   let adapter;
 
+  before(enableAjaxForAnalytics);
+  after(disableAjaxForAnalytics);
+
   beforeEach(function () {
     adapter = new AnalyticsAdapter(config);
   });

package/test/spec/modules/adfBidAdapter_spec.js

@@ -75,7 +75,7 @@ describe('Adf adapter', function () {
 
       assert.equal(request.method, 'POST');
       assert.equal(request.url, 'https://10.8.57.207/adx/openrtb');
-      assert.deepEqual(request.options, {contentType: 'application/json'});
+      assert.equal(request.options, undefined);
       assert.ok(request.data);
     });
 

package/test/spec/modules/adoceanBidAdapter_spec.js

@@ -83,6 +83,20 @@ describe('AdoceanAdapter', function () {
         'auctionId': '1d1a030790a475',
       }
     ];
+    const schainExample = {
+      'schain': {
+        ver: '1.0',
+        complete: 1,
+        nodes: [
+          {
+            asi: 'directseller.com',
+            sid: '00001!,2',
+            rid: 'BidRequest1',
+            hp: 1
+          }
+        ]
+      }
+    };
 
     const bidderRequest = {
       gdprConsent: {
@@ -134,7 +148,17 @@ describe('AdoceanAdapter', function () {
       expect(requests[0].url).to.include('aosspsizes=myaozpniqismex~300x250_300x600-myaowafpdwlrks~300x200_600x250');
       expect((requests[0].url.match(/aosspsizes=/g) || []).length).to.equal(1);
     });
-  })
+
+    it('should attach schain parameter if available', function() {
+      let requests = spec.buildRequests(bidRequests, bidderRequest);
+      expect(requests.some(e => e.url.includes('schain='))).to.be.false;
+
+      const bidsWithSchain = deepClone(bidRequests).map(e => ({...e, ...schainExample}));
+      requests = spec.buildRequests(bidsWithSchain, bidderRequest);
+      expect(requests.every(e => e.url.includes('schain=1.0,1!directseller.com,00001%21%2C2,1,BidRequest1,,,0')),
+        `One of urls does not contain valid schain param: ${requests.map(e => e.url).join('\n')}`).to.be.true;
+    });
+  });
 
   describe('interpretResponse', function () {
     const response = {

package/test/spec/modules/adriverIdSystem_spec.js

@@ -67,12 +67,16 @@ describe('AdriverIdSystem', function () {
         let request = server.requests[0];
         request.respond(200, { 'Content-Type': 'application/json' }, JSON.stringify({ adrcid: response.adrcid }));
 
-        let now = new Date();
-        now.setTime(now.getTime() + 86400 * 1825 * 1000);
+        let expectedExpiration = new Date();
+        expectedExpiration.setTime(expectedExpiration.getTime() + 86400 * 1825 * 1000);
         const minimalDate = new Date(0).toString();
 
+        function dateStringFor(date, maxDeltaMs = 2000) {
+          return sinon.match((val) => Math.abs(date.getTime() - new Date(val).getTime()) <= maxDeltaMs)
+        }
+
         if (response.adrcid) {
-          expect(setCookieStub.calledWith('adrcid', response.adrcid, now.toUTCString())).to.be.true;
+          expect(setCookieStub.calledWith('adrcid', response.adrcid, dateStringFor(expectedExpiration))).to.be.true;
           expect(setLocalStorageStub.calledWith('adrcid', response.adrcid)).to.be.true;
         } else {
           expect(setCookieStub.calledWith('adrcid', '', minimalDate)).to.be.false;

package/test/spec/modules/adyoulikeBidAdapter_spec.js

@@ -91,6 +91,20 @@ describe('Adyoulike Adapter', function () {
           }
           },
         },
+      'schain': {
+        validation: 'strict',
+        config: {
+          ver: '1.0',
+          complete: 1,
+          nodes: [
+            {
+              asi: 'indirectseller.com',
+              sid: '00001',
+              hp: 1
+            }
+          ]
+        }
+      },
       'transactionId': 'bid_id_0_transaction_id'
     }
   ];
@@ -614,7 +628,7 @@ describe('Adyoulike Adapter', function () {
       expect(request.url).to.contain(getEndpoint());
     });
 
-    it('should add gdpr/usp consent information to the request', function () {
+    it('should add gdpr/usp consent information and SChain to the request', function () {
       let consentString = 'BOJ8RZsOJ8RZsABAB8AAAAAZ+A==';
       let uspConsentData = '1YCC';
       let bidderRequest = {
@@ -637,6 +651,7 @@ describe('Adyoulike Adapter', function () {
       expect(payload.gdprConsent.consentString).to.exist.and.to.equal(consentString);
       expect(payload.gdprConsent.consentRequired).to.exist.and.to.be.true;
       expect(payload.uspConsent).to.exist.and.to.equal(uspConsentData);
+      expect(payload.Bids.bid_id_0.SChain).to.exist.and.to.deep.equal(bidRequestWithSinglePlacement[0].schain);
     });
 
     it('should not set a default value for gdpr consentRequired', function () {