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

ShowHeroes adapter v2 #5085

Merged
merged 18 commits into from
Apr 14, 2020
Merged

ShowHeroes adapter v2 #5085

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
d0b644d
add ShowHeroes Adapter
vadim-mazzherin Apr 10, 2019
b6c0154
Merge remote-tracking branch 'upstream/master'
vadim-mazzherin Sep 23, 2019
bfcdb91
ShowHeroes adapter - expanded outstream support
vadim-mazzherin Sep 23, 2019
c2e4686
Revert "ShowHeroes adapter - expanded outstream support"
vadim-mazzherin Sep 23, 2019
6c57d09
ShowHeroes adapter - expanded outstream support
vadim-mazzherin Sep 23, 2019
f10b01f
Merge branch 'master' of https://github.com/prebid/Prebid.js
veranevera Oct 1, 2019
6b36284
ShowHeroes adapter - fixes (#4222)
veranevera Oct 1, 2019
2f7f6e6
Merge branch 'master' of https://github.com/prebid/Prebid.js
veranevera Oct 7, 2019
c701851
ShowHeroes adapter - banner and outstream fixes (#4222)
veranevera Oct 7, 2019
3ea3260
Merge branch 'master' of https://github.com/prebid/Prebid.js
veranevera Oct 8, 2019
02ce519
ShowHeroes adapter - description and outstream changes (#4222)
veranevera Oct 8, 2019
041268c
ShowHeroes adapter - increase test coverage and small fix
vadim-mazzherin Oct 10, 2019
fa9d95c
Merge remote-tracking branch 'upstream/master'
vadim-mazzherin Oct 10, 2019
84009c7
Merge remote-tracking branch 'upstream/master'
vadim-mazzherin Dec 2, 2019
e11820c
ShowHeroes Adapter - naming convention issue
vadim-mazzherin Dec 3, 2019
94b1a53
Merge remote-tracking branch 'upstream/master'
vadim-mazzherin Dec 3, 2019
5319b37
Merge remote-tracking branch 'upstream/master'
vadim-mazzherin Mar 24, 2020
45b3714
Mixed AdUnits declaration support
vadim-mazzherin Apr 7, 2020
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
111 changes: 64 additions & 47 deletions modules/showheroes-bsBidAdapter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ export const spec = {
return !!bid.params.playerId;
},
buildRequests: function(validBidRequests, bidderRequest) {
let adUnits = [];
const pageURL = validBidRequests[0].params.contentPageUrl || bidderRequest.refererInfo.referer;
const isStage = !!validBidRequests[0].params.stage;
const isOutstream = utils.deepAccess(validBidRequests[0], 'mediaTypes.video.context') === 'outstream';
Expand All @@ -38,53 +39,53 @@ export const spec = {
const outstreamOptions = utils.deepAccess(validBidRequests[0], 'params.outstreamOptions');
const isBanner = !!validBidRequests[0].mediaTypes.banner || (isOutstream && !(isCustomRender || isNativeRender || isNodeRender));

let adUnits = validBidRequests.map((bid) => {
validBidRequests.forEach((bid) => {
const videoSizes = getVideoSizes(bid);
const bannerSizes = getBannerSizes(bid);
const vpaidMode = utils.getBidIdParameter('vpaidMode', bid.params);

let sizes = bid.sizes.length === 1 ? bid.sizes[0] : bid.sizes;
if (sizes && !sizes.length) {
let mediaSize;
let mediaVideoSize = utils.deepAccess(bid, 'mediaTypes.video.playerSize');
if (utils.isArray(mediaVideoSize)) {
mediaSize = mediaVideoSize;
const makeBids = (type, size) => {
let context = '';
let streamType = 2;

if (type === BANNER) {
streamType = 5;
} else {
mediaSize = bid.mediaTypes.banner.sizes;
}
if (utils.isArray(mediaSize[0])) {
sizes = mediaSize[0];
} else if (utils.isNumber(mediaSize[0])) {
sizes = mediaSize;
context = utils.deepAccess(bid, 'mediaTypes.video.context');
if (vpaidMode && context === 'instream') {
streamType = 1;
}
if (context === 'outstream') {
streamType = 5;
}
}
}

const context = utils.deepAccess(bid, 'mediaTypes.video.context');

let streamType = 2;
return {
type: streamType,
bidId: bid.bidId,
mediaType: type,
context: context,
playerId: utils.getBidIdParameter('playerId', bid.params),
auctionId: bidderRequest.auctionId,
bidderCode: BIDDER_CODE,
gdprConsent: bidderRequest.gdprConsent,
start: +new Date(),
timeout: 3000,
size: {
width: size[0],
height: size[1]
},
params: bid.params,
};
};

if (vpaidMode && context === 'instream') {
streamType = 1;
}
if (isBanner || context === 'outstream') {
streamType = 5;
}
videoSizes.forEach((size) => {
adUnits.push(makeBids(VIDEO, size));
});

return {
type: streamType,
bidId: bid.bidId,
mediaType: isBanner ? BANNER : VIDEO,
context: context,
playerId: utils.getBidIdParameter('playerId', bid.params),
auctionId: bidderRequest.auctionId,
bidderCode: BIDDER_CODE,
gdprConsent: bidderRequest.gdprConsent,
start: +new Date(),
timeout: 3000,
video: {
width: sizes[0],
height: sizes[1]
},
params: bid.params,
};
bannerSizes.forEach((size) => {
adUnits.push(makeBids(BANNER, size));
});
});

return {
Expand All @@ -94,6 +95,7 @@ export const spec = {
data: {
'user': [],
'meta': {
'adapterVersion': 2,
'pageURL': encodeURIComponent(pageURL),
'vastCacheEnabled': (!!config.getConfig('cache') && !isBanner && !outstreamOptions) || false,
'isDesktop': utils.getWindowTop().document.documentElement.clientWidth > 700,
Expand Down Expand Up @@ -156,12 +158,12 @@ function createBids(bidRes, reqData) {
bidUnit.cpm = bid.cpm;
bidUnit.requestId = bid.bidId;
bidUnit.currency = bid.currency;
bidUnit.mediaType = reqBid.mediaType || VIDEO;
bidUnit.mediaType = bid.mediaType || VIDEO;
bidUnit.ttl = TTL;
bidUnit.creativeId = 'c_' + bid.bidId;
bidUnit.netRevenue = true;
bidUnit.width = bid.video.width;
bidUnit.height = bid.video.height;
bidUnit.width = bid.size.width;
bidUnit.height = bid.size.height;
if (bid.vastXml) {
bidUnit.vastXml = bid.vastXml;
bidUnit.adResponse = {
Expand All @@ -171,16 +173,16 @@ function createBids(bidRes, reqData) {
if (bid.vastTag) {
bidUnit.vastUrl = bid.vastTag;
}
if (reqBid.mediaType === BANNER) {
if (bid.mediaType === BANNER) {
bidUnit.ad = getBannerHtml(bid, reqBid, reqData);
} else if (reqBid.context === 'outstream') {
} else if (bid.context === 'outstream') {
const renderer = Renderer.install({
id: bid.bidId,
url: '//',
config: {
playerId: reqBid.playerId,
width: bid.video.width,
height: bid.video.height,
width: bid.size.width,
height: bid.size.height,
vastUrl: bid.vastTag,
vastXml: bid.vastXml,
debug: reqData.debug,
Expand Down Expand Up @@ -267,4 +269,19 @@ function getBannerHtml (bid, reqBid, reqData) {
</html>`;
}

function getVideoSizes(bidRequest) {
return formatSizes(utils.deepAccess(bidRequest, 'mediaTypes.video.playerSize') || []);
}

function getBannerSizes(bidRequest) {
return formatSizes(utils.deepAccess(bidRequest, 'mediaTypes.banner.sizes') || bidRequest.sizes || []);
}

function formatSizes(sizes) {
if (!sizes || !sizes.length) {
return []
}
return Array.isArray(sizes[0]) ? sizes : [sizes];
}

registerBidder(spec);
110 changes: 89 additions & 21 deletions test/spec/modules/showheroes-bsBidAdapter_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,22 @@ const bidRequestBanner = {
}
}

const bidRequestBannerMultiSizes = {
...bidRequestCommonParams,
...{
'mediaTypes': {
'banner': {
'sizes': [[640, 360], [480, 320]]
}
}
}
}

const bidRequestVideoAndBanner = {
...bidRequestBanner,
...bidRequestVideo
}

describe('shBidAdapter', function () {
const adapter = newBidder(spec)

Expand Down Expand Up @@ -120,8 +136,8 @@ describe('shBidAdapter', function () {
}], bidderRequest)
const payload = request.data.requests[0];
expect(payload).to.be.an('object');
expect(payload.video).to.have.property('width', 640);
expect(payload.video).to.have.property('height', 480);
expect(payload.size).to.have.property('width', 640);
expect(payload.size).to.have.property('height', 480);

const request2 = spec.buildRequests([{
'params': {},
Expand All @@ -130,8 +146,8 @@ describe('shBidAdapter', function () {
}], bidderRequest)
const payload2 = request2.data.requests[0];
expect(payload).to.be.an('object');
expect(payload2.video).to.have.property('width', 320);
expect(payload2.video).to.have.property('height', 240);
expect(payload2.size).to.have.property('width', 320);
expect(payload2.size).to.have.property('height', 240);
})

it('should get size from mediaTypes when sizes property is empty', function () {
Expand All @@ -146,8 +162,8 @@ describe('shBidAdapter', function () {
}], bidderRequest)
const payload = request.data.requests[0];
expect(payload).to.be.an('object');
expect(payload.video).to.have.property('width', 640);
expect(payload.video).to.have.property('height', 480);
expect(payload.size).to.have.property('width', 640);
expect(payload.size).to.have.property('height', 480);

const request2 = spec.buildRequests([{
'params': {},
Expand All @@ -160,8 +176,8 @@ describe('shBidAdapter', function () {
}], bidderRequest)
const payload2 = request2.data.requests[0];
expect(payload).to.be.an('object');
expect(payload2.video).to.have.property('width', 320);
expect(payload2.video).to.have.property('height', 240);
expect(payload2.size).to.have.property('width', 320);
expect(payload2.size).to.have.property('height', 240);
})

it('should attach valid params to the payload when type is video', function () {
Expand Down Expand Up @@ -191,6 +207,38 @@ describe('shBidAdapter', function () {
expect(payload).to.have.property('type', 5);
})

it('should attach valid params to the payload when type is banner (multi sizes)', function () {
const request = spec.buildRequests([bidRequestBannerMultiSizes], bidderRequest)
const payload = request.data.requests[0];
expect(payload).to.be.an('object');
expect(payload).to.have.property('playerId', '47427aa0-f11a-4d24-abca-1295a46a46cd');
expect(payload).to.have.property('mediaType', BANNER);
expect(payload).to.have.property('type', 5);
expect(payload).to.have.nested.property('size.width', 640);
expect(payload).to.have.nested.property('size.height', 360);
const payload2 = request.data.requests[1];
expect(payload2).to.be.an('object');
expect(payload2).to.have.property('playerId', '47427aa0-f11a-4d24-abca-1295a46a46cd');
expect(payload2).to.have.property('mediaType', BANNER);
expect(payload2).to.have.property('type', 5);
expect(payload2).to.have.nested.property('size.width', 480);
expect(payload2).to.have.nested.property('size.height', 320);
})

it('should attach valid params to the payload when type is banner and video', function () {
const request = spec.buildRequests([bidRequestVideoAndBanner], bidderRequest)
const payload = request.data.requests[0];
expect(payload).to.be.an('object');
expect(payload).to.have.property('playerId', '47427aa0-f11a-4d24-abca-1295a46a46cd');
expect(payload).to.have.property('mediaType', VIDEO);
expect(payload).to.have.property('type', 2);
const payload2 = request.data.requests[1];
expect(payload2).to.be.an('object');
expect(payload2).to.have.property('playerId', '47427aa0-f11a-4d24-abca-1295a46a46cd');
expect(payload2).to.have.property('mediaType', BANNER);
expect(payload2).to.have.property('type', 5);
})

it('passes gdpr if present', function () {
const request = spec.buildRequests([bidRequestVideo], {...bidderRequest, ...gdpr})
const payload = request.data.requests[0];
Expand All @@ -208,16 +256,36 @@ describe('shBidAdapter', function () {
const vastTag = 'https://video-library.stage.showheroes.com/commercial/wrapper?player_id=47427aa0-f11a-4d24-abca-1295a46a46cd&ad_bidder=showheroes-bs&master_shadt=1&description_url=https%3A%2F%2Fbid-service.stage.showheroes.com%2Fvast%2Fad%2Fcache%2F4840b920-40e1-4e09-9231-60bbf088c8d6'
const vastXml = '<?xml version="1.0" encoding="utf-8"?><VAST version="3.0"><Error><![CDATA[https://static.showheroes.com/shim.gif]]></Error></VAST>'

const response = {
const basicResponse = {
'cpm': 5,
'currency': 'EUR',
'mediaType': VIDEO,
'context': 'instream',
'bidId': '38b373e1e31c18',
'size': {'width': 640, 'height': 480},
'vastTag': 'https:\/\/video-library.stage.showheroes.com\/commercial\/wrapper?player_id=47427aa0-f11a-4d24-abca-1295a46a46cd&ad_bidder=showheroes-bs&master_shadt=1&description_url=https%3A%2F%2Fbid-service.stage.showheroes.com%2Fvast%2Fad%2Fcache%2F4840b920-40e1-4e09-9231-60bbf088c8d6',
'vastXml': vastXml,
};

const responseVideo = {
'bids': [{
'cpm': 5,
'currency': 'EUR',
'bidId': '38b373e1e31c18',
'video': {'width': 640, 'height': 480},
'vastTag': 'https:\/\/video-library.stage.showheroes.com\/commercial\/wrapper?player_id=47427aa0-f11a-4d24-abca-1295a46a46cd&ad_bidder=showheroes-bs&master_shadt=1&description_url=https%3A%2F%2Fbid-service.stage.showheroes.com%2Fvast%2Fad%2Fcache%2F4840b920-40e1-4e09-9231-60bbf088c8d6',
'vastXml': vastXml,
...basicResponse,
}],
}
};

const responseVideoOutstream = {
'bids': [{
...basicResponse,
'context': 'outstream',
}],
};

const responseBanner = {
'bids': [{
...basicResponse,
'mediaType': BANNER,
}],
};

it('should get correct bid response when type is video', function () {
const request = spec.buildRequests([bidRequestVideo], bidderRequest)
Expand All @@ -240,14 +308,14 @@ describe('shBidAdapter', function () {
}
]

const result = spec.interpretResponse({'body': response}, request)
const result = spec.interpretResponse({'body': responseVideo}, request)
expect(result).to.deep.equal(expectedResponse)
})

it('should get correct bid response when type is banner', function () {
const request = spec.buildRequests([bidRequestBanner], bidderRequest)

const result = spec.interpretResponse({'body': response}, request)
const result = spec.interpretResponse({'body': responseBanner}, request)
expect(result[0]).to.have.property('mediaType', BANNER);
expect(result[0].ad).to.include('<script async src="https://static.showheroes.com/publishertag.js')
expect(result[0].ad).to.include('<div class="showheroes-spot"')
Expand All @@ -266,7 +334,7 @@ describe('shBidAdapter', function () {

const request = spec.buildRequests([bidRequest], bidderRequest)

const result = spec.interpretResponse({'body': response}, request)
const result = spec.interpretResponse({'body': responseVideoOutstream}, request)
const bid = result[0]
expect(bid).to.have.property('mediaType', VIDEO);

Expand Down Expand Up @@ -297,7 +365,7 @@ describe('shBidAdapter', function () {

const request = spec.buildRequests([bidRequest], bidderRequest)

const result = spec.interpretResponse({'body': response}, request)
const result = spec.interpretResponse({'body': responseVideoOutstream}, request)
const bid = result[0]
expect(bid).to.have.property('mediaType', VIDEO);

Expand Down Expand Up @@ -332,7 +400,7 @@ describe('shBidAdapter', function () {

const request = spec.buildRequests([bidRequest], bidderRequest)

const result = spec.interpretResponse({'body': response}, request)
const result = spec.interpretResponse({'body': responseVideoOutstream}, request)
const bid = result[0]
expect(bid).to.have.property('mediaType', VIDEO);

Expand Down