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.

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

Add sspBC adapter #5531

Merged
merged 8 commits into from
Aug 24, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
313 changes: 313 additions & 0 deletions modules/sspBCAdapter.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,313 @@
import * as utils from '../src/utils.js';
import { registerBidder } from '../src/adapters/bidderFactory.js';
import { BANNER } from '../src/mediaTypes.js';

const BIDDER_CODE = 'sspBC';
const BIDDER_URL = 'https://ssp.wp.pl/bidder/';
const SYNC_URL = 'https://ssp.wp.pl/bidder/usersync';
const TMAX = 450;
const BIDDER_VERSION = '4.4';
const W = window;
const { navigator } = W;

const cookieSupport = () => {
const isSafari = /^((?!chrome|android|crios|fxios).)*safari/i.test(navigator.userAgent);
const useCookies = navigator.cookieEnabled || !!document.cookie.length;

return !isSafari && useCookies;
};

const applyClientHints = ortbRequest => {
const connection = navigator.connection || false;
const viewport = W.visualViewport || false;
const segments = [];
const hints = {
'CH-Ect': connection.effectiveType,
'CH-Rtt': connection.rtt,
'CH-SaveData': connection.saveData,
'CH-Downlink': connection.downlink,
'CH-DeviceMemory': navigator.deviceMemory,
'CH-Dpr': W.devicePixelRatio,
'CH-ViewportWidth': viewport.width,
};

Object.keys(hints).forEach(key => {
const hint = hints[key];

if (hint) {
segments.push({
name: key,
value: hint.toString(),
});
}
});
const data = [
{
id: '12',
name: 'NetInfo',
segment: segments,
}];

ortbRequest.user = Object.assign(ortbRequest.user, { data });
};

function applyGdpr(bidderRequest, ortbRequest) {
if (bidderRequest && bidderRequest.gdprConsent) {
ortbRequest.regs = Object.assign(ortbRequest.regs, { '[ortb_extensions.gdpr]': bidderRequest.gdprConsent.gdprApplies ? 1 : 0 });
ortbRequest.user = Object.assign(ortbRequest.user, { '[ortb_extensions.consent]': bidderRequest.gdprConsent.consentString });
}
}

function setOnAny(collection, key) {
for (let i = 0, result; i < collection.length; i++) {
result = utils.deepAccess(collection[i], key);

if (result) {
return result;
}
}
}

/**
* @param {object} slot Ad Unit Params by Prebid
* @returns {object} Banner by OpenRTB 2.5 §3.2.6
*/
function mapBanner(slot) {
if (slot.mediaType === 'banner' ||
utils.deepAccess(slot, 'mediaTypes.banner') ||
(!slot.mediaType && !slot.mediaTypes)) {
const format = slot.sizes.map(size => ({
w: size[0],
h: size[1],
}));

// override - tylko 1szy wymiar
// format = format.slice(0, 1);
return {
format,
id: slot.bidId,
};
}
}

function mapImpression(slot) {
const imp = {
id: slot.params.id,
banner: mapBanner(slot),
/* native: mapNative(slot), */
tagid: slot.params.id,
};

const bidfloor = parseFloat(slot.params.bidfloor);

if (bidfloor) {
imp.bidfloor = bidfloor;
}

return imp;
}

function renderCreative(site, auctionId, bid, seat, request) {
let gam;

const mcad = {
id: auctionId,
seat,
seatbid: [{
bid: [bid],
}],
};

const mcbase = btoa(encodeURI(JSON.stringify(mcad)));

if (bid.adm) {
// parse adm for gam config
try {
gam = JSON.parse(bid.adm).gam;

if (!gam || !Object.keys(gam).length) {
gam = undefined;
} else {
gam.namedSizes = ['fluid'];
gam.div = 'div-gpt-ad-x01';
gam.targeting = Object.assign(gam.targeting || {}, {
OAS_retarg: '0',
PREBID_ON: '1',
emptygaf: '0',
});
}

if (gam && !gam.targeting) {
gam.targeting = {};
}
} catch (err) {
utils.logWarn('Could not parse adm data', bid.adm);
}
}

let adcode = `<head>
<title></title>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<style>
body {
background-color: transparent;
margin: 0;
padding: 0;
}
</style>
<script>
window.rekid = ${site.id};
window.wp_sn = "mc_adapter";
window.mcad = JSON.parse(decodeURI(atob("${mcbase}")));
window.gdpr = ${JSON.stringify(request.gdprConsent)};
window.page = "${site.page}";
window.ref = "${site.ref}";
`;

if (gam) {
adcode += `window.gam = ${JSON.stringify(gam)};`;
}

adcode += `</script>
</head>
<body>
<div id="c"></div>
<script id="wpjslib" crossorigin src="//std.wpcdn.pl/wpjslib/wpjslib-inline.js" async defer></script>
</body>
</html>`;

return adcode;
}

