This consent management module is designed to support the California Consumer Privacy Act (CCPA). The IAB has generalized these guidelines to cover future regulations, referring to the feature as “US Privacy.”
This module works with an IAB-compatible US Privacy API (USP-API) to fetch an encoded string representing the user’s notice and opt-out choices and make it available for adapters to consume and process. In Prebid 7+; the module defaults to working with an IAB-compatible US Privacy API; in prior versions, the module had to be configured to be in effect.
See also the Prebid Consent Management - GDPR Module for supporting the EU General Data Protection Regulation (GDPR)
Here’s a summary of the interaction process:
The IAB USP-API will respond immediately if it is available. The module timeout settings are not related to user selection, but only to API availability.
If the timeout period expires or an error from the USP-API is thrown, the auction proceeds without a US Privacy string attached.
The string has four characters:
|1) Specification Version||1|
|2) Explicit Notice/Opportunity to Opt Out||(N = No,Y = Yes,– = Not Applicable)|
|3) Has user opted-out of the sale of his or her personal information?||(N = No,Y = Yes,– = Not Applicable)|
|4) Publisher is a signatory to the IAB Limited Service Provider Agreement||(N = No,Y = Yes,– = Not Applicable)|
To utilize this module, software that provides the USP-API must to be implemented on the site to interact with the user and obtain their notice and opt-out status.
Though implementation details for the USP-API are not covered by Prebid.org, we do recommend to that you place the code before the Prebid.js code in the head of the page in order to ensure the framework is loaded before the Prebid code executes. Many publishers who ensure the prior availability of the
__uspapi set the timeout parameter to zero.
Once the USP-API is implemented, simply include this module into your build and add a
consentManagement object in the
setConfig() call. Without configuration, Prebid will throw a warning that the module is unconfigured, and will proceed with the default configuration parameter
cmpApi as ‘iab’. Adapters that support this feature will then be able to retrieve the notice and opt-out status information and incorporate it in their requests.
Here are the parameters supported in the
||The USP-API interface that is in use. Supported values are ‘iab’ or ‘static’. Static allows integrations where IAB-formatted strings are provided in a non-standard way. Default is
||Length of time (in milliseconds) to allow the USP-API to obtain the CCPA string. Default is
||An object representing the CCPA notice and opt-out status data being passed directly; only used when cmpApi is ‘static’. Default is
Note that the term ‘CMP’ (Consent Management Platform) was chosen in Prebid to keep the interface similar to the GDPR implementation, though US-Privacy doesn’t specifically use that term.
Example 1: Support both US Privacy and GDPR
Example 2: Support US Privacy; timeout the api availability at zero because it is always available if it applies
Example 3: Static CMP using custom data passing. Placing this config call in the command queue before loading Prebid is important to ensure the string is available before Prebid begins making external calls.
Example 4: Static CMP with USP string set to does not apply for all fields, which may be useful to prevent excessive interaction with the
__uspapi outside of the geographic scope. Placing this config call in the command queue before loading Prebid is important to ensure it is available early.
Follow the basic build instructions in the GitHub Prebid.js repo’s main README. To include the consent management module, an additional option must be added to the the gulp build command:
If you are submitting changes to an adapter to support this approach, please also submit a PR to the docs repo to add the
usp_supported: true variable to your respective page in the bidders directory. This will ensure that your adapter’s name will automatically appear on the list of adapters supporting US Privacy.
To find the US Privacy/CCPA notice and opt-out status information to pass along to your system, adapters should look for the
bidderRequest.uspConsent field in their
Below is a sample of how the data is structured in the
usPrivacy object is also available when registering
The object can be accessed by including it as an argument in the
Depending on your needs, you could include the US-Privacy information in a query of your pixel and/or, given the notice and opt-out status choices, determine if you should drop the pixels at all.