diff --git a/modules/trustxBidAdapter.js b/modules/trustxBidAdapter.js
index a86ac1f2874..3116400edf7 100644
--- a/modules/trustxBidAdapter.js
+++ b/modules/trustxBidAdapter.js
@@ -2,9 +2,11 @@ import * as utils from '../src/utils.js';
import {registerBidder} from '../src/adapters/bidderFactory.js';
import { Renderer } from '../src/Renderer.js';
import { VIDEO, BANNER } from '../src/mediaTypes.js';
+import { config } from '../src/config.js';
const BIDDER_CODE = 'trustx';
const ENDPOINT_URL = 'https://sofia.trustx.org/hb';
+const NEW_ENDPOINT_URL = 'https://grid.bidswitch.net/hbjson?sp=trustx';
const TIME_TO_LIVE = 360;
const ADAPTER_SYNC_URL = 'https://sofia.trustx.org/push_sync';
const RENDERER_URL = 'https://acdn.adnxs.com/video/outstream/ANOutstreamVideo.js';
@@ -40,98 +42,30 @@ export const spec = {
* @return ServerRequest Info describing the request to the server.
*/
buildRequests: function(validBidRequests, bidderRequest) {
- const auids = [];
- const bidsMap = {};
- const slotsMapByUid = {};
- const sizeMap = {};
const bids = validBidRequests || [];
- let priceType = 'net';
- let pageKeywords;
- let reqId;
-
+ const newFormatBids = [];
+ const oldFormatBids = [];
+ const requests = [];
bids.forEach(bid => {
- if (bid.params.priceType === 'gross') {
- priceType = 'gross';
- }
- reqId = bid.bidderRequestId;
- const {params: {uid}, adUnitCode} = bid;
- auids.push(uid);
- const sizesId = utils.parseSizesInput(bid.sizes);
-
- if (!pageKeywords && !utils.isEmpty(bid.params.keywords)) {
- const keywords = utils.transformBidderParamKeywords(bid.params.keywords);
-
- if (keywords.length > 0) {
- keywords.forEach(deleteValues);
- }
- pageKeywords = keywords;
- }
-
- if (!slotsMapByUid[uid]) {
- slotsMapByUid[uid] = {};
- }
- const slotsMap = slotsMapByUid[uid];
- if (!slotsMap[adUnitCode]) {
- slotsMap[adUnitCode] = {adUnitCode, bids: [bid], parents: []};
+ if (bid.params.useNewFormat) {
+ newFormatBids.push(bid);
} else {
- slotsMap[adUnitCode].bids.push(bid);
+ oldFormatBids.push(bid);
}
- const slot = slotsMap[adUnitCode];
-
- sizesId.forEach((sizeId) => {
- sizeMap[sizeId] = true;
- if (!bidsMap[uid]) {
- bidsMap[uid] = {};
- }
-
- if (!bidsMap[uid][sizeId]) {
- bidsMap[uid][sizeId] = [slot];
- } else {
- bidsMap[uid][sizeId].push(slot);
- }
- slot.parents.push({parent: bidsMap[uid], key: sizeId, uid});
- });
});
-
- const payload = {
- pt: priceType,
- auids: auids.join(','),
- sizes: utils.getKeys(sizeMap).join(','),
- r: reqId,
- wrapperType: 'Prebid_js',
- wrapperVersion: '$prebid.version$'
- };
-
- if (pageKeywords) {
- payload.keywords = JSON.stringify(pageKeywords);
- }
-
- if (bidderRequest) {
- if (bidderRequest.refererInfo && bidderRequest.refererInfo.referer) {
- payload.u = bidderRequest.refererInfo.referer;
+ if (newFormatBids.length) {
+ const newFormatRequests = newFormatRequest(newFormatBids, bidderRequest);
+ if (newFormatRequests) {
+ requests.push(newFormatRequests);
}
- if (bidderRequest.timeout) {
- payload.wtimeout = bidderRequest.timeout;
- }
- if (bidderRequest.gdprConsent) {
- if (bidderRequest.gdprConsent.consentString) {
- payload.gdpr_consent = bidderRequest.gdprConsent.consentString;
- }
- payload.gdpr_applies =
- (typeof bidderRequest.gdprConsent.gdprApplies === 'boolean')
- ? Number(bidderRequest.gdprConsent.gdprApplies) : 1;
- }
- if (bidderRequest.uspConsent) {
- payload.us_privacy = bidderRequest.uspConsent;
+ }
+ if (oldFormatBids.length) {
+ const oldFormatRequests = oldFormatRequest(oldFormatBids, bidderRequest);
+ if (oldFormatRequests) {
+ requests.push(oldFormatRequests);
}
}
-
- return {
- method: 'GET',
- url: ENDPOINT_URL,
- data: utils.parseQueryStringParameters(payload).replace(/\&$/, ''),
- bidsMap: bidsMap,
- };
+ return requests;
},
/**
* Unpack the response from the server into a list of bids.
@@ -143,8 +77,6 @@ export const spec = {
interpretResponse: function(serverResponse, bidRequest, RendererConst = Renderer) {
serverResponse = serverResponse && serverResponse.body;
const bidResponses = [];
- const bidsMap = bidRequest.bidsMap;
- const priceType = bidRequest.data.pt;
let errorMessage;
@@ -155,7 +87,7 @@ export const spec = {
if (!errorMessage && serverResponse.seatbid) {
serverResponse.seatbid.forEach(respItem => {
- _addBidResponse(_getBidFromResponse(respItem), bidsMap, priceType, bidResponses, RendererConst);
+ _addBidResponse(_getBidFromResponse(respItem), bidRequest, bidResponses, RendererConst);
});
}
if (errorMessage) utils.logError(errorMessage);
@@ -192,66 +124,75 @@ function _getBidFromResponse(respItem) {
return respItem && respItem.bid && respItem.bid[0];
}
-function _addBidResponse(serverBid, bidsMap, priceType, bidResponses, RendererConst) {
+function _addBidResponse(serverBid, bidRequest, bidResponses, RendererConst) {
if (!serverBid) return;
let errorMessage;
if (!serverBid.auid) errorMessage = LOG_ERROR_MESS.noAuid + JSON.stringify(serverBid);
if (!serverBid.adm) errorMessage = LOG_ERROR_MESS.noAdm + JSON.stringify(serverBid);
else {
- const awaitingBids = bidsMap[serverBid.auid];
- if (awaitingBids) {
- const sizeId = `${serverBid.w}x${serverBid.h}`;
- if (awaitingBids[sizeId]) {
- const slot = awaitingBids[sizeId][0];
-
- const bid = slot.bids.shift();
- const bidResponse = {
- requestId: bid.bidId, // bid.bidderRequestId,
- cpm: serverBid.price,
- width: serverBid.w,
- height: serverBid.h,
- creativeId: serverBid.auid, // bid.bidId,
- currency: 'USD',
- netRevenue: priceType !== 'gross',
- ttl: TIME_TO_LIVE,
- dealId: serverBid.dealid
- };
- if (serverBid.content_type === 'video') {
- bidResponse.vastXml = serverBid.adm;
- bidResponse.mediaType = VIDEO;
- bidResponse.adResponse = {
- content: bidResponse.vastXml
- };
- if (!bid.renderer && (!bid.mediaTypes || !bid.mediaTypes.video || bid.mediaTypes.video.context === 'outstream')) {
- bidResponse.renderer = createRenderer(bidResponse, {
- id: bid.bidId,
- url: RENDERER_URL
- }, RendererConst);
- }
- } else {
- bidResponse.ad = serverBid.adm;
- bidResponse.mediaType = BANNER;
+ const { bidsMap, priceType, newFormat } = bidRequest;
+ let bid;
+ let slot;
+ if (newFormat) {
+ bid = bidsMap[serverBid.impid];
+ } else {
+ const awaitingBids = bidsMap[serverBid.auid];
+ if (awaitingBids) {
+ const sizeId = `${serverBid.w}x${serverBid.h}`;
+ if (awaitingBids[sizeId]) {
+ slot = awaitingBids[sizeId][0];
+ bid = slot.bids.shift();
}
+ } else {
+ errorMessage = LOG_ERROR_MESS.noPlacementCode + serverBid.auid;
+ }
+ }
- bidResponses.push(bidResponse);
-
- if (!slot.bids.length) {
- slot.parents.forEach(({parent, key, uid}) => {
- const index = parent[key].indexOf(slot);
- if (index > -1) {
- parent[key].splice(index, 1);
- }
- if (!parent[key].length) {
- delete parent[key];
- if (!utils.getKeys(parent).length) {
- delete bidsMap[uid];
- }
- }
- });
+ if (!errorMessage && bid) {
+ const bidResponse = {
+ requestId: bid.bidId, // bid.bidderRequestId,
+ cpm: serverBid.price,
+ width: serverBid.w,
+ height: serverBid.h,
+ creativeId: serverBid.auid, // bid.bidId,
+ currency: 'USD',
+ netRevenue: newFormat ? false : priceType !== 'gross',
+ ttl: TIME_TO_LIVE,
+ dealId: serverBid.dealid
+ };
+ if (serverBid.content_type === 'video') {
+ bidResponse.vastXml = serverBid.adm;
+ bidResponse.mediaType = VIDEO;
+ bidResponse.adResponse = {
+ content: bidResponse.vastXml
+ };
+ if (!bid.renderer && (!bid.mediaTypes || !bid.mediaTypes.video || bid.mediaTypes.video.context === 'outstream')) {
+ bidResponse.renderer = createRenderer(bidResponse, {
+ id: bid.bidId,
+ url: RENDERER_URL
+ }, RendererConst);
}
+ } else {
+ bidResponse.ad = serverBid.adm;
+ bidResponse.mediaType = BANNER;
}
- } else {
- errorMessage = LOG_ERROR_MESS.noPlacementCode + serverBid.auid;
+
+ bidResponses.push(bidResponse);
+ }
+
+ if (slot && !slot.bids.length) {
+ slot.parents.forEach(({parent, key, uid}) => {
+ const index = parent[key].indexOf(slot);
+ if (index > -1) {
+ parent[key].splice(index, 1);
+ }
+ if (!parent[key].length) {
+ delete parent[key];
+ if (!utils.getKeys(parent).length) {
+ delete bidsMap[uid];
+ }
+ }
+ });
}
}
if (errorMessage) {
@@ -284,4 +225,343 @@ function createRenderer (bid, rendererParams, RendererConst) {
return rendererInst;
}
+function createVideoRequest(bid, mediaType) {
+ const {playerSize, mimes, durationRangeSec, protocols} = mediaType;
+ const size = (playerSize || bid.sizes || [])[0];
+ if (!size) return;
+
+ let result = utils.parseGPTSingleSizeArrayToRtbSize(size);
+
+ if (mimes) {
+ result.mimes = mimes;
+ }
+
+ if (durationRangeSec && durationRangeSec.length === 2) {
+ result.minduration = durationRangeSec[0];
+ result.maxduration = durationRangeSec[1];
+ }
+
+ if (protocols && protocols.length) {
+ result.protocols = protocols;
+ }
+
+ return result;
+}
+
+function createBannerRequest(bid, mediaType) {
+ const sizes = mediaType.sizes || bid.sizes;
+ if (!sizes || !sizes.length) return;
+
+ let format = sizes.map((size) => utils.parseGPTSingleSizeArrayToRtbSize(size));
+ let result = utils.parseGPTSingleSizeArrayToRtbSize(sizes[0]);
+
+ if (format.length) {
+ result.format = format
+ }
+ return result;
+}
+
+/**
+ * Gets bidfloor
+ * @param {Object} mediaTypes
+ * @param {Object} bid
+ * @returns {Number} floor
+ */
+function _getFloor (mediaTypes, bid) {
+ const curMediaType = mediaTypes.video ? 'video' : 'banner';
+ let floor = bid.params.bidFloor || 0;
+
+ if (typeof bid.getFloor === 'function') {
+ const floorInfo = bid.getFloor({
+ currency: 'USD',
+ mediaType: curMediaType,
+ size: bid.sizes.map(([w, h]) => ({w, h}))
+ });
+
+ if (typeof floorInfo === 'object' &&
+ floorInfo.currency === 'USD' &&
+ !isNaN(parseFloat(floorInfo.floor))) {
+ floor = Math.max(floor, parseFloat(floorInfo.floor));
+ }
+ }
+
+ return floor;
+}
+
+function newFormatRequest(validBidRequests, bidderRequest) {
+ if (!validBidRequests.length) {
+ return null;
+ }
+ let pageKeywords = null;
+ let jwpseg = null;
+ let content = null;
+ let schain = null;
+ let userId = null;
+ let userIdAsEids = null;
+ let user = null;
+ let userExt = null;
+ let {bidderRequestId, auctionId, gdprConsent, uspConsent, timeout, refererInfo} = bidderRequest || {};
+
+ const referer = refererInfo ? encodeURIComponent(refererInfo.referer) : '';
+ const imp = [];
+ const bidsMap = {};
+
+ validBidRequests.forEach((bid) => {
+ if (!bidderRequestId) {
+ bidderRequestId = bid.bidderRequestId;
+ }
+ if (!auctionId) {
+ auctionId = bid.auctionId;
+ }
+ if (!schain) {
+ schain = bid.schain;
+ }
+ if (!userId) {
+ userId = bid.userId;
+ }
+ if (!userIdAsEids) {
+ userIdAsEids = bid.userIdAsEids;
+ }
+ const {params: {uid, keywords}, mediaTypes, bidId, adUnitCode, rtd} = bid;
+ bidsMap[bidId] = bid;
+ if (!pageKeywords && !utils.isEmpty(keywords)) {
+ pageKeywords = utils.transformBidderParamKeywords(keywords);
+ }
+ const bidFloor = _getFloor(mediaTypes || {}, bid);
+ const jwTargeting = rtd && rtd.jwplayer && rtd.jwplayer.targeting;
+ if (jwTargeting) {
+ if (!jwpseg && jwTargeting.segments) {
+ jwpseg = jwTargeting.segments;
+ }
+ if (!content && jwTargeting.content) {
+ content = jwTargeting.content;
+ }
+ }
+ let impObj = {
+ id: bidId,
+ tagid: uid.toString(),
+ ext: {
+ divid: adUnitCode
+ }
+ };
+
+ if (bidFloor) {
+ impObj.bidfloor = bidFloor;
+ }
+
+ if (!mediaTypes || mediaTypes[BANNER]) {
+ const banner = createBannerRequest(bid, mediaTypes ? mediaTypes[BANNER] : {});
+ if (banner) {
+ impObj.banner = banner;
+ }
+ }
+ if (mediaTypes && mediaTypes[VIDEO]) {
+ const video = createVideoRequest(bid, mediaTypes[VIDEO]);
+ if (video) {
+ impObj.video = video;
+ }
+ }
+
+ if (impObj.banner || impObj.video) {
+ imp.push(impObj);
+ }
+ });
+
+ const source = {
+ tid: auctionId,
+ ext: {
+ wrapper: 'Prebid_js',
+ wrapper_version: '$prebid.version$'
+ }
+ };
+
+ if (schain) {
+ source.ext.schain = schain;
+ }
+
+ const bidderTimeout = config.getConfig('bidderTimeout') || timeout;
+ const tmax = timeout ? Math.min(bidderTimeout, timeout) : bidderTimeout;
+
+ let request = {
+ id: bidderRequestId,
+ site: {
+ page: referer
+ },
+ tmax,
+ source,
+ imp
+ };
+
+ if (content) {
+ request.site.content = content;
+ }
+
+ if (jwpseg && jwpseg.length) {
+ user = {
+ data: [{
+ name: 'iow_labs_pub_data',
+ segment: jwpseg.map((seg) => {
+ return {name: 'jwpseg', value: seg};
+ })
+ }]
+ };
+ }
+
+ if (gdprConsent && gdprConsent.consentString) {
+ userExt = {consent: gdprConsent.consentString};
+ }
+
+ if (userIdAsEids && userIdAsEids.length) {
+ userExt = userExt || {};
+ userExt.eids = [...userIdAsEids];
+ }
+
+ if (userExt && Object.keys(userExt).length) {
+ user = user || {};
+ user.ext = userExt;
+ }
+
+ if (user) {
+ request.user = user;
+ }
+
+ const configKeywords = utils.transformBidderParamKeywords({
+ 'user': utils.deepAccess(config.getConfig('ortb2.user'), 'keywords') || null,
+ 'context': utils.deepAccess(config.getConfig('ortb2.site'), 'keywords') || null
+ });
+
+ if (configKeywords.length) {
+ pageKeywords = (pageKeywords || []).concat(configKeywords);
+ }
+
+ if (pageKeywords && pageKeywords.length > 0) {
+ pageKeywords.forEach(deleteValues);
+ }
+
+ if (pageKeywords) {
+ request.ext = {
+ keywords: pageKeywords
+ };
+ }
+
+ if (gdprConsent && gdprConsent.gdprApplies) {
+ request.regs = {
+ ext: {
+ gdpr: gdprConsent.gdprApplies ? 1 : 0
+ }
+ }
+ }
+
+ if (uspConsent) {
+ if (!request.regs) {
+ request.regs = {ext: {}};
+ }
+ request.regs.ext.us_privacy = uspConsent;
+ }
+
+ return {
+ method: 'POST',
+ url: NEW_ENDPOINT_URL,
+ data: JSON.stringify(request),
+ newFormat: true,
+ bidsMap
+ };
+}
+
+function oldFormatRequest(validBidRequests, bidderRequest) {
+ const auids = [];
+ const bidsMap = {};
+ const slotsMapByUid = {};
+ const sizeMap = {};
+ const bids = validBidRequests || [];
+ let priceType = 'net';
+ let pageKeywords;
+ let reqId;
+
+ bids.forEach(bid => {
+ if (bid.params.priceType === 'gross') {
+ priceType = 'gross';
+ }
+ reqId = bid.bidderRequestId;
+ const {params: {uid}, adUnitCode} = bid;
+ auids.push(uid);
+ const sizesId = utils.parseSizesInput(bid.sizes);
+
+ if (!pageKeywords && !utils.isEmpty(bid.params.keywords)) {
+ const keywords = utils.transformBidderParamKeywords(bid.params.keywords);
+
+ if (keywords.length > 0) {
+ keywords.forEach(deleteValues);
+ }
+ pageKeywords = keywords;
+ }
+
+ if (!slotsMapByUid[uid]) {
+ slotsMapByUid[uid] = {};
+ }
+ const slotsMap = slotsMapByUid[uid];
+ if (!slotsMap[adUnitCode]) {
+ slotsMap[adUnitCode] = {adUnitCode, bids: [bid], parents: []};
+ } else {
+ slotsMap[adUnitCode].bids.push(bid);
+ }
+ const slot = slotsMap[adUnitCode];
+
+ sizesId.forEach((sizeId) => {
+ sizeMap[sizeId] = true;
+ if (!bidsMap[uid]) {
+ bidsMap[uid] = {};
+ }
+
+ if (!bidsMap[uid][sizeId]) {
+ bidsMap[uid][sizeId] = [slot];
+ } else {
+ bidsMap[uid][sizeId].push(slot);
+ }
+ slot.parents.push({parent: bidsMap[uid], key: sizeId, uid});
+ });
+ });
+
+ const payload = {
+ pt: priceType,
+ auids: auids.join(','),
+ sizes: utils.getKeys(sizeMap).join(','),
+ r: reqId,
+ wrapperType: 'Prebid_js',
+ wrapperVersion: '$prebid.version$'
+ };
+
+ if (pageKeywords) {
+ payload.keywords = JSON.stringify(pageKeywords);
+ }
+
+ if (bidderRequest) {
+ if (bidderRequest.refererInfo && bidderRequest.refererInfo.referer) {
+ payload.u = bidderRequest.refererInfo.referer;
+ }
+ if (bidderRequest.timeout) {
+ payload.wtimeout = bidderRequest.timeout;
+ }
+ if (bidderRequest.gdprConsent) {
+ if (bidderRequest.gdprConsent.consentString) {
+ payload.gdpr_consent = bidderRequest.gdprConsent.consentString;
+ }
+ payload.gdpr_applies =
+ (typeof bidderRequest.gdprConsent.gdprApplies === 'boolean')
+ ? Number(bidderRequest.gdprConsent.gdprApplies) : 1;
+ }
+ if (bidderRequest.uspConsent) {
+ payload.us_privacy = bidderRequest.uspConsent;
+ }
+ }
+
+ return {
+ method: 'GET',
+ url: ENDPOINT_URL,
+ data: utils.parseQueryStringParameters(payload).replace(/\&$/, ''),
+ bidsMap,
+ priceType
+ };
+}
+
registerBidder(spec);
diff --git a/modules/trustxBidAdapter.md b/modules/trustxBidAdapter.md
index a72f1ba85aa..e891df8f161 100644
--- a/modules/trustxBidAdapter.md
+++ b/modules/trustxBidAdapter.md
@@ -52,6 +52,18 @@ TrustX Bid Adapter supports Banner and Video (instream and outstream).
}
}
]
+ },{
+ code: 'test-div',
+ sizes: [[300, 250]],
+ bids: [
+ {
+ bidder: "trustx",
+ params: {
+ uid: '58851',
+ useNewFormat: true
+ }
+ }
+ ]
}
];
-```
\ No newline at end of file
+```
diff --git a/test/spec/modules/trustxBidAdapter_spec.js b/test/spec/modules/trustxBidAdapter_spec.js
index e9daaa83b5d..c0155f87ab6 100644
--- a/test/spec/modules/trustxBidAdapter_spec.js
+++ b/test/spec/modules/trustxBidAdapter_spec.js
@@ -1,6 +1,7 @@
import { expect } from 'chai';
import { spec } from 'modules/trustxBidAdapter.js';
import { newBidder } from 'src/adapters/bidderFactory.js';
+import { config } from 'src/config.js';
describe('TrustXAdapter', function () {
const adapter = newBidder(spec);
@@ -92,7 +93,7 @@ describe('TrustXAdapter', function () {
];
it('should attach valid params to the tag', function () {
- const request = spec.buildRequests([bidRequests[0]], bidderRequest);
+ const request = spec.buildRequests([bidRequests[0]], bidderRequest)[0];
expect(request.data).to.be.an('string');
const payload = parseRequest(request.data);
expect(payload).to.have.property('u', referrer);
@@ -105,7 +106,7 @@ describe('TrustXAdapter', function () {
});
it('sizes must not be duplicated', function () {
- const request = spec.buildRequests(bidRequests, bidderRequest);
+ const request = spec.buildRequests(bidRequests, bidderRequest)[0];
expect(request.data).to.be.an('string');
const payload = parseRequest(request.data);
expect(payload).to.have.property('u', referrer);
@@ -117,7 +118,7 @@ describe('TrustXAdapter', function () {
it('pt parameter must be "gross" if params.priceType === "gross"', function () {
bidRequests[1].params.priceType = 'gross';
- const request = spec.buildRequests(bidRequests, bidderRequest);
+ const request = spec.buildRequests(bidRequests, bidderRequest)[0];
expect(request.data).to.be.an('string');
const payload = parseRequest(request.data);
expect(payload).to.have.property('u', referrer);
@@ -130,7 +131,7 @@ describe('TrustXAdapter', function () {
it('pt parameter must be "net" or "gross"', function () {
bidRequests[1].params.priceType = 'some';
- const request = spec.buildRequests(bidRequests, bidderRequest);
+ const request = spec.buildRequests(bidRequests, bidderRequest)[0];
expect(request.data).to.be.an('string');
const payload = parseRequest(request.data);
expect(payload).to.have.property('u', referrer);
@@ -143,7 +144,7 @@ describe('TrustXAdapter', function () {
it('if gdprConsent is present payload must have gdpr params', function () {
const bidderRequestWithGDPR = Object.assign({gdprConsent: {consentString: 'AAA', gdprApplies: true}}, bidderRequest);
- const request = spec.buildRequests(bidRequests, bidderRequestWithGDPR);
+ const request = spec.buildRequests(bidRequests, bidderRequestWithGDPR)[0];
expect(request.data).to.be.an('string');
const payload = parseRequest(request.data);
expect(payload).to.have.property('gdpr_consent', 'AAA');
@@ -152,7 +153,7 @@ describe('TrustXAdapter', function () {
it('if gdprApplies is false gdpr_applies must be 0', function () {
const bidderRequestWithGDPR = Object.assign({gdprConsent: {consentString: 'AAA', gdprApplies: false}}, bidderRequest);
- const request = spec.buildRequests(bidRequests, bidderRequestWithGDPR);
+ const request = spec.buildRequests(bidRequests, bidderRequestWithGDPR)[0];
expect(request.data).to.be.an('string');
const payload = parseRequest(request.data);
expect(payload).to.have.property('gdpr_consent', 'AAA');
@@ -161,7 +162,7 @@ describe('TrustXAdapter', function () {
it('if gdprApplies is undefined gdpr_applies must be 1', function () {
const bidderRequestWithGDPR = Object.assign({gdprConsent: {consentString: 'AAA'}}, bidderRequest);
- const request = spec.buildRequests(bidRequests, bidderRequestWithGDPR);
+ const request = spec.buildRequests(bidRequests, bidderRequestWithGDPR)[0];
expect(request.data).to.be.an('string');
const payload = parseRequest(request.data);
expect(payload).to.have.property('gdpr_consent', 'AAA');
@@ -170,7 +171,7 @@ describe('TrustXAdapter', function () {
it('if usPrivacy is present payload must have us_privacy param', function () {
const bidderRequestWithUSP = Object.assign({uspConsent: '1YNN'}, bidderRequest);
- const request = spec.buildRequests(bidRequests, bidderRequestWithUSP);
+ const request = spec.buildRequests(bidRequests, bidderRequestWithUSP)[0];
expect(request.data).to.be.an('string');
const payload = parseRequest(request.data);
expect(payload).to.have.property('us_privacy', '1YNN');
@@ -197,7 +198,7 @@ describe('TrustXAdapter', function () {
}
);
- const request = spec.buildRequests(bidRequestWithKeywords, bidderRequest);
+ const request = spec.buildRequests(bidRequestWithKeywords, bidderRequest)[0];
expect(request.data).to.be.an('string');
const payload = parseRequest(request.data);
expect(payload.keywords).to.be.an('string');
@@ -226,6 +227,438 @@ describe('TrustXAdapter', function () {
});
});
+ describe('buildRequests with new format', function () {
+ function parseRequest(data) {
+ return JSON.parse(data);
+ }
+ const bidderRequest = {
+ refererInfo: {referer: 'https://example.com'},
+ bidderRequestId: '22edbae2733bf6',
+ auctionId: '9e2dfbfe-00c7-4f5e-9850-4044df3229c7',
+ timeout: 3000
+ };
+ const referrer = encodeURIComponent(bidderRequest.refererInfo.referer);
+
+ let bidRequests = [
+ {
+ 'bidder': 'trustx',
+ 'params': {
+ 'uid': '43',
+ 'bidFloor': 1.25,
+ 'useNewFormat': true
+ },
+ 'adUnitCode': 'adunit-code-1',
+ 'sizes': [[300, 250], [300, 600]],
+ 'mediaTypes': {
+ 'banner': {
+ 'sizes': [[300, 250], [300, 600]]
+ }
+ },
+ 'bidId': '42dbe3a7168a6a',
+ 'bidderRequestId': '22edbae2733bf6',
+ 'auctionId': '9e2dfbfe-00c7-4f5e-9850-4044df3229c7',
+ },
+ {
+ 'bidder': 'trustx',
+ 'params': {
+ 'uid': '44',
+ 'useNewFormat': true
+ },
+ 'adUnitCode': 'adunit-code-1',
+ 'sizes': [[300, 250], [300, 600]],
+ 'bidId': '30b31c1838de1e',
+ 'bidderRequestId': '22edbae2733bf6',
+ 'auctionId': '9e2dfbfe-00c7-4f5e-9850-4044df3229c7',
+ },
+ {
+ 'bidder': 'trustx',
+ 'params': {
+ 'uid': '45',
+ 'useNewFormat': true
+ },
+ 'adUnitCode': 'adunit-code-2',
+ 'sizes': [[728, 90]],
+ 'mediaTypes': {
+ 'video': {
+ 'playerSize': [[400, 600]],
+ 'mimes': ['video/mp4', 'video/webm', 'application/javascript', 'video/ogg']
+ }
+ },
+ 'bidId': '3150ccb55da321',
+ 'bidderRequestId': '22edbae2733bf6',
+ 'auctionId': '9e2dfbfe-00c7-4f5e-9850-4044df3229c7',
+ },
+ {
+ 'bidder': 'trustx',
+ 'params': {
+ 'uid': '41',
+ 'useNewFormat': true
+ },
+ 'adUnitCode': 'adunit-code-2',
+ 'sizes': [[728, 90]],
+ 'mediaTypes': {
+ 'video': {
+ 'playerSize': [[400, 600]],
+ 'protocols': [1, 2, 3]
+ },
+ 'banner': {
+ 'sizes': [[728, 90]]
+ }
+ },
+ 'bidId': '3150ccb55da321',
+ 'bidderRequestId': '22edbae2733bf6',
+ 'auctionId': '9e2dfbfe-00c7-4f5e-9850-4044df3229c7',
+ }
+ ];
+
+ it('should attach valid params to the tag', function () {
+ const request = spec.buildRequests([bidRequests[0]], bidderRequest)[0];
+ expect(request.data).to.be.an('string');
+ const payload = parseRequest(request.data);
+ expect(payload).to.deep.equal({
+ 'id': bidderRequest.bidderRequestId,
+ 'site': {
+ 'page': referrer
+ },
+ 'tmax': bidderRequest.timeout,
+ 'source': {
+ 'tid': bidderRequest.auctionId,
+ 'ext': {'wrapper': 'Prebid_js', 'wrapper_version': '$prebid.version$'}
+ },
+ 'imp': [{
+ 'id': bidRequests[0].bidId,
+ 'tagid': bidRequests[0].params.uid,
+ 'ext': {'divid': bidRequests[0].adUnitCode},
+ 'bidfloor': bidRequests[0].params.bidFloor,
+ 'banner': {
+ 'w': 300,
+ 'h': 250,
+ 'format': [{'w': 300, 'h': 250}, {'w': 300, 'h': 600}]
+ }
+ }]
+ });
+ });
+
+ it('make possible to process request without mediaTypes', function () {
+ const request = spec.buildRequests([bidRequests[0], bidRequests[1]], bidderRequest)[0];
+ expect(request.data).to.be.an('string');
+ const payload = parseRequest(request.data);
+ expect(payload).to.deep.equal({
+ 'id': bidderRequest.bidderRequestId,
+ 'site': {
+ 'page': referrer
+ },
+ 'tmax': bidderRequest.timeout,
+ 'source': {
+ 'tid': bidderRequest.auctionId,
+ 'ext': {'wrapper': 'Prebid_js', 'wrapper_version': '$prebid.version$'}
+ },
+ 'imp': [{
+ 'id': bidRequests[0].bidId,
+ 'tagid': bidRequests[0].params.uid,
+ 'ext': {'divid': bidRequests[0].adUnitCode},
+ 'bidfloor': bidRequests[0].params.bidFloor,
+ 'banner': {
+ 'w': 300,
+ 'h': 250,
+ 'format': [{'w': 300, 'h': 250}, {'w': 300, 'h': 600}]
+ }
+ }, {
+ 'id': bidRequests[1].bidId,
+ 'tagid': bidRequests[1].params.uid,
+ 'ext': {'divid': bidRequests[1].adUnitCode},
+ 'banner': {
+ 'w': 300,
+ 'h': 250,
+ 'format': [{'w': 300, 'h': 250}, {'w': 300, 'h': 600}]
+ }
+ }]
+ });
+ });
+
+ it('should attach valid params to the video tag', function () {
+ const request = spec.buildRequests(bidRequests.slice(0, 3), bidderRequest)[0];
+ expect(request.data).to.be.an('string');
+ const payload = parseRequest(request.data);
+ expect(payload).to.deep.equal({
+ 'id': bidderRequest.bidderRequestId,
+ 'site': {
+ 'page': referrer
+ },
+ 'tmax': bidderRequest.timeout,
+ 'source': {
+ 'tid': bidderRequest.auctionId,
+ 'ext': {'wrapper': 'Prebid_js', 'wrapper_version': '$prebid.version$'}
+ },
+ 'imp': [{
+ 'id': bidRequests[0].bidId,
+ 'tagid': bidRequests[0].params.uid,
+ 'ext': {'divid': bidRequests[0].adUnitCode},
+ 'bidfloor': bidRequests[0].params.bidFloor,
+ 'banner': {
+ 'w': 300,
+ 'h': 250,
+ 'format': [{'w': 300, 'h': 250}, {'w': 300, 'h': 600}]
+ }
+ }, {
+ 'id': bidRequests[1].bidId,
+ 'tagid': bidRequests[1].params.uid,
+ 'ext': {'divid': bidRequests[1].adUnitCode},
+ 'banner': {
+ 'w': 300,
+ 'h': 250,
+ 'format': [{'w': 300, 'h': 250}, {'w': 300, 'h': 600}]
+ }
+ }, {
+ 'id': bidRequests[2].bidId,
+ 'tagid': bidRequests[2].params.uid,
+ 'ext': {'divid': bidRequests[2].adUnitCode},
+ 'video': {
+ 'w': 400,
+ 'h': 600,
+ 'mimes': ['video/mp4', 'video/webm', 'application/javascript', 'video/ogg']
+ }
+ }]
+ });
+ });
+
+ it('should support mixed mediaTypes', function () {
+ const request = spec.buildRequests(bidRequests, bidderRequest)[0];
+ expect(request.data).to.be.an('string');
+ const payload = parseRequest(request.data);
+ expect(payload).to.deep.equal({
+ 'id': bidderRequest.bidderRequestId,
+ 'site': {
+ 'page': referrer
+ },
+ 'tmax': bidderRequest.timeout,
+ 'source': {
+ 'tid': bidderRequest.auctionId,
+ 'ext': {'wrapper': 'Prebid_js', 'wrapper_version': '$prebid.version$'}
+ },
+ 'imp': [{
+ 'id': bidRequests[0].bidId,
+ 'tagid': bidRequests[0].params.uid,
+ 'ext': {'divid': bidRequests[0].adUnitCode},
+ 'bidfloor': bidRequests[0].params.bidFloor,
+ 'banner': {
+ 'w': 300,
+ 'h': 250,
+ 'format': [{'w': 300, 'h': 250}, {'w': 300, 'h': 600}]
+ }
+ }, {
+ 'id': bidRequests[1].bidId,
+ 'tagid': bidRequests[1].params.uid,
+ 'ext': {'divid': bidRequests[1].adUnitCode},
+ 'banner': {
+ 'w': 300,
+ 'h': 250,
+ 'format': [{'w': 300, 'h': 250}, {'w': 300, 'h': 600}]
+ }
+ }, {
+ 'id': bidRequests[2].bidId,
+ 'tagid': bidRequests[2].params.uid,
+ 'ext': {'divid': bidRequests[2].adUnitCode},
+ 'video': {
+ 'w': 400,
+ 'h': 600,
+ 'mimes': ['video/mp4', 'video/webm', 'application/javascript', 'video/ogg'],
+ }
+ }, {
+ 'id': bidRequests[3].bidId,
+ 'tagid': bidRequests[3].params.uid,
+ 'ext': {'divid': bidRequests[3].adUnitCode},
+ 'banner': {
+ 'w': 728,
+ 'h': 90,
+ 'format': [{'w': 728, 'h': 90}]
+ },
+ 'video': {
+ 'w': 400,
+ 'h': 600,
+ 'protocols': [1, 2, 3]
+ }
+ }]
+ });
+ });
+
+ it('if gdprConsent is present payload must have gdpr params', function () {
+ const gdprBidderRequest = Object.assign({gdprConsent: {consentString: 'AAA', gdprApplies: true}}, bidderRequest);
+ const request = spec.buildRequests(bidRequests, gdprBidderRequest)[0];
+ expect(request.data).to.be.an('string');
+ const payload = parseRequest(request.data);
+ expect(payload).to.have.property('user');
+ expect(payload.user).to.have.property('ext');
+ expect(payload.user.ext).to.have.property('consent', 'AAA');
+ expect(payload).to.have.property('regs');
+ expect(payload.regs).to.have.property('ext');
+ expect(payload.regs.ext).to.have.property('gdpr', 1);
+ });
+
+ it('if usPrivacy is present payload must have us_privacy param', function () {
+ const bidderRequestWithUSP = Object.assign({uspConsent: '1YNN'}, bidderRequest);
+ const request = spec.buildRequests(bidRequests, bidderRequestWithUSP)[0];
+ expect(request.data).to.be.an('string');
+ const payload = parseRequest(request.data);
+ expect(payload).to.have.property('regs');
+ expect(payload.regs).to.have.property('ext');
+ expect(payload.regs.ext).to.have.property('us_privacy', '1YNN');
+ });
+
+ it('if userId is present payload must have user.ext param with right keys', function () {
+ const eids = [
+ {
+ source: 'pubcid.org',
+ uids: [{
+ id: 'some-random-id-value',
+ atype: 1
+ }]
+ },
+ {
+ source: 'adserver.org',
+ uids: [{
+ id: 'some-random-id-value',
+ atype: 1,
+ ext: {
+ rtiPartner: 'TDID'
+ }
+ }]
+ }
+ ];
+ const bidRequestsWithUserIds = bidRequests.map((bid) => {
+ return Object.assign({
+ userIdAsEids: eids
+ }, bid);
+ });
+ const request = spec.buildRequests(bidRequestsWithUserIds, bidderRequest)[0];
+ expect(request.data).to.be.an('string');
+ const payload = parseRequest(request.data);
+ expect(payload).to.have.property('user');
+ expect(payload.user).to.have.property('ext');
+ expect(payload.user.ext.eids).to.deep.equal(eids);
+ });
+
+ it('if schain is present payload must have source.ext.schain param', function () {
+ const schain = {
+ complete: 1,
+ nodes: [
+ {
+ asi: 'indirectseller.com',
+ sid: '00001',
+ hp: 1
+ }
+ ]
+ };
+ const bidRequestsWithSChain = bidRequests.map((bid) => {
+ return Object.assign({
+ schain: schain
+ }, bid);
+ });
+ const request = spec.buildRequests(bidRequestsWithSChain, bidderRequest)[0];
+ expect(request.data).to.be.an('string');
+ const payload = parseRequest(request.data);
+ expect(payload).to.have.property('source');
+ expect(payload.source).to.have.property('ext');
+ expect(payload.source.ext).to.have.property('schain');
+ expect(payload.source.ext.schain).to.deep.equal(schain);
+ });
+
+ it('if content and segment is present in jwTargeting, payload must have right params', function () {
+ const jsContent = {id: 'test_jw_content_id'};
+ const jsSegments = ['test_seg_1', 'test_seg_2'];
+ const bidRequestsWithJwTargeting = bidRequests.map((bid) => {
+ return Object.assign({
+ rtd: {
+ jwplayer: {
+ targeting: {
+ segments: jsSegments,
+ content: jsContent
+ }
+ }
+ }
+ }, bid);
+ });
+ const request = spec.buildRequests(bidRequestsWithJwTargeting, bidderRequest)[0];
+ expect(request.data).to.be.an('string');
+ const payload = parseRequest(request.data);
+ expect(payload).to.have.property('user');
+ expect(payload.user.data).to.deep.equal([{
+ name: 'iow_labs_pub_data',
+ segment: [
+ {name: 'jwpseg', value: jsSegments[0]},
+ {name: 'jwpseg', value: jsSegments[1]}
+ ]
+ }]);
+ expect(payload).to.have.property('site');
+ expect(payload.site.content).to.deep.equal(jsContent);
+ });
+
+ it('should contain the keyword values if it present in ortb2.(site/user)', function () {
+ const getConfigStub = sinon.stub(config, 'getConfig').callsFake(
+ arg => arg === 'ortb2.user' ? {'keywords': 'foo'} : (arg === 'ortb2.site' ? {'keywords': 'bar'} : null));
+ const request = spec.buildRequests([bidRequests[0]], bidderRequest)[0];
+ expect(request.data).to.be.an('string');
+ const payload = parseRequest(request.data);
+ expect(payload.ext.keywords).to.deep.equal([{'key': 'user', 'value': ['foo']}, {'key': 'context', 'value': ['bar']}]);
+ getConfigStub.restore();
+ });
+
+ it('shold be right tmax when timeout in config is less then timeout in bidderRequest', function() {
+ const getConfigStub = sinon.stub(config, 'getConfig').callsFake(
+ arg => arg === 'bidderTimeout' ? 2000 : null);
+ const request = spec.buildRequests([bidRequests[0]], bidderRequest)[0];
+ expect(request.data).to.be.an('string');
+ const payload = parseRequest(request.data);
+ expect(payload.tmax).to.equal(2000);
+ getConfigStub.restore();
+ });
+ it('shold be right tmax when timeout in bidderRequest is less then timeout in config', function() {
+ const getConfigStub = sinon.stub(config, 'getConfig').callsFake(
+ arg => arg === 'bidderTimeout' ? 5000 : null);
+ const request = spec.buildRequests([bidRequests[0]], bidderRequest)[0];
+ expect(request.data).to.be.an('string');
+ const payload = parseRequest(request.data);
+ expect(payload.tmax).to.equal(3000);
+ getConfigStub.restore();
+ });
+
+ describe('floorModule', function () {
+ const floorTestData = {
+ 'currency': 'USD',
+ 'floor': 1.50
+ };
+ const bidRequest = Object.assign({
+ getFloor: (_) => {
+ return floorTestData;
+ }
+ }, bidRequests[1]);
+ it('should return the value from getFloor if present', function () {
+ const request = spec.buildRequests([bidRequest], bidderRequest)[0];
+ expect(request.data).to.be.an('string');
+ const payload = parseRequest(request.data);
+ expect(payload.imp[0].bidfloor).to.equal(floorTestData.floor);
+ });
+ it('should return the getFloor.floor value if it is greater than bidfloor', function () {
+ const bidfloor = 0.80;
+ const bidRequestsWithFloor = { ...bidRequest };
+ bidRequestsWithFloor.params = Object.assign({bidFloor: bidfloor}, bidRequestsWithFloor.params);
+ const request = spec.buildRequests([bidRequestsWithFloor], bidderRequest)[0];
+ expect(request.data).to.be.an('string');
+ const payload = parseRequest(request.data);
+ expect(payload.imp[0].bidfloor).to.equal(floorTestData.floor);
+ });
+ it('should return the bidfloor value if it is greater than getFloor.floor', function () {
+ const bidfloor = 1.80;
+ const bidRequestsWithFloor = { ...bidRequest };
+ bidRequestsWithFloor.params = Object.assign({bidFloor: bidfloor}, bidRequestsWithFloor.params);
+ const request = spec.buildRequests([bidRequestsWithFloor], bidderRequest)[0];
+ expect(request.data).to.be.an('string');
+ const payload = parseRequest(request.data);
+ expect(payload.imp[0].bidfloor).to.equal(bidfloor);
+ });
+ });
+ });
+
describe('interpretResponse', function () {
const responses = [
{'bid': [{'price': 1.15, 'adm': 'test content 1
', 'auid': 43, 'h': 250, 'w': 300}], 'seat': '1'},
@@ -252,7 +685,7 @@ describe('TrustXAdapter', function () {
'auctionId': '1cbd2feafe5e8b',
}
];
- const request = spec.buildRequests(bidRequests);
+ const request = spec.buildRequests(bidRequests)[0];
const expectedResponse = [
{
'requestId': '659423fff799cb',
@@ -309,7 +742,7 @@ describe('TrustXAdapter', function () {
'auctionId': '1fa09aee5c8c99',
}
];
- const request = spec.buildRequests(bidRequests);
+ const request = spec.buildRequests(bidRequests)[0];
const expectedResponse = [
{
'requestId': '300bfeb0d71a5b',
@@ -392,7 +825,7 @@ describe('TrustXAdapter', function () {
'auctionId': '1fa09aee5c84d34',
}
];
- const request = spec.buildRequests(bidRequests);
+ const request = spec.buildRequests(bidRequests)[0];
const result = spec.interpretResponse({'body': {'seatbid': responses.slice(3)}}, request);
expect(result.length).to.equal(0);
});
@@ -462,7 +895,7 @@ describe('TrustXAdapter', function () {
'auctionId': '32a1f276cb87cb8',
}
];
- const request = spec.buildRequests(bidRequests);
+ const request = spec.buildRequests(bidRequests)[0];
const expectedResponse = [
{
'requestId': '2164be6358b9',
@@ -562,7 +995,7 @@ describe('TrustXAdapter', function () {
'auctionId': '35bcbc0f7e79c',
}
];
- const request = spec.buildRequests(bidRequests);
+ const request = spec.buildRequests(bidRequests)[0];
const expectedResponse = [
{
'requestId': '5126e301f4be',
@@ -636,7 +1069,7 @@ describe('TrustXAdapter', function () {
{'bid': [{'price': 1.15, 'adm': '\n<\/Ad>\n<\/VAST>', 'auid': 50, content_type: 'video', w: 300, h: 600}], 'seat': '2'},
{'bid': [{'price': 1.00, 'adm': '\n<\/Ad>\n<\/VAST>', 'auid': 51, content_type: 'video'}], 'seat': '2'}
];
- const request = spec.buildRequests(bidRequests);
+ const request = spec.buildRequests(bidRequests)[0];
const expectedResponse = [
{
'requestId': '57dfefb80eca',
@@ -715,7 +1148,7 @@ describe('TrustXAdapter', function () {
{'bid': [{'price': 1.00, 'adm': '\n<\/Ad>\n<\/VAST>', 'auid': 51, content_type: 'video', w: 300, h: 250}], 'seat': '2'},
{'bid': [{'price': 1.20, 'adm': '\n<\/Ad>\n<\/VAST>', 'auid': 52, content_type: 'video', w: 300, h: 250}], 'seat': '2'}
];
- const request = spec.buildRequests(bidRequests);
+ const request = spec.buildRequests(bidRequests)[0];
const expectedResponse = [
{
'requestId': 'e6e65553fc8',