Skip to content

Commit 0fdab76

Browse files
authored
PBS USGen skiprate (prebid#5887)
* PBS USGen skiprate * Update pbs-usgen.md
1 parent 0fac2c4 commit 0fdab76

2 files changed

Lines changed: 59 additions & 0 deletions

File tree

prebid-server/developers/add-a-privacy-module-java.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,3 +280,42 @@ public class MyPrivacyModule implements PrivacyModule, Loggable {
280280
}
281281
}
282282
```
283+
284+
## Privacy Trace Log and Analytics
285+
286+
The privacy module interface logs information that analytics adapters may want to consume. For example, if you're an analytics provider
287+
and want to check whether there was a skipRate config present, you can read the log for `skipped:true` and log however your analytics requires.
288+
289+
For example:
290+
291+
```
292+
{
293+
"description": "Invocation of Activity Infrastructure.",
294+
"activity": "transmitUfpd",
295+
"activity_invocation_payload": {
296+
"component_type": "BIDDER",
297+
"component_name": "bidderA"
298+
}
299+
},
300+
{
301+
"description": "Setting the default invocation result.",
302+
"allow_by_default": true
303+
},
304+
{
305+
"description": "Processing rule.",
306+
"rule_configuration": {
307+
"and": [
308+
{
309+
"privacy_module": "iab.usgeneral",
310+
"skipped": true,
311+
"result": "ABSTAIN"
312+
}
313+
]
314+
},
315+
"result": "ABSTAIN"
316+
},
317+
```
318+
319+
## Further Reading
320+
321+
- [Building a privacy module](/prebid-server/developers/add-a-privacy-module.html)

prebid-server/features/pbs-usgen.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,26 @@ Prebid approach, but they want to process SID 8 with this custom module.
148148
}
149149
```
150150

151+
### Testing
152+
153+
Before turning on the USGen module 100%, some host companies may want to partially enable it in order to gague impact. This can be done using the privacy module `skipRate` parameter. Here's an example account config:
154+
155+
```json5
156+
{
157+
"privacy": {
158+
"modules": [{
159+
"code": "iab.usgeneral",
160+
"skipRate": 95, // only run on 5% of requests. Default is to run on 100%, i.e. skipRate 0
161+
"config": {
162+
"skipSids": [9]
163+
}
164+
}]
165+
}
166+
}
167+
```
168+
169+
In order to utilize this test though, you will need an analytics adapter that can read the Activity Infrastructure log. See [privacy module analytics](/prebid-server/developers/add-a-privacy-module-java.html#privacy-trace-log-and-analytics) for more detail.
170+
151171
### Troubleshooting
152172

153173
Additional information about the outcoming of privacy module processing can be obtained by setting `ext.prebid.trace: "basic"`.

0 commit comments

Comments
 (0)