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

IX Bid Adapter: remove usage of transactionID in compliant with Prebid 8 [PB-1743] #10070

Merged
merged 1 commit into from
Jun 7, 2023
Merged

IX Bid Adapter: remove usage of transactionID in compliant with Prebid 8 [PB-1743] #10070

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
146 changes: 72 additions & 74 deletions modules/ixBidAdapter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -597,7 +597,7 @@ function getEidInfo(allEids) {
*
* @param {array} validBidRequests A list of valid bid request config objects.
* @param {object} bidderRequest An object containing other info like gdprConsent.
* @param {object} impressions An object containing a list of impression objects describing the bids for each transactionId
* @param {object} impressions An object containing a list of impression objects describing the bids for each transaction
* @param {array} version Endpoint version denoting banner, video or native.
* @return {array} List of objects describing the request to the server.
*
Expand Down Expand Up @@ -640,16 +640,15 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
siteID = validBidRequests[0].params.siteId;
payload.s = siteID;

// TODO: this logic should stop relying on `transactionId` always being available; see: https://github.com/prebid/Prebid.js/issues/9781
const transactionIds = Object.keys(impressions);
const impKeys = Object.keys(impressions);
let isFpdAdded = false;

for (let adUnitIndex = 0; adUnitIndex < transactionIds.length; adUnitIndex++) {
for (let adUnitIndex = 0; adUnitIndex < impKeys.length; adUnitIndex++) {
if (requests.length >= MAX_REQUEST_LIMIT) {
break;
}

r = addImpressions(impressions, transactionIds, r, adUnitIndex);
r = addImpressions(impressions, impKeys, r, adUnitIndex);

const fpd = deepAccess(bidderRequest, 'ortb2') || {};
const site = { ...(fpd.site || fpd.context) };
Expand All @@ -666,9 +665,9 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
}

// add identifiers info to ixDiag
r = addIdentifiersInfo(impressions, r, transactionIds, adUnitIndex, payload, baseUrl);
r = addIdentifiersInfo(impressions, r, impKeys, adUnitIndex, payload, baseUrl);

const isLastAdUnit = adUnitIndex === transactionIds.length - 1;
const isLastAdUnit = adUnitIndex === impKeys.length - 1;

if (isLastAdUnit) {
requests.push({
Expand Down Expand Up @@ -862,24 +861,24 @@ function applyRegulations(r, bidderRequest) {
* addImpressions adds impressions to request object
*
* @param {array} impressions List of impressions to be added to the request.
* @param {array} transactionIds List of transaction Ids.
* @param {array} impKeys List of impression keys.
* @param {object} r Reuqest object.
* @param {int} adUnitIndex Index of the current add unit
* @return {object} Reqyest object with added impressions describing the request to the server.
*/
function addImpressions(impressions, transactionIds, r, adUnitIndex) {
const adUnitImpressions = impressions[transactionIds[adUnitIndex]];
function addImpressions(impressions, impKeys, r, adUnitIndex) {
const adUnitImpressions = impressions[impKeys[adUnitIndex]];
const { missingImps: missingBannerImpressions = [], ixImps = [] } = adUnitImpressions;
const sourceImpressions = { ixImps, missingBannerImpressions };
const impressionObjects = Object.keys(sourceImpressions)
.map((key) => sourceImpressions[key])
.filter(item => Array.isArray(item))
.reduce((acc, curr) => acc.concat(...curr), []);

const gpid = impressions[transactionIds[adUnitIndex]].gpid;
const dfpAdUnitCode = impressions[transactionIds[adUnitIndex]].dfp_ad_unit_code;
const tid = impressions[transactionIds[adUnitIndex]].tid;
const sid = impressions[transactionIds[adUnitIndex]].sid
const gpid = impressions[impKeys[adUnitIndex]].gpid;
const dfpAdUnitCode = impressions[impKeys[adUnitIndex]].dfp_ad_unit_code;
const tid = impressions[impKeys[adUnitIndex]].tid;
const sid = impressions[impKeys[adUnitIndex]].sid

if (impressionObjects.length && BANNER in impressionObjects[0]) {
const { id, banner: { topframe } } = impressionObjects[0];
Expand All @@ -903,7 +902,7 @@ function addImpressions(impressions, transactionIds, r, adUnitIndex) {
}
}

const position = impressions[transactionIds[adUnitIndex]].pos;
const position = impressions[impKeys[adUnitIndex]].pos;
if (isInteger(position)) {
_bannerImpression.banner.pos = position;
}
Expand All @@ -924,7 +923,7 @@ function addImpressions(impressions, transactionIds, r, adUnitIndex) {
_bannerImpression.bidfloorcur = impressionObjects[0].bidfloorcur;
}

const adUnitFPD = impressions[transactionIds[adUnitIndex]].adUnitFPD
const adUnitFPD = impressions[impKeys[adUnitIndex]].adUnitFPD
if (adUnitFPD) {
_bannerImpression.ext.data = adUnitFPD;
}
Expand Down Expand Up @@ -1061,17 +1060,17 @@ function addAdUnitFPD(imp, bid) {
*
* @param {array} impressions List of impressions to be added to the request.
* @param {object} r Reuqest object.
* @param {array} transactionIds List of transaction Ids.
* @param {array} impKeys List of impression keys.
* @param {int} adUnitIndex Index of the current add unit
* @param {object} payload Request payload object.
* @param {string} baseUrl Base exchagne URL.
* @return {object} Reqyest object with added indentigfier info to ixDiag.
*/
function addIdentifiersInfo(impressions, r, transactionIds, adUnitIndex, payload, baseUrl) {
const pbaAdSlot = impressions[transactionIds[adUnitIndex]].pbadslot;
const tagId = impressions[transactionIds[adUnitIndex]].tagId;
const adUnitCode = impressions[transactionIds[adUnitIndex]].adUnitCode;
const divId = impressions[transactionIds[adUnitIndex]].divId;
function addIdentifiersInfo(impressions, r, impKeys, adUnitIndex, payload, baseUrl) {
const pbaAdSlot = impressions[impKeys[adUnitIndex]].pbadslot;
const tagId = impressions[impKeys[adUnitIndex]].tagId;
const adUnitCode = impressions[impKeys[adUnitIndex]].adUnitCode;
const divId = impressions[impKeys[adUnitIndex]].divId;
if (pbaAdSlot || tagId || adUnitCode || divId) {
r.ext.ixdiag.pbadslot = pbaAdSlot;
r.ext.ixdiag.tagid = tagId;
Expand Down Expand Up @@ -1101,7 +1100,7 @@ function _getUserIds(bidRequest) {
*/
function buildIXDiag(validBidRequests) {
var adUnitMap = validBidRequests
.map(bidRequest => bidRequest.transactionId)
.map(bidRequest => bidRequest.adUnitCode)
.filter((value, index, arr) => arr.indexOf(value) === index);

var ixdiag = {
Expand All @@ -1120,7 +1119,7 @@ function buildIXDiag(validBidRequests) {

// create ad unit map and collect the required diag properties
for (let i = 0; i < adUnitMap.length; i++) {
var bid = validBidRequests.filter(bidRequest => bidRequest.transactionId === adUnitMap[i])[0];
var bid = validBidRequests.filter(bidRequest => bidRequest.adUnitCode === adUnitMap[i])[0];

if (deepAccess(bid, 'mediaTypes')) {
if (Object.keys(bid.mediaTypes).length > 1) {
Expand Down Expand Up @@ -1182,18 +1181,18 @@ function createNativeImps(validBidRequest, nativeImps) {
const imp = bidToNativeImp(validBidRequest);

if (Object.keys(imp).length != 0) {
nativeImps[validBidRequest.transactionId] = {};
nativeImps[validBidRequest.transactionId].ixImps = [];
nativeImps[validBidRequest.transactionId].ixImps.push(imp);
nativeImps[validBidRequest.transactionId].gpid = deepAccess(validBidRequest, 'ortb2Imp.ext.gpid');
nativeImps[validBidRequest.transactionId].dfp_ad_unit_code = deepAccess(validBidRequest, 'ortb2Imp.ext.data.adserver.adslot');
nativeImps[validBidRequest.transactionId].pbadslot = deepAccess(validBidRequest, 'ortb2Imp.ext.data.pbadslot');
nativeImps[validBidRequest.transactionId].tagId = deepAccess(validBidRequest, 'params.tagId');
nativeImps[validBidRequest.adUnitCode] = {};
nativeImps[validBidRequest.adUnitCode].ixImps = [];
nativeImps[validBidRequest.adUnitCode].ixImps.push(imp);
nativeImps[validBidRequest.adUnitCode].gpid = deepAccess(validBidRequest, 'ortb2Imp.ext.gpid');
nativeImps[validBidRequest.adUnitCode].dfp_ad_unit_code = deepAccess(validBidRequest, 'ortb2Imp.ext.data.adserver.adslot');
nativeImps[validBidRequest.adUnitCode].pbadslot = deepAccess(validBidRequest, 'ortb2Imp.ext.data.pbadslot');
nativeImps[validBidRequest.adUnitCode].tagId = deepAccess(validBidRequest, 'params.tagId');

const adUnitCode = validBidRequest.adUnitCode;
const divId = document.getElementById(adUnitCode) ? adUnitCode : getGptSlotInfoForAdUnitCode(adUnitCode).divId;
nativeImps[validBidRequest.transactionId].adUnitCode = adUnitCode;
nativeImps[validBidRequest.transactionId].divId = divId;
nativeImps[validBidRequest.adUnitCode].adUnitCode = adUnitCode;
nativeImps[validBidRequest.adUnitCode].divId = divId;
}
}

Expand All @@ -1205,18 +1204,18 @@ function createNativeImps(validBidRequest, nativeImps) {
function createVideoImps(validBidRequest, videoImps) {
const imp = bidToVideoImp(validBidRequest);
if (Object.keys(imp).length != 0) {
videoImps[validBidRequest.transactionId] = {};
videoImps[validBidRequest.transactionId].ixImps = [];
videoImps[validBidRequest.transactionId].ixImps.push(imp);
videoImps[validBidRequest.transactionId].gpid = deepAccess(validBidRequest, 'ortb2Imp.ext.gpid');
videoImps[validBidRequest.transactionId].dfp_ad_unit_code = deepAccess(validBidRequest, 'ortb2Imp.ext.data.adserver.adslot');
videoImps[validBidRequest.transactionId].pbadslot = deepAccess(validBidRequest, 'ortb2Imp.ext.data.pbadslot');
videoImps[validBidRequest.transactionId].tagId = deepAccess(validBidRequest, 'params.tagId');
videoImps[validBidRequest.adUnitCode] = {};
videoImps[validBidRequest.adUnitCode].ixImps = [];
videoImps[validBidRequest.adUnitCode].ixImps.push(imp);
videoImps[validBidRequest.adUnitCode].gpid = deepAccess(validBidRequest, 'ortb2Imp.ext.gpid');
videoImps[validBidRequest.adUnitCode].dfp_ad_unit_code = deepAccess(validBidRequest, 'ortb2Imp.ext.data.adserver.adslot');
videoImps[validBidRequest.adUnitCode].pbadslot = deepAccess(validBidRequest, 'ortb2Imp.ext.data.pbadslot');
videoImps[validBidRequest.adUnitCode].tagId = deepAccess(validBidRequest, 'params.tagId');

const adUnitCode = validBidRequest.adUnitCode;
const divId = document.getElementById(adUnitCode) ? adUnitCode : getGptSlotInfoForAdUnitCode(adUnitCode).divId;
videoImps[validBidRequest.transactionId].adUnitCode = adUnitCode;
videoImps[validBidRequest.transactionId].divId = divId;
videoImps[validBidRequest.adUnitCode].adUnitCode = adUnitCode;
videoImps[validBidRequest.adUnitCode].divId = divId;
}
}

Expand All @@ -1231,39 +1230,39 @@ function createBannerImps(validBidRequest, missingBannerSizes, bannerImps) {

const bannerSizeDefined = includesSize(deepAccess(validBidRequest, 'mediaTypes.banner.sizes'), deepAccess(validBidRequest, 'params.size'));

if (!bannerImps.hasOwnProperty(validBidRequest.transactionId)) {
bannerImps[validBidRequest.transactionId] = {};
if (!bannerImps.hasOwnProperty(validBidRequest.adUnitCode)) {
bannerImps[validBidRequest.adUnitCode] = {};
}

bannerImps[validBidRequest.transactionId].gpid = deepAccess(validBidRequest, 'ortb2Imp.ext.gpid');
bannerImps[validBidRequest.transactionId].dfp_ad_unit_code = deepAccess(validBidRequest, 'ortb2Imp.ext.data.adserver.adslot');
bannerImps[validBidRequest.transactionId].tid = deepAccess(validBidRequest, 'ortb2Imp.ext.tid');
bannerImps[validBidRequest.transactionId].pbadslot = deepAccess(validBidRequest, 'ortb2Imp.ext.data.pbadslot');
bannerImps[validBidRequest.transactionId].tagId = deepAccess(validBidRequest, 'params.tagId');
bannerImps[validBidRequest.transactionId].pos = deepAccess(validBidRequest, 'mediaTypes.banner.pos');
bannerImps[validBidRequest.adUnitCode].gpid = deepAccess(validBidRequest, 'ortb2Imp.ext.gpid');
bannerImps[validBidRequest.adUnitCode].dfp_ad_unit_code = deepAccess(validBidRequest, 'ortb2Imp.ext.data.adserver.adslot');
bannerImps[validBidRequest.adUnitCode].tid = deepAccess(validBidRequest, 'ortb2Imp.ext.tid');
bannerImps[validBidRequest.adUnitCode].pbadslot = deepAccess(validBidRequest, 'ortb2Imp.ext.data.pbadslot');
bannerImps[validBidRequest.adUnitCode].tagId = deepAccess(validBidRequest, 'params.tagId');
bannerImps[validBidRequest.adUnitCode].pos = deepAccess(validBidRequest, 'mediaTypes.banner.pos');

// AdUnit-Specific First Party Data
const adUnitFPD = deepAccess(validBidRequest, 'ortb2Imp.ext.data');
if (adUnitFPD) {
bannerImps[validBidRequest.transactionId].adUnitFPD = adUnitFPD;
bannerImps[validBidRequest.adUnitCode].adUnitFPD = adUnitFPD;
}

const sid = deepAccess(validBidRequest, 'params.id');
if (sid && (typeof sid === 'string' || typeof sid === 'number')) {
bannerImps[validBidRequest.transactionId].sid = String(sid);
bannerImps[validBidRequest.adUnitCode].sid = String(sid);
}

const adUnitCode = validBidRequest.adUnitCode;
const divId = document.getElementById(adUnitCode) ? adUnitCode : getGptSlotInfoForAdUnitCode(adUnitCode).divId;
bannerImps[validBidRequest.transactionId].adUnitCode = adUnitCode;
bannerImps[validBidRequest.transactionId].divId = divId;
bannerImps[validBidRequest.adUnitCode].adUnitCode = adUnitCode;
bannerImps[validBidRequest.adUnitCode].divId = divId;

// Create IX imps from params.size
if (bannerSizeDefined) {
if (!bannerImps[validBidRequest.transactionId].hasOwnProperty('ixImps')) {
bannerImps[validBidRequest.transactionId].ixImps = [];
if (!bannerImps[validBidRequest.adUnitCode].hasOwnProperty('ixImps')) {
bannerImps[validBidRequest.adUnitCode].ixImps = [];
}
bannerImps[validBidRequest.transactionId].ixImps.push(imp);
bannerImps[validBidRequest.adUnitCode].ixImps.push(imp);
}

updateMissingSizes(validBidRequest, missingBannerSizes, imp);
Expand All @@ -1277,14 +1276,13 @@ function createBannerImps(validBidRequest, missingBannerSizes, bannerImps) {
* @param {object} imp The impression for the bidrequest
*/
function updateMissingSizes(validBidRequest, missingBannerSizes, imp) {
const transactionID = validBidRequest.transactionId;
if (missingBannerSizes.hasOwnProperty(transactionID)) {
if (missingBannerSizes.hasOwnProperty(validBidRequest.adUnitCode)) {
let currentSizeList = [];
if (missingBannerSizes[transactionID].hasOwnProperty('missingSizes')) {
currentSizeList = missingBannerSizes[transactionID].missingSizes;
if (missingBannerSizes[validBidRequest.adUnitCode].hasOwnProperty('missingSizes')) {
currentSizeList = missingBannerSizes[validBidRequest.adUnitCode].missingSizes;
}
removeFromSizes(currentSizeList, validBidRequest.params.size);
missingBannerSizes[transactionID].missingSizes = currentSizeList;
missingBannerSizes[validBidRequest.adUnitCode].missingSizes = currentSizeList;
} else {
// New Ad Unit
if (deepAccess(validBidRequest, 'mediaTypes.banner.sizes')) {
Expand All @@ -1294,7 +1292,7 @@ function updateMissingSizes(validBidRequest, missingBannerSizes, imp) {
'missingSizes': sizeList,
'impression': imp
};
missingBannerSizes[transactionID] = newAdUnitEntry;
missingBannerSizes[validBidRequest.adUnitCode] = newAdUnitEntry;
}
}
}
Expand Down Expand Up @@ -1612,23 +1610,23 @@ export const spec = {
});

// Step 2: Update banner impressions with missing sizes
for (let transactionId in missingBannerSizes) {
if (missingBannerSizes.hasOwnProperty(transactionId)) {
let missingSizes = missingBannerSizes[transactionId].missingSizes;
for (let adunitCode in missingBannerSizes) {
if (missingBannerSizes.hasOwnProperty(adunitCode)) {
let missingSizes = missingBannerSizes[adunitCode].missingSizes;

if (!bannerImps.hasOwnProperty(transactionId)) {
bannerImps[transactionId] = {};
if (!bannerImps.hasOwnProperty(adunitCode)) {
bannerImps[adunitCode] = {};
}
if (!bannerImps[transactionId].hasOwnProperty('missingImps')) {
bannerImps[transactionId].missingImps = [];
bannerImps[transactionId].missingCount = 0;
if (!bannerImps[adunitCode].hasOwnProperty('missingImps')) {
bannerImps[adunitCode].missingImps = [];
bannerImps[adunitCode].missingCount = 0;
}

let origImp = missingBannerSizes[transactionId].impression;
let origImp = missingBannerSizes[adunitCode].impression;
for (let i = 0; i < missingSizes.length; i++) {
let newImp = createMissingBannerImp(validBidRequests[0], origImp, missingSizes[i]);
bannerImps[transactionId].missingImps.push(newImp);
bannerImps[transactionId].missingCount++;
bannerImps[adunitCode].missingImps.push(newImp);
bannerImps[adunitCode].missingCount++;
}
}
}
Expand Down
6 changes: 4 additions & 2 deletions test/spec/modules/ixBidAdapter_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,11 +389,11 @@ describe('IndexexchangeAdapter', function () {
ext: {
tid: '173f49a8-7549-4218-a23c-e7ba59b47230',
data: {
pbadslot: 'div-gpt-ad-1460505748562-0'
pbadslot: 'div-gpt-ad-1460505748562-1'
}
}
},
adUnitCode: 'div-gpt-ad-1460505748562-0',
adUnitCode: 'div-gpt-ad-1460505748562-1',
transactionId: '273f49a8-7549-4218-a23c-e7ba59b47230',
bidId: '1a2b3c4e',
bidderRequestId: '11a22b33c44e',
Expand Down Expand Up @@ -2435,9 +2435,11 @@ describe('IndexexchangeAdapter', function () {
bid1.bidId = '2f6g5s5e';

const bid2 = utils.deepClone(bid1);
bid2.adUnitCode = 'div-gpt-2'
bid2.transactionId = 'tr2';
bid2.mediaTypes.banner.sizes = [[220, 221], [222, 223], [300, 250]];
const bid3 = utils.deepClone(bid1);
bid3.adUnitCode = 'div-gpt-3'
bid3.transactionId = 'tr3';
bid3.mediaTypes.banner.sizes = [[330, 331], [332, 333], [300, 250]];

Expand Down