diff --git a/dev-docs/modules/bidResponseFilter.md b/dev-docs/modules/bidResponseFilter.md index 85f753c272..2330ead05a 100644 --- a/dev-docs/modules/bidResponseFilter.md +++ b/dev-docs/modules/bidResponseFilter.md @@ -23,6 +23,7 @@ Fields that can be configured: - `cat` - Banned categories ids - `adv` - Banned advertiser domains - `attr` - Banned attributes +- `mediaTypes` - Banned bids of mediaTypes not present on adUnit ### Field configuration object @@ -46,7 +47,46 @@ Fields that can be configured: attr: { enforce: false, blockUnknown: false + }, + mediaTypes: { + enforce: true, + blockUnknown: true } } }); ``` + +### Media types configuration + +The new `mediaTypes` parameter allows you to block bids whose mediaType does not match any of the media types declared at the ad unit level. + +### Disabling In-Banner video + +To block bids containing In-Banner Video creatives [IAB Creative Attributes 6 and 7, as defined in the AdCOM 1.0 specification](https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/main/AdCOM%20v1.0%20FINAL.md#list_creativeattributes), configure the Bid Response Filter module to reject these responses. + +Restrict the ad unit to banner only and declare disallowed creative attributes (battr) directly in the ad unit definition: + +```javascript +const adUnit = { + code: 'banner-adunit', + mediaTypes: { + banner: { + battr: [6, 7] // Block In-Banner Video creative attributes + } + }, + bids: [ /* bidder configs */ ] +}; +``` + +Enable both the attr and mediaTypes filters in the bidResponseFilter configuration: + +```javascript +pbjs.setConfig({ + bidResponseFilter: { + attr: { enforce: true }, + mediaTypes: { + banner: { enforce: true } + } + } +}); +```