New Module: Bid response filter #12147

mkomorski · 2024-08-20T12:23:30Z

Type of change

Description of change

Other information

patmmccann · 2024-08-20T14:44:40Z

let's make sure to help populate attr and categories with https://github.com/prebid/Prebid.js/blob/9e2c63ec92b3f88882d04ae2b9cbbdc80f504a32/libraries/ortbConverter/processors/default.js#L98C1-L99C1
let's filter on any response category, not just primary.

patmmccann · 2024-08-20T15:01:48Z

https://docs.prebid.org/prebid-server/pbs-modules/ortb2-blocking.html#configuration-details

patmmccann · 2024-08-20T15:03:02Z

lets set boolean for each of the field and add the unknown toggle in the config eg `

block-unknown-adv-cat --

`

github-actions · 2024-08-21T18:14:01Z

Tread carefully! This PR adds 6 linter errors (possibly disabled through directives):

modules/bidResponseFilter/index.js (+6 errors)

dgirardi · 2024-08-21T22:00:54Z

modules/bidResponseFilter/index.js

+import { getHook } from '../../src/hook.js';
+
+export const MODULE_NAME = 'bidResponseFilter';
+export const PUBLISHER_FILTER_REJECTION_REASON = 'PUBLISHER_FILTER_REJECTION_REASON';


these should be human readable

dgirardi · 2024-08-21T22:06:53Z

modules/bidResponseFilter/index.js

