Prebid Server adapter: fledge support #9342

dgirardi · 2022-12-14T19:57:16Z

Type of change

Feature

Description of change

This adds untested support for fledge in the PBS adapter, following the spec described here.

In addition this also refactors some of the other logic around fledge:

the interpretResponse return value API has been changed from {bids: [...], fledgeAuctionConfigs: [{bidId, ...config}] } to {bids: [...], fledgeAuctionConfigs: [{bidId, config}]}
the addComponentAuction signature has been changed from (bidRequest, fledgeAuctionConfig) to (adUnitCode, fledgeAuctionConfig)
the logic to flag bidderRequest.fledgeEnabled has been moved to the fledge module
ortbConverter now automatically sets imp.ext.ae for all adapters; and parses ext.prebid.fledge for those that choose to use PBS extensions.

Other information

Closes #9080
Documentation TBD

…fig} to {bidId, config: fledgeAuctionConfig}

robertrmartinez · 2023-02-01T16:02:32Z

test/spec/modules/fledge_spec.js

@@ -35,3 +42,166 @@ describe('fledgeForGpt module', function() {
    });


prob does not matter but this is still calling bidRequest instead of adUnitCode for addComponentAuctionHook

Line 40 in fledge_spec

JoelPM · 2023-03-01T18:15:55Z

@laurb9 - mind giving this a review?

laurb9 · 2023-03-04T03:23:33Z

@dgirardi I tested this PR with openx adapter, both direct and via prebid-server (both varieties), and it is working for me.

Setup:
I set up three bidders on a local test page: openx (because it supports FLEDGE already), plus two s2s configs with custom endpoints for PBS-Go and PBS-Java, both also calling aliased openx.
Local test bidder that responds with a bid and fledge auction config like the openx endpoint would.
Started dev Prebid.js with fledgeForGpt,openxOrtbBidAdapter,prebidServerBidAdapter modules.
Started latest PBS-Go and PBS-Java from their repos, configured with that same local test bidder endpoint for openx.

Result:
I see all three "fledgeForGpt register component auction config" messages corresponding to each bidder response on the GPT slot.

laurb9 · 2023-03-04T03:37:44Z

I've also tested on a stable Chrome without fledge support, and I see that imp.ext.ae is no longer being sent and the eventual s2s fledge auction configs get the expected warning:

Prebid WARNING: Received fledge auction configuration for an impression that was not in the request or did not ask for it {impid: 'div-gpt-ad-1460505748561-0', bidder: 'openx-via-pbs-go', adapter: 'openx', config: {…}}....

But the fledge configs coming from adapters still attempt to register the component auction, as the original code made no attempt to filter them either. I see it as more of a consistency issue now, as nothing will happen either way - or we could disable the module altogether so no fledge processing takes place.

laurb9 · 2023-03-04T03:44:38Z

modules/fledgeForGpt.js

@@ -31,12 +32,10 @@ export function init(cfg) {
  }
 }

