Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Debugging Module: Bid responses for various media types (+ TestBidder) #12720

Merged
merged 8 commits into from
Feb 20, 2025
Merged

Debugging Module: Bid responses for various media types (+ TestBidder) #12720

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0c0b08e
12512 Mock bid responses for various media types
mkomorski Feb 2, 2025
ff7adf6
lint fix
mkomorski Feb 2, 2025
18c51d5
resolvers execution fix
mkomorski Feb 2, 2025
7379f8c
Merge branch 'master' into mkomorski/debugging-mock-responses
mkomorski Feb 4, 2025
e94b789
+ basic examples
mkomorski Feb 7, 2025
1ee8306
comments
mkomorski Feb 7, 2025
bcd3b58
adapt native to ortb & refactor video example
mkomorski Feb 13, 2025
e38c31d
moving renderer to bid response
mkomorski Feb 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions integrationExamples/testBidder/testBidderBannerExample.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
<html>
<head>
<title>Prebid Test Bidder Example</title>
<script src="../../build/dev/prebid.js" async></script>
<script>
var pbjs = pbjs || {};
pbjs.que = pbjs.que || [];

const adUnitCode = 'adUnit-0000';

const adUnits = [{
mediaTypes: {
banner: {
sizes: [600, 500]
}
},
code: adUnitCode,
bids: [
{bidder: 'testBidder', params: {}}
]
}]

pbjs.que.push(function () {

/**
* BID RESPONSE SIMULATION SECTION START
*
* This section handles simulating a bidder
* that will always respond with bid responses.
*
* This part should not be present in production.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Almost nothing in any integration example should be left in production.

*/
pbjs.registerBidAdapter(null, 'testBidder', {
supportedMediaTypes: ['banner', 'video', 'native'],
isBidRequestValid: () => true
});

pbjs.setConfig({
debugging: {
enabled: true,
intercept: [
{
when: {
bidder: 'testBidder',
},
then: {
creativeId: 'testCreativeId',
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this just to have something here? I think it should work with an empty object.

}
}
]
}
});
/**
* BID RESPONSE SIMULATION SECTION END
*/

pbjs.addAdUnits(adUnits);
pbjs.requestBids({
adUnitCodes: [adUnitCode],
bidsBackHandler: function() {
const bids = pbjs.getHighestCpmBids(adUnitCode);
const winningBid = bids[0];
const div = document.getElementById('banner');
let iframe = document.createElement('iframe');
iframe.frameBorder = '0';
div.appendChild(iframe);
var iframeDoc = iframe.contentWindow.document;
pbjs.renderAd(iframeDoc, winningBid.adId);
}
});
});
</script>
</head>
<body>
<h2>Prebid Test Bidder Example</h2>
<h5>Banner ad</h5>
<div id="banner"></div>
</body>
</html>
151 changes: 151 additions & 0 deletions integrationExamples/testBidder/testBidderNativeExample.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
<html>
<head>
<title>Prebid Test Bidder Example</title>
<script src="../../build/dev/prebid.js" async></script>
<script>
var pbjs = pbjs || {};
pbjs.que = pbjs.que || [];

const adUnitCode = 'adUnit-0000';

const adUnits = [{
mediaTypes: {
native: {
ortb: {
assets: [
{
required: true,
id: 1,
img: {
type: 3,
wmin: 100,
hmin: 100,
}
},
{
required: true,
id: 2,
img: {
type: 3,
wmin: 200,
hmin: 200
}
},
{
required: true,
id: 3,
data: {
type: 3,
len: 20
}
},
{
required: true,
id: 4,
title: {
len: 20
}
}
]
}
}
},
code: adUnitCode,
bids: [
{bidder: 'testBidder', params: {}}
]
}]

pbjs.que.push(function () {

/**
* BID RESPONSE SIMULATION SECTION START
*
* This section handles simulating a bidder
* that will always respond with bid responses.
*
* This part should not be present in production.
*/
pbjs.registerBidAdapter(null, 'testBidder', {
supportedMediaTypes: ['banner', 'video', 'native'],
isBidRequestValid: () => true
});

pbjs.setConfig({
debugging: {
enabled: true,
intercept: [
{
when: {
bidder: 'testBidder',
},
then: {
creativeId: 'testCreativeId',
}
}
]
}
});
/**
* BID RESPONSE SIMULATION SECTION END
*/

pbjs.addAdUnits(adUnits);
pbjs.requestBids({
adUnitCodes: [adUnitCode],
bidsBackHandler: function() {
const bids = pbjs.getHighestCpmBids(adUnitCode);
const bid = bids[0];
const slot = document.getElementById('native');
const iframe = document.createElement('iframe');
Object.entries({
frameBorder: 0,
marginWidth: 0,
marginHeight: 0,
width: 600,
height: 500,
scrolling: 'no',
srcdoc: document.getElementById('native-template').innerHTML
}).forEach(([prop, val]) => iframe.setAttribute(prop, val));
slot.appendChild(iframe);
iframe.onload = () => pbjs.renderAd(iframe.contentDocument, bid.adId);
}
});
});
</script>
</head>
<body>
<template id="native-template">
<style>
body {
display: inline-block;
}

.container {
display: inline-block;
font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
font-size: 14px;
line-height: 1.42857143;
box-sizing: border-box;
border: 3px dashed red;
padding: 20px;
color: #333;
}

.img {
width: 300px;
height: 200px;
}

</style>
<div class="container">
<h1>##hb_native_asset_id_4##</h1>
<h3>Rating: ##hb_native_asset_id_3##</h3>
<img class="img" src="##hb_native_asset_id_1##" alt="bg" />
</div>
</template>
<h2>Prebid Test Bidder Example</h2>
<h5>Native ad</h5>
<div id="native"></div>
</body>
</html>
75 changes: 75 additions & 0 deletions integrationExamples/testBidder/testBidderVideoExample.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<html>
<head>
<title>Prebid Test Bidder Example</title>
<script src="../../build/dev/prebid.js" async></script>
<script>
var pbjs = pbjs || {};
pbjs.que = pbjs.que || [];

const adUnitCode = 'adUnit-0000';

const adUnits = [{
mediaTypes: {
video: {
playerSize: [640, 360],
context: 'outstream'
}
},
code: adUnitCode,
bids: [
{bidder: 'testBidder', params: {}}
]
}]

pbjs.que.push(function () {

/**
* BID RESPONSE SIMULATION SECTION START
*
* This section handles simulating a bidder
* that will always respond with bid responses.
*
* This part should not be present in production.
*/
pbjs.registerBidAdapter(null, 'testBidder', {
supportedMediaTypes: ['banner', 'video', 'native'],
isBidRequestValid: () => true
});

pbjs.setConfig({
debugging: {
enabled: true,
intercept: [
{
when: {
bidder: 'testBidder',
},
then: {
creativeId: 'testCreativeId',
}
}
]
}
});
/**
* BID RESPONSE SIMULATION SECTION END
*/

pbjs.addAdUnits(adUnits);
pbjs.requestBids({
adUnitCodes: [adUnitCode],
bidsBackHandler: function() {
const bids = pbjs.getHighestCpmBids(adUnitCode);
const winningBid = bids[0];
pbjs.renderAd(document, winningBid.adId);
}
});
});
</script>
</head>
<body>
<h2>Prebid Test Bidder Example</h2>
<h5>Video ad</h5>
<div id="player"></div>
</body>
</html>
Loading