forked from prebid/Prebid.js
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Submit Brightcom Bid Adapter (prebid#3614)
* Add Brightcom Bid Adapter * brightcomBidAdapter: remove getTopWindowLocation call * brightcomBidAdapter: fix naming
- Loading branch information
1 parent
7ce5df6
commit 41867ad
Showing
3 changed files
with
567 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,246 @@ | ||
import * as utils from '../src/utils'; | ||
import * as url from '../src/url'; | ||
import { registerBidder } from '../src/adapters/bidderFactory'; | ||
import { BANNER } from '../src/mediaTypes'; | ||
import { config } from '../src/config'; | ||
|
||
const BIDDER_CODE = 'brightcom'; | ||
const URL = 'https://brightcombid.marphezis.com/hb'; | ||
|
||
export const spec = { | ||
code: BIDDER_CODE, | ||
supportedMediaTypes: [BANNER], | ||
isBidRequestValid, | ||
buildRequests, | ||
interpretResponse, | ||
getUserSyncs | ||
}; | ||
|
||
function buildRequests(bidReqs, bidderRequest) { | ||
try { | ||
let referrer = ''; | ||
if (bidderRequest && bidderRequest.refererInfo) { | ||
referrer = bidderRequest.refererInfo.referer; | ||
} | ||
const brightcomImps = []; | ||
const publisherId = utils.getBidIdParameter('publisherId', bidReqs[0].params); | ||
utils._each(bidReqs, function (bid) { | ||
bid.sizes = ((utils.isArray(bid.sizes) && utils.isArray(bid.sizes[0])) ? bid.sizes : [bid.sizes]); | ||
bid.sizes = bid.sizes.filter(size => utils.isArray(size)); | ||
const processedSizes = bid.sizes.map(size => ({w: parseInt(size[0], 10), h: parseInt(size[1], 10)})); | ||
|
||
const element = document.getElementById(bid.adUnitCode); | ||
const minSize = _getMinSize(processedSizes); | ||
const viewabilityAmount = _isViewabilityMeasurable(element) | ||
? _getViewability(element, utils.getWindowTop(), minSize) | ||
: 'na'; | ||
const viewabilityAmountRounded = isNaN(viewabilityAmount) ? viewabilityAmount : Math.round(viewabilityAmount); | ||
|
||
const imp = { | ||
id: bid.bidId, | ||
banner: { | ||
format: processedSizes, | ||
ext: { | ||
viewability: viewabilityAmountRounded | ||
} | ||
}, | ||
tagid: String(bid.adUnitCode) | ||
}; | ||
const bidFloor = utils.getBidIdParameter('bidFloor', bid.params); | ||
if (bidFloor) { | ||
imp.bidfloor = bidFloor; | ||
} | ||
brightcomImps.push(imp); | ||
}); | ||
const brightcomBidReq = { | ||
id: utils.getUniqueIdentifierStr(), | ||
imp: brightcomImps, | ||
site: { | ||
domain: url.parse(referrer).host, | ||
page: referrer, | ||
publisher: { | ||
id: publisherId | ||
} | ||
}, | ||
device: { | ||
devicetype: _getDeviceType(), | ||
w: screen.width, | ||
h: screen.height | ||
}, | ||
tmax: config.getConfig('bidderTimeout') | ||
}; | ||
|
||
return { | ||
method: 'POST', | ||
url: URL, | ||
data: JSON.stringify(brightcomBidReq), | ||
options: {contentType: 'text/plain', withCredentials: false} | ||
}; | ||
} catch (e) { | ||
utils.logError(e, {bidReqs, bidderRequest}); | ||
} | ||
} | ||
|
||
function isBidRequestValid(bid) { | ||
if (bid.bidder !== BIDDER_CODE || typeof bid.params === 'undefined') { | ||
return false; | ||
} | ||
|
||
if (typeof bid.params.publisherId === 'undefined') { | ||
return false; | ||
} | ||
|
||
return true; | ||
} | ||
|
||
function interpretResponse(serverResponse) { | ||
if (!serverResponse.body || typeof serverResponse.body != 'object') { | ||
utils.logWarn('Brightcom server returned empty/non-json response: ' + JSON.stringify(serverResponse.body)); | ||
return []; | ||
} | ||
const { body: {id, seatbid} } = serverResponse; | ||
try { | ||
const brightcomBidResponses = []; | ||
if (id && | ||
seatbid && | ||
seatbid.length > 0 && | ||
seatbid[0].bid && | ||
seatbid[0].bid.length > 0) { | ||
seatbid[0].bid.map(brightcomBid => { | ||
brightcomBidResponses.push({ | ||
requestId: brightcomBid.impid, | ||
cpm: parseFloat(brightcomBid.price), | ||
width: parseInt(brightcomBid.w), | ||
height: parseInt(brightcomBid.h), | ||
creativeId: brightcomBid.crid || brightcomBid.id, | ||
currency: 'USD', | ||
netRevenue: true, | ||
mediaType: BANNER, | ||
ad: _getAdMarkup(brightcomBid), | ||
ttl: 60 | ||
}); | ||
}); | ||
} | ||
return brightcomBidResponses; | ||
} catch (e) { | ||
utils.logError(e, {id, seatbid}); | ||
} | ||
} | ||
|
||
// Don't do user sync for now | ||
function getUserSyncs(syncOptions, responses, gdprConsent) { | ||
return []; | ||
} | ||
|
||
function _isMobile() { | ||
return (/(ios|ipod|ipad|iphone|android)/i).test(navigator.userAgent); | ||
} | ||
|
||
function _isConnectedTV() { | ||
return (/(smart[-]?tv|hbbtv|appletv|googletv|hdmi|netcast\.tv|viera|nettv|roku|\bdtv\b|sonydtv|inettvbrowser|\btv\b)/i).test(navigator.userAgent); | ||
} | ||
|
||
function _getDeviceType() { | ||
return _isMobile() ? 1 : _isConnectedTV() ? 3 : 2; | ||
} | ||
|
||
function _getAdMarkup(bid) { | ||
let adm = bid.adm; | ||
if ('nurl' in bid) { | ||
adm += utils.createTrackPixelHtml(bid.nurl); | ||
} | ||
return adm; | ||
} | ||
|
||
function _isViewabilityMeasurable(element) { | ||
return !_isIframe() && element !== null; | ||
} | ||
|
||
function _getViewability(element, topWin, { w, h } = {}) { | ||
return utils.getWindowTop().document.visibilityState === 'visible' | ||
? _getPercentInView(element, topWin, { w, h }) | ||
: 0; | ||
} | ||
|
||
function _isIframe() { | ||
try { | ||
return utils.getWindowSelf() !== utils.getWindowTop(); | ||
} catch (e) { | ||
return true; | ||
} | ||
} | ||
|
||
function _getMinSize(sizes) { | ||
return sizes.reduce((min, size) => size.h * size.w < min.h * min.w ? size : min); | ||
} | ||
|
||
function _getBoundingBox(element, { w, h } = {}) { | ||
let { width, height, left, top, right, bottom } = element.getBoundingClientRect(); | ||
|
||
if ((width === 0 || height === 0) && w && h) { | ||
width = w; | ||
height = h; | ||
right = left + w; | ||
bottom = top + h; | ||
} | ||
|
||
return { width, height, left, top, right, bottom }; | ||
} | ||
|
||
function _getIntersectionOfRects(rects) { | ||
const bbox = { | ||
left: rects[0].left, | ||
right: rects[0].right, | ||
top: rects[0].top, | ||
bottom: rects[0].bottom | ||
}; | ||
|
||
for (let i = 1; i < rects.length; ++i) { | ||
bbox.left = Math.max(bbox.left, rects[i].left); | ||
bbox.right = Math.min(bbox.right, rects[i].right); | ||
|
||
if (bbox.left >= bbox.right) { | ||
return null; | ||
} | ||
|
||
bbox.top = Math.max(bbox.top, rects[i].top); | ||
bbox.bottom = Math.min(bbox.bottom, rects[i].bottom); | ||
|
||
if (bbox.top >= bbox.bottom) { | ||
return null; | ||
} | ||
} | ||
|
||
bbox.width = bbox.right - bbox.left; | ||
bbox.height = bbox.bottom - bbox.top; | ||
|
||
return bbox; | ||
} | ||
|
||
function _getPercentInView(element, topWin, { w, h } = {}) { | ||
const elementBoundingBox = _getBoundingBox(element, { w, h }); | ||
|
||
// Obtain the intersection of the element and the viewport | ||
const elementInViewBoundingBox = _getIntersectionOfRects([ { | ||
left: 0, | ||
top: 0, | ||
right: topWin.innerWidth, | ||
bottom: topWin.innerHeight | ||
}, elementBoundingBox ]); | ||
|
||
let elementInViewArea, elementTotalArea; | ||
|
||
if (elementInViewBoundingBox !== null) { | ||
// Some or all of the element is in view | ||
elementInViewArea = elementInViewBoundingBox.width * elementInViewBoundingBox.height; | ||
elementTotalArea = elementBoundingBox.width * elementBoundingBox.height; | ||
|
||
return ((elementInViewArea / elementTotalArea) * 100); | ||
} | ||
|
||
// No overlap between element and the viewport; therefore, the element | ||
// lies completely out of view | ||
return 0; | ||
} | ||
|
||
registerBidder(spec); |
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,38 @@ | ||
# Overview | ||
|
||
``` | ||
Module Name: Brightcom Bid Adapter | ||
Module Type: Bidder Adapter | ||
Maintainer: vladislavy@brightcom.com | ||
``` | ||
|
||
# Description | ||
|
||
Brightcom's adapter integration to the Prebid library. | ||
|
||
# Test Parameters | ||
|
||
``` | ||
var adUnits = [ | ||
{ | ||
code: 'test-leaderboard', | ||
sizes: [[728, 90]], | ||
bids: [{ | ||
bidder: 'brightcom', | ||
params: { | ||
publisherId: 2141020, | ||
bidFloor: 0.01 | ||
} | ||
}] | ||
}, { | ||
code: 'test-banner', | ||
sizes: [[300, 250]], | ||
bids: [{ | ||
bidder: 'brightcom', | ||
params: { | ||
publisherId: 2141020 | ||
} | ||
}] | ||
} | ||
] | ||
``` |
Oops, something went wrong.