Consent management
Last edited: 2024/09/23
Consent management triggers Prebid Modules responsible for passing on user’s consent information from your CMP to Bidder adapters in Prebid to consume and process. Yieldbird Platform supports all consent frameworks:
- GDPR / TCF
- CCPA
- GPP
Please refer to Prebid documentation for the most up to date information about these modules:
How to configure Consent Management?
In the Old Platform
Consent Management (on / off)
If you enable Consent Management, Yieldbird will fetch (when available) the encoded string representing the user’s consent choices and make it available for your Bidders in Prebid Stack to consume and process.
After switching Consent Management on, Yieldbird will use the following default settings:
- cmpApi - The CMP interface that is in use. Supported values are
iaborstatic. Static allows integrations where IAB-formatted consent strings are provided in a non-standard way. Default value used isiab. - timeout - Length of time (in milliseconds) to allow the CMP to obtain the GDPR consent string.
Default value used is
8000 ms. - allowAuctionWithoutConsent - (TCF v1.1 only) Determines what will happen if obtaining consent information from the CMP fails; either allow the auction to proceed (
true) or cancel the auction (false). Default value used isfalse.
- First, loading a CMP stub synchronously (The CMP stub is a script which holds the Transparency Consent Framework (TCF) API which allows the external system to communicate with the CMP itself and read the encoded consent),
- Asynchronously loading the CMP code,
- Afterwards, loading Yieldbird’s tag.
Also, please check Prebid documentation on CMP best practices: link
Wait for TCF (on / off)
To choose whether you wish to Wait for TCF or not, you need to understand the following - the consent management works asynchronously with the CMP meaning that the Yieldbird Platform script can execute independently from your CMP script which means it can execute at a different pace. If Yieldbird script is faster, then it will not receive in time the TCF string from your CMP and therefore will not be able to pass it to your Bidders. The auction will still take place, but some (minority) Bidders, who make the reception of the TCF a condition to bid, will not bid.
Default is off - this configuration is the simplest and safest.
To wait for the TCF, you need to switch Wait go TCF to on and choose on of the options:
- Timeout
- Infinity wait
Yieldbird will execute the Prebid script after receiving the TCF string from your CMP, but will only wait for the specified timeout. For example, setting a 3-second timeout means that if Yieldbird doesn't receive the TCF within 3 seconds, it will start the Prebid auction as if the TCF string were empty (with no information about consent).
Yieldbird will wait for TCF infinitely before it starts Prebid Auction.
- set Wait for TCF = <on> with infinity wait if the majority of your traffic comes from European Economic Area
- set Wat for TCF = <off> if majority of your traffic comes from outside European Economic Area
This feature gets deprecated in the New Platform.
In the New Platform
You can set up Consent management at the workspace level (meaning the setting will be applied to all Domains). If needed, you can then customize it for specific Domains.
Example:Imagine you manage 10 Domains: 1 Domain has over 99% traffic from the USA, while 9 Domains have over 99% traffic from the European Union. You can set TCF = <on> at the Workspace level and then customize it for the "US" Domain to US privacy = <on> TCF = <on> or <off>.
Setting default Consent Management settings
Default Prebid Consent Management settings apply to all inventory in your Workspace unless you select value specific for particular Domain. To manage it:
- Go to Global Setup > Prebid > Defaults: Consent Management.
- Toggle on the Consent Management modules that you want to apply to all Domains by default.
- Once you toggle on the particular module, you will be able to customize some of its parameters. For these parameters that are not listed, Module’s default parameters are used.
What if a config parameter that you need is not available?
In such case, please either reach out to your Customer Success Manager, or post a feature request directly in the Feature Portal.
Customizing the setup on particular Domain
- Go to Inventory > Domains > edit > Prebid Stack: Consent Management.
- Toggle <on> Customize Consent Management on this Domain.
- Toggle on the Consent Management modules that you want to apply to this Domain.
- Once you toggle on the particular module, you will be able to customize some of its parameters. For these parameters that are not listed, Module’s default parameters are used.
- For your convenience the Related settings box shows the default Consent Management setup on your workspace.
What if a config parameter that you need is not available?
In such case, please either reach out to your Customer Success Manager, or post a feature request directly in the Feature Portal.
Learn more about how Consent Management timeout corresponds to Prebid Auction timeout in the article about Prebid Timeouts.