+};
+
+export function addBidResponseHook(next, adUnitCode, bid, reject) {
+  const { bcat = [], badv = [], battr = [] } = config.getAnyConfig('ortb2') || {};


ortb2 can be different for each bid response. You can get a specific response's with auctionManager.index.getBidderRequest(bid)?.ortb2; however, responses can also not be associated with any request, in which case the best avialable ortb2 is the one associated with the auction (like you used in #11946)

It may be worth to add a getOrtb2 method to auctionManager.idex - similar to getMediaTypes, which also has a fallback for when there is no request.

I just noticed that battr is not here - it's repeated for each media type in imp. It's not clear where the publisher should set it - candidates are ortb2Imp[mediaType].battr and mediaTypes[mediaType].battr

Assuming the first one should have priority, we could:

update ad unit validation for each media type to find battr from ortb2Imp[type].battr, falling back to mediaTypes[type].battr, and copy it to both places

add some unit test for ortbConverter banner, video and native to make sure the "right" battr wins

this should then look for battr from index.getBidRequest(bid).ortb2Imp[bid.mediaType].battr, falling back to index.getAdUnit(bid).ortb2Imp[bid.mediaType].battr when there is no request for the bid

(pending confirmation on the relative priority of ortb2Imp vs mediaTypes)

dgirardi · 2024-08-21T22:11:54Z

modules/bidResponseFilter/index.js

+  const { bcat = [], badv = [], battr = [] } = config.getAnyConfig('ortb2') || {};
+  const moduleConfig = config.getConfig(MODULE_NAME);
+
+  const catConfig = moduleConfig?.cat || { enforce: true, block_unknown_cat: true };


if I

setConfig({bidResponseFilter: {cat: {block_unknown_cat: false}}})

my expectation would be that bcat would still be enforced (e.g., enforce defaults to true), but I think this would disable it.

dgirardi · 2024-08-21T22:15:47Z

modules/bidResponseFilter/index.js

+  const moduleConfig = config.getConfig(MODULE_NAME);
+
+  const catConfig = moduleConfig?.cat || { enforce: true, block_unknown_cat: true };
+  const advConfig = moduleConfig?.adv || { enforce: true, block_unknown_adomain: true };


It's probably out of scope, but I don't like these parameter names. attr: {block_uknown_attr} is redundant; and we do not use snake_case anywhere else. It's also inconsistent within itself (why cat/block_unknown_cat, but adv/block_unknown_adomain?)

If we weren't following PBS this would be something like adv: {enforce, blockUnknown}. Do we still prefer PBS's syntax @patmmccann ?

those are good reasons to abandon the hope of matching the syntax. oh well

dgirardi · 2024-09-05T13:52:26Z

libraries/ortbConverter/processors/default.js

+          bidResponse.meta.secondaryCatIds = bid.cat;
+          bidResponse.meta.primaryCatId = bid.cat[0];


is a primary category also a secondary category?

dgirardi · 2024-09-05T13:54:55Z

src/auctionIndex.js

@@ -65,6 +65,9 @@ export function AuctionIndex(getAuctions) {
          .flatMap(ber => ber.bids)
          .find(br => br && br.bidId === requestId);
      }
+    },
+    getOrtb2(bid) {
+      return this.getBidderRequest(bid)?.ortb2 || this.getAuction(bid)?.ortb2


auctions do not have an ortb2 property. This should be getFPD().global.

dgirardi · 2024-09-05T14:06:28Z

src/prebid.js

+  if (adUnit.ortb2Imp?.[mediaType] && battr) {
+    adUnit.ortb2Imp[mediaType].battr = battr;
+  }
+  if (adUnit.mediaTypes?.[mediaType] && battr) {
+    adUnit.mediaTypes[mediaType].battr = battr;
+  }


IMO this should always copy it over, since the goal is to make it easy to find for adapters. For example if I have {mediaTypes: {video: {battr}}, ortbImp: {}}, it would remain relegated to mediaTypes; turn it around and it would remain only in ortb2Imp, and adapters would still need to check both places. (They're also both decent test cases). We should also probably log a warning if they're both specified but they differ.

github-actions · 2024-09-11T13:56:50Z

Tread carefully! This PR adds 1 linter error (possibly disabled through directives):

src/prebid.js (+1 error)

dgirardi · 2024-09-11T15:36:08Z

src/prebid.js

+  const mediaTypes = adUnit.mediaTypes || {};
+
+  if (ortb2Imp[mediaType]?.battr && mediaTypes[mediaType]?.battr && (ortb2Imp[mediaType]?.battr !== mediaTypes[mediaType]?.battr)) {
+    logWarn('battr field differ between ortb2Imp and mediaTypes');


this should give some clue as to where the problem is - e.g. adUnit '${adUnit.code}' has ... or ...and mediaTypes:', adUnit), or both

dgirardi · 2024-09-11T15:49:52Z

src/prebid.js

+  adUnit.ortb2Imp = {...ortb2Imp, [mediaType]: {...(ortb2Imp[mediaType] || {}), battr}};
+  adUnit.mediaTypes = {...mediaTypes, [mediaType]: {...(mediaTypes[mediaType] || {}), battr}};


I think this would add battr: undefined in most cases. You can also simplify a bit by using deepSetValue, e.g.

Suggested change

adUnit.ortb2Imp = {...ortb2Imp, [mediaType]: {...(ortb2Imp[mediaType] || {}), battr}};

adUnit.mediaTypes = {...mediaTypes, [mediaType]: {...(mediaTypes[mediaType] || {}), battr}};

if (battr != null) {

['mediaTypes', 'ortb2Imp'].forEach(target => deepSetValue(adUnit, `${target}.${mediaType}.battr`, battr))

}

could you please also add some tests?

dgirardi · 2024-09-11T15:50:12Z

test/spec/modules/dsp_genieeBidAdapter_spec.js

@@ -121,7 +121,9 @@ describe('Geniee adapter tests', () => {
        currency: 'JPY',
        mediaType: 'banner',
        meta: {
-          advertiserDomains: ['geniee.co.jp']
+          advertiserDomains: ['geniee.co.jp'],


was this failing tests? it shouldn't need to be changed - you may need to tear down the bidResponseFilter tests. (if this was failing, more will likely be affected in the future, so it's better to try to get rid of test side effects).

* initial commit * update * review changes * + auction index * unit tests to ortb converter * review changes * battr setting * improvements * fix log message --------- Co-authored-by: Marcin Komorski <marcinkomorski@Marcins-MacBook-Pro.local> Co-authored-by: Marcin Komorski <marcinkomorski@marcins-mbp.home> Co-authored-by: Demetrio Girardi <dgirardi@prebid.org>

initial commit

ce5bcdb

mkomorski marked this pull request as draft August 20, 2024 12:23

update

a89fcbd

mkomorski marked this pull request as ready for review August 21, 2024 18:14

mkomorski requested a review from dgirardi August 21, 2024 18:14

dgirardi reviewed Aug 21, 2024

View reviewed changes

patmmccann mentioned this pull request Aug 22, 2024

Sharethrough Bid Adapter: support battr property in bid requests #12162

Merged

1 task

jsnellbaker assigned dgirardi Aug 26, 2024

jsnellbaker added the feature label Aug 26, 2024

review changes

ed8dda8

mkomorski force-pushed the bidResponseFilter branch from 2962389 to 839fe58 Compare August 28, 2024 13:25

+ auction index

5697f4e

mkomorski force-pushed the bidResponseFilter branch from 839fe58 to 5697f4e Compare August 28, 2024 14:25

unit tests to ortb converter

585bb46

mkomorski requested review from patmmccann and dgirardi September 2, 2024 10:41

dgirardi reviewed Sep 5, 2024

View reviewed changes

Marcin Komorski and others added 2 commits September 10, 2024 12:51

review changes

66bc55a

battr setting

8366048

mkomorski requested a review from dgirardi September 11, 2024 13:56

dgirardi reviewed Sep 11, 2024

View reviewed changes

improvements

f90c448

mkomorski requested a review from dgirardi September 12, 2024 08:28

fix log message

fb9458c

mkomorski force-pushed the bidResponseFilter branch from fb9458c to e72e53f Compare September 12, 2024 14:37

dgirardi force-pushed the bidResponseFilter branch from e72e53f to fb9458c Compare September 12, 2024 14:57

dgirardi approved these changes Sep 12, 2024

View reviewed changes

patmmccann merged commit 7ac768f into master Oct 8, 2024
9 checks passed

patmmccann deleted the bidResponseFilter branch October 8, 2024 03:21

mkomorski mentioned this pull request Oct 10, 2024

bidResponseFilter module docs prebid/prebid.github.io#5647

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Module: Bid response filter #12147

New Module: Bid response filter #12147

mkomorski commented Aug 20, 2024

patmmccann commented Aug 20, 2024

patmmccann commented Aug 20, 2024

patmmccann commented Aug 20, 2024

github-actions bot commented Aug 21, 2024

dgirardi Aug 21, 2024

dgirardi Aug 21, 2024 •

edited

Loading

dgirardi Aug 22, 2024

dgirardi Aug 21, 2024

dgirardi Aug 21, 2024 •

edited

Loading

patmmccann Aug 22, 2024 •

edited

Loading

dgirardi Sep 5, 2024

dgirardi Sep 5, 2024

dgirardi Sep 5, 2024

github-actions bot commented Sep 11, 2024

dgirardi Sep 11, 2024

dgirardi Sep 11, 2024

dgirardi Sep 11, 2024

		bidResponse.meta.secondaryCatIds = bid.cat;
		bidResponse.meta.primaryCatId = bid.cat[0];

		adUnit.ortb2Imp = {...ortb2Imp, [mediaType]: {...(ortb2Imp[mediaType] \|\| {}), battr}};
		adUnit.mediaTypes = {...mediaTypes, [mediaType]: {...(mediaTypes[mediaType] \|\| {}), battr}};

New Module: Bid response filter #12147

New Module: Bid response filter #12147

Conversation

mkomorski commented Aug 20, 2024

Type of change

Description of change

Other information

patmmccann commented Aug 20, 2024

patmmccann commented Aug 20, 2024

patmmccann commented Aug 20, 2024

github-actions bot commented Aug 21, 2024

Choose a reason for hiding this comment

dgirardi Aug 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dgirardi Aug 21, 2024 • edited Loading

Choose a reason for hiding this comment

patmmccann Aug 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Sep 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dgirardi Aug 21, 2024 •

edited

Loading

dgirardi Aug 21, 2024 •

edited

Loading

patmmccann Aug 22, 2024 •

edited

Loading