-export function addComponentAuctionHook(next, bidRequest, componentAuctionConfig) {
+export function addComponentAuctionHook(next, adUnitCode, componentAuctionConfig) {


Would a hook not benefit more from seeing the original bidRequest ?

possibly, but we don't always have it. In prebid server we may have multiple requests (the fledge config references an imp, but there can be any number of bidders (requests) for that imp). With allowUnknownBidderCodes we may also have zero.

modules/fledgeForGpt.js

Co-authored-by: Laurentiu Badea <laurb9@users.noreply.github.com>

…ledge

patmmccann · 2023-03-10T16:39:37Z

@laurb9 how do things look now?

laurb9 · 2023-03-13T20:35:59Z

modules/fledgeForGpt.js

 }
+
+export function markBidsForFledge(next, bidderRequests) {


This function enables FLEDGE for bidderRequests, should the name be markBidderRequestsForFledge or just markForFledge ?

laurb9

Looks good to me and it works. After playing with it I noticed a couple new and inherited behaviors that don't impact functionality but can be misinterpreted, so I added a few comments.

Also, the log message fledgeForGpt isEnabled: true is emitted on a non-FLEDGE supporting browser, with no indication that we know it will not work and that imp.ext.ae is removed from explicit pub-supplied configuration. I've come to think it is more helpful to see the final computed state of the enablement that considers the browser support, perhaps with some detail about how it was derived.

laurb9 · 2023-03-14T05:28:35Z

modules/fledgeForGpt.js

+  (ortbResponse.ext?.prebid?.fledge?.auctionconfigs || []).forEach((cfg) => {
+    const impCtx = context.impContext[cfg.impid];
+    if (!impCtx?.imp?.ext?.ae) {
+      logWarn('Received fledge auction configuration for an impression that was not in the request or did not ask for it', cfg, impCtx?.imp);


validation behavior is different between PBS and regular adapter. If adapters adopt this method it may become a non-issue but it may be confusing as is.

I am not sure this validation makes sense outside of here. There are two things we are checking here -

the request should have set imp.ext.ae; does this check make sense for an adapter that (in general) may not be using ORTB at all?

the fledge config should refer to an imp that existed in the request. this is necessary for PBS because the protocol pairs a fledge config with impid. But, for client-side adapters, they must provide a valid bidId instead - the check is here, although there's no warning.

I can add a warning for 2, I'm not sure about 1.

Should be fine to leave it as it is now and update in a later iteration if it becomes a problem with usage.

laurb9 · 2023-03-14T05:37:17Z

modules/fledgeForGpt.js

@@ -48,5 +47,50 @@ export function addComponentAuctionHook(next, bidRequest, componentAuctionConfig
    logWarn(MODULE, `unable to register component auction config for: ${adUnitCode} x ${seller}.`);


Should addComponentAuction be skipped altogether if FLEDGE is not supported ?
On such a browser, receiving unsolicited auction configs from an adapter will print this misleading under the circumstances warning.

why is the warning misleading? to me it makes perfect sense: if your browser does not support flegde, bidders should not be trying to run fledge auctions and I'd want to be warned if they do.

The message "unable to do something" tells me the expectation was that it should have been able to, so something went wrong.
If it said "ignored unsolicited fledge configs", that would be more accurate, but I understand we may not want to have a log message for every specific condition

* upstream/master: Prebid Server adapter: fledge support (prebid#9342) Taboola Bid Adapter: resolve AUCTION_PRICE macro (prebid#9735) Revert "IntentIQ Analytics Module : initial release (prebid#9322)" (prebid#9734) IntentIQ Analytics Module : initial release (prebid#9322) Increment version to 7.44.0-pre Prebid 7.43.0 release Core: allow restriction of cookies / localStorage through `bidderSettings.*.storageAllowed` (prebid#9660) Add 9 Dots Media alias (prebid#9699) Smaato: Adapters that accept geolocation data from bid parameters should also accept it from ortb2.(device|user).geo (prebid#9676) (prebid#9725) Adloox AdServer Video : lengthen test timeouts (prebid#9728) RTBHouse Bid Adapter: change `source.tid` to contain `auctionId` and populate imp-level `ext.tid` (prebid#9726) chore: update `getAudiencesAsBidderOrtb2` implementation and test (prebid#9720) CORE: allow to disable setting the pbjs global variable (prebid#9568) Display.io Bid Adapter: ad request parameters renaming, user session saving (prebid#9553) CORE: add bid to winningBids when marking as used (prebid#9612) Concert Bid Adapter: enable support for GPP consent and remove user sync (prebid#9700) Sonobi Bid Adapter: add IntentIq Id (prebid#9649) added fix and support for multibid module (prebid#9602) Update Permutive RTD documentation (prebid#9697) Adkernel Bid Adapter: add adlive.io alias (prebid#9714) FPD Enrichment: use low entropy method by default to fetch user agent data (prebid#9711) GumGum Bid Adapter : send gpp data in bidrequest (prebid#9707) Adagio Bid Adapter : add new params `splitKeyword` and `dl` to bidRequest payload (prebid#9694) fix lint and test failures Increment version to 7.43.0-pre Prebid 7.42.0 release Fluct Bid Adapter: add user sync support (prebid#9651) VIS.X fix onTimeout data (prebid#9657) ShowHeroes Bid Adapter: added support for USP (prebid#9681) Core: improve FPD enrichment (prebid#9659) changed the URL (prebid#9698) Permutive RTD Module: migrate appnexus to ortb2 (prebid#9630) Disable describe.only and it.only (prebid#9693) DistroScale bidder enhancement (prebid#9641) minutemediaplus Bid Adapter - pass gpp, sua and bid data to server. (prebid#9637) LiveIntent UserId module: update LiveConnect dependency (prebid#9672) Criteo Bid Adapter: reinforce adomain type in case of missmatch (prebid#9687) SmartyTech Bid Adapter : add size parameters (prebid#9692) Revert "Nativo Bid Adapter: adding UserId support (prebid#9583)" (prebid#9691) GDPR consent management: accept static config without `getTCData` (prebid#9664) Kulturemedia Bid Adapter: New Adapter (prebid#9613) Nativo Bid Adapter: adding UserId support (prebid#9583) Underdog Media Bid Adapter: Switch request to method to POST (prebid#9547) ZetaGlobalSsp: provide schain (prebid#9678) Next Millennium Bid Adapter : added `imp[].id` required parameter for openrtb 2.5 request. (prebid#9675) Increment version to 7.42.0-pre Prebid 7.41.0 release DFP video adserver module: set `description_url` to pub's URL by default; do not skip setting it if `cache.url` is set (prebid#9665) support the timeout parameter in the conversant adapter (prebid#9673) Browsi Bid Adapter: initial release (prebid#9562) feat(permutiveRtd): add `ix` and custom cohort `ortb2.user.data` (prebid#9631) Freewheel SSP Adapter: add prebid version in ad request (prebid#9667) Yandex Bid Adapter: (prebid#9604) Bump webpack from 5.74.0 to 5.76.0 (prebid#9668) Deleted the default empty string from userConsent argument in the module's init-function. (prebid#9663) AdUp Technology bid adapter: avoid modification of bid request (prebid#9656) NoBid Bid Adapter: support for Floors (prebid#9635) Freewheel SSP Bid Adapter : support userIdAsEids (prebid#9655) Missena: add userEids, add network and cpm to tracking (prebid#9645) IX Bid Adapter: update additional consent field (prebid#9650) Aduptech Bid Adapter : add GVLID (prebid#9658) Core: make video cache timeout configurable (prebid#9578) Delete flocIdSystem.js (prebid#9652) TheMediaGrid Bid Adapter : support gpp (prebid#9629) Stv Bid Adapter : initial adapter release (prebid#9533) CleanMediaNet Bid Adapter : add userid support and update testing (prebid#9608) Update creative.html (prebid#9648) PubWise Bid Adapter: support video and improve tests (prebid#9576) Increment version to 7.41.0-pre Prebid 7.40.0 release Rubicon Bid Adapter: add size 1x2 (prebid#9644) main>modules\neuwoRtdProvider.js > apiUrl format handling improved, removed unnecessary parameter integrationExamples\gpt\neuwoRtdProvider_example.html > fixed render-step handling on warning (prebid#9646) Core: fix native render when adUnits defines `mediaTypes.native.ortb` but adapter replies with "legacy" native bid (prebid#9638) kueezRtb Bid Adapter: pass sua data to server. (prebid#9643) update Mediago & Discovery BidAdapter:remove size filter (prebid#9585) Permutive RTD Module: migrate magnite to ortb2 (prebid#9555) Vidazoo Bid Adapter: pass sua params. (prebid#9636) ADJS-1271-send-envelope-param-for-lexicon (prebid#9634) Nexx360 Bid Adapter: native support added and ortbConverter usage (prebid#9626) PBjs Core: do not rely on an extendable `window.Promise` (prebid#9558) TheMediaGrid Bid Adapters : do not use jwp segments from bid.rtd field (prebid#9627) read video size from playerSize (prebid#9625) Lemma Digital Bid Adapter : initial adapter release (prebid#9532) smallfix on response validation (prebid#9623) Updated adf adapter to support native with type; use ortb request for natives (prebid#9616) kargo adapter - adding prebid version to requests (prebid#9620) Rubicon bid adapter: remove pchain support (prebid#9621) trigger build revert tag out markWinningBidAsUsed entirely remove unnecessary feature tag tag out ORTB video conversion utils tag out video-related code in native.js tag out video-related code in renderAd replace callPrebidCache with getHook result tag out adpod-related logic Define "VIDEO" compile time feature flag

pm-nitin-nimbalkar · 2023-04-04T12:41:21Z

@dgirardi Can you please include the fledge example in integrationExamples/gpt folder for reference ?

* Move fledge logic to fledge module * Change fledge interpretResponse API: from {bidId, ...fledgeAuctionConfig} to {bidId, config: fledgeAuctionConfig} * Fledge ORTB processors * PBS adapter fledge impl * Update modules/fledgeForGpt.js Co-authored-by: Laurentiu Badea <laurb9@users.noreply.github.com> * fix fledge tests to pass adUnitCode * Update text * Fix test case to reflect check on `navigator.joinAdInterestGroup` * Adjust warnings * Name change --------- Co-authored-by: Laurentiu Badea <laurb9@users.noreply.github.com>

dgirardi added 4 commits December 14, 2022 09:37

Move fledge logic to fledge module

b868186

Change fledge interpretResponse API: from {bidId, ...fledgeAuctionCon…

b5aa696

…fig} to {bidId, config: fledgeAuctionConfig}

Fledge ORTB processors

a9cdc9c

PBS adapter fledge impl

0c26667

ChrisHuie requested a review from mmoschovas December 19, 2022 12:33

ChrisHuie assigned mmoschovas Dec 19, 2022

ChrisHuie added the maintenance label Dec 19, 2022

ChrisHuie requested a review from robertrmartinez December 19, 2022 12:33

ChrisHuie assigned robertrmartinez Dec 19, 2022

dgirardi mentioned this pull request Jan 25, 2023

Prebid Core: emit seatnonbid from prebid server #9453

Merged

1 task

robertrmartinez reviewed Feb 1, 2023

View reviewed changes

laurb9 reviewed Mar 4, 2023

View reviewed changes

modules/fledgeForGpt.js Outdated Show resolved Hide resolved

dgirardi and others added 6 commits March 7, 2023 13:50

Merge branch 'master' into pbs-fledge

37f3609

Update modules/fledgeForGpt.js

6e63a9c

Co-authored-by: Laurentiu Badea <laurb9@users.noreply.github.com>

fix fledge tests to pass adUnitCode

404749b

Merge branch 'pbs-fledge' of github.com:dgirardi/Prebid.js into pbs-f…

f9d7d7c

…ledge

Update text

fb897e7

Fix test case to reflect check on navigator.joinAdInterestGroup

c05bba2

patmmccann requested review from laurb9 and robertrmartinez and removed request for laurb9 March 10, 2023 16:39

laurb9 reviewed Mar 13, 2023

View reviewed changes

laurb9 approved these changes Mar 14, 2023

View reviewed changes

Merge branch 'master' into pbs-fledge

555e2ef

dgirardi added 2 commits March 14, 2023 10:32

Adjust warnings

827890d

Name change

abe74d1

mmoschovas approved these changes Mar 17, 2023

View reviewed changes

patmmccann merged commit 78c1dd3 into prebid:master Mar 30, 2023

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

Prebid Server adapter: fledge support #9342

Prebid Server adapter: fledge support #9342

dgirardi commented Dec 14, 2022

robertrmartinez Feb 1, 2023

JoelPM commented Mar 1, 2023

laurb9 commented Mar 4, 2023

laurb9 commented Mar 4, 2023

laurb9 Mar 4, 2023

dgirardi Mar 7, 2023

patmmccann commented Mar 10, 2023

laurb9 Mar 13, 2023

laurb9 left a comment

laurb9 Mar 14, 2023

dgirardi Mar 14, 2023

laurb9 Mar 14, 2023

laurb9 Mar 14, 2023

dgirardi Mar 14, 2023 •

edited

Loading

laurb9 Mar 14, 2023

pm-nitin-nimbalkar commented Apr 4, 2023

		@@ -35,3 +42,166 @@ describe('fledgeForGpt module', function() {
		});

		@@ -48,5 +47,50 @@ export function addComponentAuctionHook(next, bidRequest, componentAuctionConfig
		logWarn(MODULE, `unable to register component auction config for: ${adUnitCode} x ${seller}.`);

Prebid Server adapter: fledge support #9342

Prebid Server adapter: fledge support #9342

Conversation

dgirardi commented Dec 14, 2022

Type of change

Description of change

Other information

Choose a reason for hiding this comment

JoelPM commented Mar 1, 2023

laurb9 commented Mar 4, 2023

laurb9 commented Mar 4, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

patmmccann commented Mar 10, 2023

Choose a reason for hiding this comment

laurb9 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

dgirardi Mar 14, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pm-nitin-nimbalkar commented Apr 4, 2023

dgirardi Mar 14, 2023 •

edited

Loading