PAAPI: add top level auction example #11259

dgirardi · 2024-03-26T16:44:29Z

Type of change

Feature

Description of change

Add requestedSize to the configs returned by pbjs.getPAAPIConfig. For now, this is the first banner size defined by the ad unit.
Add an example showing how to use getPAAPIConfig to run a top level auction using your own decision logic, using a test IG set up by openx and the debugging module.

patmmccann · 2024-03-27T15:54:38Z

integrationExamples/gpt/top-level-paapi/tl_paapi_example.html

+            });
+        });
+
+        function raa() {


does it make sense to have some of this code in a submodule, which might end up being extremely compact on initial commit, but would provide the convenient logical abstraction that a user would pick the PAAPI submodule associated with their choice of TLS?

I think so yes. A pub makes 2 decisions.

I want to run PAAPI with prebid

I want to do it myself (pub sub module) or I want GPT to do it for me

patmmccann · 2024-03-27T15:56:51Z

integrationExamples/gpt/top-level-paapi/tl_paapi_example.html

+            if (pbjs.adserverRequestSent) return;
+            pbjs.adserverRequestSent = true;
+            raa().then((allPaapi) => {
+                if (!allPaapi) {


this calls gam if paapi doesn't fill, correct? But PAAPI will always fill if we give it the best contextual bid from prebid as its best alternative? Is the below code basically saying 'Let's compete Prebid vs PAAPI, and if neither provide any ad call gam?'

I don't think we can give it the best contextual bid. Some bidders may decide to provide "extra" bids for it, but those don't necessarily contain all, or even the same, contextual bids, and Prebid can't control them.

That's auctionSignals.prebid.bidfloor no ? I don't know if all buyers take it into account, so it may still not fill even if everyone bid all the time and above the floor.

Anyway, I assume that deleting the <div> is what makes GAM skip that slot if it was filled by PAAPI. Is there a better way to disable the slot more explicitly and perhaps less permanent ? It's fine either way as a test page but I imagine it won't work if I wanted to periodically refresh the ads.

Yes, this is not a great way to render. I am not sure yet what the render API will look like:

when using GAM, the use case I'm hearing is to run fledge only after GAM picks the Prebid contextual winner (to keep adx demand in GAM). In practice this would mean returning the URN back to the rendering logic running in the GAM creative (PUC or equivalent). The publisher would not call any rendering API but somehow enable this behavior.

when not using GAM, the publisher calls renderAd(document, adId). We could do something similar and only "pretend" to render adId, rendering the fledge ad instead in a nested frame, if the publisher enabled the same behavior as above. Or we could provide separate runPaapi/renderPaapi APIs.

I'm not sure there will be a use case for what's demoed here, only run gam if fledge has no winner. Pubs would probably prefer to let GAM run fledge and get better demand.

patmmccann · 2024-03-27T16:55:32Z

integrationExamples/gpt/top-level-paapi/decisionLogic.js

+  browserSignals,
+  directFromSellerSignals,
+) {
+  var score = bid+20;


reference comparison to floor (or top prebid bid)

var sellerSignals = auctionConfig.sellerSignals; var floor = sellerSignals.floor || 0; var modifiedBid = bid * 0.95; // temporary reporting: https://github.com/WICG/turtledove/blob/main/Proposed_First_FLEDGE_OT_Details.md#reporting const reportingBrowserSignals = {...browserSignals, bid, modifiedBid} const macros = '&winningBid=${winningBid}&winningBidCurrency=${winningBidCurrency}&topLevelWinningBid=${topLevelWinningBid}&topLevelWinningBidCurrency=${topLevelWinningBidCurrency}'; globalThis.forDebuggingOnly?.reportAdAuctionLoss( buildReportURL('bid-loss', auctionConfig, reportingBrowserSignals) + macros); globalThis.forDebuggingOnly?.reportAdAuctionWin( buildReportURL('bid-win', auctionConfig, reportingBrowserSignals) + macros); return { ad: null, desirability: (modifiedBid > floor && (browserSignals.bidCurrency == '???' || auctionConfig.sellerCurrency == browserSignals.bidCurrency)) ? modifiedBid : 0, allowComponentAuction: true, bid: modifiedBid }; }

citing my source ```https://privacysandbox.openx.net/fledge/decision-logic-component.js````

patmmccann · 2024-03-27T16:57:38Z

integrationExamples/gpt/top-level-paapi/decisionLogic.js

+  console.groupEnd();
+  console.groupEnd();
+
+  log('reportResult', { auctionConfig, browserSignals, directFromSellerSignals });


could we demonstrate calling a url in sellerSingals

eg

const reportingURL =
(sellerSignals.reportingURL || 'https://privacysandbox-reporting.openx.net/fledgeReporting')
+ '?'
+ Object.entries(params)
.filter(([k,v]) => v)
.map(([k,v]) => ${k}=${encodeURIComponent(v)})
.join('&');

return reportingURL;
}

dgirardi · 2024-03-27T18:11:11Z

My plan for this is to update decisionLogic so that it demonstrates floor enforcement, and remove the reportResult portion.

Pending are:

moving the runAdAuction logic into a module. This should also define new events to fire for PAAPI won / loss.
moving the rendering logic into paapi.js. This should define a new rendering API. It's unclear yet how to deal with size (see PAAPI module: fill out auctionSignals.prebid.ortb2Imp.banner better #11189)
a reference implementation for the decision logic that includes reporting.

Let me know if you'd prefer some of the above to be included in this.

jdwieland8282 · 2024-03-27T19:33:40Z

I'm working on finding a pub willing to run a demo for us. If we don't find one by May 1 what are our options? My preference would be to use Chrome flags to run the demo from prebid.org.

laurb9 · 2024-03-28T22:35:13Z

integrationExamples/gpt/top-level-paapi/decisionLogic.js

+    trustedScoringSignals,
+    browserSignals,
+    directFromSellerSignals
+  });


Objects logged from worklets cannot be expanded after the worklet finished.
I usually do JSON.stringify() while skipping perBuyerSignals from the logged auctionConfig (too large). Is there a better way ?

laurb9 · 2024-03-28T23:02:46Z

integrationExamples/gpt/top-level-paapi/tl_paapi_example.html

+                                                'bid': 1.5
+                                            }
+                                        },
+                                        'resolveToConfig': true,


should leave this out for component, I do not think it has any effect

laurb9 · 2024-03-29T04:32:20Z

integrationExamples/gpt/top-level-paapi/tl_paapi_example.html

+<code>--enable-features=CookieDeprecationFacilitatedTesting:label/treatment_1.2/force_eligible/true
+    --privacy-sandbox-enrollment-overrides=https://localhost:9999</code>
+<p>Join interest group at <a href="https://privacysandbox.openx.net/fledge/advertiser">https://privacysandbox.openx.net/fledge/advertiser</a>
+</p>


Can make it fully local with

navigator.joinAdInterestGroup({ name: 'prebid-test', owner: window.location.origin, biddingLogicURL: (new URL('buyer.js', window.location)).toString(), ads: [{ renderURL: (new URL('ad.html', window.location)).toString(), }], adComponents: [] }, 600);

and a short buyer js

My intention was to make this as real-world as possible but I couldn't get any adapter that would both work and agree to be in here. Mocking openx' response was a compromise, hopefully temporary.

I was not sure if the demo needed to be self-contained. If so, the buyer can be local too, at a small cost of being slightly confusing to share a domain with seller. It's fine either way.

Mocking the openx adapter response is also fine - I was not aware this is possible so thanks for showing me how to do it :)

integrationExamples/gpt/top-level-paapi/decisionLogic.js

laurb9 · 2024-03-29T05:37:18Z

integrationExamples/gpt/top-level-paapi/tl_paapi_example.html

+            if (pbjs.adserverRequestSent) return;
+            pbjs.adserverRequestSent = true;
+            raa().then((allPaapi) => {
+                if (!allPaapi) {


That's auctionSignals.prebid.bidfloor no ? I don't know if all buyers take it into account, so it may still not fill even if everyone bid all the time and above the floor.

Anyway, I assume that deleting the <div> is what makes GAM skip that slot if it was filled by PAAPI. Is there a better way to disable the slot more explicitly and perhaps less permanent ? It's fine either way as a test page but I imagine it won't work if I wanted to periodically refresh the ads.

laurb9 · 2024-03-29T05:40:23Z

integrationExamples/gpt/top-level-paapi/decisionLogic.js

+  console.groupEnd();
+  console.log(...LOG_PREFIX, 'Result:', result);
+  return result;
+}


reportResult should still be defined even if it does not do anything, to avoid

Worklet error: https://127.0.0.1:9999/integrationExamples/gpt/top-level-paapi/decisionLogic.js reportResult is not a function.

Could be something like this

function reportResult(auctionConfig, browserSignals) { log('reportResult', { auctionConfig, browserSignals }); sendReportTo(`${auctionConfig.seller}/report/win?${Object.entries(browserSignals).map(([k, v]) => `${k}=${encodeURIComponent(v)}`).join('&')}`); return {} }

that would replace it with an error about the report call failing :) I am already worried about people copying this demo into production so I'd rather avoid it; the plan is to work with @patmmccann to publish an actual reference implementation separately

Is this about the event url showing up as an error in the Network tab ? It's still useful to look at parameters, but if unwanted can comment out sendReportTo or make it conditional on something like sellerSignals.reportURL

patmmccann · 2024-04-18T20:14:32Z

moving the runAdAuction logic into a module. This should also define new events to fire for PAAPI won / loss.

tracking as #10690

piotrj-rtbh · 2024-04-24T09:16:04Z

@patmmccann and @dgirardi, did you have a chance to run the TL auction example on a Dev Chrome?
Mine is Version 126.0.6423.2 (Official Build) dev (64-bit) and once run (with all the appropriate flags) I get an error in the console:

utils.js:211 Prebid ERROR: Error executing bidsBackHandler null TypeError: Cannot read properties of undefined (reading 'apply')
    at navigator.runAdAuction (tl_paapi_example.html:10:45)
    at tl_paapi_example.html:116:42
    at Array.map (<anonymous>)
    at raa (tl_paapi_example.html:115:22)
    at sendAdserverRequest (tl_paapi_example.html:144:13)
    at Object.auctionDone (prebid.js:546:9)
    at auction.js:225:23
    at auction.js:441:5
    at executeCallback (auction.js:219:7)
    at auctionDone (auction.js:251:5)

I cannot figure out why is that happening, all is defined properly and this is not case for my regular Version 124.0.6367.61 (Official Build) (64-bit) - this one works like a charm.

* bidderFactory fledge API: accept single fledge configs * PAAPI: add top level auction example * update example formatting * provide bidfloor in top level auctionSignals * update example decisionLogic to enforce auction floor, remove reporting * PR feedback * add reportResult

dgirardi added 5 commits March 20, 2024 09:49

bidderFactory fledge API: accept single fledge configs

09ff42e

Merge branch 'master' into paapi-ortb

43eb284

PAAPI: add top level auction example

2c302ae

Merge branch 'master' into paapi-ortb

0eafac1

update example formatting

25a8ef0

dgirardi force-pushed the paapi-ortb branch from ed407f9 to 25a8ef0 Compare March 26, 2024 16:51

dgirardi mentioned this pull request Mar 26, 2024

PAAPI module: fill out auctionSignals.prebid.ortb2Imp.banner better #11189

Closed

ChrisHuie added the feature label Mar 27, 2024

ChrisHuie requested review from jlquaccia and jsnellbaker March 27, 2024 14:47

ChrisHuie assigned jlquaccia, jsnellbaker and laurb9 Mar 27, 2024

ChrisHuie requested a review from laurb9 March 27, 2024 14:47

patmmccann reviewed Mar 27, 2024

View reviewed changes

provide bidfloor in top level auctionSignals

a24948a

update example decisionLogic to enforce auction floor, remove reporting

4917330

laurb9 reviewed Mar 29, 2024

View reviewed changes

dgirardi added 3 commits March 29, 2024 09:01

PR feedback

acc2619

add reportResult

ab4a7a6

Merge branch 'master' into paapi-ortb

209d190

patmmccann approved these changes Apr 16, 2024

View reviewed changes

laurb9 approved these changes Apr 16, 2024

View reviewed changes

patmmccann merged commit 122a72a into prebid:master Apr 17, 2024
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PAAPI: add top level auction example #11259

PAAPI: add top level auction example #11259

dgirardi commented Mar 26, 2024 •

edited

Loading

patmmccann Mar 27, 2024

jdwieland8282 Mar 27, 2024 •

edited

Loading

patmmccann Mar 27, 2024

dgirardi Mar 27, 2024

laurb9 Mar 29, 2024

dgirardi Mar 29, 2024

patmmccann Mar 27, 2024 •

edited by muuki88

Loading

patmmccann Mar 27, 2024

patmmccann Mar 27, 2024

dgirardi commented Mar 27, 2024

jdwieland8282 commented Mar 27, 2024

laurb9 Mar 28, 2024

laurb9 Mar 28, 2024

laurb9 Mar 29, 2024

dgirardi Mar 29, 2024

laurb9 Mar 29, 2024

laurb9 Mar 29, 2024

laurb9 Mar 29, 2024

dgirardi Mar 29, 2024

laurb9 Mar 29, 2024

patmmccann commented Apr 18, 2024

piotrj-rtbh commented Apr 24, 2024 •

edited

Loading

PAAPI: add top level auction example #11259

PAAPI: add top level auction example #11259

Conversation

dgirardi commented Mar 26, 2024 • edited Loading

Type of change

Description of change

Choose a reason for hiding this comment

jdwieland8282 Mar 27, 2024 • 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

patmmccann Mar 27, 2024 • edited by muuki88 Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dgirardi commented Mar 27, 2024

jdwieland8282 commented Mar 27, 2024

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

patmmccann commented Apr 18, 2024

piotrj-rtbh commented Apr 24, 2024 • edited Loading

dgirardi commented Mar 26, 2024 •

edited

Loading

jdwieland8282 Mar 27, 2024 •

edited

Loading

patmmccann Mar 27, 2024 •

edited by muuki88

Loading

piotrj-rtbh commented Apr 24, 2024 •

edited

Loading