prebid.js 7.53.0 → 7.54.0

package/modules/pubmaticAnalyticsAdapter.js

@@ -256,6 +256,10 @@ export function getMetadata(meta) {
   return metaObj;
 }
 
+function isS2SBidder(bidder) {
+  return (s2sBidders.indexOf(bidder) > -1) ? 1 : 0
+}
+
 function gatherPartnerBidsForAdUnitForLogger(adUnit, adUnitId, highestBid) {
   highestBid = (highestBid && highestBid.length > 0) ? highestBid[0] : null;
   return Object.keys(adUnit.bids).reduce(function(partnerBids, bidId) {
@@ -275,7 +279,7 @@ function gatherPartnerBidsForAdUnitForLogger(adUnit, adUnitId, highestBid) {
         'l1': bid.bidResponse ? bid.clientLatencyTimeMs : 0,
         'l2': 0,
         'adv': bid.bidResponse ? getAdDomain(bid.bidResponse) || undefined : undefined,
-        'ss': (s2sBidders.indexOf(bid.bidder) > -1) ? 1 : 0,
+        'ss': isS2SBidder(bid.bidder),
         't': (bid.status == ERROR && bid.error.code == TIMEOUT_ERROR) ? 1 : 0,
         'wb': (highestBid && highestBid.adId === bid.adId ? 1 : 0),
         'mi': bid.bidResponse ? (bid.bidResponse.mi || undefined) : undefined,
@@ -311,6 +315,14 @@ function getAdUnit(adUnits, adUnitId) {
   return adUnits.filter(adUnit => (adUnit.divID && adUnit.divID == adUnitId) || (adUnit.code == adUnitId))[0];
 }
 
+function getTgId() {
+  var testGroupId = parseInt(config.getConfig('testGroupId') || 0);
+  if (testGroupId <= 15 && testGroupId >= 0) {
+    return testGroupId;
+  }
+  return 0;
+}
+
 function executeBidsLoggerCall(e, highestCpmBids) {
   let auctionId = e.auctionId;
   let referrer = config.getConfig('pageUrl') || cache.auctions[auctionId].referer || '';
@@ -337,13 +349,7 @@ function executeBidsLoggerCall(e, highestCpmBids) {
   outputObj['pid'] = '' + profileId;
   outputObj['pdvid'] = '' + profileVersionId;
   outputObj['dvc'] = {'plt': getDevicePlatform()};
-  outputObj['tgid'] = (function() {
-    var testGroupId = parseInt(config.getConfig('testGroupId') || 0);
-    if (testGroupId <= 15 && testGroupId >= 0) {
-      return testGroupId;
-    }
-    return 0;
-  })();
+  outputObj['tgid'] = getTgId();
 
   if (floorData) {
     outputObj['fmv'] = floorData.floorRequestData ? floorData.floorRequestData.modelVersion || undefined : undefined;
@@ -391,6 +397,12 @@ function executeBidWonLoggerCall(auctionId, adUnitId) {
 
   const adapterName = getAdapterNameForAlias(winningBid.adapterCode || winningBid.bidder);
   let origAdUnit = getAdUnit(cache.auctions[auctionId].origAdUnits, adUnitId) || {};
+  let auctionCache = cache.auctions[auctionId];
+  let floorData = auctionCache.floorData;
+  let referrer = config.getConfig('pageUrl') || cache.auctions[auctionId].referer || '';
+  let adv = winningBid.bidResponse ? getAdDomain(winningBid.bidResponse) || undefined : undefined;
+  let fskp = floorData ? (floorData.floorRequestData ? (floorData.floorRequestData.skipped == false ? 0 : 1) : undefined) : undefined;
+
   let pixelURL = END_POINT_WIN_BID_LOGGER;
   pixelURL += 'pubid=' + publisherId;
   pixelURL += '&purl=' + enc(config.getConfig('pageUrl') || cache.auctions[auctionId].referer || '');
@@ -407,6 +419,17 @@ function executeBidWonLoggerCall(auctionId, adUnitId) {
   pixelURL += '&eg=' + enc(winningBid.bidResponse.bidGrossCpmUSD);
   pixelURL += '&kgpv=' + enc(getValueForKgpv(winningBid, adUnitId));
   pixelURL += '&piid=' + enc(winningBid.bidResponse.partnerImpId || EMPTY_STRING);
+
+  pixelURL += '&plt=' + enc(getDevicePlatform());
+  pixelURL += '&psz=' + enc((winningBid?.bidResponse?.dimensions?.width || '0') + 'x' +
+    (winningBid?.bidResponse?.dimensions?.height || '0'));
+  pixelURL += '&tgid=' + enc(getTgId());
+  adv && (pixelURL += '&adv=' + enc(adv));
+  pixelURL += '&orig=' + enc(getDomainFromUrl(referrer));
+  pixelURL += '&ss=' + enc(isS2SBidder(winningBid.bidder));
+  (fskp != undefined) && (pixelURL += '&fskp=' + enc(fskp));
+  pixelURL += '&af=' + enc(winningBid.bidResponse ? (winningBid.bidResponse.mediaType || undefined) : undefined);
+
   ajax(
     pixelURL,
     null,

package/modules/teadsBidAdapter.js

@@ -227,7 +227,6 @@ function buildRequestObject(bid) {
   reqObj.placementId = parseInt(placementId, 10);
   reqObj.pageId = parseInt(pageId, 10);
   reqObj.adUnitCode = getBidIdParameter('adUnitCode', bid);
-  reqObj.auctionId = getBidIdParameter('auctionId', bid);
   reqObj.transactionId = getBidIdParameter('transactionId', bid);
   if (gpid) { reqObj.gpid = gpid; }
   return reqObj;

package/modules/topicsFpdModule.js

@@ -28,7 +28,10 @@ export const lastUpdated = 'lastUpdated';
 const iframeLoadedURL = [];
 const TAXONOMIES = {
   // map from topic taxonomyVersion to IAB segment taxonomy
-  '1': 600
+  '1': 600,
+  '2': 601,
+  '3': 602,
+  '4': 603
 }
 
 function partitionBy(field, items) {

package/modules/videojsVideoProvider.js

@@ -628,6 +628,8 @@ export const utils = {
         return 'adserror';
       case CONTENT_LOADED:
         return 'loadstart';
+      case ERROR:
+        return ['error', 'aderror', 'contenterror'];
       case PLAY:
         return PLAY + 'ing';
       case PLAYBACK_REQUEST:

package/modules/vrtcalBidAdapter.js

@@ -93,6 +93,11 @@ export const spec = {
         params.imp[0].banner.h = bid.sizes[0][1];
       }
 
+      if (bid.ortb2?.regs?.gpp) {
+        params.regs.ext.gpp = bid.ortb2.regs.gpp;
+        params.regs.ext.gpp_sid = bid.ortb2.regs.gpp_sid;
+      }
+
       return {method: 'POST', url: 'https://rtb.vrtcal.com/bidder_prebid.vap?ssp=1804', data: JSON.stringify(params), options: {withCredentials: false, crossOrigin: true}};
     });
 

package/package.json

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

package/test/spec/modules/adhashBidAdapter_spec.js

@@ -88,7 +88,7 @@ describe('adhashBidAdapter', function () {
       );
       expect(result.length).to.equal(1);
       expect(result[0].method).to.equal('POST');
-      expect(result[0].url).to.equal('https://bidder.adhash.com/rtb?version=3.2&prebid=true&publisher=0xc3b09b27e9c6ef73957901aa729b9e69e5bbfbfb');
+      expect(result[0].url).to.equal('https://bidder.adhash.com/rtb?version=3.6&prebid=true&publisher=0xc3b09b27e9c6ef73957901aa729b9e69e5bbfbfb');
       expect(result[0].bidRequest).to.equal(bidRequest);
       expect(result[0].data).to.have.property('timezone');
       expect(result[0].data).to.have.property('location');
@@ -104,7 +104,7 @@ describe('adhashBidAdapter', function () {
       const result = spec.buildRequests([ bidRequest ], { gdprConsent: { gdprApplies: true, consentString: 'example' } });
       expect(result.length).to.equal(1);
       expect(result[0].method).to.equal('POST');
-      expect(result[0].url).to.equal('https://bidder.adhash.com/rtb?version=3.2&prebid=true&publisher=0xc3b09b27e9c6ef73957901aa729b9e69e5bbfbfb');
+      expect(result[0].url).to.equal('https://bidder.adhash.com/rtb?version=3.6&prebid=true&publisher=0xc3b09b27e9c6ef73957901aa729b9e69e5bbfbfb');
       expect(result[0].bidRequest).to.equal(bidRequest);
       expect(result[0].data).to.have.property('timezone');
       expect(result[0].data).to.have.property('location');
@@ -152,6 +152,8 @@ describe('adhashBidAdapter', function () {
           ['дума', 'full', 1],
           ['старт', 'starts', 1],
           ['край', 'ends', 1],
+          ['onq jbeq', 'partial', 1],
+          ['dhrra qvrf', 'combo', 2],
         ],
         maxScore: 2
       }
@@ -196,6 +198,13 @@ describe('adhashBidAdapter', function () {
       expect(spec.interpretResponse(serverResponse, request).length).to.equal(0);
     });
 
+    it('should return empty array when there are bad words (partial, compound phrase)', function () {
+      bodyStub = sinon.stub(window.top.document.body, 'innerText').get(function() {
+        return 'example text partialbad wordb bad wordb example bad wordbtext' + ' word'.repeat(994);
+      });
+      expect(spec.interpretResponse(serverResponse, request).length).to.equal(0);
+    });
+
     it('should return empty array when there are bad words (starts)', function () {
       bodyStub = sinon.stub(window.top.document.body, 'innerText').get(function() {
         return 'example text startsWith starts text startsAgain' + ' word'.repeat(994);
@@ -224,6 +233,13 @@ describe('adhashBidAdapter', function () {
       expect(spec.interpretResponse(serverResponse, request).length).to.equal(0);
     });
 
+    it('should return empty array when there are bad words (combo)', function () {
+      bodyStub = sinon.stub(window.top.document.body, 'innerText').get(function() {
+        return 'queen of england dies, the queen dies' + ' word'.repeat(993);
+      });
+      expect(spec.interpretResponse(serverResponse, request).length).to.equal(0);
+    });
+
     it('should return empty array when there are bad words (regexp)', function () {
       bodyStub = sinon.stub(window.top.document.body, 'innerText').get(function() {
         return 'example text xxxayyy zzxxxAyyyzz text xxxbyyy' + ' word'.repeat(994);

package/test/spec/modules/hypelabBidAdapter_spec.js

@@ -0,0 +1,281 @@
+import { expect } from 'chai';
+import sinon from 'sinon';
+import { server } from '../../mocks/xhr';
+
+import {
+  mediaSize,
+  spec,
+  BIDDER_CODE,
+  ENDPOINT_URL,
+  REQUEST_ROUTE,
+} from 'modules/hypelabBidAdapter.js';
+
+import { BANNER } from 'src/mediaTypes.js';
+
+const mockValidBidRequest = {
+  bidder: 'hypelab',
+  params: {
+    property_slug: 'prebid',
+    placement_slug: 'test_placement',
+    uuid: '',
+    sdk_version: '0.1.0',
+    provider_name: 'react',
+    provider_version: '0.3.1',
+  },
+  userIds: [],
+  mediaTypes: {
+    banner: {
+      sizes: [[728, 90]],
+    },
+  },
+  adUnitCode: 'test-div',
+  sizes: [[728, 90]],
+  bidId: '24d2b2c86c5e19',
+  bidderRequestId: '1d1f40b509f18',
+  auctionId: '3bf3b1fb-cb0a-4ee8-90ef-69b8e6e56dbd',
+  bidRequestsCount: 1,
+  bidderRequestsCount: 1,
+  bidderWinsCount: 0,
+};
+
+const mockValidBidRequests = [mockValidBidRequest];
+
+const mockServerResponse = {
+  body: {
+    status: 'success',
+    data: {
+      currency: 'USD',
+      campaign_slug: '9dbe230882',
+      creative_set_slug: '842984f045',
+      creative_set: {
+        image: {
+          url: 'https://cloudfront.net/up/asset/12345',
+          height: 90,
+          width: 728,
+        },
+      },
+      cpm: 1.5,
+      html: "<!DOCTYPE html>\n      <html lang=\"en\">\n          <head>\n              <meta charset=\"UTF-8\">\n              <title>Ad</title>\n              <style>\n                  html, body {\n                      margin: 0;\n                      padding: 0;\n                      overflow: hidden;\n                  }\n              </style>\n          </head>\n          <body>\n              <a\n            id=\"link\"\n            href=https://web.hypelab-staging.com/click?campaign_slug=9dbe230882&creative_set_slug=842984f045&placement_slug=test_placement \n            target=\"_blank\">\n            <img src=\"https://di30gnjrtlisb.cloudfront.net/up/asset/d1d1d65463/8eb7e9065e.jpg?tr=w-728,h-90\">\n        </a>\n        \n              <script>\n                  function track(type) {\n                      var request = new XMLHttpRequest();\n                      request.open('POST', 'https://api.hypelab-staging.com/v1/events');\n                      request.setRequestHeader('Content-Type', 'application/json');\n\n                      var event = {\n                          property_slug: 'prebid',\n                          placement_slug: 'test_placement',\n                          campaign_slug: '9dbe230882',\n                          creative_set_slug: '842984f045',\n                          type: type,\n                          uuid: '',\n                          wids: []\n                      };\n\n                      request.send(JSON.stringify(event));\n                  }\n\n                  document.getElementById('link').addEventListener('click', function() {\n                      track('click');\n                  });\n\n                  track('impression');\n              </script>\n          </body>\n      </html>\n    ",
+      advertiser_domains: ['ogx.com'],
+      media_type: 'banner',
+      ttl: 360,
+    },
+  },
+};
+
+const mockBidderRequest = {
+  bidderCode: 'hypelab',
+  auctionId: '4462005b-ba06-49a9-a95d-0209c22f4606',
+  bidderRequestId: '1bf399761210ad',
+  bids: mockValidBidRequests,
+  auctionStart: 1684983987435,
+  timeout: 2000,
+  refererInfo: {
+    topmostLocation: 'https://example.com/hello_world.html',
+    location: 'https://example.com/hello_world.html',
+    canonicalUrl: null,
+    page: 'https://example.com/hello_world.html',
+    domain: null,
+    ref: null,
+  },
+};
+
+const mockBidRequest = {
+  method: 'POST',
+  url: 'https://api.hypelab.com/v1/prebid_requests',
+  options: {
+    contentType: 'application/json',
+    withCredentials: false,
+  },
+  data: {
+    property_slug: 'prebid',
+    placement_slug: 'test_placement',
+    provider_version: '0.0.1',
+    provider_name: 'prebid',
+    referrer: 'https://example.com',
+    sdk_version: '7.51.0-pre',
+    sizes: [[728, 90]],
+    wids: [],
+    uuid: 'tmp_c5abf809-47d6-40b9-8274-372c6d816dd8',
+    bidRequestsCount: 1,
+    bidderRequestsCount: 1,
+    bidderWinsCount: 0,
+  },
+  bidId: '2e02b562f700ae',
+};
+
+describe('hypelabBidAdapter', function () {
+  describe('mediaSize', function () {
+    describe('when given an invalid media object', function () {
+      expect(mediaSize({})).to.eql({ width: 0, height: 0 });
+    });
+
+    describe('when given a valid media object', function () {
+      expect(
+        mediaSize({ creative_set: { image: { width: 728, height: 90 } } })
+      ).to.eql({ width: 728, height: 90 });
+    });
+  });
+
+  describe('isBidRequestValid', function () {
+    describe('when given an invalid bid request', function () {
+      expect(spec.isBidRequestValid({})).to.equal(false);
+    });
+
+    describe('when given a valid bid request', function () {
+      expect(spec.isBidRequestValid(mockValidBidRequest)).to.equal(true);
+    });
+  });
+
+  describe('Bidder code valid', function () {
+    expect(spec.code).to.equal(BIDDER_CODE);
+  });
+
+  describe('Media types valid', function () {
+    expect(spec.supportedMediaTypes).to.contain(BANNER);
+  });
+
+  describe('Bid request valid', function () {
+    expect(spec.isBidRequestValid(mockValidBidRequest)).to.equal(true);
+  });
+
+  describe('buildRequests', () => {
+    describe('returns a valid request', function () {
+      const result = spec.buildRequests(
+        mockValidBidRequests,
+        mockBidderRequest
+      );
+      expect(result).to.be.an('array');
+
+      const first = result[0] || {};
+      expect(first).to.be.an('object');
+      expect(first.method).to.equal('POST');
+      expect(first.url).to.be.a('string');
+      expect(first.url).to.equal(ENDPOINT_URL + REQUEST_ROUTE);
+
+      const data = first.data || {};
+      expect(data).to.be.an('object');
+      expect(data.property_slug).to.be.a('string');
+      expect(data.placement_slug).to.be.a('string');
+      expect(data.bidRequestsCount).to.be.a('number');
+      expect(data.bidderRequestsCount).to.be.a('number');
+      expect(data.bidderWinsCount).to.be.a('number');
+    });
+
+    describe('should set uuid to the first id in userIdAsEids', () => {
+      mockValidBidRequests[0].userIdAsEids = [
+        {
+          source: 'pubcid.org',
+          uids: [
+            {
+              id: 'pubcid_id',
+            },
+          ],
+        },
+        {
+          source: 'criteo.com',
+          uids: [
+            {
+              id: 'criteo_id',
+            },
+          ],
+        },
+      ];
+
+      const result = spec.buildRequests(
+        mockValidBidRequests,
+        mockBidderRequest
+      );
+
+      const data = result[0].data || {};
+      expect(data.uuid).to.be.eq('pubcid_id');
+    });
+  });
+
+  describe('interpretResponse', () => {
+    describe('successfully interpret a valid response', function () {
+      const result = spec.interpretResponse(mockServerResponse, mockBidRequest);
+
+      expect(result).to.be.an('array');
+      const data = result[0] || {};
+      expect(data).to.be.an('object');
+      expect(data.requestId).to.be.a('string');
+      expect(data.cpm).to.be.a('number');
+      expect(data.width).to.be.a('number');
+      expect(data.height).to.be.a('number');
+      expect(data.creativeId).to.be.a('string');
+      expect(data.currency).to.be.a('string');
+      expect(data.netRevenue).to.be.a('boolean');
+      expect(data.referrer).to.be.a('string');
+      expect(data.ttl).to.be.a('number');
+      expect(data.ad).to.be.a('string');
+      expect(data.mediaType).to.be.a('string');
+      expect(data.meta.advertiserDomains).to.be.an('array');
+    });
+
+    describe('should return a blank array if cpm is not set', () => {
+      mockServerResponse.body.data.cpm = undefined;
+      const result = spec.interpretResponse(mockServerResponse, mockBidRequest);
+      expect(result).to.eql([]);
+    });
+  });
+
+  describe('report', () => {
+    it('returns if REPORTING_ROUTE is not set', () => {
+      spec.REPORTING_ROUTE = '';
+      expect(spec.report('test', {})).to.be.undefined;
+    });
+
+    it('makes a POST request if REPORTING_ROUTE is set', () => {
+      spec.report('test', {}, '/v1/events');
+
+      expect(server.requests[0].url).to.equals(
+        'https://api.hypelab.com/v1/events'
+      );
+    });
+  });
+
+  describe('callbacks', () => {
+    let bid = {};
+    let reportStub;
+
+    beforeEach(() => (reportStub = sinon.stub(spec, 'report')));
+    afterEach(() => reportStub.restore());
+
+    describe('onTimeout', () => {
+      it('should call report with the correct data', () => {
+        spec.onTimeout(bid);
+
+        expect(reportStub.calledOnce).to.be.true;
+        expect(reportStub.getCall(0).args).to.eql(['timeout', bid]);
+      });
+    });
+
+    describe('onSetTargeting', () => {
+      it('should call report with the correct data', () => {
+        spec.onSetTargeting(bid);
+
+        expect(reportStub.calledOnce).to.be.true;
+        expect(reportStub.getCall(0).args).to.eql(['setTargeting', bid]);
+      });
+    });
+
+    describe('onBidWon', () => {
+      it('should call report with the correct data', () => {
+        spec.onBidWon(bid);
+
+        expect(reportStub.calledOnce).to.be.true;
+        expect(reportStub.getCall(0).args).to.eql(['bidWon', bid]);
+      });
+    });
+
+    describe('onBidderError', () => {
+      it('should call report with the correct data', () => {
+        spec.onBidderError(bid);
+
+        expect(reportStub.calledOnce).to.be.true;
+        expect(reportStub.getCall(0).args).to.eql(['bidderError', bid]);
+      });
+    });
+  });
+});

package/test/spec/modules/oxxionRtdProvider_spec.js

@@ -114,7 +114,8 @@ describe('oxxionRtdProvider', () => {
     auctionEnd.bidsReceived = bids;
     it('call everything', function() {
       oxxionSubmodule.getBidRequestData(request, null, moduleConfig);
-      oxxionSubmodule.onAuctionEndEvent(auctionEnd, moduleConfig);
+      oxxionSubmodule.onBidResponseEvent(auctionEnd.bidsReceived[0], moduleConfig);
+      oxxionSubmodule.onBidResponseEvent(auctionEnd.bidsReceived[1], moduleConfig);
     });
     it('check vastImpUrl', function() {
       expect(auctionEnd.bidsReceived[0]).to.have.property('vastImpUrl');
@@ -136,7 +137,7 @@ describe('oxxionRtdProvider', () => {
       expect(inlineImpressions).to.have.lengthOf.above(0);
     });
     it('check cpmIncrement', function() {
-      expect(auctionEnd.bidsReceived[1].vastImpUrl).to.contain(encodeURI('cpmIncrement=1'));
+      expect(auctionEnd.bidsReceived[1].vastImpUrl).to.contain(encodeURI('cpmIncrement=0'));
     });
   });
 });

package/test/spec/modules/pubmaticAnalyticsAdapter_spec.js

@@ -443,6 +443,13 @@ describe('pubmatic analytics adapter', function () {
       expect(data.eg).to.equal('1.23');
       expect(data.en).to.equal('1.23');
       expect(data.piid).to.equal('partnerImpressionID-1');
+      expect(data.plt).to.equal('1');
+      expect(data.psz).to.equal('640x480');
+      expect(data.tgid).to.equal('15');
+      expect(data.orig).to.equal('www.test.com');
+      expect(data.ss).to.equal('1');
+      expect(data.fskp).to.equal('0');
+      expect(data.af).to.equal('video');
     });
 
     it('bidCpmAdjustment: USD: Logger: best case + win tracker', function() {

package/test/spec/modules/teadsBidAdapter_spec.js

@@ -121,6 +121,13 @@ describe('teadsBidAdapter', () => {
       expect(request.method).to.equal('POST');
     });
 
+    it('should not send auctionId in bid request ', function() {
+      const request = spec.buildRequests(bidRequests, bidderResquestDefault);
+      const payload = JSON.parse(request.data);
+
+      expect(payload.data[0].auctionId).to.not.exist
+    });
+
     it('should send US Privacy to endpoint', function() {
       let usPrivacy = 'OHHHFCP1'
       let bidderRequest = {

package/test/spec/modules/vrtcalBidAdapter_spec.js

@@ -55,14 +55,21 @@ describe('vrtcalBidAdapter', function () {
       expect(request[0].data).to.match(/"bidfloor":0.55/);
     });
 
-    it('pass GDPR,CCPA, and COPPA indicators/consent strings with the request when present', function () {
+    it('pass GDPR,CCPA,COPPA, and GPP indicators/consent strings with the request when present', function () {
       bidRequests[0].gdprConsent = {consentString: 'gdpr-consent-string', gdprApplies: true};
       bidRequests[0].uspConsent = 'ccpa-consent-string';
       config.setConfig({ coppa: false });
 
+      bidRequests[0].ortb2 = {
+        regs: {
+          gpp: 'testGpp',
+          gpp_sid: [1, 2, 3]
+        }
+      }
+
       request = spec.buildRequests(bidRequests);
       expect(request[0].data).to.match(/"user":{"ext":{"consent":"gdpr-consent-string"/);
-      expect(request[0].data).to.match(/"regs":{"coppa":0,"ext":{"gdpr":1,"us_privacy":"ccpa-consent-string"}}/);
+      expect(request[0].data).to.match(/"regs":{"coppa":0,"ext":{"gdpr":1,"us_privacy":"ccpa-consent-string","gpp":"testGpp","gpp_sid":\[1,2,3\]}}/);
     });
 
     it('pass bidder timeout/tmax with the request', function () {