1plusX RTD submodule: New RTD Module #8614

bwhisp · 2022-06-28T13:48:45Z

Type of change

Bugfix
Feature (New RTD submodule)
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 PR adds a RTD submodule for 1plusX
This module will fetch first party data from 1plusX's Profile API consisting of :

the audiences the user is part of
the topics related to the page

Then it will transmit this data to the supported & selected bid adapters through setBidderConfig

Contents of the PR :
- 1plusX RTD module: modules/1plusXRtdProvider.js
- Unit tests for 1plusX RTD module: test/spec/modules/1plusXRtdProvider_spec.js
- Integration example for 1plusX RTD module: integrationExamples/gpt/1plusXRtdProviderExample.html
- Documentation for 1plusX RTD module: modules/1plusXRtdProvider.md

For any changes that affect user-facing APIs or example code documented on http://prebid.org, please provide:

PR adding the documentation : 1plusX RTD submodule docs prebid.github.io#3873

Other information

I am not 100% sure about where to write the data in the ORTB2 format when updating the bid adapter configs.

The data I am fetching from 1plusX's Profile API consists of lists of custom-defined Ids that don't follow the standard taxonomy.
While I found info about where to write audience segments & topics in ORTB2; it seemed that it concerned only those following the standard taxonomy.

I reached a solution by combining the ORTB2 specs (pages 31 & 25) AND some examples from other RTD Providers :

audience segments will be written in an element of ortb2.user.data array
topics will be written in ortb2.site.keywords

I will add comments to the related parts of the code, please review these parts with special care.

bwhisp · 2022-06-28T13:51:31Z

modules/1plusXRtdProvider.js

