Permutive RTD module: support IAB Audience taxonomy #8242

desbo · 2022-03-31T12:44:01Z

Type of change

Feature

Description of change

Updates the Permutive RTD module to facilitate for segmentation by
the new IAB Audience taxonomy.

To achieve this, this change introduces the concept of "transformations"
on the ORT2B user.data object. There are two components to these
transformations: a new transformations property on the Prebid config,
to be set by the publisher, and logic in the module for the actual
behaviour of the transformation.

We plan to use the transformation logic in this PR, combined with
configuration we'll share with publishers, to send IAB Audience
taxonomy cohort IDs to bidders.

Updates the Permutive RTD module to facilitate for segmentation by the new IAB Audience taxonomy. To achieve this, this change introduces the concept of "transformations" on the ORT2B `user.data` object. There are two components to these transformations: a new `transformations` property on the Prebid config, to be set by the publisher, and logic in the module for the actual behaviour of the transformation. We plan to use the transformation logic in this PR, combined with configuration we'll share with publishers, to send IAB Audience taxonomy cohort IDs to bidders.

lgtm-com · 2022-03-31T12:52:44Z

This pull request introduces 1 alert when merging 000411a into 82987c6 - view on LGTM.com

new alerts:

1 for Superfluous trailing arguments

patmmccann · 2022-04-02T03:00:35Z

This feels like a super clunky experience for publishers. Why doesn't your endpoint return the transformation mappings instead of asking publishers to define potentially enormous config?

Also, it would be super trivial to take segtax as an input instead of hard coding it to '4'

integrationExamples/gpt/permutiveRtdProvider_example.html

patmmccann · 2022-04-02T03:06:01Z

modules/permutiveRtdProvider.js

