prebid.js 7.35.0 → 7.36.0

package/modules/smilewantedBidAdapter.js

@@ -63,6 +63,11 @@ export const spec = {
         payload.gdpr_consent = bidderRequest.gdprConsent.consentString;
         payload.gdpr = bidderRequest.gdprConsent.gdprApplies; // we're handling the undefined case server side
       }
+
+      if (bid && bid.userIdAsEids) {
+        payload.eids = bid.userIdAsEids;
+      }
+
       var payloadString = JSON.stringify(payload);
       return {
         method: 'POST',

package/modules/topicsFpdModule.md

@@ -0,0 +1,62 @@
+# Overview
+
+Module Name: topicsFpdModule
+
+# Description
+Purpose of this module is to call the Topics API (document.browsingTopics()) which will fetch the first party domain as well third party domain(Iframe) topics data which will be sent onto user.data in bid stream. 
+
+The intent of the Topics API is to provide callers (including third-party ad-tech or advertising providers on the page that run script) with coarse-grained advertising topics that the page visitor might currently be interested in. 
+
+Topics Module(topicsFpdModule) should be included in prebid final package to call topics API.
+Module topicsFpdModule helps to call the Topics API which will send topics data in bid stream (onto user.data)
+
+```
+try {
+    if ('browsingTopics' in document && document.featurePolicy.allowsFeature('browsing-topics')) {
+        topics = document.browsingTopics();
+    }
+} catch (e) {
+    console.error('Could not call topics API', e);
+}
+```
+
+# Topics Iframe Configuration
+
+Topics iframe implementation is the enhancements of existing module under topicsFpdModule.js where different bidders will call the topic API under their domain to fetch the topics for respective domain and the segment data will be part of ORTB request under user.data object. Default config is maintained in the module itself. 
+
+Below are the configuration which can be used to configure and override the default config maintained in the module.
+
+```
+pbjs.setConfig({
+    userSync: {
+        ...,
+        topics: { 
+            maxTopicCaller: 3, // SSP rotation 
+            bidders: [{
+                bidder: 'pubmatic',
+                iframeURL: 'https://ads.pubmatic.com/AdServer/js/topics/topics_frame.html',
+                expiry: 7 // Configurable expiry days
+            },{
+                bidder: 'rubicon',
+                iframeURL: 'https://rubicon.com:8080/topics/fpd/topic.html', // dummy URL
+                expiry: 7 // Configurable expiry days
+            },{
+                bidder: 'appnexus',
+                iframeURL: 'https://appnexus.com:8080/topics/fpd/topic.html', // dummy URL
+                expiry: 7 // Configurable expiry days
+            }]
+        }
+        ....
+    }
+})
+```
+
+## Topics Config Descriptions
+
+| Field | Required? | Type | Description |
+|---|---|---|---|
+| topics.maxTopicCaller | no | integer | Defines the maximum numbers of Bidders Iframe which needs to be loaded on the publisher page. Default is 1 which is hardcoded in Module. Eg: topics.maxTopicCaller is set to 3. If there are 10 bidders configured along with their iframe URLS, random 3 bidders iframe URL is loaded which will call TOPICS API. If topics.maxTopicCaller is set to 0, it will load random 1(default) bidder iframe atleast. |
+| topics.bidders | no | Array of objects  | Array of topics callers with the iframe locations and other necessary informations like bidder(Bidder code) and expiry. Default Array of topics in the module itself.|
+| topics.bidders[].bidder | yes | string  | Bidder Code of the bidder(SSP).  |
+| topics.bidders[].iframeURL | yes | string  | URL which is hosted on bidder/SSP/third-party domains which will call Topics API.  |
+| topics.bidders[].expiry | no | integer  | Max number of days where Topics data will be persist. If Data is stored for more than mentioned expiry day, it will be deleted from storage. Default is 21 days which is hardcoded in Module. |

package/modules/userId/eids.js

@@ -282,7 +282,7 @@ export const USER_IDS_CONFIG = {
   },
 
   amxId: {
-    source: 'amxrtb.com',
+    source: 'amxdt.net',
     atype: 1,
   },
 

package/modules/vidazooBidAdapter.js

@@ -27,6 +27,7 @@ export const SUPPORTED_ID_SYSTEMS = {
   'tdid': 1,
   'pubProvidedId': 1
 };
+export const webSessionId = 'wsid_' + parseInt(Date.now() * Math.random());
 const storage = getStorageManager({gvlid: GVLID, bidderCode: BIDDER_CODE});
 
 function getTopWindowQueryParams() {
@@ -131,7 +132,8 @@ function buildRequest(bid, topWindowUrl, sizes, bidderRequest, bidderTimeout) {
     bidRequestsCount: bidRequestsCount,
     bidderRequestsCount: bidderRequestsCount,
     bidderWinsCount: bidderWinsCount,
-    bidderTimeout: bidderTimeout
+    bidderTimeout: bidderTimeout,
+    webSessionId: webSessionId
   };
 
   appendUserIdsToRequestPayload(data, userId);

package/modules/yahoosspBidAdapter.js

@@ -24,7 +24,7 @@ const SUPPORTED_USER_ID_SOURCES = [
   'adserver.org',
   'adtelligent.com',
   'akamai.com',
-  'amxrtb.com',
+  'amxdt.net',
   'audigent.com',
   'britepool.com',
   'criteo.com',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prebid.js",
-  "version": "7.35.0",
+  "version": "7.36.0",
   "description": "Header Bidding Management Library",
   "main": "src/prebid.js",
   "scripts": {
@@ -130,7 +130,7 @@
     "express": "^4.15.4",
     "fun-hooks": "^0.9.9",
     "just-clone": "^1.0.2",
-    "live-connect-js": "3.0.5"
+    "live-connect-js": "^4.0.0"
   },
   "optionalDependencies": {
     "fsevents": "^2.3.2"

package/test/spec/modules/33acrossBidAdapter_spec.js

@@ -218,6 +218,14 @@ describe('33acrossBidAdapter:', function () {
       return this;
     };
 
+    this.withReferer = referer => {
+      Object.assign(ttxRequest.site, {
+        ref: referer
+      });
+
+      return this;
+    };
+
     this.withSchain = schain => {
       Object.assign(ttxRequest, {
         source: {
@@ -1187,26 +1195,51 @@ describe('33acrossBidAdapter:', function () {
       });
     });
 
-    context('when referer value is available', function() {
-      it('returns corresponding server requests with site.page set', function() {
-        const bidderRequest = {
-          refererInfo: {
-            page: 'http://foo.com/bar'
-          }
-        };
+    context('when refererInfo values are available', function() {
+      context('when refererInfo.page is defined', function() {
+        it('returns corresponding server requests with site.page set', function() {
+          const bidderRequest = {
+            refererInfo: {
+              page: 'http://foo.com/bar'
+            }
+          };
 
-        const ttxRequest = new TtxRequestBuilder()
-          .withBanner()
-          .withProduct()
-          .withPageUrl('http://foo.com/bar')
-          .build();
-        const serverRequest = new ServerRequestBuilder()
-          .withData(ttxRequest)
-          .build();
+          const ttxRequest = new TtxRequestBuilder()
+            .withBanner()
+            .withProduct()
+            .withPageUrl('http://foo.com/bar')
+            .build();
+          const serverRequest = new ServerRequestBuilder()
+            .withData(ttxRequest)
+            .build();
 
-        const [ builtServerRequest ] = spec.buildRequests(bidRequests, bidderRequest);
+          const [ builtServerRequest ] = spec.buildRequests(bidRequests, bidderRequest);
 
-        validateBuiltServerRequest(builtServerRequest, serverRequest);
+          validateBuiltServerRequest(builtServerRequest, serverRequest);
+        });
+      });
+
+      context('when refererInfo.ref is defined', function() {
+        it('returns corresponding server requests with site.ref set', function() {
+          const bidderRequest = {
+            refererInfo: {
+              ref: 'google.com'
+            }
+          };
+
+          const ttxRequest = new TtxRequestBuilder()
+            .withBanner()
+            .withProduct()
+            .withReferer('google.com')
+            .build();
+          const serverRequest = new ServerRequestBuilder()
+            .withData(ttxRequest)
+            .build();
+
+          const [ builtServerRequest ] = spec.buildRequests(bidRequests, bidderRequest);
+
+          validateBuiltServerRequest(builtServerRequest, serverRequest);
+        });
       });
     });
 
@@ -1246,7 +1279,7 @@ describe('33acrossBidAdapter:', function () {
     });
 
     context('when referer value is not available', function() {
-      it('returns corresponding server requests without site.page set', function() {
+      it('returns corresponding server requests without site.page and site.ref set', function() {
         const bidderRequest = {
           refererInfo: {}
         };

package/test/spec/modules/admaruBidAdapter_spec.js

@@ -121,4 +121,52 @@ describe('Admaru Adapter', function () {
       expect(result.length).to.equal(0);
     });
   });
+
+  describe('getUserSyncs()', () => {
+    it('should return iframe user sync if iframe sync is enabled', () => {
+      const syncs = spec.getUserSyncs(
+        {
+          pixelEnabled: true,
+          iframeEnabled: true,
+        },
+        null
+      );
+
+      expect(syncs).to.deep.equal([
+        {
+          type: 'iframe',
+          url: 'https://p2.admaru.net/UserSync/sync',
+        },
+      ]);
+    });
+
+    it('should return image syncs if they are enabled and iframe is disabled', () => {
+      const syncs = spec.getUserSyncs(
+        {
+          pixelEnabled: true,
+          iframeEnabled: false,
+        },
+        null
+      );
+
+      expect(syncs).to.deep.equal([
+        {
+          type: 'image',
+          url: 'https://p2.admaru.net/UserSync/sync',
+        },
+      ]);
+    });
+
+    it('should not return user syncs if syncs are disabled', () => {
+      const syncs = spec.getUserSyncs(
+        {
+          pixelEnabled: false,
+          iframeEnabled: false,
+        },
+        null
+      );
+
+      expect(syncs).to.deep.equal([]);
+    });
+  });
 });

package/test/spec/modules/aidemBidAdapter_spec.js

@@ -13,7 +13,7 @@ const VALID_BIDS = [
     params: {
       siteId: '301491',
       publisherId: '3021491',
-      placementId: 13144370,
+      placementId: '13144370',
     },
     mediaTypes: {
       banner: {
@@ -26,7 +26,7 @@ const VALID_BIDS = [
     params: {
       siteId: '301491',
       publisherId: '3021491',
-      placementId: 13144370,
+      placementId: '13144370',
     },
     mediaTypes: {
       video: {
@@ -110,7 +110,7 @@ const INVALID_BIDS = [
     },
     params: {
       siteId: '301491',
-      placementId: 13144370,
+      placementId: '13144370',
     },
   },
   {
@@ -126,7 +126,7 @@ const INVALID_BIDS = [
     },
     params: {
       siteId: '301491',
-      placementId: 13144370,
+      placementId: '13144370',
     },
   },
   {
@@ -143,7 +143,7 @@ const INVALID_BIDS = [
     },
     params: {
       siteId: '301491',
-      placementId: 13144370,
+      placementId: '13144370',
       video: {
         size: [480, 40]
       }
@@ -167,8 +167,8 @@ const DEFAULT_VALID_BANNER_REQUESTS = [
       }
     },
     params: {
-      siteId: 1,
-      placementId: 13144370
+      siteId: '1',
+      placementId: '13144370'
     },
     src: 'client',
     transactionId: '54a58774-7a41-494e-9aaf-fa7b79164f0c'
@@ -192,8 +192,8 @@ const DEFAULT_VALID_VIDEO_REQUESTS = [
       }
     },
     params: {
-      siteId: 1,
-      placementId: 13144370
+      siteId: '1',
+      placementId: '13144370'
     },
     src: 'client',
     transactionId: '54a58774-7a41-494e-9aaf-fa7b79164f0c'
@@ -289,14 +289,25 @@ const WIN_NOTICE = {
     'hb_size': '300x250',
     'hb_source': 'client',
     'hb_format': 'banner',
-    'hb_adomain': 'tenutabene.it'
+    'hb_adomain': 'example.com'
   },
+
   'auctionId': '85864730-6cbc-4e56-bc3c-a4a6596dca5b',
   'currency': [
     'USD'
   ],
   'mediaType': 'banner',
+  'advertiserDomains': [
+    'abc.com'
+  ],
   'size': '300x250',
+  'params': [
+    {
+      'placementId': '13144370',
+      'siteId': '23434',
+      'publisherId': '7689670753'
+    }
+  ],
   'width': 300,
   'height': 250,
   'status': 'rendered',
@@ -365,6 +376,62 @@ describe('Aidem adapter', () => {
       deepSetValue(validVideoRequest.params, 'video.size', [640, 480])
       expect(spec.isBidRequestValid(validVideoRequest)).to.be.true
     });
+
+    it('BANNER: should return true if rateLimit is 1', function () {
+      // spec.isBidRequestValid()
+      const validBannerRequest = utils.deepClone(VALID_BIDS[0])
+      deepSetValue(validBannerRequest.params, 'rateLimit', 1)
+      expect(spec.isBidRequestValid(validBannerRequest)).to.be.true
+    });
+
+    it('BANNER: should return false if rateLimit is 0', function () {
+      // spec.isBidRequestValid()
+      const validBannerRequest = utils.deepClone(VALID_BIDS[0])
+      deepSetValue(validBannerRequest.params, 'rateLimit', 0)
+      expect(spec.isBidRequestValid(validBannerRequest)).to.be.false
+    });
+
+    it('BANNER: should return false if rateLimit is not between 0 and 1', function () {
+      // spec.isBidRequestValid()
+      const validBannerRequest = utils.deepClone(VALID_BIDS[0])
+      deepSetValue(validBannerRequest.params, 'rateLimit', 1.2)
+      expect(spec.isBidRequestValid(validBannerRequest)).to.be.false
+    });
+
+    it('BANNER: should return false if rateLimit is not a number', function () {
+      // spec.isBidRequestValid()
+      const validBannerRequest = utils.deepClone(VALID_BIDS[0])
+      deepSetValue(validBannerRequest.params, 'rateLimit', '0.5')
+      expect(spec.isBidRequestValid(validBannerRequest)).to.be.false
+    });
+
+    it('VIDEO: should return true if rateLimit is 1', function () {
+      // spec.isBidRequestValid()
+      const validVideoRequest = utils.deepClone(VALID_BIDS[1])
+      deepSetValue(validVideoRequest.params, 'rateLimit', 1)
+      expect(spec.isBidRequestValid(validVideoRequest)).to.be.true
+    });
+
+    it('VIDEO: should return false if rateLimit is 0', function () {
+      // spec.isBidRequestValid()
+      const validVideoRequest = utils.deepClone(VALID_BIDS[1])
+      deepSetValue(validVideoRequest.params, 'rateLimit', 0)
+      expect(spec.isBidRequestValid(validVideoRequest)).to.be.false
+    });
+
+    it('VIDEO: should return false if rateLimit is not between 0 and 1', function () {
+      // spec.isBidRequestValid()
+      const validBannerRequest = utils.deepClone(VALID_BIDS[1])
+      deepSetValue(validBannerRequest.params, 'rateLimit', 1.2)
+      expect(spec.isBidRequestValid(validBannerRequest)).to.be.false
+    });
+
+    it('VIDEO: should return false if rateLimit is not a number', function () {
+      // spec.isBidRequestValid()
+      const validBannerRequest = utils.deepClone(VALID_BIDS[1])
+      deepSetValue(validBannerRequest.params, 'rateLimit', '0.5')
+      expect(spec.isBidRequestValid(validBannerRequest)).to.be.false
+    });
   });
 
   describe('buildRequests', () => {

package/test/spec/modules/ajaBidAdapter_spec.js

@@ -45,6 +45,26 @@ describe('AjaAdapter', function () {
         bidId: '30b31c1838de1e',
         bidderRequestId: '22edbae2733bf6',
         auctionId: '1d1a030790a475',
+        ortb2: {
+          device: {
+            sua: {
+              source: 2,
+              platform: {
+                brand: 'Android',
+                version: ['8', '0', '0']
+              },
+              browsers: [
+                {brand: 'Not_A Brand', version: ['99', '0', '0', '0']},
+                {brand: 'Google Chrome', version: ['109', '0', '5414', '119']},
+                {brand: 'Chromium', version: ['109', '0', '5414', '119']}
+              ],
+              mobile: 1,
+              model: 'SM-G955U',
+              bitness: '64',
+              architecture: ''
+            }
+          }
+        }
       }
     ];
 
@@ -58,7 +78,7 @@ describe('AjaAdapter', function () {
       const requests = spec.buildRequests(bidRequests, bidderRequest);
       expect(requests[0].url).to.equal(ENDPOINT);
       expect(requests[0].method).to.equal('GET');
-      expect(requests[0].data).to.equal('asi=123456&skt=5&prebid_id=30b31c1838de1e&prebid_ver=$prebid.version$&page_url=https%3A%2F%2Fhoge.com&');
+      expect(requests[0].data).to.equal('asi=123456&skt=5&prebid_id=30b31c1838de1e&prebid_ver=$prebid.version$&page_url=https%3A%2F%2Fhoge.com&sua=%7B%22source%22%3A2%2C%22platform%22%3A%7B%22brand%22%3A%22Android%22%2C%22version%22%3A%5B%228%22%2C%220%22%2C%220%22%5D%7D%2C%22browsers%22%3A%5B%7B%22brand%22%3A%22Not_A%20Brand%22%2C%22version%22%3A%5B%2299%22%2C%220%22%2C%220%22%2C%220%22%5D%7D%2C%7B%22brand%22%3A%22Google%20Chrome%22%2C%22version%22%3A%5B%22109%22%2C%220%22%2C%225414%22%2C%22119%22%5D%7D%2C%7B%22brand%22%3A%22Chromium%22%2C%22version%22%3A%5B%22109%22%2C%220%22%2C%225414%22%2C%22119%22%5D%7D%5D%2C%22mobile%22%3A1%2C%22model%22%3A%22SM-G955U%22%2C%22bitness%22%3A%2264%22%2C%22architecture%22%3A%22%22%7D&');
     });
   });
 

package/test/spec/modules/aolBidAdapter_spec.js

@@ -84,7 +84,7 @@ describe('AolAdapter', function () {
     'admixer.net': '100',
     'adserver.org': '200',
     'adtelligent.com': '300',
-    'amxrtb.com': '500',
+    'amxdt.net': '500',
     'audigent.com': '600',
     'britepool.com': '700',
     'criteo.com': '800',
@@ -110,7 +110,7 @@ describe('AolAdapter', function () {
   const USER_ID_DATA = {
     admixerId: SUPPORTED_USER_ID_SOURCES['admixer.net'],
     adtelligentId: SUPPORTED_USER_ID_SOURCES['adtelligent.com'],
-    amxId: SUPPORTED_USER_ID_SOURCES['amxrtb.com'],
+    amxId: SUPPORTED_USER_ID_SOURCES['amxdt.net'],
     britepoolid: SUPPORTED_USER_ID_SOURCES['britepool.com'],
     criteoId: SUPPORTED_USER_ID_SOURCES['criteo.com'],
     connectid: SUPPORTED_USER_ID_SOURCES['verizonmedia.com'],