Pre-auction filters and pbAdslot support

modules/prebidServerBidAdapter/index.js

@@ -481,6 +481,15 @@ const OPEN_RTB_PROTOCOL = {
 
  const imp = { id: adUnit.code, ext, secure: _s2sConfig.secure };
 
+ /**
+ * Prebid AdSlot
+ * @type {(string|undefined)}
+ */
+ const pbAdSlot = utils.deepAccess(adUnit, 'fpd.context.pbAdSlot');
+ if (typeof pbAdSlot === 'string' && pbAdSlot) {
+ utils.deepSetValue(imp, 'ext.context.data.adslot', pbAdSlot);
+ }
+
  Object.assign(imp, mediaTypes);
 
  if (imp.banner || imp.video || imp.native) {

modules/rubiconBidAdapter.js

@@ -267,6 +267,15 @@ export const spec = {
  utils.deepSetValue(data, 'source.ext.schain', bidRequest.schain);
  }
 
+ /**
+ * Prebid AdSlot
+ * @type {(string|undefined)}
+ */
+ const pbAdSlot = utils.deepAccess(bidRequest, 'fpd.context.pbAdSlot');
+ if (typeof pbAdSlot === 'string' && pbAdSlot) {
+ utils.deepSetValue(data.imp[0].ext, 'context.data.adslot', pbAdSlot);
+ }
+
  return {
  method: 'POST',
  url: VIDEO_ENDPOINT,
@@ -489,6 +498,15 @@ export const spec = {
  });
  }
 
+ /**
+ * Prebid AdSlot
+ * @type {(string|undefined)}
+ */
+ const pbAdSlot = utils.deepAccess(bidRequest, 'fpd.context.pbAdSlot');
+ if (typeof pbAdSlot === 'string' && pbAdSlot) {
+ data['tg_i.dfp_ad_unit_code'] = pbAdSlot.replace(/^\/+/, '');
+ }
+
  // digitrust properties
  const digitrustParams = _getDigiTrustQueryParams(bidRequest, 'FASTLANE');
  Object.assign(data, digitrustParams);

src/adapterManager.js

@@ -66,6 +66,7 @@ function getBids({bidderCode, auctionId, bidderRequestId, adUnits, labels, src})
  }
 
  bid = Object.assign({}, bid, getDefinedParams(adUnit, [
+ 'fpd',
  'mediaType',
  'renderer'
  ]));
