GPP Control Module - US state strings

Overview

This consent management control module is designed to support the Global Privacy Platform US state strings, GPP sections 8 through 12. It works by translating them into an equivalent US national string as detailed in Interpreting USNat strings, and using it to apply the same activity restrictions.

Prebid functionality created to address regulatory requirements does not replace each party’s responsibility to determine its own legal obligations and comply with all applicable laws. We recommend consulting with your legal counsel before determining how to utilize these features in support of your overall privacy approach. This module is not intended to replace other consent modules; it supplements them.

Page Integration

By default, including this module enables activity restrictions for GPP sections from ID 8 to 12, as long as the consentManagementGpp module is also included and configured. Optional configuration options are:

Param Type Description Example
gpp.mspa Object    
gpp.mspa.sids Array GPP SIDs that should be covered by activity restrictions. Defaults to all US state SIDs ([8, 9, 10, 11, 12]). This is the only value needed for normal operation. Other options are for special cases and future-proofing. [8, 9]
gpp.mspa.sections Object Map from section ID to per-section configuration options {8: {name: 'usca'}}
gpp.mspa.sections.name String GPP API name to use for the section. Defaults to the names given listed under section information -> section IDs. This option would only be used if your CMP has named their sections in a non-standard way. uscav3
gpp.mspa.sections.normalizeAs integer Normalize the flags for this section as if it were the number provided. See example. Each section defaults to its own ID. 8

Examples

Enable activity controls for certain sections only

pbjs.setConfig({
  consentManagement: {
      gpp: {
          mspa: {
              sids: [8, 9] // enable only for CA and VA
          }
      }
  }
})

Non-standard GPP API names

If the CMP has a non-standard label for a given section, the name parameter may be used:

pbjs.setConfig({
  consentManagement: {
    gpp: {
      mspa: {
        sections: {
          8: {
            name: 'uspcav1' // Use 'uspcav1' instead of 'usca' to retrieve section 8 from the CMP
          }
        }
      }
    }
  }
})

Select normalization rule

This module provides a normalization algorithm for each section from 8 to 12, which it uses to translate each section’s data into its equivalent section 7 (usnat) representation. It is possible to re-use them for other sections; this can be useful if new GPP sections are released and they happen to follow the same format as an exising one. For example, if a new US GPP SID 51 comes along that should be read from the CMP as ‘uss51’ and normalized the same as California’s string, here’s the config:

pbjs.setConfig({
  consentManagement: {
    gpp: {
      mspa: {
        sids: [51],       // SID for the 51st state
        sections: {
          51: {
            // expect the CMP to provide section 51, with API name 'uss51', and the same format as section 8 (CA)
            name: 'uss51',
            normalizeAs: 8 
          }
        }
      }
    }
  }
})

Build the Package

Follow the basic build instructions in the GitHub Prebid.js repo’s main README. To include the consent management module and the GPP Control - US states module, an additional option must be added to the gulp build command:

gulp build --modules=consentManagementGpp,gppContol_usstates,bidAdapter1,bidAdapter2

You can also use the Prebid.js Download page.

Further Reading