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

Jump to bottom

Sonobi Adapter - 3.0 prep - get sizes from mediaTypes.banner instead of bid.sizes #4311

Merged
merged 1 commit into from
Oct 22, 2019
Merged

Sonobi Adapter - 3.0 prep - get sizes from mediaTypes.banner instead of bid.sizes #4311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 41 additions & 2 deletions modules/sonobiBidAdapter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,36 @@ export const spec = {
* @param {BidRequest} bid - The bid params to validate.
* @return {boolean} True if this is a valid bid, and false otherwise.
*/
isBidRequestValid: bid => !!(bid.params && (bid.params.ad_unit || bid.params.placement_id) && (bid.params.sizes || bid.sizes)),
isBidRequestValid: (bid) => {
if (!bid.params) {
return false;
}
if (!bid.params.ad_unit && !bid.params.placement_id) {
return false;
}

if (!deepAccess(bid, 'mediaTypes.banner') && !deepAccess(bid, 'mediaTypes.video')) {
return false;
}

if (deepAccess(bid, 'mediaTypes.banner')) { // Sonobi does not support multi type bids, favor banner over video
if (!deepAccess(bid, 'mediaTypes.banner.sizes') && !bid.params.sizes) {
// sizes at the banner or params level is required.
return false;
}
} else if (deepAccess(bid, 'mediaTypes.video')) {
if (deepAccess(bid, 'mediaTypes.video.context') === 'outstream' && !bid.params.sizes) {
// bids.params.sizes is required for outstream video adUnits
return false;
}
if (deepAccess(bid, 'mediaTypes.video.context') === 'instream' && !deepAccess(bid, 'mediaTypes.video.playerSize')) {
// playerSize is required for instream adUnits.
return false;
}
}

return true;
},
/**
* Make a server request from the list of BidRequests.
*
Expand Down Expand Up @@ -227,10 +255,21 @@ function _findBidderRequest(bidderRequests, bidId) {
}

function _validateSize (bid) {
if (deepAccess(bid, 'mediaTypes.video')) {
return ''; // Video bids arent allowed to override sizes via the trinity request
}

if (bid.params.sizes) {
return parseSizesInput(bid.params.sizes).join(',');
}
return parseSizesInput(bid.sizes).join(',');
if (deepAccess(bid, 'mediaTypes.banner.sizes')) {
return parseSizesInput(deepAccess(bid, 'mediaTypes.banner.sizes')).join(',');
}

// Handle deprecated sizes definition
if (bid.sizes) {
return parseSizesInput(bid.sizes).join(',');
}
}

function _validateSlot (bid) {
Expand Down
279 changes: 207 additions & 72 deletions test/spec/modules/sonobiBidAdapter_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,87 +19,222 @@ describe('SonobiBidAdapter', function () {
})

describe('.isBidRequestValid', function () {
let bid = {
'bidder': 'sonobi',
'params': {
'ad_unit': '/7780971/sparks_prebid_MR',
'sizes': [[300, 250], [300, 600]],
'floor': '1'
},
'adUnitCode': 'adunit-code',
'sizes': [[300, 250], [300, 600]],
'bidId': '30b31c1838de1e',
'bidderRequestId': '22edbae2733bf6',
'auctionId': '1d1a030790a475',
}

it('should return true when required params found', function () {
expect(spec.isBidRequestValid(bid)).to.equal(true)
})

it('should return true when bid.params.placement_id and bid.params.sizes are found', function () {
let bid = Object.assign({}, bid)
delete bid.params
delete bid.sizes
bid.params = {
'placement_id': '1a2b3c4d5e6f1a2b3c4d',
'sizes': [[300, 250], [300, 600]],
}
it('should return false if there are no params', () => {
const bid = {
'bidder': 'sonobi',
'adUnitCode': 'adunit-code',
'mediaTypes': {
banner: {
sizes: [[300, 250], [300, 600]]
}
},
'bidId': '30b31c1838de1e',
'bidderRequestId': '22edbae2733bf6',
'auctionId': '1d1a030790a475',
};
expect(spec.isBidRequestValid(bid)).to.equal(false);
});

expect(spec.isBidRequestValid(bid)).to.equal(true)
})
it('should return false if there is no placement_id param and no ad_unit param', () => {
const bid = {
'bidder': 'sonobi',
'adUnitCode': 'adunit-code',
params: {
placementId: '1a2b3c4d5e6f1a2b3c4d',
},
'mediaTypes': {
banner: {
sizes: [[300, 250], [300, 600]]
}
},
'bidId': '30b31c1838de1e',
'bidderRequestId': '22edbae2733bf6',
'auctionId': '1d1a030790a475',
};
expect(spec.isBidRequestValid(bid)).to.equal(false);
});

it('should return true when bid.params.placement_id and bid.sizes are found', function () {
let bid = Object.assign({}, bid)
delete bid.params
bid.sizes = [[300, 250], [300, 600]]
bid.params = {
'placement_id': '1a2b3c4d5e6f1a2b3c4d',
}
it('should return false if there is no mediaTypes', () => {
const bid = {
'bidder': 'sonobi',
'adUnitCode': 'adunit-code',
params: {
placement_id: '1a2b3c4d5e6f1a2b3c4d'
},
'mediaTypes': {
},
'bidId': '30b31c1838de1e',
'bidderRequestId': '22edbae2733bf6',
'auctionId': '1d1a030790a475',
};
expect(spec.isBidRequestValid(bid)).to.equal(false);
});

expect(spec.isBidRequestValid(bid)).to.equal(true)
})
it('should return true if the bid is valid', () => {
const bid = {
'bidder': 'sonobi',
'adUnitCode': 'adunit-code',
params: {
placement_id: '1a2b3c4d5e6f1a2b3c4d'
},
'mediaTypes': {
banner: {
sizes: [[300, 250], [300, 600]]
}
},
'bidId': '30b31c1838de1e',
'bidderRequestId': '22edbae2733bf6',
'auctionId': '1d1a030790a475',
};
expect(spec.isBidRequestValid(bid)).to.equal(true);
});

it('should return true when bid.params.ad_unit and bid.params.sizes are found', function () {
let bid = Object.assign({}, bid)
delete bid.params
delete bid.sizes
bid.params = {
'ad_unit': '/7780971/sparks_prebid_MR',
'sizes': [[300, 250], [300, 600]],
}
describe('banner', () => {
it('should return false if there are no banner sizes and no param sizes', () => {
const bid = {
'bidder': 'sonobi',
'adUnitCode': 'adunit-code',
params: {
placement_id: '1a2b3c4d5e6f1a2b3c4d'
},
'mediaTypes': {
banner: {

expect(spec.isBidRequestValid(bid)).to.equal(true)
})
}
},
'bidId': '30b31c1838de1e',
'bidderRequestId': '22edbae2733bf6',
'auctionId': '1d1a030790a475',
};
expect(spec.isBidRequestValid(bid)).to.equal(false);
});

it('should return true when bid.params.ad_unit and bid.sizes are found', function () {
let bid = Object.assign({}, bid)
delete bid.params
bid.sizes = [[300, 250], [300, 600]]
bid.params = {
'ad_unit': '/7780971/sparks_prebid_MR',
}
it('should return true if there is banner sizes and no param sizes', () => {
const bid = {
'bidder': 'sonobi',
'adUnitCode': 'adunit-code',
params: {
placement_id: '1a2b3c4d5e6f1a2b3c4d'
},
'mediaTypes': {
banner: {
sizes: [[300, 250], [300, 600]]
}
},
'bidId': '30b31c1838de1e',
'bidderRequestId': '22edbae2733bf6',
'auctionId': '1d1a030790a475',
};
expect(spec.isBidRequestValid(bid)).to.equal(true);
});

expect(spec.isBidRequestValid(bid)).to.equal(true)
})
it('should return true if there is param sizes and no banner sizes', () => {
const bid = {
'bidder': 'sonobi',
'adUnitCode': 'adunit-code',
params: {
placement_id: '1a2b3c4d5e6f1a2b3c4d',
sizes: [[300, 250], [300, 600]]
},
'mediaTypes': {
banner: {
}
},
'bidId': '30b31c1838de1e',
'bidderRequestId': '22edbae2733bf6',
'auctionId': '1d1a030790a475',
};
expect(spec.isBidRequestValid(bid)).to.equal(true);
});
});

it('should return false when no params are found', function () {
let bid = Object.assign({}, bid)
delete bid.params
expect(spec.isBidRequestValid(bid)).to.equal(false)
})
describe('video', () => {
describe('instream', () => {
it('should return false if there is no playerSize defined in the video mediaType', () => {
const bid = {
'bidder': 'sonobi',
'adUnitCode': 'adunit-code',
params: {
placement_id: '1a2b3c4d5e6f1a2b3c4d',
sizes: [[300, 250], [300, 600]]
},
'mediaTypes': {
video: {
context: 'instream'
}
},
'bidId': '30b31c1838de1e',
'bidderRequestId': '22edbae2733bf6',
'auctionId': '1d1a030790a475',
};
expect(spec.isBidRequestValid(bid)).to.equal(false);
});

it('should return true if there is playerSize defined on the video mediaType', () => {
const bid = {
'bidder': 'sonobi',
'adUnitCode': 'adunit-code',
params: {
placement_id: '1a2b3c4d5e6f1a2b3c4d',
},
'mediaTypes': {
video: {
context: 'instream',
playerSize: [300, 250]
}
},
'bidId': '30b31c1838de1e',
'bidderRequestId': '22edbae2733bf6',
'auctionId': '1d1a030790a475',
};
expect(spec.isBidRequestValid(bid)).to.equal(true);
});
});

it('should return false when bid.params.placement_id and bid.params.ad_unit are not found', function () {
let bid = Object.assign({}, bid)
delete bid.params
bid.params = {
'placement_id': 0,
'ad_unit': 0,
'sizes': [[300, 250], [300, 600]],
}
expect(spec.isBidRequestValid(bid)).to.equal(false)
})
})
describe('outstream', () => {
it('should return false if there is no param sizes', () => {
const bid = {
'bidder': 'sonobi',
'adUnitCode': 'adunit-code',
params: {
placement_id: '1a2b3c4d5e6f1a2b3c4d',
},
'mediaTypes': {
video: {
context: 'outstream',
playerSize: [300, 250]
}
},
'bidId': '30b31c1838de1e',
'bidderRequestId': '22edbae2733bf6',
'auctionId': '1d1a030790a475',
};
expect(spec.isBidRequestValid(bid)).to.equal(false);
});

it('should return true if there is param sizes', () => {
const bid = {
'bidder': 'sonobi',
'adUnitCode': 'adunit-code',
params: {
placement_id: '1a2b3c4d5e6f1a2b3c4d',
sizes: [300, 250]

},
'mediaTypes': {
video: {
context: 'outstream'
}
},
'bidId': '30b31c1838de1e',
'bidderRequestId': '22edbae2733bf6',
'auctionId': '1d1a030790a475',
};
expect(spec.isBidRequestValid(bid)).to.equal(true);
});
});
});
});

describe('.buildRequests', function () {
beforeEach(function() {
Expand Down