@@ -174,6 +175,12 @@ export let uspDataHandler = {
 };
 
 adapterManager.makeBidRequests = hook('sync', function (adUnits, auctionStart, auctionId, cbTimeout, labels) {
+ /**
+ * emit and pass adunits for external modification
+ * @see {@link https://github.com/prebid/Prebid.js/issues/4149|Issue}
+ */
+ events.emit(CONSTANTS.EVENTS.BEFORE_REQUEST_BIDS, adUnits);
+
  let bidRequests = [];
 
  let bidderCodes = getBidderCodes(adUnits);

src/constants.json

@@ -33,6 +33,7 @@
  "BID_WON": "bidWon",
  "BIDDER_DONE": "bidderDone",
  "SET_TARGETING": "setTargeting",
+ "BEFORE_REQUEST_BIDS": "beforeRequestBids",
  "REQUEST_BIDS": "requestBids",
  "ADD_AD_UNITS": "addAdUnits",
  "AD_RENDER_FAILED" : "adRenderFailed"

test/spec/modules/prebidServerBidAdapter_spec.js

@@ -1288,6 +1288,80 @@ describe('S2S Adapter', function () {
  const parsedRequestBody = JSON.parse(server.requests[0].requestBody);
  expect(parsedRequestBody.source.ext.schain).to.deep.equal(schainObject);
  })
+
+ describe('pbAdSlot config', function () {
+ it('should not send \"imp.ext.context.data.adslot\" if \"fpd.context\" is undefined', function () {
+ const ortb2Config = utils.deepClone(CONFIG);
+ ortb2Config.endpoint = 'https://prebid.adnxs.com/pbs/v1/openrtb2/auction';
+ const consentConfig = { s2sConfig: ortb2Config };
+ config.setConfig(consentConfig);
+ const bidRequest = utils.deepClone(REQUEST);
+
+ adapter.callBids(bidRequest, BID_REQUESTS, addBidResponse, done, ajax);
+ const parsedRequestBody = JSON.parse(server.requests[0].requestBody);
+
+ expect(parsedRequestBody.imp).to.be.a('array');
+ expect(parsedRequestBody.imp[0]).to.be.a('object');
+ expect(parsedRequestBody.imp[0]).to.not.have.deep.nested.property('ext.context.data.adslot');
+ });
+
+ it('should not send \"imp.ext.context.data.adslot\" if \"fpd.context.pbAdSlot\" is undefined', function () {
+ const ortb2Config = utils.deepClone(CONFIG);
+ ortb2Config.endpoint = 'https://prebid.adnxs.com/pbs/v1/openrtb2/auction';
+ const consentConfig = { s2sConfig: ortb2Config };
+ config.setConfig(consentConfig);
+ const bidRequest = utils.deepClone(REQUEST);
+ bidRequest.ad_units[0].fpd = {};
+
+ adapter.callBids(bidRequest, BID_REQUESTS, addBidResponse, done, ajax);
+ const parsedRequestBody = JSON.parse(server.requests[0].requestBody);
+
+ expect(parsedRequestBody.imp).to.be.a('array');
+ expect(parsedRequestBody.imp[0]).to.be.a('object');
+ expect(parsedRequestBody.imp[0]).to.not.have.deep.nested.property('ext.context.data.adslot');
+ });
+
+ it('should not send \"imp.ext.context.data.adslot\" if \"fpd.context.pbAdSlot\" is empty string', function () {
+ const ortb2Config = utils.deepClone(CONFIG);
+ ortb2Config.endpoint = 'https://prebid.adnxs.com/pbs/v1/openrtb2/auction';
+ const consentConfig = { s2sConfig: ortb2Config };
+ config.setConfig(consentConfig);
+ const bidRequest = utils.deepClone(REQUEST);
+ bidRequest.ad_units[0].fpd = {
+ context: {
+ pbAdSlot: ''
+ }
+ };
+
+ adapter.callBids(bidRequest, BID_REQUESTS, addBidResponse, done, ajax);
+ const parsedRequestBody = JSON.parse(server.requests[0].requestBody);
+
+ expect(parsedRequestBody.imp).to.be.a('array');
+ expect(parsedRequestBody.imp[0]).to.be.a('object');
+ expect(parsedRequestBody.imp[0]).to.not.have.deep.nested.property('ext.context.data.adslot');
+ });
+
+ it('should send \"imp.ext.context.data.adslot\" if \"fpd.context.pbAdSlot\" value is a non-empty string', function () {
+ const ortb2Config = utils.deepClone(CONFIG);
+ ortb2Config.endpoint = 'https://prebid.adnxs.com/pbs/v1/openrtb2/auction';
+ const consentConfig = { s2sConfig: ortb2Config };
+ config.setConfig(consentConfig);
+ const bidRequest = utils.deepClone(REQUEST);
+ bidRequest.ad_units[0].fpd = {
+ context: {
+ pbAdSlot: '/a/b/c'
+ }
+ };
+
+ adapter.callBids(bidRequest, BID_REQUESTS, addBidResponse, done, ajax);
+ const parsedRequestBody = JSON.parse(server.requests[0].requestBody);
+
+ expect(parsedRequestBody.imp).to.be.a('array');
+ expect(parsedRequestBody.imp[0]).to.be.a('object');
+ expect(parsedRequestBody.imp[0]).to.have.deep.nested.property('ext.context.data.adslot');
+ expect(parsedRequestBody.imp[0].ext.context.data.adslot).to.equal('/a/b/c');
+ });
+ });
  });
 
  describe('response handler', function () {

test/spec/modules/rubiconBidAdapter_spec.js

@@ -1260,6 +1260,77 @@ describe('the rubicon adapter', function () {
  });
  });
  })