+const ortb2UserDataTransformations = {
+  iabAudienceTaxonomy11: (userData, config) => ({
+    name: userData.name,
+    ext: { segtax: '4' },


If you're making pubs define all the transformations, no reason you can't let this be a param...

patmmccann · 2022-04-02T03:12:46Z

test/spec/modules/permutiveRtdProvider_spec.js

+          },
+          {
+            name: 'permutive.com',
+            ext: { segtax: '4' },


It's an integer

patmmccann · 2022-04-02T03:15:01Z

test/spec/modules/permutiveRtdProvider_spec.js

+            segment: expectedTargetingData
+          },
+          {
+            name: 'permutive.com',


Is it really permutive that decided the audience member belongs in that iab segment if permutive fails to provide the transformations? The publisher could easily transform any permutive segment to any iab segment; so I'm not sure this remains correct.

patmmccann · 2022-04-02T05:48:31Z

modules/permutiveRtdProvider.js

-  const segment = segmentData.ac.map(seg => {
-    return { id: seg }
-  })
+function mergeOrtbConfig (currConfig, segmentIDs, transformationConfigs) {


There's a utils function for this now, i think it's called mergeDeep

Thanks for the suggestion – after looking at this function I realised it's not really doing a simple merge of two objects but actually updating the user.data array with some new entries. So I don't think mergeDeep is suitable here, but I've renamed the function to clarify what it does.

desbo · 2022-04-04T10:10:26Z

@patmmccann thanks for the review so far. In terms of the overhead for publishers: I should have mentioned that this change is to support a test with a single publisher that will only involve a small selection of cohorts. For this test, Permutive will provide the publisher with the segment mapping for use in their config, and we already have agreement from the publisher on this way of working for the test.

Our plan was to go with this approach for the test and then revisit our implementation so that the segment mappings come from our SDK rather than the Prebid module in the long term. Ultimately I'd expect that publishers would only need to include a simple flag in their config. Would you accept these changes to the config in light of this extra context? I'll address your other outstanding points of course.

patmmccann · 2022-04-04T18:44:18Z

If you make segtax default to 4 but be overridable in config; i'd be happy to merge. Publishers want code that is "future-proof"; they don't want to have to suddenly upgrade prebid to support segtax i, j or k in their permutive adapter. We much prefer when adapters keep this in mind. If you look at the iab content taxonomy, it has quickly iterated from 2.1 -> 2.2 -> 3.0, each with a different segtax. I would not be surprised if audience gets a new segtax number shortly.

desbo · 2022-04-05T10:52:59Z

@patmmccann thanks! I've addressed your comments now, most importantly to include segtax as a config parameter.
Eventually we'll be back with another PR that removes the need for publishers to include the segment ID mappings in their config too, but hopefully this is acceptable in its current form for the test I mentioned.

edit to mention that I'll be away for the next couple of weeks and my colleagues @bartholomews and @Mullefa will commit to this branch if there are any more changes to make.

patmmccann · 2022-04-07T17:48:07Z

integrationExamples/gpt/permutiveRtdProvider_example.html

-                          name: 'www.dataprovider1.com',
-                          ext: { taxonomyname: 'iab_audience_taxonomy' },
-                          segment: [{ id: '687' }, { id: '123' }]
-                        },


two things left: circleci needs to run; add a segtax here. Can be the permutive contextual segtax or the iab contextual (don't use the audience bc that is user.data)

patmmccann · 2022-04-07T17:49:27Z

@patmmccann thanks! I've addressed your comments now, most importantly to include segtax as a config parameter. Eventually we'll be back with another PR that removes the need for publishers to include the segment ID mappings in their config too, but hopefully this is acceptable in its current form for the test I mentioned.

edit to mention that I'll be away for the next couple of weeks and my colleagues @bartholomews and @Mullefa will commit to this branch if there are any more changes to make.

Thanks so much! Did you notice circleci didnt run? Usually helps to unfollow your fork in circleci before you make the change. Just one tiny change in the example file requested.

desbo · 2022-04-07T18:58:18Z

@patmmccann thanks again. I've added segtax to the example, hopefully in the right place but if not, please let me know and one of my teammates will fix. CircleCI is now running after updating this branch with master, although a lot of the tests are timing out – think these are unrelated to my changes?

bartholomews · 2022-04-11T14:06:14Z

Hi @patmmccann circleci is now green, please let me know if there's anything else left to address! Thanks

Remove unused argument

8392b6c

jsnellbaker requested a review from musikele March 31, 2022 14:46

jsnellbaker assigned musikele Mar 31, 2022

jsnellbaker added feature needs review labels Mar 31, 2022

patmmccann self-assigned this Apr 2, 2022

patmmccann reviewed Apr 2, 2022

View reviewed changes

integrationExamples/gpt/permutiveRtdProvider_example.html Show resolved Hide resolved

patmmccann requested changes Apr 2, 2022

View reviewed changes

patmmccann added maintenance and removed feature labels Apr 2, 2022

patmmccann reviewed Apr 2, 2022

View reviewed changes

desbo added 4 commits April 5, 2022 09:06

Parameterise segtax and make it a number

4b2c75e

Update readme

91d7319

Rename function

40f45c9

Remove deprecated data structure from example

2a90d5b

desbo force-pushed the permutive-iab-test branch from 964f71b to 2a90d5b Compare April 5, 2022 10:50

Fix config in example

5965ccf

desbo requested a review from patmmccann April 6, 2022 09:29

patmmccann approved these changes Apr 7, 2022

View reviewed changes

patmmccann requested changes Apr 7, 2022

View reviewed changes

desbo added 2 commits April 7, 2022 19:48

Add missing segtax to example

24662a5

Merge remote-tracking branch 'prebid/master' into permutive-iab-test

49ce2a5

bartholomews added 2 commits April 8, 2022 15:44

Merge remote-tracking branch 'upstream/master' into permutive-iab-test

05cc357

Trigger CI

8f3747e

patmmccann approved these changes Apr 11, 2022

View reviewed changes

patmmccann merged commit 930b94d into prebid:master Apr 11, 2022

dgirardi mentioned this pull request Apr 28, 2022

Merge master into prebid-7 #8336

Merged

saxsir mentioned this pull request Oct 5, 2022

update: bid-strap use prebid v6.29.3 voyagegroup/Prebid.js#29

Closed

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Permutive RTD module: support IAB Audience taxonomy #8242

Permutive RTD module: support IAB Audience taxonomy #8242

desbo commented Mar 31, 2022 •

edited

Loading

lgtm-com bot commented Mar 31, 2022

patmmccann commented Apr 2, 2022 •

edited

Loading

patmmccann Apr 2, 2022

patmmccann Apr 2, 2022

patmmccann Apr 2, 2022

patmmccann Apr 2, 2022 •

edited

Loading

desbo Apr 5, 2022

desbo commented Apr 4, 2022 •

edited

Loading

patmmccann commented Apr 4, 2022 •

edited

Loading

desbo commented Apr 5, 2022 •

edited

Loading

patmmccann Apr 7, 2022

patmmccann commented Apr 7, 2022

desbo commented Apr 7, 2022

bartholomews commented Apr 11, 2022

Permutive RTD module: support IAB Audience taxonomy #8242

Permutive RTD module: support IAB Audience taxonomy #8242

Conversation

desbo commented Mar 31, 2022 • edited Loading

Type of change

Description of change

lgtm-com bot commented Mar 31, 2022

patmmccann commented Apr 2, 2022 • edited Loading

patmmccann Apr 2, 2022

Choose a reason for hiding this comment

patmmccann Apr 2, 2022

Choose a reason for hiding this comment

patmmccann Apr 2, 2022

Choose a reason for hiding this comment

patmmccann Apr 2, 2022 • edited Loading

Choose a reason for hiding this comment

desbo Apr 5, 2022

Choose a reason for hiding this comment

desbo commented Apr 4, 2022 • edited Loading

patmmccann commented Apr 4, 2022 • edited Loading

desbo commented Apr 5, 2022 • edited Loading

patmmccann Apr 7, 2022

Choose a reason for hiding this comment

patmmccann commented Apr 7, 2022

desbo commented Apr 7, 2022

bartholomews commented Apr 11, 2022

desbo commented Mar 31, 2022 •

edited

Loading

patmmccann commented Apr 2, 2022 •

edited

Loading

patmmccann Apr 2, 2022 •

edited

Loading

desbo commented Apr 4, 2022 •

edited

Loading

patmmccann commented Apr 4, 2022 •

edited

Loading

desbo commented Apr 5, 2022 •

edited

Loading