Experimental Fledge Module & OpenXOrtb Adapter: initial release and bidder support #8716

kenan-gillet · 2022-07-20T16:11:12Z

Type of change

Feature

Description of change

Allow running/rendering fledge ad when prebid ad wins

Other information

demo is at https://codinginadtech.com/prebid-live-tests/fledge/?pbjs_debug=true&test=true&use_test_ad=true&fledge_enabled=true

Co-authored-by: Laurentiu Badea laurentiu.badea@openx.com
Co-authored-by: Luigi Sayson luigi.sayson@openx.com
Co-authored-by: Kenan Gillet kenan.gillet@openx.com

lgtm-com · 2022-07-20T16:18:37Z

This pull request introduces 4 alerts when merging 8be2ee1 into cb7c510 - view on LGTM.com

new alerts:

3 for Unused variable, import, function or class
1 for Unneeded defensive code

kenan-gillet · 2022-07-20T16:25:07Z

demo is at https://codinginadtech.com/prebid-live-tests/fledge/?pbjs_debug=true&test=true&use_test_ad=true&fledge_enabled=false

Co-authored-by: Laurentiu Badea <laurentiu.badea@openx.com> Co-authored-by: Luigi Sayson <luigi.sayson@openx.com> Co-authored-by: Kenan Gillet <kenan.gillet@openx.com>

lgtm-com · 2022-07-20T16:41:56Z

This pull request introduces 1 alert when merging 16103ac into cb7c510 - view on LGTM.com

new alerts:

1 for Unneeded defensive code

piotrj-rtbh · 2022-07-21T11:48:19Z

demo is at https://codinginadtech.com/prebid-live-tests/fledge/?pbjs_debug=true&test=true&use_test_ad=true&fledge_enabled=false

Unfortunately, regardless of value of the fledge_enabled flag: true or false, the demo page sends an error to the browser's console:
prebid.js:5 Prebid openx ERROR: Bidder openx failed to interpret the server's response. Continuing without bids null TypeError: Cannot use 'in' operator to search for 'nbr' in at prebid.js:12:4571

patmmccann · 2022-07-21T14:21:14Z

@brodrigu are you able to arrange a reviewer?

kenan-gillet · 2022-07-21T14:58:18Z

thank you piotrj-rtbh

Unfortunately, regardless of value of the fledge_enabled flag: true or false, the demo page sends an error to the browser's console: prebid.js:5 Prebid openx ERROR: Bidder openx failed to interpret the server's response. Continuing without bids null TypeError: Cannot use 'in' operator to search for 'nbr' in at prebid.js:12:4571

thanks, seems to be unrelated as it looks like the response.body is null

#8725 should avoid the unnecessary logging

src/adapters/bidderFactory.js

src/fledgeManager.js

musikele · 2022-07-26T08:37:46Z

Hey @kenan-gillet and @patmmccann - I have a few questions in order to review this PR; keep in mind that I've not yet looked at the code. I first have to understand what is Fledge exactly.

Is this PR related to this issue Introducing a Fledge module #7634 that describes the introduction of a Fledge module?
is this PR meant to be merged ? Since there's the word POC in the title I assume it is not. Do I have to review just the general approach?
What should I focus on?

patmmccann · 2022-07-27T18:43:39Z

Hey @kenan-gillet and @patmmccann - I have a few questions in order to review this PR; keep in mind that I've not yet looked at the code. I first have to understand what is Fledge exactly.

Is this PR related to this issue Introducing a Fledge module #7634 that describes the introduction of a Fledge module?

Yes

is this PR meant to be merged ? Since there's the word POC in the title I assume it is not. Do I have to review just the general approach?

It is meant to be merged, I think POC is referring to the fact that Fledge itself is still in a POC state with origin trials live.

What should I focus on?

I'm not sure, the main functionalities are detection of a fledge eligible auction (likely to occur on chrome 104 with privacy sandbox opted into), passing of the auctionconfig from the bidder to the module, and submission of auction config to an external api. I suppose focus may be on confirming all of those seem to operate roughly as expected.

