Add static API option to the consentManagementUsp module.

[dbirkbeck]

The GDPR consent management module has a static configuration option. This change adds "static" as an API option to the consentManagementUsp module.

Type of change

• Bugfix
• Feature
• New bidder adapter
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Does this change affect user-facing APIs or examples documented on http://prebid.org?
• Other

Description of change

This change allows a static configuration such as the following to be used rather than the 'iab' API.

consentManagement: {
    usp: {
        cmpApi: 'static',
        consentData: {
            getUSPData: {
                uspString: '1YYY'
            }
        }
    }
}

[jsnellbaker]

@dbirkbeck Can you please put together some unit tests that use this new static config approach and add them to this PR?

[harpere]

@dbirkbeck this implementation works, BUT I think we should be consistent with the format the GDPR consentManagement module uses. I realize that internally we are NOT consistent, but I think the external API should be (and we probably should change the internal representation of the consent data to be consistent as well). this is what I'm proposing:

consentManagement: {
    usp: {
        cmpApi: 'static',
        consentData: {
            getUSPData: {
                uspString: '1YNY'
            }
        }
    }
}

Notice getUSPData corresponds to the "command" used to retrieve the data from the USP CMP, and uspString is the actual param name returned by the CMP. So in addition to being consistent with the GDPR implementation, it's also consistent with the object returned by the CMP, and adds flexibility for other USP "commands" we might support in the future.

[harpere]

As mentioned in the previous comment, we should be consistent with the GDPR format. It would be nice to update the internal implementation used in lookupUspConsent(), processUspData(), and elsewhere (that could come later), but we should at least support a consistent format in the public API.

[dbirkbeck]

I've updated the module/unit test to reflect the new public API format. It is agreed that changing the internal implementation may be desirable but doing so will require a much larger effort and should probably be left to a next step.

[harpere]

Thx. LGTM

[harpere]

@dbirkbeck would you update the docs at https://github.com/prebid/prebid.github.io/blob/master/dev-docs/modules/consentManagementUsp.md ? I think you could copy/modify the static documentation from https://github.com/prebid/prebid.github.io/blob/master/dev-docs/modules/consentManagement.md

[dbirkbeck]

A pull request has been created for the documentation updates requested.

[adrianpoix]

@dbirkbeck is static API option for CCPA available with v2.44.2 ?

[dbirkbeck]

@adrianpoix The static API for CCPA is only in 3.2.0 thus far. As most are moving toward 3.x and I wasn't sure how many would use the static API, I focussed my efforts on that branch. I can create a PR for the 2.x branch as well if you think there is value in it.

[jsnellbaker]

@dbirkbeck & @adrianpoix

We actually just created/merged a PR yesterday for the 2.44.x-legacy branch that adds the static approach for the CCPA/USP API. It should be available for use with the next legacy release - which should happen next week (in the 2.44.3 release).

Forgot to link the PR in question. #4705

[dbirkbeck]

@jsnellbaker Excellent, thanks for merging into the legacy branch!

[adrianpoix]

@jsnellbaker & @dbirkbeck thanks for merging !

I use Audience Network bid adapter and they didn't migrate to 3.x.x yet so I have to keep 2.x.x for now