This feature is currently only available in PBS-Java.
Important: This resource should not be construed as legal advice and Prebid.org makes no guarantees about compliance with any law or regulation. Please note that because every company and its collection, use, and storage of personal data is different, you should seek independent legal advice relating to obligations under European and /or US regulations, including the GDPR, individual state laws, the ePrivacy Directive and CCPA. Only a lawyer can provide you with legal advice specifically tailored to your situation. Nothing in this guide is intended to provide you with, or should be used as a substitute for, legal advice tailored to your business.
This document covers how to configure the US General Privacy Module
for Prebid Server.
See the Prebid Multi-State Privacy Agreement Support page for details on how specifically GPP strings are processed. This module interprets the strings as defined in that document. If a publisher wishes to override the interpretation coded into this module, there are two options:
“USGen
” is a ‘privacy module’ called by the Activity Control system for a specific scenario. e.g.
This module’s job is figure out from the GPP strings whether or not the activity should be allowed. Unlike the similarly-named Prebid.js USNat module, this module also supports the US states defined by the IAB as having slightly different protocols. i.e. while the Prebid.js module only processes GPP Section (SID) 7, this Prebid Server module processes SIDs 7-12. That’s why we call it “US General” rather than “US National”, which implies SID 7.
Here are the steps need to activate the module within Prebid Server:
The USGen privacy module is included in PBS-Java 1.126, but is not activated until it’s placed
in the global or account-level config in a privacy.modules
object.
Here’s an example:
{
"privacy": {
"modules": [{
"code": "iab.usgeneral", // the USNat module's code
"config": {
"skipSids": [9]
}
}]
}
}
Parameter | Type | Scope | Description |
---|---|---|---|
skipSids | array of integer | Optional | Do not process the named section IDs. |
By default the module will process GPP SIDs 7-12. The skipSids
parameter allows the publisher to define a different processing flow for different GPP SIDs.
The USGen Privacy Module will not operate within the PBS workflow unless it’s called by the Activity Control system. e.g.
{
"privacy": {
"allowactivities": {
"ACTIVITY": {
"default": true,
"rules": [{
"privacyreg": ["*"] // this causes the Activity Control to call this module
},{
... more rules ...
}]
}
}
}
}
Here’s how the module works when called by an Activity Control:
regs.gpp
regs.gpp_sid
. This is an array of integers.abstain
.allow: false
to the Activity Control system.allow: true
to the Activity Control systemabstain
In this scenario, a host company has created a special module for a publisher implementing custom processing logic. The publisher wants to process GPP SIDs 7,9-12 with the default Prebid approach, but they want to process SID 8 with this custom module.
{
"privacy": {
"modules": [{
"code": "iab.usgeneral", // the USNat module's code
"config": {
"skipSids": [8]
}
},{
"code": "publisherP.specialCAprocessing" // only activates for SID 8
}],
"allowactivities": {
"ACTIVITY": {
"default": true,
"rules": [{
"privacyreg": ["*"]
}]
}
}
}
}
Additional information about the outcoming of privacy module processing can be obtained by setting ext.prebid.trace: "basic"
.