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

Criteo Bid Adapter: add support for banner+native multiformat ad unit #8842

Merged
merged 1 commit into from
Aug 18, 2022
Merged
Show file tree
Hide file tree
Changes from all 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
32 changes: 19 additions & 13 deletions modules/criteoBidAdapter.js
Original file line number Diff line number Diff line change
Expand Up @@ -469,15 +469,20 @@ function buildCdbRequest(context, bidRequests, bidderRequest) {
if (bidRequest.params.publisherSubId) {
slot.publishersubid = bidRequest.params.publisherSubId;
}
if (bidRequest.params.nativeCallback || deepAccess(bidRequest, `mediaTypes.${NATIVE}`)) {

if (bidRequest.params.nativeCallback || hasNativeMediaType(bidRequest)) {
slot.native = true;
if (!checkNativeSendId(bidRequest)) {
logWarn(LOG_PREFIX + 'all native assets containing URL should be sent as placeholders with sendId(icon, image, clickUrl, displayUrl, privacyLink, privacyIcon)');
}
slot.sizes = parseSizes(deepAccess(bidRequest, 'mediaTypes.banner.sizes'), parseNativeSize);
} else {
}

if (hasBannerMediaType(bidRequest)) {
slot.sizes = parseSizes(deepAccess(bidRequest, 'mediaTypes.banner.sizes'), parseSize);
} else {
slot.sizes = [];
}

if (hasVideoMediaType(bidRequest)) {
const video = {
playersizes: parseSizes(deepAccess(bidRequest, 'mediaTypes.video.playerSize'), parseSize),
Expand Down Expand Up @@ -554,17 +559,18 @@ function parseSize(size) {
return size[0] + 'x' + size[1];
}

function parseNativeSize(size) {
if (size[0] === undefined && size[1] === undefined) {
return '2x2';
}
return size[0] + 'x' + size[1];
}

function hasVideoMediaType(bidRequest) {
return deepAccess(bidRequest, 'mediaTypes.video') !== undefined;
}

function hasBannerMediaType(bidRequest) {
return deepAccess(bidRequest, 'mediaTypes.banner') !== undefined;
}

function hasNativeMediaType(bidRequest) {
return deepAccess(bidRequest, 'mediaTypes.native') !== undefined;
}

function hasValidVideoMediaType(bidRequest) {
let isValid = true;

Expand Down Expand Up @@ -646,18 +652,18 @@ function enrichSlotWithFloors(slot, bidRequest) {
if (bidRequest.mediaTypes?.banner) {
slotFloors.banner = {};
const bannerSizes = parseSizes(deepAccess(bidRequest, 'mediaTypes.banner.sizes'))
bannerSizes.forEach(bannerSize => slotFloors.banner[parseSize(bannerSize).toString()] = bidRequest.getFloor({size: bannerSize, mediaType: BANNER}));
bannerSizes.forEach(bannerSize => slotFloors.banner[parseSize(bannerSize).toString()] = bidRequest.getFloor({ size: bannerSize, mediaType: BANNER }));
}

if (bidRequest.mediaTypes?.video) {
slotFloors.video = {};
const videoSizes = parseSizes(deepAccess(bidRequest, 'mediaTypes.video.playerSize'))
videoSizes.forEach(videoSize => slotFloors.video[parseSize(videoSize).toString()] = bidRequest.getFloor({size: videoSize, mediaType: VIDEO}));
videoSizes.forEach(videoSize => slotFloors.video[parseSize(videoSize).toString()] = bidRequest.getFloor({ size: videoSize, mediaType: VIDEO }));
}

if (bidRequest.mediaTypes?.native) {
slotFloors.native = {};
slotFloors.native['*'] = bidRequest.getFloor({size: '*', mediaType: NATIVE});
slotFloors.native['*'] = bidRequest.getFloor({ size: '*', mediaType: NATIVE });
}

if (Object.keys(slotFloors).length > 0) {
Expand Down
61 changes: 35 additions & 26 deletions test/spec/modules/criteoBidAdapter_spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import * as utils from 'src/utils.js';
import * as refererDetection from 'src/refererDetection.js';
import { config } from '../../../src/config.js';
import * as storageManager from 'src/storageManager.js';
import {BANNER, NATIVE, VIDEO} from '../../../src/mediaTypes.js';
import { BANNER, NATIVE, VIDEO } from '../../../src/mediaTypes.js';

describe('The Criteo bidding adapter', function () {
let utilsMock, sandbox;
Expand Down Expand Up @@ -707,7 +707,7 @@ describe('The Criteo bidding adapter', function () {
expect(ortbRequest.slots[0].sizes[0]).to.equal('undefinedxundefined');
});

it('should properly detect and get sizes of native sizeless banner', function () {
it('should properly detect and forward native flag', function () {
const bidRequests = [
{
mediaTypes: {
Expand All @@ -722,11 +722,10 @@ describe('The Criteo bidding adapter', function () {
];
const request = spec.buildRequests(bidRequests, bidderRequest);
const ortbRequest = request.data;
expect(ortbRequest.slots[0].sizes).to.have.lengthOf(1);
expect(ortbRequest.slots[0].sizes[0]).to.equal('2x2');
expect(ortbRequest.slots[0].native).to.equal(true);
});

it('should properly detect and get size of native sizeless banner', function () {
it('should properly detect and forward native flag', function () {
const bidRequests = [
{
mediaTypes: {
Expand All @@ -741,8 +740,7 @@ describe('The Criteo bidding adapter', function () {
];
const request = spec.buildRequests(bidRequests, bidderRequest);
const ortbRequest = request.data;
expect(ortbRequest.slots[0].sizes).to.have.lengthOf(1);
expect(ortbRequest.slots[0].sizes[0]).to.equal('2x2');
expect(ortbRequest.slots[0].native).to.equal(true);
});

it('should properly build a networkId request', function () {
Expand Down Expand Up @@ -1258,11 +1256,13 @@ describe('The Criteo bidding adapter', function () {
if (inputParams.mediaType === BANNER && inputParams.size[0] === 300 && inputParams.size[1] === 250) {
return {
currency: 'USD',
floor: 1.0};
floor: 1.0
};
} else if (inputParams.mediaType === BANNER && inputParams.size[0] === 728 && inputParams.size[1] === 90) {
return {
currency: 'USD',
floor: 2.0};
floor: 2.0
};
} else {
return {}
}
Expand All @@ -1273,9 +1273,10 @@ describe('The Criteo bidding adapter', function () {
const request = spec.buildRequests(bidRequests, bidderRequest);
expect(request.data.slots[0].ext.floors).to.deep.equal({
'banner': {
'300x250': {'currency': 'USD', 'floor': 1},
'728x90': {'currency': 'USD', 'floor': 2}
}});
'300x250': { 'currency': 'USD', 'floor': 1 },
'728x90': { 'currency': 'USD', 'floor': 2 }
}
});
});

it('should properly build a video request with several player sizes with floors', function () {
Expand All @@ -1297,11 +1298,13 @@ describe('The Criteo bidding adapter', function () {
if (inputParams.mediaType === VIDEO && inputParams.size[0] === 300 && inputParams.size[1] === 250) {
return {
currency: 'USD',
floor: 1.0};
floor: 1.0
};
} else if (inputParams.mediaType === VIDEO && inputParams.size[0] === 728 && inputParams.size[1] === 90) {
return {
currency: 'USD',
floor: 2.0};
floor: 2.0
};
} else {
return {}
}
Expand All @@ -1312,9 +1315,10 @@ describe('The Criteo bidding adapter', function () {
const request = spec.buildRequests(bidRequests, bidderRequest);
expect(request.data.slots[0].ext.floors).to.deep.equal({
'video': {
'300x250': {'currency': 'USD', 'floor': 1},
'728x90': {'currency': 'USD', 'floor': 2}
}});
'300x250': { 'currency': 'USD', 'floor': 1 },
'728x90': { 'currency': 'USD', 'floor': 2 }
}
});
});

it('should properly build a multi format request with floors', function () {
Expand Down Expand Up @@ -1347,19 +1351,23 @@ describe('The Criteo bidding adapter', function () {
if (inputParams.mediaType === BANNER && inputParams.size[0] === 300 && inputParams.size[1] === 250) {
return {
currency: 'USD',
floor: 1.0};
floor: 1.0
};
} else if (inputParams.mediaType === BANNER && inputParams.size[0] === 728 && inputParams.size[1] === 90) {
return {
currency: 'USD',
floor: 2.0};
floor: 2.0
};
} else if (inputParams.mediaType === VIDEO && inputParams.size[0] === 640 && inputParams.size[1] === 480) {
return {
currency: 'EUR',
floor: 3.2};
floor: 3.2
};
} else if (inputParams.mediaType === NATIVE && inputParams.size === '*') {
return {
currency: 'YEN',
floor: 4.99};
floor: 4.99
};
} else {
return {}
}
Expand All @@ -1371,15 +1379,16 @@ describe('The Criteo bidding adapter', function () {
expect(request.data.slots[0].ext.data.someContextAttribute).to.deep.equal('abc');
expect(request.data.slots[0].ext.floors).to.deep.equal({
'banner': {
'300x250': {'currency': 'USD', 'floor': 1},
'728x90': {'currency': 'USD', 'floor': 2}
'300x250': { 'currency': 'USD', 'floor': 1 },
'728x90': { 'currency': 'USD', 'floor': 2 }
},
'video': {
'640x480': {'currency': 'EUR', 'floor': 3.2}
'640x480': { 'currency': 'EUR', 'floor': 3.2 }
},
'native': {
'*': {'currency': 'YEN', 'floor': 4.99}
}});
'*': { 'currency': 'YEN', 'floor': 4.99 }
}
});
});
});

Expand Down