prebid.js 7.25.0 → 7.26.0

package/modules/zeusPrimeRtdProvider.md

@@ -0,0 +1,60 @@
+# Overview
+
+Module Name: Zeus Prime RTD Provider
+Module Type: Rtd Provider
+Maintainer: support@zeustechnology.com
+
+## Description
+
+The Zeus Prime RTD Provider provides integration of Zeus Prime onto sites with Prebid. This module will request information from Zeus Prime servers to add the page level targeting required for Prime into the customer's ad setup.
+
+Zeus Prime runs as soon as the code is initialized, so it can retrieve the information required from the Zeus Prime server to create the targeting key-values. Zeus Prime will provide two page level key-values: `zeus_<yourGamId>` and `zeus_insights`. Zeus Prime provides contextual information about a pages content, and does not provide user information that could present privacy implications.
+
+For more information and help with setting up Zeus Prime, see the [onboarding documentation site](https://onboarding.zeustechnology.com).
+
+## Usage
+
+To use Zeus Prime, add `zeusPrimeRtdProvider` into your Prebid build: 
+
+```
+gulp build --modules=rtdModule,zeusPrimeRtdProvider
+```
+
+> Note that the global RTD module, `rtdModule`, is required for the Zeus Prime RTD module.
+
+Once the code is included, configure Zeus Prime in your Prebid configuration: 
+
+```javascript
+pbjs.setConfig({
+  ...,
+  realTimeData: {
+    dataProviders: [{
+      name: 'zeusPrime',
+      waitForIt: false,
+      params: {
+        gamId: '<yourGamId>'
+      }
+    }]
+  },
+  ...
+})
+```
+
+## Parameters
+
+The parameters below describe the configuration object used to configure Zeus Prime. 
+
+| Name                   | Type     | Description                                                                                   | Default |
+|------------------------|----------|-----------------------------------------------------------------------------------------------|---------|
+| name                   | String   | This will always be `zeusPrime`                                                               | -       |
+| waitForIt              | Boolean  | Should be false since Zeus Prime runs on initial load and not during the bidding cycle.       | `false` |
+| params                 | Object   |                                                                                               | -       |
+| params.gamId           | String   | The gamId or Google Ad Manager Network Code to access your Google Ad Manager instance.        | -       |
+
+### `gamId` Parameter
+
+Zeus Prime requires the gamId parameter, or the Google Ad Manager Network Code, to reference your account. See the [Google documentation](https://support.google.com/admanager/answer/7674889?hl=en) to find out where you can retrieve the Network Code.
+
+## Troubleshooting 
+
+For troubleshooting steps and guides to assist with verifying your Zeus Prime installation, see our [installation documentation](https://onboarding.zeustechnology.com/docs/installation).

package/package.json

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

package/src/adloader.js

@@ -6,7 +6,6 @@ const _requestCache = new WeakMap();
 const _approvedLoadExternalJSList = [
   'debugging',
   'adloox',
-  'admatic',
   'criteo',
   'outstream',
   'adagio',

package/test/spec/modules/admaticBidAdapter_spec.js

@@ -3,7 +3,7 @@ import {spec, storage} from 'modules/admaticBidAdapter.js';
 import {newBidder} from 'src/adapters/bidderFactory.js';
 import {getStorageManager} from 'src/storageManager';
 
-const ENDPOINT = 'https://layer.serve.admatic.com.tr/v1';
+const ENDPOINT = 'https://layer.serve.admatic.com.tr/pb?bidder=admatic';
 
 describe('admaticBidAdapter', () => {
   const adapter = newBidder(spec);
@@ -18,7 +18,8 @@ describe('admaticBidAdapter', () => {
     let bid = {
       'bidder': 'admatic',
       'params': {
-        'networkId': 10433394
+        'networkId': 10433394,
+        'host': 'layer.serve.admatic.com.tr'
       },
       'adUnitCode': 'adunit-code',
       'sizes': [[300, 250], [300, 600]],
@@ -37,10 +38,268 @@ describe('admaticBidAdapter', () => {
       delete bid.params;
 
       bid.params = {
-        'networkId': 0
+        'networkId': 0,
+        'host': 'layer.serve.admatic.com.tr'
       };
 
       expect(spec.isBidRequestValid(bid)).to.equal(false);
     });
   });
+
+  describe('buildRequests', function () {
+    it('sends bid request to ENDPOINT via POST', function () {
+      let validRequest = [ {
+        'bidder': 'admatic',
+        'params': {
+          'networkId': 10433394,
+          'host': 'layer.serve.admatic.com.tr'
+        },
+        'mediaTypes': {
+          'banner': {
+            'sizes': [[300, 250], [728, 90]]
+          }
+        },
+        getFloor: inputParams => {
+          if (inputParams.mediaType === BANNER && inputParams.size[0] === 300 && inputParams.size[1] === 250) {
+            return {
+              currency: 'USD',
+              floor: 1.0
+            };
+          } else if (inputParams.mediaType === BANNER && inputParams.size[0] === 728 && inputParams.size[1] === 90) {
+            return {
+              currency: 'USD',
+              floor: 2.0
+            };
+          } else {
+            return {}
+          }
+        },
+        'user': {
+          'ua': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36'
+        },
+        'blacklist': [],
+        'site': {
+          'page': 'http://localhost:8888/admatic.html',
+          'ref': 'http://localhost:8888',
+          'publisher': {
+            'name': 'localhost',
+            'publisherId': 12321312
+          }
+        },
+        'imp': [
+          {
+            'size': [
+              {
+                'w': 300,
+                'h': 250
+              },
+              {
+                'w': 728,
+                'h': 90
+              }
+            ],
+            'id': '2205da7a81846b',
+            'floors': {
+              'banner': {
+                '300x250': { 'currency': 'USD', 'floor': 1 },
+                '728x90': { 'currency': 'USD', 'floor': 2 }
+              }
+            }
+          }
+        ],
+        'ext': {
+          'cur': 'USD',
+          'bidder': 'admatic'
+        }
+      } ];
+      let bidderRequest = {
+        'bidder': 'admatic',
+        'params': {
+          'networkId': 10433394,
+          'host': 'layer.serve.admatic.com.tr'
+        },
+        'mediaTypes': {
+          'banner': {
+            'sizes': [[300, 250], [728, 90]]
+          }
+        },
+        getFloor: inputParams => {
+          if (inputParams.mediaType === BANNER && inputParams.size[0] === 300 && inputParams.size[1] === 250) {
+            return {
+              currency: 'USD',
+              floor: 1.0
+            };
+          } else if (inputParams.mediaType === BANNER && inputParams.size[0] === 728 && inputParams.size[1] === 90) {
+            return {
+              currency: 'USD',
+              floor: 2.0
+            };
+          } else {
+            return {}
+          }
+        },
+        'user': {
+          'ua': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36'
+        },
+        'blacklist': [],
+        'site': {
+          'page': 'http://localhost:8888/admatic.html',
+          'ref': 'http://localhost:8888',
+          'publisher': {
+            'name': 'localhost',
+            'publisherId': 12321312
+          }
+        },
+        'imp': [
+          {
+            'size': [
+              {
+                'w': 300,
+                'h': 250
+              },
+              {
+                'w': 728,
+                'h': 90
+              }
+            ],
+            'id': '2205da7a81846b',
+            'floors': {
+              'banner': {
+                '300x250': { 'currency': 'USD', 'floor': 1 },
+                '728x90': { 'currency': 'USD', 'floor': 2 }
+              }
+            }
+          }
+        ],
+        'ext': {
+          'cur': 'USD',
+          'bidder': 'admatic'
+        }
+      };
+      const request = spec.buildRequests(validRequest, bidderRequest);
+      expect(request.url).to.equal(ENDPOINT);
+      expect(request.method).to.equal('POST');
+    });
+
+    it('should properly build a banner request with floors', function () {
+      let bidRequests = [
+        {
+          'bidder': 'admatic',
+          'params': {
+            'networkId': 10433394,
+            'host': 'layer.serve.admatic.com.tr'
+          },
+          'mediaTypes': {
+            'banner': {
+              'sizes': [[300, 250], [728, 90]]
+            }
+          },
+          getFloor: inputParams => {
+            if (inputParams.mediaType === BANNER && inputParams.size[0] === 300 && inputParams.size[1] === 250) {
+              return {
+                currency: 'USD',
+                floor: 1.0
+              };
+            } else if (inputParams.mediaType === BANNER && inputParams.size[0] === 728 && inputParams.size[1] === 90) {
+              return {
+                currency: 'USD',
+                floor: 2.0
+              };
+            } else {
+              return {}
+            }
+          }
+        },
+      ];
+      let bidderRequest = {
+        'bidder': 'admatic',
+        'params': {
+          'networkId': 10433394,
+          'host': 'layer.serve.admatic.com.tr'
+        },
+        'adUnitCode': 'adunit-code',
+        'sizes': [[300, 250], [728, 90]],
+        'bidId': '30b31c1838de1e',
+        'bidderRequestId': '22edbae2733bf6',
+        'auctionId': '1d1a030790a475',
+        'creativeId': 'er2ee',
+        'mediaTypes': {
+          'banner': {
+            'sizes': [[300, 250], [728, 90]]
+          }
+        }
+      };
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      request.data.imp[0].floors = {
+        'banner': {
+          '300x250': { 'currency': 'USD', 'floor': 1 },
+          '728x90': { 'currency': 'USD', 'floor': 2 }
+        }
+      };
+    });
+  });
+
+  describe('interpretResponse', function () {
+    it('should get correct bid responses', function() {
+      let bids = { body: {
+        data: [
+          {
+            'id': 1,
+            'creative_id': '374',
+            'width': 300,
+            'height': 250,
+            'price': 0.01,
+            'bidder': 'admatic',
+            'adomain': ['admatic.com.tr'],
+            'party_tag': '<div></div>'
+          }
+        ],
+        'queryId': 'cdnbh24rlv0hhkpfpln0',
+        'status': true
+      }};
+
+      let expectedResponse = [
+        {
+          requestId: 1,
+          cpm: 0.01,
+          width: 300,
+          height: 250,
+          currency: 'TRY',
+          netRevenue: true,
+          ad: '<div></div>',
+          creativeId: '374',
+          meta: {
+            advertiserDomains: ['admatic.com.tr']
+          },
+          ttl: 360,
+          bidder: 'admatic'
+        }
+      ];
+      const request = {
+        ext: {
+          'cur': 'TRY',
+          'type': 'admatic'
+        }
+      };
+      let result = spec.interpretResponse(bids, {data: request});
+      expect(result).to.eql(expectedResponse);
+    });
+
+    it('handles nobid responses', function () {
+      let request = {
+        ext: {
+          'cur': 'TRY',
+          'type': 'admatic'
+        }
+      };
+      let bids = { body: {
+        data: [],
+        'queryId': 'cdnbh24rlv0hhkpfpln0',
+        'status': true
+      }};
+
+      let result = spec.interpretResponse(bids, {data: request});
+      expect(result.length).to.equal(0);
+    });
+  });
 });

package/test/spec/modules/beopBidAdapter_spec.js

@@ -216,4 +216,56 @@ describe('BeOp Bid Adapter tests', () => {
       expect(triggerPixelStub.getCall(0).args[0]).to.exist.and.to.include('pid=5a8af500c9e77c00017e4cad');
     });
   });
+
+  describe('Ensure keywords is always array of string', function () {
+    let bidRequests = [];
+    afterEach(function () {
+      bidRequests = [];
+    });
+
+    it('should work with keywords as an array', function () {
+      let bid = Object.assign({}, validBid);
+      bid.params.keywords = ['a', 'b'];
+      bidRequests.push(bid);
+      config.setConfig({
+        currency: { adServerCurrency: 'USD' }
+      });
+      const request = spec.buildRequests(bidRequests, {});
+      const payload = JSON.parse(request.data);
+      const url = request.url;
+      expect(payload.kwds).to.exist;
+      expect(payload.kwds).to.include('a');
+      expect(payload.kwds).to.include('b');
+    });
+
+    it('should work with keywords as a string', function () {
+      let bid = Object.assign({}, validBid);
+      bid.params.keywords = 'list of keywords';
+      bidRequests.push(bid);
+      config.setConfig({
+        currency: { adServerCurrency: 'USD' }
+      });
+      const request = spec.buildRequests(bidRequests, {});
+      const payload = JSON.parse(request.data);
+      const url = request.url;
+      expect(payload.kwds).to.exist;
+      expect(payload.kwds).to.include('list of keywords');
+    });
+
+    it('should work with keywords as a string containing a comma', function () {
+      let bid = Object.assign({}, validBid);
+      bid.params.keywords = 'list, of, keywords';
+      bidRequests.push(bid);
+      config.setConfig({
+        currency: { adServerCurrency: 'USD' }
+      });
+      const request = spec.buildRequests(bidRequests, {});
+      const payload = JSON.parse(request.data);
+      const url = request.url;
+      expect(payload.kwds).to.exist;
+      expect(payload.kwds).to.include('list');
+      expect(payload.kwds).to.include('of');
+      expect(payload.kwds).to.include('keywords');
+    })
+  })
 });

package/test/spec/modules/captifyRtdProvider_spec.js

@@ -0,0 +1,253 @@
+import {addSegmentData, captifySubmodule, getMatchingBidders, setCaptifyTargeting} from 'modules/captifyRtdProvider.js';
+import {server} from 'test/mocks/xhr.js';
+import {config} from 'src/config.js';
+import {deepAccess} from '../../../src/utils';
+
+const responseHeader = {'Content-Type': 'application/json'};
+const defaultRequestUrl = 'https://live-classification.cpx.to/prebid-segments';
+
+describe('captifyRtdProvider', function () {
+  describe('init function', function () {
+    it('successfully instantiates, when configured properly', function () {
+      const config = {
+        params: {
+          pubId: 123456,
+          bidders: ['appnexus'],
+        }
+      };
+      expect(captifySubmodule.init(config, null)).to.equal(true);
+    });
+
+    it('return false on init, when config is invalid', function () {
+      const config = {
+        params: {}
+      };
+      expect(captifySubmodule.init(config, null)).to.equal(false);
+      expect(captifySubmodule.init(null, null)).to.equal(false);
+    });
+
+    it('return false on init, when pubId is absent', function () {
+      const config = {
+        params: {
+          bidders: ['appnexus'],
+        }
+      };
+      expect(captifySubmodule.init(config, null)).to.equal(false);
+      expect(captifySubmodule.init(null, null)).to.equal(false);
+    });
+
+    it('return false on init, when bidders is empty array', function () {
+      const config = {
+        params: {
+          bidders: [],
+          pubId: 123,
+        }
+      };
+      expect(captifySubmodule.init(config, null)).to.equal(false);
+      expect(captifySubmodule.init(null, null)).to.equal(false);
+    });
+  });
+
+  describe('addSegmentData function', function () {
+    it('adds segment data', function () {
+      config.resetConfig();
+
+      let data = {
+        xandr: [111111, 222222],
+      };
+
+      addSegmentData(['appnexus'], data);
+      expect(deepAccess(config.getConfig(), 'appnexusAuctionKeywords.captify_segments')).to.eql(data['xandr']);
+    });
+  });
+
+  describe('getMatchingBidders function', function () {
+    it('returns only bidders that used within adUnits', function () {
+      const moduleConfig = {
+        params: {
+          pubId: 123,
+          bidders: ['appnexus', 'pubmatic'],
+        }
+      };
+      let reqBidsConfigObj = {
+        adUnits: [{
+          bids: [{
+            bidder: 'appnexus',
+            params: {
+              placementId: 13144370
+            }
+          }]
+        }]
+      };
+
+      let matchedBidders = getMatchingBidders(moduleConfig, reqBidsConfigObj);
+      expect(matchedBidders).to.eql(['appnexus']);
+    });
+
+    it('return empty result, when there are no bidders configured for adUnits', function () {
+      const moduleConfig = {
+        params: {
+          pubId: 123,
+          bidders: ['pubmatic'],
+        }
+      };
+      let reqBidsConfigObj = {
+        adUnits: [{
+          bids: []
+        }]
+      };
+      expect(getMatchingBidders(moduleConfig, reqBidsConfigObj)).to.be.empty;
+    });
+
+    it('return empty result, when there are no bidders matched', function () {
+      const moduleConfig = {
+        params: {
+          pubId: 123,
+          bidders: ['pubmatic'],
+        }
+      };
+      let reqBidsConfigObj = {
+        adUnits: [{
+          bids: [{
+            params: {
+              bidder: 'appnexus',
+              placementId: 13144370,
+            }
+          }]
+        }]
+      };
+      expect(getMatchingBidders(moduleConfig, reqBidsConfigObj)).to.be.empty;
+    });
+
+    it('return empty result, when there are no adUnits with bidders', function () {
+      const moduleConfig = {
+        params: {
+          pubId: 123,
+          bidders: ['pubmatic'],
+        }
+      };
+      let reqBidsConfigObj = {
+        adUnits: [{
+          bids: [{
+            params: {
+              placementId: 13144370,
+            }
+          }]
+        }]
+      };
+      expect(getMatchingBidders(moduleConfig, reqBidsConfigObj)).to.be.empty;
+    });
+  });
+
+  describe('integration test with mock live-classification response', function () {
+    const moduleConfig = {
+      params: {
+        pubId: 123456,
+        bidders: ['appnexus'],
+      }
+    };
+
+    const reqBidsConfigObj = {
+      adUnits: [{
+        bids: [{
+          bidder: 'appnexus',
+          params: {
+            placementId: 13144370
+          }
+        }, {
+          bidder: 'other'
+        }]
+      }]
+    };
+
+    const expectedUrlParam = 'http://localhost:9876/context.html';
+
+    it('gets data from async request and adds segment data', function () {
+      config.resetConfig();
+      let data = {xandr: [111111, 222222]};
+      const callbackSpy = sinon.spy();
+      setCaptifyTargeting(reqBidsConfigObj, callbackSpy, moduleConfig, {});
+      let request = server.requests[0];
+      let requestBody = JSON.parse(server.requests[0].requestBody);
+      expect(request.url).to.be.eq(defaultRequestUrl);
+      expect(requestBody['pubId']).to.eq(moduleConfig.params.pubId);
+      expect(requestBody['url']).to.eq(expectedUrlParam);
+      request.respond(200, responseHeader, JSON.stringify(data));
+      expect(deepAccess(config.getConfig(), 'appnexusAuctionKeywords.captify_segments')).to.eql(data['xandr']);
+      expect(callbackSpy.calledOnce).to.be.true;
+    });
+
+    it('do not send classification request, if no matching adUnits on page', function () {
+      config.resetConfig();
+      let reqBidsConfigObj = {
+        adUnits: [{
+          bids: [
+            {bidder: 'pubmatic'}
+          ]
+        }]
+      };
+      const callbackSpy = sinon.spy();
+      setCaptifyTargeting(reqBidsConfigObj, callbackSpy, moduleConfig, {});
+      expect(server.requests).to.be.empty;
+    });
+
+    it('gets data from async request and adds segment data, using URL from config', function () {
+      config.resetConfig();
+      let data = {xandr: [111111, 222222]};
+      const callbackSpy = sinon.spy();
+      const testUrl = 'http://my-test-server.com/path';
+      const conf = {
+        params: {
+          url: testUrl,
+          pubId: 123456,
+          bidders: ['appnexus'],
+        }
+      };
+      setCaptifyTargeting(reqBidsConfigObj, callbackSpy, conf, {});
+      let request = server.requests[0];
+      let requestBody = JSON.parse(server.requests[0].requestBody);
+      expect(request.url).to.be.eq(testUrl);
+      expect(requestBody['pubId']).to.eq(conf.params.pubId);
+      expect(requestBody['url']).to.eq(expectedUrlParam);
+      request.respond(200, responseHeader, JSON.stringify(data));
+      expect(deepAccess(config.getConfig(), 'appnexusAuctionKeywords.captify_segments')).to.eql(data['xandr']);
+      expect(callbackSpy.calledOnce).to.be.true;
+    });
+
+    it('do not set anything, in case server responded with 202', function () {
+      config.resetConfig();
+      const callbackSpy = sinon.spy();
+      setCaptifyTargeting(reqBidsConfigObj, callbackSpy, moduleConfig, {});
+      let request = server.requests[0];
+      let requestBody = JSON.parse(server.requests[0].requestBody);
+      expect(request.url).to.be.eq(defaultRequestUrl);
+      expect(requestBody['pubId']).to.eq(moduleConfig.params.pubId);
+      expect(requestBody['url']).to.eq(expectedUrlParam);
+      request.respond(202, responseHeader, '');
+      expect(deepAccess(config.getConfig(), 'appnexusAuctionKeywords.captify_segments')).to.be.undefined;
+      expect(callbackSpy.calledOnce).to.be.true;
+    });
+
+    it('do not set anything, in case server responded with error', function () {
+      config.resetConfig();
+      const callbackSpy = sinon.spy();
+      setCaptifyTargeting(reqBidsConfigObj, callbackSpy, moduleConfig, {});
+      let request = server.requests[0];
+      expect(request.url).to.be.eq(defaultRequestUrl);
+      request.respond(500, null, '');
+      expect(deepAccess(config.getConfig(), 'appnexusAuctionKeywords.captify_segments')).to.be.undefined;
+      expect(callbackSpy.calledOnce).to.be.true;
+    });
+
+    it('do not set anything, in case request error', function () {
+      config.resetConfig();
+      const callbackSpy = sinon.spy();
+      setCaptifyTargeting(reqBidsConfigObj, callbackSpy, moduleConfig, {});
+      let request = server.requests[0];
+      expect(request.url).to.be.eq(defaultRequestUrl);
+      request.abort('test error');
+      expect(deepAccess(config.getConfig(), 'appnexusAuctionKeywords.captify_segments')).to.be.undefined;
+      expect(callbackSpy.calledOnce).to.be.true;
+    });
+  });
+});