Ability to statically pass consentData #2636

ptomasroos · 2018-05-29T08:20:23Z

Type of change

Feature

Description of change

For some services its reasonable to not render the cmp api on every page view when a given user has already given consent and change this in his or hers settings. We only have 100% signed in users on our impressions and it would be very valuable for us to be able to set the consentData staticly on page rendering in order to speed up loading and retrieval of consentData.

Other information

Also reported in #2567 the ability to avoid using cmp, I think its fair to use a CMP to generate the consentData in order for it to be compliant but at least pass it when its not changed or altered through the config

bretg · 2018-06-06T17:40:30Z

test/spec/modules/consentManagement_spec.js

+      });
+      it('results in user settings overriding system defaults', () => {
+        let staticConfig = {
+          cmpApi: 'static',


Needs to be part of a consentManagement object:

pbjs.setConfig({ consentManagement: { cmpApi: 'iab', timeout: 8000, allowAuctionWithoutConsent: false } });

This issue exists in another test in this file.

This setup is working because the setConfig used in the unit test file is calling the local version of the function that's inside consentManagement.js; it's not being routed through the config.setConfig() function that requires config object names.

From an off-line discussion, I plan to rewrite the unit tests to better reflect usage; ideally after this PR is finished.

All right! Cool! Thanks for the clarification

bretg · 2018-06-06T17:42:58Z

In general I'm good with pubs being in charge of passing consent values. Don't have a strong opinion about implementation approach. In any case, there will need to be docs changes to http://prebid.org/dev-docs/modules/consentManagement.html

jsnellbaker

@ptomasroos In addition to @bretg's suggestions for a documentation update, I found one other point that should be reviewed. Once those are in place, these changes should be fine.

jsnellbaker · 2018-06-11T12:15:15Z

modules/consentManagement.js

+      staticConsentData = config.consentData;
+      consentTimeout = 0;
+    } else {
+      utils.logInfo(`consentManagement config with cmpApi: 'static' did not specify consentData. No consents will be available to adapters.`);


This should likely be an logWarn or logError instead of a logInfo type message; as this is a negative situation that should be highlighted/easy to spot for a dev troubleshooting.

Thanks, will fix!

polapi · 2018-06-19T10:51:24Z

Hey, I'd like to push forward this pull request. @ptomasroos can you help with this?

I tried to help by updating the documentation. Here is my branch:
https://github.com/prebid/prebid.github.io/compare/master...polapi:static-consent-config?expand=1

I am not sure about usage of the changes you made. Please check if I understand correctly. Also I guess the actual pull request should be opened when this one is ready to be merged.

Remaining changes I guess are quite minor, would you have time to deal with them?

Thanks.

ptomasroos · 2018-06-20T10:10:26Z

I will move on with this next week since I'm currently a bit busy on schedule @polapi

stale · 2018-07-04T10:49:18Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

polapi · 2018-07-04T15:34:57Z

Hi @protomasroos . You mentioned you'll push the pull request forward last week. Is there anything I can help with to make it happen?

polapi · 2018-07-18T09:19:57Z

Hi @protomasroos, It seems you don't have time to work on this. Maybe it would be better to close the pull request so maybe someone else would implement this functionality (instead thinking you're working on this)?

ptomasroos · 2018-07-19T19:43:25Z

I'm on vacation, feel free to fork otherwise i will complete this within a few weeks when coming back.

stale · 2018-08-02T19:56:35Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale · 2018-08-17T12:40:18Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

ptomasroos · 2018-08-17T13:07:52Z

Good news coming up, will fix this during next week when I'm back at work since we need it now as well

polapi · 2018-08-30T07:36:11Z

@ptomasroos How is it going? I guess you will again announce you are going to work on this next week?

ptomasroos · 2018-08-30T07:53:52Z

@polapi right, its not easy to be CEO, CTO, CMO, COO and CCO. But I will do my best to complete this, since you're having plenty of free time, feel free to press the fork button and complete this? Otherwise I will move on to do this when this is highest on my prio list. Most likely next week

ptomasroos · 2018-09-05T18:49:20Z

I've now rebased and fixed the minor @jsnellbaker , created the documentation as requested by @bretg

ptomasroos · 2018-09-07T10:31:35Z

The only thing I'm really thinking about here is the format the static data is passed in. Because currently it expects the output from the iab cmp, and when using a lib like the consent-string (from iab) which decodes and encodes the consent string's its returned in another format.

It would probably be wise at least that we match the format in some way from these general libraries published from iab.

https://github.com/InteractiveAdvertisingBureau/Consent-String-SDK-JS
https://github.com/InteractiveAdvertisingBureau/Consent-String-SDK-Java
https://github.com/InteractiveAdvertisingBureau/Consent-String-SDK-C
ect..

Feels like the consentManagement.js expects the results from a iab __cmp implementation and we should probably try to avoid this. And maybe just pass the consent-string into it instead and let prebid decode? Opinions?

bretg · 2018-09-07T21:44:52Z

test/spec/modules/consentManagement_spec.js

+      });
+      it('results in user settings overriding system defaults', () => {
+        let staticConfig = {
+          cmpApi: 'static',


jsnellbaker · 2018-09-10T12:49:46Z

@ptomasroos Thanks for putting the additional changes together.

In regards to your additional point, currently the module is meant to access the consent data from CMP and pass it along down-stream for other sources (ad-servers, etc) to read/parse. If we were to add responsibility for Prebid to decode/encode the consent values and handle it properly as well as change the type of data we'd be passing to the adapters (if I'm reading that right?), it'd likely require some additional effort that I think falls outside the scope of this PR.

If you want to pursue this topic further, can you please open a new issue? There we can have a cleaner (ie not getting bogged down with PR changes in the conversation history) and more focused discussion on the proposed changes and the desired scope of the module.

* Added static consentData to consentManagement config * Added test for static cmpApi * logError instead of logInfo

jaiminpanchal27 assigned jsnellbaker May 30, 2018

bretg requested changes Jun 6, 2018

View reviewed changes

bretg added the needs docs label Jun 6, 2018

jsnellbaker requested changes Jun 11, 2018

View reviewed changes

stale bot added the stale label Jul 4, 2018

stale bot removed the stale label Jul 4, 2018

stale bot added the stale label Aug 2, 2018

jsnellbaker added needs update and removed stale labels Aug 3, 2018

stale bot added the stale label Aug 17, 2018

stale bot removed the stale label Aug 17, 2018

ptomasroos added 2 commits September 5, 2018 20:13

Added static consentData to consentManagement config

0b8e101

Added test for static cmpApi

614d4b2

ptomasroos force-pushed the static-consent-config branch from a7ce552 to 614d4b2 Compare September 5, 2018 18:14

logError instead of logInfo

73928d0

ptomasroos mentioned this pull request Sep 5, 2018

Added docs for static consent mgmt prebid/prebid.github.io#956

Merged

bretg approved these changes Sep 7, 2018

View reviewed changes

bretg removed the needs docs label Sep 7, 2018

jsnellbaker approved these changes Sep 10, 2018

View reviewed changes

jsnellbaker merged commit 6a3d628 into prebid:master Sep 10, 2018

ptomasroos added a commit to happypancake/Prebid.js that referenced this pull request Sep 25, 2018

Ability to statically pass consentData (prebid#2636)

e95a6bb

* Added static consentData to consentManagement config * Added test for static cmpApi * logError instead of logInfo

StefanWallin pushed a commit to mittmedia/Prebid.js that referenced this pull request Sep 28, 2018

Ability to statically pass consentData (prebid#2636)

8a74be5

* Added static consentData to consentManagement config * Added test for static cmpApi * logError instead of logInfo

SublimeJeremy pushed a commit to SublimeSkinz/Prebid.js that referenced this pull request Oct 1, 2018

Ability to statically pass consentData (prebid#2636)

06ae895

* Added static consentData to consentManagement config * Added test for static cmpApi * logError instead of logInfo

ghost pushed a commit to devunrulymedia/Prebid.js that referenced this pull request Jan 30, 2019

Ability to statically pass consentData (prebid#2636)

870e134

* Added static consentData to consentManagement config * Added test for static cmpApi * logError instead of logInfo

pedrolopezmrf pushed a commit to Marfeel/Prebid.js that referenced this pull request Mar 18, 2019

Ability to statically pass consentData (prebid#2636)

6f28aee

* Added static consentData to consentManagement config * Added test for static cmpApi * logError instead of logInfo

AlessandroDG pushed a commit to simplaex/Prebid.js that referenced this pull request Mar 26, 2019

Ability to statically pass consentData (prebid#2636)

01e9f48

* Added static consentData to consentManagement config * Added test for static cmpApi * logError instead of logInfo

AlessandroDG pushed a commit to simplaex/Prebid.js that referenced this pull request Mar 26, 2019

Ability to statically pass consentData (prebid#2636)

ba9ebff

* Added static consentData to consentManagement config * Added test for static cmpApi * logError instead of logInfo

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ability to statically pass consentData #2636

Ability to statically pass consentData #2636

ptomasroos commented May 29, 2018

bretg Jun 6, 2018

jsnellbaker Jun 11, 2018

ptomasroos Jun 20, 2018

bretg Sep 7, 2018

bretg commented Jun 6, 2018

jsnellbaker left a comment

jsnellbaker Jun 11, 2018

ptomasroos Jun 20, 2018

polapi commented Jun 19, 2018

ptomasroos commented Jun 20, 2018

stale bot commented Jul 4, 2018

polapi commented Jul 4, 2018

polapi commented Jul 18, 2018

ptomasroos commented Jul 19, 2018

stale bot commented Aug 2, 2018

stale bot commented Aug 17, 2018

ptomasroos commented Aug 17, 2018

polapi commented Aug 30, 2018

ptomasroos commented Aug 30, 2018

ptomasroos commented Sep 5, 2018

ptomasroos commented Sep 7, 2018

bretg Sep 7, 2018

jsnellbaker commented Sep 10, 2018

Ability to statically pass consentData #2636

Ability to statically pass consentData #2636

Conversation

ptomasroos commented May 29, 2018

Type of change

Description of change

Other information

bretg Jun 6, 2018

Choose a reason for hiding this comment

jsnellbaker Jun 11, 2018

Choose a reason for hiding this comment

ptomasroos Jun 20, 2018

Choose a reason for hiding this comment

bretg Sep 7, 2018

Choose a reason for hiding this comment

bretg commented Jun 6, 2018

jsnellbaker left a comment

Choose a reason for hiding this comment

jsnellbaker Jun 11, 2018

Choose a reason for hiding this comment

ptomasroos Jun 20, 2018

Choose a reason for hiding this comment

polapi commented Jun 19, 2018

ptomasroos commented Jun 20, 2018

stale bot commented Jul 4, 2018

polapi commented Jul 4, 2018

polapi commented Jul 18, 2018

ptomasroos commented Jul 19, 2018

stale bot commented Aug 2, 2018

stale bot commented Aug 17, 2018

ptomasroos commented Aug 17, 2018

polapi commented Aug 30, 2018

ptomasroos commented Aug 30, 2018

ptomasroos commented Sep 5, 2018

ptomasroos commented Sep 7, 2018

bretg Sep 7, 2018

Choose a reason for hiding this comment

jsnellbaker commented Sep 10, 2018