Skip to content

Commit

Permalink
convert bidders: iqm
Browse files Browse the repository at this point in the history
  • Loading branch information
@dgirardi
dgirardi committed May 20, 2022
1 parent f95f031 commit 4486b4f
Show file tree
Hide file tree
Showing 2 changed files with 172 additions and 29 deletions.
31 changes: 7 additions & 24 deletions modules/iqmBidAdapter.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ export const spec = {
imp.video = _buildVideoORTB(bid);
imp.mediatype = 'video';
}
const site = getSite(bid);
const site = getSite(bidderRequest);
let device = getDevice(bid.params);
finalRequest = {
sizes: bid.sizes,
Expand All @@ -116,6 +116,8 @@ export const spec = {
adUnitCode: bid.adUnitCode,
bidderRequestId: bid.bidderRequestId,
uuid: bid.bidId,
// TODO: please do not send internal data structures over the network
// I am not going to attempt to accomodate this, no way this is usable on their end, it changes way too frequently
bidderRequest
}
const request = {
Expand Down Expand Up @@ -227,19 +229,10 @@ function getSite(bidderRequest) {

const {refererInfo} = bidderRequest;

if (canAccessTopWindow()) {
const wt = getWindowTop();
domain = wt.location.hostname;
page = wt.location.href;
referrer = wt.document.referrer || '';
} else if (refererInfo.reachedTop) {
const url = parseUrl(refererInfo.referer);
domain = url.hostname;
page = refererInfo.referer;
} else if (refererInfo.stack && refererInfo.stack.length && refererInfo.stack[0]) {
const url = parseUrl(refererInfo.stack[0]);
domain = url.hostname;
}
// TODO: are these the right refererInfo values?
domain = refererInfo.domain;
page = refererInfo.page;
referrer = refererInfo.ref;

return {
domain,
Expand All @@ -249,16 +242,6 @@ function getSite(bidderRequest) {
};
};

function canAccessTopWindow() {
try {
if (getWindowTop().location.href) {
return true;
}
} catch (error) {
return false;
}
}

function _buildVideoORTB(bidRequest) {
const videoAdUnit = deepAccess(bidRequest, 'mediaTypes.video');
const videoBidderParams = deepAccess(bidRequest, 'params.video', {});
Expand Down
170 changes: 165 additions & 5 deletions test/spec/modules/iqmBidAdapter_spec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,41 @@ describe('iqmAdapter', function () {
bidderRequestsCount: 1,
bidderWinsCount: 0}];

let bidderRequest = {bidderCode: 'iqm', auctionId: '565ab569-ab95-40d6-8b42-b9707a92062f', bidderRequestId: '13c05d264c7ffe', bids: [{bidder: 'iqm', params: {publisherId: 'df5fd732-c5f3-11e7-abc4-cec278b6b50a', placementId: 23451, bidfloor: 0.5}, crumbs: {pubcid: 'a0f51f64-6d86-41d0-abaf-7ece71404d94'}, fpd: {context: {pbAdSlot: '/19968336/header-bid-tag-0'}}, mediaTypes: {banner: {sizes: [[300, 250]]}}, adUnitCode: '/19968336/header-bid-tag-0', transactionId: '56fe8d92-ff6e-4c34-90ad-2f743cd0eae8', sizes: [[300, 250]], bidId: '266d810da21904', bidderRequestId: '13c05d264c7ffe', auctionId: '565ab569-ab95-40d6-8b42-b9707a92062f', src: 'client', bidRequestsCount: 1, bidderRequestsCount: 1, bidderWinsCount: 0}], auctionStart: 1615205942159, timeout: 7000, refererInfo: {referer: 'http://test.localhost:9999/integrationExamples/gpt/hello_world.html', reachedTop: true, isAmp: false, numIframes: 0, stack: ['http://test.localhost:9999/integrationExamples/gpt/hello_world.html'], canonicalUrl: null}, start: 1615205942162};
let bidderRequest = {
bidderCode: 'iqm',
auctionId: '565ab569-ab95-40d6-8b42-b9707a92062f',
bidderRequestId: '13c05d264c7ffe',
bids: [{
bidder: 'iqm',
params: {publisherId: 'df5fd732-c5f3-11e7-abc4-cec278b6b50a', placementId: 23451, bidfloor: 0.5},
crumbs: {pubcid: 'a0f51f64-6d86-41d0-abaf-7ece71404d94'},
fpd: {context: {pbAdSlot: '/19968336/header-bid-tag-0'}},
mediaTypes: {banner: {sizes: [[300, 250]]}},
adUnitCode: '/19968336/header-bid-tag-0',
transactionId: '56fe8d92-ff6e-4c34-90ad-2f743cd0eae8',
sizes: [[300, 250]],
bidId: '266d810da21904',
bidderRequestId: '13c05d264c7ffe',
auctionId: '565ab569-ab95-40d6-8b42-b9707a92062f',
src: 'client',
bidRequestsCount: 1,
bidderRequestsCount: 1,
bidderWinsCount: 0
}],
auctionStart: 1615205942159,
timeout: 7000,
refererInfo: {
page: 'http://test.localhost:9999/integrationExamples/gpt/hello_world.html',
domain: 'test.localhost.com:9999',
ref: null,
reachedTop: true,
isAmp: false,
numIframes: 0,
stack: ['http://test.localhost:9999/integrationExamples/gpt/hello_world.html'],
canonicalUrl: null
},
start: 1615205942162
};

it('should parse out sizes', function () {
let temp = [];
Expand All @@ -142,7 +176,52 @@ describe('iqmAdapter', function () {
});
it('should attach valid video params to the tag', function () {
let validBidRequests_video = [{bidder: 'iqm', params: {publisherId: 'df5fd732-c5f3-11e7-abc4-cec278b6b50a', placementId: 23451, bidfloor: 0.5, video: {placement: 2, mimes: ['video/mp4'], protocols: [2, 5], skipppable: true, playback_method: ['auto_play_sound_off']}}, crumbs: {pubcid: '09b8f065-9d1b-4a36-bd0c-ea22e2dad807'}, fpd: {context: {pbAdSlot: 'video1'}}, mediaTypes: {video: {playerSize: [[640, 480]], context: 'instream'}}, adUnitCode: 'video1', transactionId: '86795c66-acf9-4dd5-998f-6d5362aaa541', sizes: [[640, 480]], bidId: '28bfb7e2d12897', bidderRequestId: '16e1ce8481bc6d', auctionId: '3140a2ec-d567-4db0-9bbb-eb6fa20ccb71', src: 'client', bidRequestsCount: 1, bidderRequestsCount: 1, bidderWinsCount: 0}];
let bidderRequest_video = {bidderCode: 'iqm', auctionId: '3140a2ec-d567-4db0-9bbb-eb6fa20ccb71', bidderRequestId: '16e1ce8481bc6d', bids: [{bidder: 'iqm', params: {publisherId: 'df5fd732-c5f3-11e7-abc4-cec278b6b50a', placementId: 23451, bidfloor: 0.5, video: {placement: 2, mimes: ['video/mp4'], protocols: [2, 5], skipppable: true, playback_method: ['auto_play_sound_off']}}, crumbs: {pubcid: '09b8f065-9d1b-4a36-bd0c-ea22e2dad807'}, fpd: {context: {pbAdSlot: 'video1'}}, mediaTypes: {video: {playerSize: [[640, 480]], context: 'instream'}}, adUnitCode: 'video1', transactionId: '86795c66-acf9-4dd5-998f-6d5362aaa541', sizes: [[640, 480]], bidId: '28bfb7e2d12897', bidderRequestId: '16e1ce8481bc6d', auctionId: '3140a2ec-d567-4db0-9bbb-eb6fa20ccb71', src: 'client', bidRequestsCount: 1, bidderRequestsCount: 1, bidderWinsCount: 0}], auctionStart: 1615271191985, timeout: 3000, refererInfo: {referer: 'http://test.localhost:9999/integrationExamples/gpt/pbjs_video_adUnit.html', reachedTop: true, isAmp: false, numIframes: 0, stack: ['http://test.localhost:9999/integrationExamples/gpt/pbjs_video_adUnit.html'], canonicalUrl: null}, start: 1615271191988};
let bidderRequest_video = {
bidderCode: 'iqm',
auctionId: '3140a2ec-d567-4db0-9bbb-eb6fa20ccb71',
bidderRequestId: '16e1ce8481bc6d',
bids: [{
bidder: 'iqm',
params: {
publisherId: 'df5fd732-c5f3-11e7-abc4-cec278b6b50a',
placementId: 23451,
bidfloor: 0.5,
video: {
placement: 2,
mimes: ['video/mp4'],
protocols: [2, 5],
skipppable: true,
playback_method: ['auto_play_sound_off']
}
},
crumbs: {pubcid: '09b8f065-9d1b-4a36-bd0c-ea22e2dad807'},
fpd: {context: {pbAdSlot: 'video1'}},
mediaTypes: {video: {playerSize: [[640, 480]], context: 'instream'}},
adUnitCode: 'video1',
transactionId: '86795c66-acf9-4dd5-998f-6d5362aaa541',
sizes: [[640, 480]],
bidId: '28bfb7e2d12897',
bidderRequestId: '16e1ce8481bc6d',
auctionId: '3140a2ec-d567-4db0-9bbb-eb6fa20ccb71',
src: 'client',
bidRequestsCount: 1,
bidderRequestsCount: 1,
bidderWinsCount: 0
}],
auctionStart: 1615271191985,
timeout: 3000,
refererInfo: {
page: 'http://test.localhost:9999/integrationExamples/gpt/pbjs_video_adUnit.html',
domain: 'test.localhost.com:9999',
ref: null,
reachedTop: true,
isAmp: false,
numIframes: 0,
stack: ['http://test.localhost:9999/integrationExamples/gpt/pbjs_video_adUnit.html'],
canonicalUrl: null
},
start: 1615271191988
};
const request = spec.buildRequests(validBidRequests_video, bidderRequest_video);
const payload = request[0].data;
expect(payload.imp.id).to.exist;
Expand All @@ -161,11 +240,13 @@ describe('iqmAdapter', function () {
});

it('should add referer info to payload', function () {
// TODO: this is wrong on multiple levels
// The payload contains everything in `bidderRequest`; that is sometimes not even serializable
// this should not be testing the validity of internal Prebid structures
const request = spec.buildRequests(validBidRequests, bidderRequest);
const payload = request[0].data;

expect(payload.bidderRequest.refererInfo).to.exist;
expect(payload.bidderRequest.refererInfo).to.deep.equal({referer: 'http://test.localhost:9999/integrationExamples/gpt/hello_world.html', reachedTop: true, isAmp: false, numIframes: 0, stack: ['http://test.localhost:9999/integrationExamples/gpt/hello_world.html'], canonicalUrl: null});
});
})

Expand Down Expand Up @@ -193,7 +274,41 @@ describe('iqmAdapter', function () {
bidRequestsCount: 1,
bidderRequestsCount: 1,
bidderWinsCount: 0}];
let bidderRequest = {bidderCode: 'iqm', auctionId: '565ab569-ab95-40d6-8b42-b9707a92062f', bidderRequestId: '13c05d264c7ffe', bids: [{bidder: 'iqm', params: {publisherId: 'df5fd732-c5f3-11e7-abc4-cec278b6b50a', placementId: 23451, bidfloor: 0.5}, crumbs: {pubcid: 'a0f51f64-6d86-41d0-abaf-7ece71404d94'}, fpd: {context: {pbAdSlot: '/19968336/header-bid-tag-0'}}, mediaTypes: {banner: {sizes: [[300, 250]]}}, adUnitCode: '/19968336/header-bid-tag-0', transactionId: '56fe8d92-ff6e-4c34-90ad-2f743cd0eae8', sizes: [[300, 250]], bidId: '266d810da21904', bidderRequestId: '13c05d264c7ffe', auctionId: '565ab569-ab95-40d6-8b42-b9707a92062f', src: 'client', bidRequestsCount: 1, bidderRequestsCount: 1, bidderWinsCount: 0}], auctionStart: 1615205942159, timeout: 7000, refererInfo: {referer: 'http://test.localhost:9999/integrationExamples/gpt/hello_world.html', reachedTop: true, isAmp: false, numIframes: 0, stack: ['http://test.localhost:9999/integrationExamples/gpt/hello_world.html'], canonicalUrl: null}, start: 1615205942162};
let bidderRequest = {
bidderCode: 'iqm',
auctionId: '565ab569-ab95-40d6-8b42-b9707a92062f',
bidderRequestId: '13c05d264c7ffe',
bids: [{
bidder: 'iqm',
params: {publisherId: 'df5fd732-c5f3-11e7-abc4-cec278b6b50a', placementId: 23451, bidfloor: 0.5},
crumbs: {pubcid: 'a0f51f64-6d86-41d0-abaf-7ece71404d94'},
fpd: {context: {pbAdSlot: '/19968336/header-bid-tag-0'}},
mediaTypes: {banner: {sizes: [[300, 250]]}},
adUnitCode: '/19968336/header-bid-tag-0',
transactionId: '56fe8d92-ff6e-4c34-90ad-2f743cd0eae8',
sizes: [[300, 250]],
bidId: '266d810da21904',
bidderRequestId: '13c05d264c7ffe',
auctionId: '565ab569-ab95-40d6-8b42-b9707a92062f',
src: 'client',
bidRequestsCount: 1,
bidderRequestsCount: 1,
bidderWinsCount: 0
}],
auctionStart: 1615205942159,
timeout: 7000,
refererInfo: {
page: 'http://test.localhost:9999/integrationExamples/gpt/hello_world.html',
domain: 'test.localhost.com:9999',
ref: null,
reachedTop: true,
isAmp: false,
numIframes: 0,
stack: ['http://test.localhost:9999/integrationExamples/gpt/hello_world.html'],
canonicalUrl: null
},
start: 1615205942162
};
let response = {

id: '5bdbab92aae961cfbdf7465d',
Expand All @@ -213,7 +328,52 @@ describe('iqmAdapter', function () {

let validBidRequests_temp_video =
[{bidder: 'iqm', params: {publisherId: 'df5fd732-c5f3-11e7-abc4-cec278b6b50a', placementId: 23451, bidfloor: 0.5, video: {placement: 2, mimes: ['video/mp4'], protocols: [2, 5], skipppable: true, playback_method: ['auto_play_sound_off']}}, crumbs: {pubcid: 'cd86c3ff-d630-40e6-83ab-420e9e800594'}, fpd: {context: {pbAdSlot: 'video1'}}, mediaTypes: {video: {playerSize: [[640, 480]], context: 'instream'}}, adUnitCode: 'video1', transactionId: '8335b266-7a41-45f9-86a2-92fdc7cf0cd9', sizes: [[640, 480]], bidId: '26274beff25455', bidderRequestId: '17c5d8c3168761', auctionId: '2c592dcf-7dfc-4823-8203-dd1ebab77fe0', src: 'client', bidRequestsCount: 1, bidderRequestsCount: 1, bidderWinsCount: 0}];
let bidderRequest_video = {bidderCode: 'iqm', auctionId: '3140a2ec-d567-4db0-9bbb-eb6fa20ccb71', bidderRequestId: '16e1ce8481bc6d', bids: [{bidder: 'iqm', params: {publisherId: 'df5fd732-c5f3-11e7-abc4-cec278b6b50a', placementId: 23451, bidfloor: 0.5, video: {placement: 2, mimes: ['video/mp4'], protocols: [2, 5], skipppable: true, playback_method: ['auto_play_sound_off']}}, crumbs: {pubcid: '09b8f065-9d1b-4a36-bd0c-ea22e2dad807'}, fpd: {context: {pbAdSlot: 'video1'}}, mediaTypes: {video: {playerSize: [[640, 480]], context: 'instream'}}, adUnitCode: 'video1', transactionId: '86795c66-acf9-4dd5-998f-6d5362aaa541', sizes: [[640, 480]], bidId: '28bfb7e2d12897', bidderRequestId: '16e1ce8481bc6d', auctionId: '3140a2ec-d567-4db0-9bbb-eb6fa20ccb71', src: 'client', bidRequestsCount: 1, bidderRequestsCount: 1, bidderWinsCount: 0}], auctionStart: 1615271191985, timeout: 3000, refererInfo: {referer: 'http://test.localhost:9999/integrationExamples/gpt/pbjs_video_adUnit.html', reachedTop: true, isAmp: false, numIframes: 0, stack: ['http://test.localhost:9999/integrationExamples/gpt/pbjs_video_adUnit.html'], canonicalUrl: null}, start: 1615271191988};
let bidderRequest_video = {
bidderCode: 'iqm',
auctionId: '3140a2ec-d567-4db0-9bbb-eb6fa20ccb71',
bidderRequestId: '16e1ce8481bc6d',
bids: [{
bidder: 'iqm',
params: {
publisherId: 'df5fd732-c5f3-11e7-abc4-cec278b6b50a',
placementId: 23451,
bidfloor: 0.5,
video: {
placement: 2,
mimes: ['video/mp4'],
protocols: [2, 5],
skipppable: true,
playback_method: ['auto_play_sound_off']
}
},
crumbs: {pubcid: '09b8f065-9d1b-4a36-bd0c-ea22e2dad807'},
fpd: {context: {pbAdSlot: 'video1'}},
mediaTypes: {video: {playerSize: [[640, 480]], context: 'instream'}},
adUnitCode: 'video1',
transactionId: '86795c66-acf9-4dd5-998f-6d5362aaa541',
sizes: [[640, 480]],
bidId: '28bfb7e2d12897',
bidderRequestId: '16e1ce8481bc6d',
auctionId: '3140a2ec-d567-4db0-9bbb-eb6fa20ccb71',
src: 'client',
bidRequestsCount: 1,
bidderRequestsCount: 1,
bidderWinsCount: 0
}],
auctionStart: 1615271191985,
timeout: 3000,
refererInfo: {
page: 'http://test.localhost:9999/integrationExamples/gpt/pbjs_video_adUnit.html',
domain: 'test.localhost.com:9999',
ref: '',
reachedTop: true,
isAmp: false,
numIframes: 0,
stack: ['http://test.localhost:9999/integrationExamples/gpt/pbjs_video_adUnit.html'],
canonicalUrl: null
},
start: 1615271191988
};

it('handles non-banner media responses', function () {
let response = {id: '2341234', seatbid: [{bid: [{id: 'bid-2341234-1', impid: '1', price: 9, nurl: 'https://frontend.stage.iqm.com/static/vast-01.xml', adm: 'http://cdn.iqm.com/pbd?raw=312730_203cf73dc83fb_2824348636878_pbd', adomain: ['app1.stage.iqm.com'], cid: '168900', crid: 'cr-304503', attr: []}]}], bidid: '2341234'};
Expand Down

0 comments on commit 4486b4f

Please sign in to comment.