However, it seems @brodrigu has kindly contributed comments; I would be comfortable taking his review as the second review if he is as well.

…nConfigs

@piotrj-rtbh

``` prebid.js:5 Prebid openx ERROR: Bidder openx failed to interpret the server's response. Continuing without bids null TypeError: Cannot use 'in' operator to search for 'nbr' in at prebid.js:12:4571 ``` Thanks @piotrj-rtbh

- make fledgeManager into a module - add top-level auction handling - add support for registering component auction to GPT ad slot - remove hard coded demo auction config, ensure auctionSignals is not undefined (prebid#61) Co-authored-by: Laurentiu Badea <laurentiu.badea@openx.com> Co-authored-by: Luigi Sayson <luigi.sayson@openx.com> Co-authored-by: Kenan Gillet <kenan.gillet@openx.com>

dgirardi · 2022-08-18T15:13:05Z

modules/fledge.js

+  const MODULE = 'fledge secure';
+  const fledgeAuctionConfig = getAuctionConfig(adObject);
+  if (fledgeAuctionConfig) {
+    logWarn(MODULE, `Ad id ${adObject.adId} is being fledged`, fledgeAuctionConfig);


Are warnings appropriate here? it doesn't appear like anything went wrong.

These merely indicate our interest in seeing that particular message when it happens during development.
We will change to more appropriate logging levels.

dgirardi · 2022-08-18T15:19:26Z

modules/fledge.js

+    return targetAdUnitCode == adUnitCode;
+  });
+  if (componentAuctionsForAdUnitCode.length == 0) {
+    logInfo(MODULE, `NOT running runAdAuction for adUnitCode=${targetAdUnitCode} since there are no componentAuctions`);


conversely this sounds like a warning to me :)

dgirardi · 2022-08-18T15:24:43Z

modules/fledge.js

+
+export function getAuctionConfig(bid) {
+  const targetAdUnitCode = bid.adUnitCode;
+  const componentAuctionsForAdUnitCode = _componentAuctions.filter((componentAuction) => {


you can run an auction with multiple adUnits that have the same code, you can also run multiple auctions on the same adUnits. Does this approach work for those cases?

bids have a transactionId that might work better as a filter. They are unique for each auction-adUnit pair, and you should have their association with the fledge configs through their bidId.

adUnitCode is needed to find the GPT slot associated with the adUnit. With GAM, which may well be most of the use cases, the fledge auction config is set on the GPT slot and GPT triggers the auction.

When GAM isn't in use, the configs could be organized a different way, true, but this depends on what the buyers expect to bid on and those bidding functions would then need to take into account the whole environment they bid in.

Would you happen to know the use case for sharing adUnitCode across different adunits ? Is this a common case ?

Twin ad unit codes.

Even when using GAM, it looks easier to me to filter by transactionId. If you don't you'll have to filter by adUnitCode and auctionId, and that does not cover the repeated adUnitCode case.

dgirardi · 2022-08-18T15:33:42Z

modules/fledge.js

+  }
+
+  // fallback if there is no top-level seller defined
+  const randomIdx = Math.floor(Math.random() * componentAuctionsForAdUnitCode.length);


I don't think this makes sense, won't it result in fewer / lower bids overall, since it excludes the original winning bid (that may be higher than fledge's)? to me it seems like a top level auction managed by Prebid is required to avoid throwing that away, I'm not sure that it even makes sense to allow configurable seller / decision logic.

The expectation for a correctly configured publisher is for the decisionLogicUrl to be defined and the "multiple ssp with top level support" path be taken. The decision logic script will likely be provided by prebid as a common resource in some way.

Due to the special requirements for serving it*), it cannot be bundled in, so for the moment we made it configurable.

*) the response header x-allow-fledge: true must be passed when serving the decision logic scripts. It also has to come from the same domain as the seller.

That's reasonable, but if no decision logic is available, to me it'd seem better to discard fledge rather than awarding the auction to a random fledge bidder.

dgirardi · 2022-08-18T15:40:51Z

modules/fledge.js

+        logWarn(MODULE, `Ad id ${adObject.adId} was NOT fledged, rendering normal ad`);
+      }
+      // we use the default secure rendering
+      next(reply, data, adObject, {isFledge: true});