const spec = {
code: BIDDER_CODE,
aliases: [],
supportedMediaTypes: [BANNER],
isBidRequestValid(bid) {
if (bid.params && bid.params.siteId && bid.params.id) {
return true;
}

return false;
},
buildRequests(validBidRequests, bidderRequest) {
if ((!validBidRequests) || (validBidRequests.length < 1)) {
return false;
}

const siteId = setOnAny(validBidRequests, 'params.siteId');
const page = setOnAny(validBidRequests, 'params.page') || bidderRequest.refererInfo.referer;
const domain = setOnAny(validBidRequests, 'params.domain') || utils.parseUrl(page).hostname;
const tmax = setOnAny(validBidRequests, 'params.tmax') ? parseInt(setOnAny(validBidRequests, 'params.tmax'), 10) : TMAX;
const pbver = '$prebid.version$';

let ref;

try {
if (W.self === W.top && document.referrer) { ref = document.referrer; }
} catch (e) {
}

const payload = {
id: bidderRequest.auctionId,
site: { id: siteId, page, domain, ref },
imp: validBidRequests.map(slot => mapImpression(slot)),
tmax,
user: {},
regs: {},
};

applyGdpr(bidderRequest, payload);
applyClientHints(payload);

return {
method: 'POST',
url: BIDDER_URL + '?cs=' + cookieSupport() + '&bdver=' + BIDDER_VERSION + '&pbver=' + pbver + '&inver=0',
data: JSON.stringify(payload),
bidderRequest,
};
},

interpretResponse(serverResponse, request) {
const response = serverResponse.body;
const bids = [];
const site = JSON.parse(request.data).site; // dane o stronie i refererze takie same jak wysylalismy do proxy
let seat;

if (response.seatbid !== undefined) {
response.seatbid.forEach(seatbid => {
seat = seatbid.seat;
seatbid.bid.forEach(serverBid => {
const bidRequest = request.bidderRequest.bids.filter(b => b.params.id === serverBid.impid)[0];

if (bidRequest) {
const bidFloor = bidRequest.params.bidFloor || 0;
const bidCpm = bidRequest.params.flatCpm;

if (!serverBid.gam && bidRequest.params.gam) {
// build GAM config
serverBid.gam = JSON.stringify({
placement: bidRequest.params.gam,
multiplier: 1,
floor: bidRequest.params.gamFloor,
ceil: 100,
namedSizes: ['fluid'],
div: 'div-gpt-ad-x01',
targeting: {
OAS_retarg: '0',
PREBID_ON: '1',
DFPHASH: '',
emptygaf: '0',
},
});
}

const bid = {
requestId: bidRequest.bidId,
creativeId: serverBid.crid || 'bc' + Math.floor(1E10 * Math.random()),
cpm: bidCpm || serverBid.price,
currency: response.cur,
ttl: serverBid.exp || 300,
width: serverBid.w,
height: serverBid.h,
bidderCode: BIDDER_CODE,
mediaType: 'banner',
Copy link
Collaborator

Choose a reason for hiding this comment

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

please create meta.advertiserDomains

Copy link
Collaborator

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Understood! I've looked into it, and while our JSON endpoint does not return bid metadata, it should be available server-side (as underlying logic is using openRTB protocol).

I've created a change request, will update adapter & pull request once it's done.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adapter & test have been updated, bids now have meta.advertiserDomains property:
meta: { advertiserDomains: serverBid.adomain, },

netRevenue: true,
ad: renderCreative(site, response.id, serverBid, seat, request.bidderRequest),
};

if (bid.cpm > 0) {
if (bid.cpm >= bidFloor) {
bids.push(bid);
} else {
utils.logWarn('Discarding bid due to bidFloor setting', bid.cpm, bidFloor);
}
}
} else {
utils.logWarn('Discarding response - no matching request', serverBid.impid);
}
});
});
}

return bids;
},
getUserSyncs(syncOptions) {
if (syncOptions.iframeEnabled) {
return [{
type: 'iframe',
url: SYNC_URL,
}];
}
utils.logWarn('sspBC adapter requires iframe based user sync.');
},
onTimeout() {
},
};

registerBidder(spec);

export {
spec,
};
40 changes: 40 additions & 0 deletions modules/sspBCAdapter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Overview

Module Name: sspBC Bidder Adapter
Module Type: Bidder Adapter
Maintainer: wojciech.bialy@grupawp.pl

# Description

Module that connects to Wirtualna Polska Media header bidding endpoint to fetch bids.
Only banner format is supported.
Supported currencies: USD, EUR, PLN


Required parameters:


# Test Parameters
```
var adUnits = [
// Banner adUnit
{
code: 'banner-div',
mediaTypes: {
banner: {
sizes: [[300, 250], [300,600]]
}
},
bids: [{
bidder: 'sspBC',
params: {
id: '006', // required
siteId: '235911', // required
domain: 'somesite.pl', // optional
page: 'somesite.pl/somepage.html', // optional
tmax: 250 // optional
}
}]
}
];
```
Loading