+
+ describe('Prebid AdSlot', function () {
+ beforeEach(function () {
+ // enforce that the bid at 0 does not have a 'context' property
+ if (bidderRequest.bids[0].hasOwnProperty('fpd')) {
+ delete bidderRequest.bids[0].fpd;
+ }
+ });
+
+ it('should not send \"tg_i.dfp_ad_unit_code\" if \"fpd.context\" object is not valid', function () {
+ const [request] = spec.buildRequests(bidderRequest.bids, bidderRequest);
+ const data = parseQuery(request.data);
+
+ expect(data).to.be.an('Object');
+ expect(data).to.not.have.property('tg_i.dfp_ad_unit_code');
+ });
+
+ it('should not send \"tg_i.dfp_ad_unit_code\" if \"fpd.context.pbAdSlot\" is undefined', function () {
+ bidderRequest.bids[0].fpd = {};
+
+ const [request] = spec.buildRequests(bidderRequest.bids, bidderRequest);
+ const data = parseQuery(request.data);
+
+ expect(data).to.be.an('Object');
+ expect(data).to.not.have.property('tg_i.dfp_ad_unit_code');
+ });
+
+ it('should not send \"tg_i.dfp_ad_unit_code\" if \"fpd.context.pbAdSlot\" value is an empty string', function () {
+ bidderRequest.bids[0].fpd = {
+ context: {
+ pbAdSlot: ''
+ }
+ };
+
+ const [request] = spec.buildRequests(bidderRequest.bids, bidderRequest);
+ const data = parseQuery(request.data);
+
+ expect(data).to.be.an('Object');
+ expect(data).to.not.have.property('tg_i.dfp_ad_unit_code');
+ });
+
+ it('should send \"tg_i.dfp_ad_unit_code\" if \"fpd.context.pbAdSlot\" value is a valid string', function () {
+ bidderRequest.bids[0].fpd = {
+ context: {
+ pbAdSlot: 'abc'
+ }
+ }
+
+ const [request] = spec.buildRequests(bidderRequest.bids, bidderRequest);
+ const data = parseQuery(request.data);
+
+ expect(data).to.be.an('Object');
+ expect(data).to.have.property('tg_i.dfp_ad_unit_code');
+ expect(data['tg_i.dfp_ad_unit_code']).to.equal('abc');
+ });
+
+ it('should send \"tg_i.dfp_ad_unit_code\" if \"fpd.context.pbAdSlot\" value is a valid string, but all leading slash characters should be removed', function () {
+ bidderRequest.bids[0].fpd = {
+ context: {
+ pbAdSlot: '/a/b/c'
+ }
+ };
+
+ const [request] = spec.buildRequests(bidderRequest.bids, bidderRequest);
+ const data = parseQuery(request.data);
+
+ expect(data).to.be.an('Object');
+ expect(data).to.have.property('tg_i.dfp_ad_unit_code');
+ expect(data['tg_i.dfp_ad_unit_code']).to.equal('a/b/c');
+ });
+ });
  });
 
  describe('for video requests', function () {
@@ -1568,6 +1639,38 @@ describe('the rubicon adapter', function () {
  const [request] = spec.buildRequests(bidderRequest.bids, bidderRequest);
  expect(request.data.regs.coppa).to.equal(1);
  });
+
+ it('should include pbAdSlot in bid request', function () {
+ createVideoBidderRequest();
+ bidderRequest.bids[0].fpd = {
+ context: {
+ pbAdSlot: '1234567890'
+ }
+ };
+
+ sandbox.stub(Date, 'now').callsFake(() =>
+ bidderRequest.auctionStart + 100
+ );
+
+ const [request] = spec.buildRequests(bidderRequest.bids, bidderRequest);
+ expect(request.data.imp[0].ext.context.data.adslot).to.equal('1234567890');
+ });
+ });
+
+ it('should include pbAdSlot in bid request', function () {
+ createVideoBidderRequest();
+ bidderRequest.bids[0].fpd = {
+ context: {
+ pbAdSlot: '1234567890'
+ }
+ };
+
+ sandbox.stub(Date, 'now').callsFake(() =>
+ bidderRequest.auctionStart + 100
+ );
+
+ const [request] = spec.buildRequests(bidderRequest.bids, bidderRequest);
+ expect(request.data.imp[0].ext.context.data.adslot).to.equal('1234567890');
  });
 
  describe('combineSlotUrlParams', function () {