I think isFledge here should be true only if you got a fledgeAdUri back from navigator.runAdAuction.

dgirardi · 2022-08-18T15:45:52Z

modules/fledge.js

+
+export function runAdAuction(bid, next, doc, id, options) {
+  if (bid.mediaType == 'video') {
+    logWarn(MODULE, 'Video fledge ads not yet supported.');


I don't think native would work either, since it can't be reduced to a single URL.

dgirardi · 2022-08-18T15:50:01Z

modules/fledge.js

+      if (fledgeAdUri) {
+        logWarn(MODULE, `Ad id ${adObject.adId} has been fledged by ${fledgeAdUri}`);
+        adObject.ad = '';
+        adObject.adUrl = fledgeAdUri;


most other things in adObject would be incorrect, and I'm worried that will cause things to break - in fact I think that's inevitable in the long run. Is it feasible to create a new object here, or would that force you to still pick incorrect values? Maybe it would be better to run the fledge auction from the creative directly.

kenan-gillet · 2022-08-25T21:53:37Z

hello,
thank you all for your comments and insights.
We had some internal discussions about the running/rendering of fledge ads and we would like to re-focus our effort on merging the much simpler, useful, less experimental GPT use case first.

Also, we will create a separate PR to continue working on prebid running the fledge auction and rendering the winning fledge ads if people are still interested.

patmmccann · 2022-08-31T16:59:20Z

@bwschmidt would appreciate your review as second review here

dgirardi

You were not kidding, this is a lot simper. The linter is complaining right now, but if once fixed tests pass this LGTM.

modules/fledgeForGpt.js

bwschmidt · 2022-09-01T02:23:31Z

@patmmccann @kenan-gillet the module itself lgtm. Enablement does not seem clear to me.

The readme indicates

enabling fledge support for the adunit

ortb2Imp.ext.ae must be 1

ortb2Imp: {
    ext: {
        ae: 1
    }
}

however i do not see this actually referenced in the code. Is fledge meant to be enabled globally or per ad slot? I think its working globally per bidder now and the openx adapter is doing this

    if (bidderRequest.fledgeEnabled) {
      imp.ext.ae = bid?.ortb2Imp?.ext?.ae
    }

i think that is fine i would just make the readme more clear

kenan-gillet · 2022-09-01T17:33:13Z

thanks @bwschmidt , I made clearer that it is needs to be enabled at 3 different levels

@piotrj-rtbh

…idder support (prebid#8716) * Fledge POC: adding run ad auction and rendering with openxOrtbBidAdapter Co-authored-by: Laurentiu Badea <laurentiu.badea@openx.com> Co-authored-by: Luigi Sayson <luigi.sayson@openx.com> Co-authored-by: Kenan Gillet <kenan.gillet@openx.com> * Remove defensive coding: gtpSlotInfo is always an object * Change onBidderAuctionResponse callback to specialized onFledgeAuctionConfigs * openxOrtbBidAdapter: avoid error logging when response body is null ``` prebid.js:5 Prebid openx ERROR: Bidder openx failed to interpret the server's response. Continuing without bids null TypeError: Cannot use 'in' operator to search for 'nbr' in at prebid.js:12:4571 ``` Thanks @piotrj-rtbh * Fledge Modularized - make fledgeManager into a module - add top-level auction handling - add support for registering component auction to GPT ad slot - remove hard coded demo auction config, ensure auctionSignals is not undefined (prebid#61) Co-authored-by: Laurentiu Badea <laurentiu.badea@openx.com> Co-authored-by: Luigi Sayson <luigi.sayson@openx.com> Co-authored-by: Kenan Gillet <kenan.gillet@openx.com> * Split GPT handling into its own module * Remove fledge run/rendered by prebid * Fix lint issues and name inconsistency * Update unit test after switching to GPT only * fix/remove no more relevant tests * fledgeForGpt: clarify documentation of configuration Co-authored-by: Laurentiu Badea <laurentiu.badea@openx.com> Co-authored-by: Luigi Sayson <luigi.sayson@openx.com>

@piotrj-rtbh

…idder support (prebid#8716) * Fledge POC: adding run ad auction and rendering with openxOrtbBidAdapter Co-authored-by: Laurentiu Badea <laurentiu.badea@openx.com> Co-authored-by: Luigi Sayson <luigi.sayson@openx.com> Co-authored-by: Kenan Gillet <kenan.gillet@openx.com> * Remove defensive coding: gtpSlotInfo is always an object * Change onBidderAuctionResponse callback to specialized onFledgeAuctionConfigs * openxOrtbBidAdapter: avoid error logging when response body is null ``` prebid.js:5 Prebid openx ERROR: Bidder openx failed to interpret the server's response. Continuing without bids null TypeError: Cannot use 'in' operator to search for 'nbr' in at prebid.js:12:4571 ``` Thanks @piotrj-rtbh * Fledge Modularized - make fledgeManager into a module - add top-level auction handling - add support for registering component auction to GPT ad slot - remove hard coded demo auction config, ensure auctionSignals is not undefined (#61) Co-authored-by: Laurentiu Badea <laurentiu.badea@openx.com> Co-authored-by: Luigi Sayson <luigi.sayson@openx.com> Co-authored-by: Kenan Gillet <kenan.gillet@openx.com> * Split GPT handling into its own module * Remove fledge run/rendered by prebid * Fix lint issues and name inconsistency * Update unit test after switching to GPT only * fix/remove no more relevant tests * fledgeForGpt: clarify documentation of configuration Co-authored-by: Laurentiu Badea <laurentiu.badea@openx.com> Co-authored-by: Luigi Sayson <luigi.sayson@openx.com>

Fledge POC: adding run ad auction and rendering with openxOrtbBidAdapter

16103ac

Co-authored-by: Laurentiu Badea <laurentiu.badea@openx.com> Co-authored-by: Luigi Sayson <luigi.sayson@openx.com> Co-authored-by: Kenan Gillet <kenan.gillet@openx.com>

kenan-gillet force-pushed the master_with_fledge branch from 8be2ee1 to 16103ac Compare July 20, 2022 16:34

Remove defensive coding: gtpSlotInfo is always an object

7088315

patmmccann requested a review from dgirardi July 21, 2022 14:20

patmmccann added the feature label Jul 21, 2022

dgirardi reviewed Jul 21, 2022

View reviewed changes

src/adapters/bidderFactory.js Outdated Show resolved Hide resolved

src/adapters/bidderFactory.js Outdated Show resolved Hide resolved

src/fledgeManager.js Outdated Show resolved Hide resolved

brodrigu reviewed Jul 21, 2022

View reviewed changes

src/fledgeManager.js Outdated Show resolved Hide resolved

src/fledgeManager.js Outdated Show resolved Hide resolved

src/fledgeManager.js Outdated Show resolved Hide resolved

ChrisHuie assigned patmmccann and unassigned patmmccann Jul 25, 2022

patmmccann requested a review from musikele July 25, 2022 17:04

patmmccann assigned musikele and dgirardi Jul 25, 2022

patmmccann linked an issue Jul 27, 2022 that may be closed by this pull request

Introducing a Fledge module #7634

Closed

laurb9 and others added 2 commits July 29, 2022 18:57

Change onBidderAuctionResponse callback to specialized onFledgeAuctio…

1297681

…nConfigs

patmmccann changed the title ~~Fledge POC: adding run ad auction and rendering with openxOrtbBidAdapter~~ Fledge Module: adding run ad auction and rendering with openxOrtbBidAdapter Aug 3, 2022

patmmccann changed the title ~~Fledge Module: adding run ad auction and rendering with openxOrtbBidAdapter~~ Fledge Module & OpenXOrtb Adapter: initial release and bidder support Aug 3, 2022

patmmccann changed the title ~~Fledge Module & OpenXOrtb Adapter: initial release and bidder support~~ Experimental Fledge Module & OpenXOrtb Adapter: initial release and bidder support Aug 17, 2022

Merge branch 'master' into master_with_fledge

5eec115

dgirardi reviewed Aug 18, 2022

View reviewed changes

Split GPT handling into its own module

286e2c1

Remove fledge run/rendered by prebid

8866e10

JoelPM mentioned this pull request Aug 25, 2022

Introducing a Fledge module #7634

Closed

patmmccann removed the request for review from musikele August 31, 2022 16:58

patmmccann unassigned musikele Aug 31, 2022

dgirardi reviewed Aug 31, 2022

View reviewed changes

modules/fledgeForGpt.js Outdated Show resolved Hide resolved

kenan-gillet added 3 commits August 31, 2022 11:21

Fix lint issues and name inconsistency

d13bf45

Update unit test after switching to GPT only

b560fd1

fix/remove no more relevant tests

65f15b7

fledgeForGpt: clarify documentation of configuration

c930324

dgirardi approved these changes Sep 1, 2022

View reviewed changes

patmmccann approved these changes Sep 1, 2022

View reviewed changes

patmmccann merged commit ab1282b into prebid:master Sep 1, 2022

laurb9 mentioned this pull request Nov 4, 2022

Define how server-side adapters should pass fledge auction config prebid/prebid-server#2411

Closed

This was referenced Nov 8, 2022

[RTB House] Process FLEDGE request/response rtbh-lotani/Prebid.js#4

Merged

RTB House Bid Adapter: Process FLEDGE request/response #9215

Merged

RTB House Bid Adapter: Process FLEDGE request/response rtbh-lotani/Prebid.js#5

Merged

laurb9 mentioned this pull request Apr 20, 2023

Documentation: Add FLEDGE aka Protected Audience API examples #9839

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Experimental Fledge Module & OpenXOrtb Adapter: initial release and bidder support #8716

Experimental Fledge Module & OpenXOrtb Adapter: initial release and bidder support #8716

kenan-gillet commented Jul 20, 2022 •

edited

Loading

lgtm-com bot commented Jul 20, 2022

kenan-gillet commented Jul 20, 2022

lgtm-com bot commented Jul 20, 2022

piotrj-rtbh commented Jul 21, 2022

patmmccann commented Jul 21, 2022

kenan-gillet commented Jul 21, 2022

musikele commented Jul 26, 2022

patmmccann commented Jul 27, 2022

dgirardi Aug 18, 2022

laurb9 Aug 19, 2022

dgirardi Aug 18, 2022

dgirardi Aug 18, 2022

laurb9 Aug 19, 2022

dgirardi Aug 19, 2022 •

edited

Loading

dgirardi Aug 18, 2022

laurb9 Aug 19, 2022

dgirardi Aug 19, 2022

dgirardi Aug 18, 2022

dgirardi Aug 18, 2022

dgirardi Aug 18, 2022

kenan-gillet commented Aug 25, 2022

patmmccann commented Aug 31, 2022

dgirardi left a comment

bwschmidt commented Sep 1, 2022

kenan-gillet commented Sep 1, 2022

Experimental Fledge Module & OpenXOrtb Adapter: initial release and bidder support #8716

Experimental Fledge Module & OpenXOrtb Adapter: initial release and bidder support #8716

Conversation

kenan-gillet commented Jul 20, 2022 • edited Loading

Type of change

Description of change

Other information

lgtm-com bot commented Jul 20, 2022

kenan-gillet commented Jul 20, 2022

lgtm-com bot commented Jul 20, 2022

piotrj-rtbh commented Jul 21, 2022

patmmccann commented Jul 21, 2022

kenan-gillet commented Jul 21, 2022

musikele commented Jul 26, 2022

patmmccann commented Jul 27, 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

Choose a reason for hiding this comment

dgirardi Aug 19, 2022 • edited Loading

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

kenan-gillet commented Aug 25, 2022

patmmccann commented Aug 31, 2022

dgirardi left a comment

Choose a reason for hiding this comment

bwschmidt commented Sep 1, 2022

enabling fledge support for the adunit

kenan-gillet commented Sep 1, 2022

kenan-gillet commented Jul 20, 2022 •

edited

Loading

dgirardi Aug 19, 2022 •

edited

Loading