+ * @param {string[]} topics Represents the topics of the page
+ * @returns {Object} Object describing the updates to make on bidder configs
+ */
+export const buildOrtb2Updates = ({ segments = [], topics = [] }) => {


This function will create the updates to the ORTB2 object to be set on bid adapters configs

bwhisp · 2022-06-28T13:52:19Z

modules/1plusXRtdProvider.js

+  const userData = {
+    name: '1plusX.com',
+    segment: segments.map((segmentId) => ({ id: segmentId }))
+  };


Here is the element I will add to ortb2.user.data containing the audience segments

bwhisp · 2022-06-28T13:52:52Z

modules/1plusXRtdProvider.js

+  const site = {
+    keywords: topics.join(',')
+  };


Here are the topics I will write to ortb2.site.keywords

site.content.data.segment.id

you may notice that appnexus doesnt support site.content.data.segment.id. In that case, we would prefer a change to the appnexus adapter to put the data in the keywords vector than a change to your module to write it to where it no longer belongs or special appnexus handling in your adapter. We have an open issue to remove similar special handling for appnexus in the airgrid and permutive adapters (among possible others)

Hi @patmmccann,

I will make the change by handling appnexus separately
May I get the issue number you were referring to ?

bwhisp · 2022-06-28T13:53:27Z

modules/1plusXRtdProvider.js

+  const currentSite = deepAccess(bidderConfigCopy, 'ortb2.site')
+  const updatedSite = mergeDeep(currentSite, site);


Writing topics to ortb2.site.keywords

this is the wrong place for these data

bwhisp · 2022-06-28T13:54:34Z

modules/1plusXRtdProvider.js

+  const currentUserData = deepAccess(bidderConfigCopy, 'ortb2.user.data') || [];
+  const updatedUserData = [
+    ...currentUserData.filter(({ name }) => name != userData.name),
+    userData
+  ];


In ortb2.user.data; replacing the element bearing 1plusX.com name with the element defined at buildOrtb2Updates::const userData

Fawke

Hi @bwhisp,

Thanks for the PR. While I'm still reviewing your changes, here are a few quick things that I noticed.

Your test coverage is at ~67%. We need to have more than 80% code coverage.
You need to add your module in .submodules.json file.

**to check code-coverage, you can run the command, gulp test-coverage and see the report. Here's a screenshot of what I got when I ran it.

patmmccann · 2022-07-05T15:07:19Z

modules/1plusXRtdProvider.md

+| params.timeout    | Integer       | timeout (ms)                                                     | 1000ms                                                   |
+
+## Supported Bidders
+At the moment only Appnexus (`appnexus`) and Magnite (`rubicon`) are supported


This is a rules violation

I just removed the SUPPORTED_BIDDERS limitation

patmmccann · 2022-07-05T15:08:37Z

integrationExamples/gpt/1plusXRtdProviderExample.html

+      gads.type = 'text/javascript';
+      var useSSL = 'https:' == document.location.protocol;
+      gads.src = (useSSL ? 'https:' : 'http:') +
+        '//www.googletagservices.com/tag/js/gpt.js';


please load from correct location

Hi @patmmccann
I took this piece of code from another module implementation example.
These same lines are used in several module examples.

Shall I take /workspaces/Prebid.js/integrationExamples/gpt/hello_world.html as a model instead ?

We have an open docs issue to update all the locations to gpt.js new official host (doubleclick.net), while that is still outstanding, we'd prefer to not add things to fix later

patmmccann · 2022-07-05T15:15:18Z

test/spec/modules/1plusXRtdProvider_spec.js

+      }
+    }
+
+    it("doesn't set config for unsupported bidders", () => {


demonstrates the rules violation

I just removed the SUPPORTED_BIDDERS limitation

bwhisp · 2022-07-05T15:34:12Z

Hi @bwhisp,

Thanks for the PR. While I'm still reviewing your changes, here are a few quick things that I noticed.

Your test coverage is at ~67%. We need to have more than 80% code coverage.

You need to add your module in .submodules.json file.

**to check code-coverage, you can run the command, gulp test-coverage and see the report. Here's a screenshot of what I got when I ran it.

Hi @Fawke

Thank you for the heads up!
I updated my tests for better coverage, adding tests for the extractConfig function
Now the coverage should be better

Tomorrow I'll work on @patmmccann 's comments which will have the effect of removing the SUPPORTED_BIDDERS limitation

bwhisp · 2022-07-06T10:29:36Z

Hi @patmmccann

thank you for the review

I've worked on the requested changes:

removed the supported bidders limitation
changed location to write topics to site.content.data.segment.id
introduced legacy processing for appnexus (writing data to site.keywords for this bidder)
updated tests

There's still 1 pending question about your comment on 1plusXRtdProviderExample.html

patmmccann · 2022-07-06T14:15:57Z

@bwhisp thank you for promptly addressing the rules concerns.

@Fawke remains the code reviewer; i just wanted to assist with rules feedback

patmmccann · 2022-07-06T14:20:26Z

modules/1plusXRtdProvider.js

+  } else {
+    const siteContentData = {
+      name: ORTB2_NAME,
+      segment: topics.map((topicId) => ({ id: topicId }))


You should also write to site.content.data.ext.segtax, if the segtax is custom to 1+x, you can reserve an integer with a pr to iab segtax.md file in the openrtb repo

I will take care of it tomorrow

shall I also write a segtax for what I put in user.data.segment ?

I opened InteractiveAdvertisingBureau/openrtb#108 for that matter

Fawke

Hi @bwhisp,

I went through your changes, they mostly look good. I just wanted to say that the Appnexus bid adapter doesn't yet read values from the ortb2 object. So, the special handling that you are doing for Appnexus currently, it won't work.

You will need to modify the bidRequest object directly and set bid.params.keywords. See an example here for airgridRtdProvider.

I also see a merge conflict in the .submodules.json file.

bwhisp · 2022-07-12T14:56:17Z

Hi @Fawke

thank you for the review.
How shall I proceed with the merge conflict? On the PR it states that Only those with write access to this repository can merge pull requests.. If required I can pull master and perform the merge locally but I want to make sure to follow any process if there's one.

I will also look at airgridRtdProvider and update the handling for Appnexus

Fawke · 2022-07-13T07:55:56Z

@bwhisp Yeah, you can pull in master and perform the merge locally.

…ons (#2)

…name

…onKeywords

bwhisp · 2022-07-13T09:01:27Z

Hi @Fawke

following your feedback I updated the handling of Appnexus & I resolved the merge conflict

Fawke

LGTM!
Will wait for @patmmccann approval before merging.

bwhisp · 2022-07-14T16:18:41Z

Hello @patmmccann @Fawke

thank you for the review and the approval :)

I created a PR at InteractiveAdvertisingBureau/openrtb#108 to introduce the 1plusX audience & content taxonomies that will be used in this RTD module
Do you know if it's a prerequisite that InteractiveAdvertisingBureau/openrtb#108 is merged before #8614?
If yes, do you know who can perform a review? I've seen @patmmccann doing a few of them in the past but not 100% sure it's still the case

patmmccann · 2022-07-14T17:06:10Z

IAB reviews those

* Empty shell for 1plusX RTD submodule (#1) * Submodule initialization & functions (init; getBidRequestData) skeletons (#2) * Testing for init function (#3) * Requesting Profile API for Data (#4) * Extract PAPI response & implementation example * Transmitting targeting data to bidder adapters * Markdown file documentation * Code cleaned & jsDoc completed * Change contact email + beautify parameters table + fix type in param name * Change customerId param type to string in doc * Add 1plusXRtdProvider as submodule of rtdModule * Add more tests on extractConfig amongst others * Remove SUPPORTED_BIDDERS limitation * Remove supported bidders from docs * Write to site.content.data.segment.id & keep legacy support for appnexus * Change location of googleTagServices * Add segtax for site.content.data * Handle audiences for appNexus by putting them in config.appnexusAuctionKeywords

bwhisp commented Jun 28, 2022

View reviewed changes

bwhisp mentioned this pull request Jun 28, 2022

1plusX RTD submodule docs prebid/prebid.github.io#3873

Merged

8 tasks

ChrisHuie changed the title ~~1plusX RTD submodule~~ 1plusX RTD submodule: New RTD Module Jun 28, 2022

ChrisHuie added the feature label Jun 28, 2022

ChrisHuie requested a review from Fawke June 28, 2022 17:43

ChrisHuie assigned Fawke Jun 28, 2022

Fawke reviewed Jul 5, 2022

View reviewed changes

patmmccann requested changes Jul 5, 2022

View reviewed changes

patmmccann added the do not merge label Jul 5, 2022

patmmccann reviewed Jul 5, 2022

View reviewed changes

patmmccann added the taxonomy label Jul 5, 2022

bwhisp requested a review from patmmccann July 6, 2022 10:22

patmmccann reviewed Jul 6, 2022

View reviewed changes

bwhisp requested review from Fawke and patmmccann July 8, 2022 08:33

Fawke reviewed Jul 12, 2022

View reviewed changes

bwhisp force-pushed the DC-2488-1plusX-RTD-module branch from 98f4e94 to 04ae259 Compare July 13, 2022 08:36

bwhisp added 3 commits July 13, 2022 10:59

Empty shell for 1plusX RTD submodule (#1)

3cac5cc

Submodule initialization & functions (init; getBidRequestData) skelet…

a8bfc74

…ons (#2)

Testing for init function (#3)

a54ccc5

bwhisp and others added 15 commits July 13, 2022 10:59

Requesting Profile API for Data (#4)

d07ef85

Extract PAPI response & implementation example

2ec7ed6

Transmitting targeting data to bidder adapters

452f93a

Markdown file documentation

598b5b6

Code cleaned & jsDoc completed

223dd0a

Change contact email + beautify parameters table + fix type in param …

2fe4e8d

…name

Change customerId param type to string in doc

6e034f3

Add 1plusXRtdProvider as submodule of rtdModule

a0fd461

Add more tests on extractConfig amongst others

4267664

Remove SUPPORTED_BIDDERS limitation

136882c

Remove supported bidders from docs

7a0cae4

Write to site.content.data.segment.id & keep legacy support for appnexus

bd1108b

Change location of googleTagServices

b4c4124

Add segtax for site.content.data

1c0c339

Handle audiences for appNexus by putting them in config.appnexusAucti…

7d91251

…onKeywords

bwhisp force-pushed the DC-2488-1plusX-RTD-module branch from 04ae259 to 7d91251 Compare July 13, 2022 08:59

bwhisp requested a review from Fawke July 13, 2022 13:55

Fawke approved these changes Jul 14, 2022

View reviewed changes

patmmccann approved these changes Jul 14, 2022

View reviewed changes

patmmccann removed the do not merge label Jul 14, 2022

patmmccann merged commit b613039 into prebid:master Jul 14, 2022

bwhisp mentioned this pull request Aug 29, 2022

Defining the compatibility chart of 1plusX RTD module #8910

Closed

patmmccann mentioned this pull request Sep 1, 2022

Appnexus Bid Adapter: add support to read ortb2 keywords #8939

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

1plusX RTD submodule: New RTD Module #8614

1plusX RTD submodule: New RTD Module #8614

bwhisp commented Jun 28, 2022 •

edited

Loading

bwhisp Jun 28, 2022

bwhisp Jun 28, 2022

bwhisp Jun 28, 2022

patmmccann Jul 5, 2022

patmmccann Jul 5, 2022

bwhisp Jul 6, 2022

patmmccann Jul 6, 2022

bwhisp Jun 28, 2022

patmmccann Jul 5, 2022

bwhisp Jun 28, 2022

Fawke left a comment

patmmccann Jul 5, 2022

bwhisp Jul 6, 2022

patmmccann Jul 5, 2022

bwhisp Jul 6, 2022

patmmccann Jul 6, 2022

bwhisp Jul 6, 2022

patmmccann Jul 5, 2022

bwhisp Jul 6, 2022

bwhisp commented Jul 5, 2022

bwhisp commented Jul 6, 2022 •

edited

Loading

patmmccann commented Jul 6, 2022

patmmccann Jul 6, 2022

bwhisp Jul 6, 2022

bwhisp Jul 6, 2022

bwhisp Jul 7, 2022

Fawke left a comment

bwhisp commented Jul 12, 2022

Fawke commented Jul 13, 2022 •

edited

Loading

bwhisp commented Jul 13, 2022

Fawke left a comment

bwhisp commented Jul 14, 2022 •

edited

Loading

patmmccann commented Jul 14, 2022

		const currentSite = deepAccess(bidderConfigCopy, 'ortb2.site')
		const updatedSite = mergeDeep(currentSite, site);

1plusX RTD submodule: New RTD Module #8614

1plusX RTD submodule: New RTD Module #8614

Conversation

bwhisp commented Jun 28, 2022 • edited Loading

Type of change

Description of change

Other information

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fawke left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bwhisp commented Jul 5, 2022

bwhisp commented Jul 6, 2022 • edited Loading

patmmccann commented Jul 6, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fawke left a comment

Choose a reason for hiding this comment

bwhisp commented Jul 12, 2022

Fawke commented Jul 13, 2022 • edited Loading

bwhisp commented Jul 13, 2022

Fawke left a comment

Choose a reason for hiding this comment

bwhisp commented Jul 14, 2022 • edited Loading

patmmccann commented Jul 14, 2022

bwhisp commented Jun 28, 2022 •

edited

Loading

bwhisp commented Jul 6, 2022 •

edited

Loading

Fawke commented Jul 13, 2022 •

edited

Loading

bwhisp commented Jul 14, 2022 •

edited

Loading