-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PAAPI: add top level auction example (#11259)
* 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
- Loading branch information
Showing
6 changed files
with
302 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| function logPrefix(scope) { | ||
| return [ | ||
| `%c PAAPI %c ${scope} %c`, | ||
| 'color: green; background-color:yellow; border: 1px solid black', | ||
| 'color: blue; border:1px solid black', | ||
| '', | ||
| ]; | ||
| } | ||
|
|
||
| function scoreAd( | ||
| adMetadata, | ||
| bid, | ||
| auctionConfig, | ||
| trustedScoringSignals, | ||
| browserSignals, | ||
| directFromSellerSignals | ||
| ) { | ||
| console.group(...logPrefix('scoreAd'), 'Buyer:', browserSignals.interestGroupOwner); | ||
| console.log('Context:', JSON.stringify({ | ||
| adMetadata, | ||
| bid, | ||
| auctionConfig: { | ||
| ...auctionConfig, | ||
| componentAuctions: '[omitted]' | ||
| }, | ||
| trustedScoringSignals, | ||
| browserSignals, | ||
| directFromSellerSignals | ||
| }, ' ', ' ')); | ||
|
|
||
| const result = { | ||
| desirability: bid, | ||
| allowComponentAuction: true, | ||
| }; | ||
| const {bidfloor, bidfloorcur} = auctionConfig.auctionSignals?.prebid || {}; | ||
| if (bidfloor) { | ||
| if (browserSignals.bidCurrency !== '???' && browserSignals.bidCurrency !== bidfloorcur) { | ||
| console.log(`Floor currency (${bidfloorcur}) does not match bid currency (${browserSignals.bidCurrency}), and currency conversion is not yet implemented. Rejecting bid.`); | ||
| result.desirability = -1; | ||
| } else if (bid < bidfloor) { | ||
| console.log(`Bid (${bid}) lower than contextual winner/floor (${bidfloor}). Rejecting bid.`); | ||
| result.desirability = -1; | ||
| result.rejectReason = 'bid-below-auction-floor'; | ||
| } | ||
| } | ||
| console.log('Result:', result); | ||
| console.groupEnd(); | ||
| return result; | ||
| } | ||
|
|
||
| function reportResult(auctionConfig, browserSignals) { | ||
| console.group(...logPrefix('reportResult')); | ||
| console.log('Context', JSON.stringify({auctionConfig, browserSignals}, ' ', ' ')); | ||
| console.groupEnd(); | ||
| sendReportTo(`${auctionConfig.seller}/report/win?${Object.entries(browserSignals).map(([k, v]) => `${k}=${encodeURIComponent(v)}`).join('&')}`); | ||
| return {}; | ||
| } |
188 changes: 188 additions & 0 deletions
188
integrationExamples/gpt/top-level-paapi/tl_paapi_example.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,188 @@ | ||
| <html> | ||
| <head> | ||
| <script async src="../../../../build/dev/prebid.js"></script> | ||
| <script> | ||
| // intercept navigator.runAdAuction and print parameters to console | ||
| (() => { | ||
| var originalRunAdAuction = navigator.runAdAuction; | ||
| navigator.runAdAuction = function (...args) { | ||
| console.log('%c runAdAuction', 'background: cyan; border: 2px; border-radius: 3px', ...args); | ||
| return originalRunAdAuction.apply(navigator, args); | ||
| }; | ||
| })(); | ||
| </script> | ||
|
|
||
| <script async src="https://securepubads.g.doubleclick.net/tag/js/gpt.js"></script> | ||
|
|
||
| <script> | ||
| var FAILSAFE_TIMEOUT = 3300; | ||
| var PREBID_TIMEOUT = 3000; | ||
| var adUnits = [{ | ||
| code: 'div-1', | ||
| mediaTypes: { | ||
| banner: { | ||
| sizes: [[300, 250]], | ||
| } | ||
| }, | ||
| ortb2Imp: { | ||
| ext: { | ||
| ae: 1 | ||
| } | ||
| }, | ||
| bids: [ | ||
| { | ||
| bidder: 'openx', | ||
| params: { | ||
| unit: '538703464', | ||
| response_template_name: 'test_banner_ad', | ||
| test: true, | ||
| delDomain: 'sademo-d.openx.net' | ||
| } | ||
| }, | ||
|
|
||
| ], | ||
| } | ||
| ] | ||
| ; | ||
|
|
||
| var pbjs = pbjs || {}; | ||
| pbjs.que = pbjs.que || []; | ||
|
|
||
| var googletag = googletag || {}; | ||
| googletag.cmd = googletag.cmd || []; | ||
| googletag.cmd.push(function () { | ||
| googletag.pubads().disableInitialLoad(); | ||
| }); | ||
|
|
||
| pbjs.que.push(function () { | ||
| pbjs.setConfig({ | ||
| debug: true, | ||
| paapi: { | ||
| enabled: true, | ||
| gpt: { | ||
| autoconfig: false | ||
| } | ||
| }, | ||
| debugging: { | ||
| enabled: true, | ||
| intercept: [ | ||
| { | ||
| when: { | ||
| bidder: 'openx', | ||
| }, | ||
| then: { | ||
| cpm: 0.1 | ||
| }, | ||
| paapi() { | ||
| return [ | ||
| { | ||
| 'seller': 'https://privacysandbox.openx.net', | ||
| 'decisionLogicURL': 'https://privacysandbox.openx.net/fledge/decision-logic-component.js', | ||
| 'sellerSignals': { | ||
| 'floor': 0.01, | ||
| 'currency': 'USD', | ||
| 'auctionTimestamp': new Date().getTime(), | ||
| 'publisherId': '537143056', | ||
| 'adUnitId': '538703464' | ||
| }, | ||
| 'interestGroupBuyers': [ | ||
| 'https://privacysandbox.openx.net' | ||
| ], | ||
| 'perBuyerSignals': { | ||
| 'https://privacysandbox.openx.net': { | ||
| 'bid': 1.5 | ||
| } | ||
| }, | ||
| 'sellerCurrency': 'USD' | ||
| } | ||
| ]; | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
| }); | ||
|
|
||
| pbjs.addAdUnits(adUnits); | ||
| pbjs.requestBids({ | ||
| bidsBackHandler: sendAdserverRequest, | ||
| timeout: PREBID_TIMEOUT | ||
| }); | ||
| }); | ||
|
|
||
| function raa() { | ||
| return Promise.all( | ||
| Object.entries(pbjs.getPAAPIConfig()) | ||
| .map(([adUnitCode, auctionConfig]) => { | ||
| return navigator.runAdAuction({ | ||
| seller: window.location.origin, | ||
| decisionLogicURL: new URL('decisionLogic.js', window.location).toString(), | ||
| resolveToConfig: false, | ||
| ...auctionConfig | ||
| }).then(urn => { | ||
| if (urn) { | ||
| // if we have a paapi winner, replace the adunit div | ||
| // with an iframe that renders it | ||
| const iframe = document.createElement('iframe'); | ||
| Object.assign(iframe, { | ||
| src: urn, | ||
| frameBorder: 0, | ||
| scrolling: 'no', | ||
| }, auctionConfig.requestedSize); | ||
| const div = document.getElementById(adUnitCode); | ||
| div.parentElement.insertBefore(iframe, div); | ||
| div.remove(); | ||
| return true; | ||
| } | ||
| }); | ||
| }) | ||
| ).then(won => won.every(el => el)); | ||
| } | ||
|
|
||
| function sendAdserverRequest() { | ||
| if (pbjs.adserverRequestSent) return; | ||
| pbjs.adserverRequestSent = true; | ||
| raa().then((allPaapi) => { | ||
| if (!allPaapi) { | ||
| googletag.cmd.push(function () { | ||
| pbjs.que.push(function () { | ||
| pbjs.setTargetingForGPTAsync(); | ||
| googletag.pubads().refresh(); | ||
| }); | ||
| }); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| setTimeout(function () { | ||
| sendAdserverRequest(); | ||
| }, FAILSAFE_TIMEOUT); | ||
|
|
||
| googletag.cmd.push(function () { | ||
| googletag.defineSlot('/19968336/header-bid-tag-0', [[300, 250], [300, 600]], 'div-1').addService(googletag.pubads()); | ||
|
|
||
| googletag.pubads().enableSingleRequest(); | ||
| googletag.enableServices(); | ||
| }); | ||
| </script> | ||
| </head> | ||
|
|
||
| <body> | ||
| <h2>Standalone PAAPI Prebid.js Example</h2> | ||
| <p>Start local server with:</p> | ||
| <code>gulp serve-fast --https</code> | ||
| <p>Chrome flags:</p> | ||
| <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> | ||
| <h5>Div-1</h5> | ||
| <div id='div-1' style='min-width: 300px; min-height: 250px;'> | ||
| <script type='text/javascript'> | ||
| googletag.cmd.push(function () { | ||
| googletag.display('div-1'); | ||
| }); | ||
| </script> | ||
| </div> | ||
|
|
||
| </body> | ||
| </html> |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters