Skip to content

Commit c8ed5f6

Browse files
authored
dsaControl module docs (prebid#5202)
1 parent d62a6d7 commit c8ed5f6

1 file changed

Lines changed: 54 additions & 0 deletions

File tree

dev-docs/modules/dsaControl.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
layout: page_v2
3+
title: DSA Control Module
4+
display_name: DSA Control Module
5+
description: Digital Services Act bid validation
6+
page_type: module
7+
module_code : dsaControl
8+
enable_download : true
9+
sidebarType : 1
10+
---
11+
12+
# DSA Control Module
13+
{:.no_toc}
14+
15+
* TOC
16+
{:toc}
17+
18+
## Overview
19+
20+
The ORTB [DSA extension](https://github.com/InteractiveAdvertisingBureau/openrtb/blob/main/extensions/community_extensions/dsa_transparency.md) provides a method for publishers to request DSA transparency information, and for buyers to attach it to their bids.
21+
This module adds validation for DSA information, discarding bids that do not match what was requested.
22+
23+
## Usage
24+
25+
With this module installed, validations are enabled by requesting DSA transparency information. For example:
26+
27+
```javascript
28+
pbjs.setConfig({
29+
ortb2: {
30+
regs: {
31+
ext: {
32+
dsa: {
33+
dsarequired: 2,
34+
pubrender: 0
35+
// ...
36+
}
37+
}
38+
}
39+
}
40+
})
41+
```
42+
43+
This module will then enforce that:
44+
45+
* all bids include DSA information, if required (`dsarequired` is either `2` or `3`);
46+
* all bids that provide DSA information use a compatible rendering method:
47+
* if the request indicates that the publisher can't render (`pubrender` is `0`), then the advertiser must (`adrender` cannot be `0`);
48+
* if it indicates that the publisher will render (`pubrender` is `2`), then the advertiser must not (`adrender` cannot be `1`).
49+
50+
Bids that fail the checks above are rejected with a console warning and removed from the auction.
51+
52+
## Further Reading
53+
54+
* [DSA Transparency](https://github.com/InteractiveAdvertisingBureau/openrtb/blob/main/extensions/community_extensions/dsa_transparency.md)

0 commit comments

Comments
 (0)