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

VIS.X adapter: fix for multiformat ad units & added fields to bidResponse.meta #6936

Merged
merged 4 commits into from
Jun 4, 2021
Merged

VIS.X adapter: fix for multiformat ad units & added fields to bidResponse.meta #6936

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1194513
VIS.X: fallback to banner if video configuration isn't supported
Jun 3, 2021
a76c56f
VIS.X: unused prop
Jun 3, 2021
c7dedbb
VIS.X: pass advertiserDomains & mediaType to bidResponse.meta
Jun 4, 2021
f098a54
Merge remote-tracking branch 'upstream/master' into visx-fix-for-mult…
Jun 4, 2021
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
63 changes: 49 additions & 14 deletions modules/visxBidAdapter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,11 @@ export const spec = {
supportedMediaTypes: [BANNER, VIDEO],
isBidRequestValid: function(bid) {
if (_isVideoBid(bid)) {
if (!_isValidVideoBid(bid)) {
return false;
if (!_isValidVideoBid(bid, true)) {
// in case if video bid configuration invalid will try to send bid request for banner
if (!_isBannerBid(bid)) {
return false;
}
}
}
return !!bid.params.uid;
Expand Down Expand Up @@ -243,6 +246,10 @@ function _addBidResponse(serverBid, bidsMap, currency, bidResponses, bidsWithout
netRevenue: true,
ttl: TIME_TO_LIVE,
dealId: serverBid.dealid,
meta: {
advertiserDomains: serverBid.advertiserDomains ? serverBid.advertiserDomains : [],
mediaType: serverBid.mediaType
},
};

if (serverBid.ext && serverBid.ext.prebid) {
Expand Down Expand Up @@ -289,23 +296,35 @@ function _isVideoBid(bid) {
return bid.mediaType === VIDEO || deepAccess(bid, 'mediaTypes.video');
}

function _isValidVideoBid(bid) {
function _isBannerBid(bid) {
return bid.mediaType === BANNER || deepAccess(bid, 'mediaTypes.banner');
}

function _isValidVideoBid(bid, logErrors = false) {
let result = true;
const videoMediaType = deepAccess(bid, 'mediaTypes.video');
if (videoMediaType.context !== VIDEO_INSTREAM) {
logError(LOG_ERROR_MESS.onlyVideoInstream)
if (logErrors) {
logError(LOG_ERROR_MESS.onlyVideoInstream);
}
result = false;
}
if (!(videoMediaType.playerSize && parseSizesInput(deepAccess(videoMediaType, 'playerSize', [])))) {
logError(LOG_ERROR_MESS.videoMissing + 'playerSize');
if (logErrors) {
logError(LOG_ERROR_MESS.videoMissing + 'playerSize');
}
result = false;
}
if (!videoMediaType.mimes) {
logError(LOG_ERROR_MESS.videoMissing + 'mimes');
if (logErrors) {
logError(LOG_ERROR_MESS.videoMissing + 'mimes');
}
result = false;
}
if (!videoMediaType.protocols) {
logError(LOG_ERROR_MESS.videoMissing + 'protocols');
if (logErrors) {
logError(LOG_ERROR_MESS.videoMissing + 'protocols');
}
result = false;
}
return result;
Expand All @@ -323,13 +342,29 @@ function _initVideoTypes(bids) {
if (bids && bids.length) {
bids.forEach(function (bid) {
const mediaTypes = deepAccess(bid, 'mediaTypes.video', {});
_playerSize.push(parseSizesInput(deepAccess(mediaTypes, 'playerSize', [])).join('|'));
_protocols.push(deepAccess(mediaTypes, 'protocols', []).join('|'));
_api.push(deepAccess(mediaTypes, 'api', []).join('|'));
_mimes.push(deepAccess(mediaTypes, 'mimes', []).join('|'));
_minduration.push(deepAccess(mediaTypes, 'minduration', null));
_maxduration.push(deepAccess(mediaTypes, 'maxduration', null));
_skip.push(deepAccess(mediaTypes, 'skip', null));
let bidPlayerSize = '';
let bidProtocols = '';
let bidApi = '';
let bidMimes = '';
let bidMinduration = null;
let bidMaxduration = null;
let bidSkip = null;
if (_isVideoBid(bid) && _isValidVideoBid(bid)) {
bidPlayerSize = parseSizesInput(deepAccess(mediaTypes, 'playerSize', [])).join('|');
bidProtocols = deepAccess(mediaTypes, 'protocols', []).join('|');
bidApi = deepAccess(mediaTypes, 'api', []).join('|');
bidMimes = deepAccess(mediaTypes, 'mimes', []).join('|');
bidMinduration = deepAccess(mediaTypes, 'minduration', null);
bidMaxduration = deepAccess(mediaTypes, 'maxduration', null);
bidSkip = deepAccess(mediaTypes, 'skip', null);
}
_playerSize.push(bidPlayerSize);
_protocols.push(bidProtocols);
_api.push(bidApi);
_mimes.push(bidMimes);
_minduration.push(bidMinduration);
_maxduration.push(bidMaxduration);
_skip.push(bidSkip);
});
}
_playerSize = _playerSize.join(',');
Expand Down
117 changes: 106 additions & 11 deletions test/spec/modules/visxBidAdapter_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,11 +302,50 @@ describe('VisxAdapter', function () {
});
});

describe('buildRequests (multiple media types w/ unsupported video+outstream)', function () {
const bidderRequest = {
refererInfo: {
referer: 'https://example.com'
}
};
const referrer = bidderRequest.refererInfo.referer;
const bidRequests = [
{
'bidder': 'visx',
'params': {
'uid': '903538'
},
'adUnitCode': 'misconfigured-video',
'sizes': [[300, 250], [300, 600]],
'mediaTypes': {
'video': {
'context': 'outstream',
'playerSize': [400, 300]
}
},
'bidId': '39aff3a7169a6a',
'bidderRequestId': '22edffe2733bf6',
'auctionId': '1d1a030790a476',
}
];

it('should send requst for banner bid', function () {
const request = spec.buildRequests([bidRequests[0]], bidderRequest);
const payload = request.data;
expect(payload).to.be.an('object');
expect(payload).to.have.property('u', referrer);
expect(payload).to.have.property('pt', 'net');
expect(payload).to.have.property('auids', '903538');
expect(payload).to.have.property('sizes', '300x250,300x600');
expect(payload).to.not.have.property('playerSize');
});
});

describe('interpretResponse', function () {
const responses = [
{'bid': [{'price': 1.15, 'adm': '<div>test content 1</div>', 'auid': 903535, 'h': 250, 'w': 300, 'cur': 'EUR'}], 'seat': '1'},
{'bid': [{'price': 0.5, 'adm': '<div>test content 2</div>', 'auid': 903536, 'h': 600, 'w': 300, 'cur': 'EUR'}], 'seat': '1'},
{'bid': [{'price': 0.15, 'adm': '<div>test content 3</div>', 'auid': 903535, 'h': 90, 'w': 728, 'cur': 'EUR'}], 'seat': '1'},
{'bid': [{'price': 1.15, 'adm': '<div>test content 1</div>', 'auid': 903535, 'h': 250, 'w': 300, 'cur': 'EUR', 'mediaType': 'banner', 'advertiserDomains': ['some_domain.com']}], 'seat': '1'},
{'bid': [{'price': 0.5, 'adm': '<div>test content 2</div>', 'auid': 903536, 'h': 600, 'w': 300, 'cur': 'EUR', 'mediaType': 'banner'}], 'seat': '1'},
{'bid': [{'price': 0.15, 'adm': '<div>test content 3</div>', 'auid': 903535, 'h': 90, 'w': 728, 'cur': 'EUR', 'mediaType': 'banner'}], 'seat': '1'},
{'bid': [{'price': 0, 'auid': 903537, 'h': 250, 'w': 300, 'cur': 'EUR'}], 'seat': '1'},
{'bid': [{'price': 0, 'adm': '<div>test content 5</div>', 'h': 250, 'w': 300, 'cur': 'EUR'}], 'seat': '1'},
undefined,
Expand Down Expand Up @@ -341,6 +380,10 @@ describe('VisxAdapter', function () {
'currency': 'EUR',
'netRevenue': true,
'ttl': 360,
'meta': {
'advertiserDomains': ['some_domain.com'],
'mediaType': 'banner',
},
}
];

Expand Down Expand Up @@ -397,6 +440,10 @@ describe('VisxAdapter', function () {
'currency': 'EUR',
'netRevenue': true,
'ttl': 360,
'meta': {
'advertiserDomains': ['some_domain.com'],
'mediaType': 'banner',
},
},
{
'requestId': '4dff80cc4ee346',
Expand All @@ -409,6 +456,10 @@ describe('VisxAdapter', function () {
'currency': 'EUR',
'netRevenue': true,
'ttl': 360,
'meta': {
'advertiserDomains': [],
'mediaType': 'banner',
},
},
{
'requestId': '5703af74d0472a',
Expand All @@ -421,6 +472,10 @@ describe('VisxAdapter', function () {
'currency': 'EUR',
'netRevenue': true,
'ttl': 360,
'meta': {
'advertiserDomains': [],
'mediaType': 'banner',
},
}
];

Expand Down Expand Up @@ -456,6 +511,10 @@ describe('VisxAdapter', function () {
'currency': 'PLN',
'netRevenue': true,
'ttl': 360,
'meta': {
'advertiserDomains': ['some_domain.com'],
'mediaType': 'banner',
},
}
];

Expand Down Expand Up @@ -509,11 +568,11 @@ describe('VisxAdapter', function () {

it('complicated case', function () {
const fullResponse = [
{'bid': [{'price': 1.15, 'adm': '<div>test content 1</div>', 'auid': 903535, 'h': 250, 'w': 300, 'cur': 'EUR'}], 'seat': '1'},
{'bid': [{'price': 0.5, 'adm': '<div>test content 2</div>', 'auid': 903536, 'h': 600, 'w': 300, 'cur': 'EUR'}], 'seat': '1'},
{'bid': [{'price': 0.15, 'adm': '<div>test content 3</div>', 'auid': 903535, 'h': 90, 'w': 728, 'cur': 'EUR'}], 'seat': '1'},
{'bid': [{'price': 0.15, 'adm': '<div>test content 4</div>', 'auid': 903535, 'h': 600, 'w': 300, 'cur': 'EUR'}], 'seat': '1'},
{'bid': [{'price': 0.5, 'adm': '<div>test content 5</div>', 'auid': 903536, 'h': 600, 'w': 350, 'cur': 'EUR'}], 'seat': '1'},
{'bid': [{'price': 1.15, 'adm': '<div>test content 1</div>', 'auid': 903535, 'h': 250, 'w': 300, 'cur': 'EUR', 'mediaType': 'banner', 'advertiserDomains': ['some_domain.com']}], 'seat': '1'},
{'bid': [{'price': 0.5, 'adm': '<div>test content 2</div>', 'auid': 903536, 'h': 600, 'w': 300, 'cur': 'EUR', 'mediaType': 'banner'}], 'seat': '1'},
{'bid': [{'price': 0.15, 'adm': '<div>test content 3</div>', 'auid': 903535, 'h': 90, 'w': 728, 'cur': 'EUR', 'mediaType': 'banner'}], 'seat': '1'},
{'bid': [{'price': 0.15, 'adm': '<div>test content 4</div>', 'auid': 903535, 'h': 600, 'w': 300, 'cur': 'EUR', 'mediaType': 'banner'}], 'seat': '1'},
{'bid': [{'price': 0.5, 'adm': '<div>test content 5</div>', 'auid': 903536, 'h': 600, 'w': 350, 'cur': 'EUR', 'mediaType': 'banner'}], 'seat': '1'},
];
const bidRequests = [
{
Expand Down Expand Up @@ -585,6 +644,10 @@ describe('VisxAdapter', function () {
'currency': 'EUR',
'netRevenue': true,
'ttl': 360,
'meta': {
'advertiserDomains': ['some_domain.com'],
'mediaType': 'banner',
},
},
{
'requestId': '4e111f1b66e4',
Expand All @@ -597,6 +660,10 @@ describe('VisxAdapter', function () {
'currency': 'EUR',
'netRevenue': true,
'ttl': 360,
'meta': {
'advertiserDomains': [],
'mediaType': 'banner',
},
},
{
'requestId': '26d6f897b516',
Expand All @@ -609,6 +676,10 @@ describe('VisxAdapter', function () {
'currency': 'EUR',
'netRevenue': true,
'ttl': 360,
'meta': {
'advertiserDomains': [],
'mediaType': 'banner',
},
},
{
'requestId': '326bde7fbf69',
Expand All @@ -621,6 +692,10 @@ describe('VisxAdapter', function () {
'currency': 'EUR',
'netRevenue': true,
'ttl': 360,
'meta': {
'advertiserDomains': [],
'mediaType': 'banner',
},
},
{
'requestId': '1751cd90161',
Expand All @@ -633,6 +708,10 @@ describe('VisxAdapter', function () {
'currency': 'EUR',
'netRevenue': true,
'ttl': 360,
'meta': {
'advertiserDomains': [],
'mediaType': 'banner',
},
}
];

Expand All @@ -642,8 +721,8 @@ describe('VisxAdapter', function () {

it('dublicate uids and sizes in one slot', function () {
const fullResponse = [
{'bid': [{'price': 1.15, 'adm': '<div>test content 1</div>', 'auid': 903535, 'h': 250, 'w': 300, 'cur': 'EUR'}], 'seat': '1'},
{'bid': [{'price': 0.5, 'adm': '<div>test content 2</div>', 'auid': 903535, 'h': 250, 'w': 300, 'cur': 'EUR'}], 'seat': '1'},
{'bid': [{'price': 1.15, 'adm': '<div>test content 1</div>', 'auid': 903535, 'h': 250, 'w': 300, 'cur': 'EUR', 'mediaType': 'banner'}], 'seat': '1'},
{'bid': [{'price': 0.5, 'adm': '<div>test content 2</div>', 'auid': 903535, 'h': 250, 'w': 300, 'cur': 'EUR', 'mediaType': 'banner'}], 'seat': '1'},
];
const bidRequests = [
{
Expand Down Expand Up @@ -693,6 +772,10 @@ describe('VisxAdapter', function () {
'currency': 'EUR',
'netRevenue': true,
'ttl': 360,
'meta': {
'advertiserDomains': [],
'mediaType': 'banner',
},
},
{
'requestId': '57b2ebe70e16',
Expand All @@ -705,6 +788,10 @@ describe('VisxAdapter', function () {
'currency': 'EUR',
'netRevenue': true,
'ttl': 360,
'meta': {
'advertiserDomains': [],
'mediaType': 'banner',
},
}
];

Expand All @@ -714,7 +801,7 @@ describe('VisxAdapter', function () {

it('handles video bid', function () {
const fullResponse = [
{'bid': [{'price': 0.5, 'adm': '<VAST/>', 'auid': 903537, 'w': 400, 'h': 300, 'cur': 'EUR'}], 'seat': '1'},
{'bid': [{'price': 0.5, 'adm': '<VAST/>', 'auid': 903537, 'w': 400, 'h': 300, 'cur': 'EUR', 'mediaType': 'video'}], 'seat': '1'},
];
const bidRequests = [
{
Expand Down Expand Up @@ -751,6 +838,10 @@ describe('VisxAdapter', function () {
'currency': 'EUR',
'netRevenue': true,
'ttl': 360,
'meta': {
'advertiserDomains': [],
'mediaType': 'video',
},
}
];
const result = spec.interpretResponse({'body': {'seatbid': fullResponse}}, request);
Expand Down Expand Up @@ -786,6 +877,10 @@ describe('VisxAdapter', function () {
'currency': 'EUR',
'netRevenue': true,
'ttl': 360,
'meta': {
'advertiserDomains': ['some_domain.com'],
'mediaType': 'banner',
},
'ext': {
'events': {
'pending': pendingUrl,
Expand Down