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

Adding "Ad Position" dimension to the Schema #19

Merged
merged 3 commits into from
Apr 24, 2020
Merged

Adding "Ad Position" dimension to the Schema #19

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
becf5d1
tracking and publishing adposition info (in ad unit info)
suribabuox Apr 17, 2020
65e9a9b
Merge branch 'openx-adapter' of https://github.com/openx/Prebid.js in…
suribabuox Apr 17, 2020
5a7b762
Fixed edge cases for finding ad position using intersection area
suribabuox Apr 21, 2020
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
132 changes: 110 additions & 22 deletions modules/openxAnalyticsAdapter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,24 +272,23 @@ function removeads(info) {
}

function getAuctionIdByAdId(adId) {
let auctionId;
utils._map(eventStack, value => value).forEach(function(auctionInfo) {
let auctionId, adUnitCode;
utils._each(eventStack, function(auctionInfo) {
if (auctionInfo && auctionInfo.events) {
let bidWonEvent;
bidWonEvent = auctionInfo.events.filter(function(eventsInfo) {
return eventsInfo.eventType === 'bidWon';
});

if (bidWonEvent.length > 0) {
bidWonEvent.forEach(function(bidWon) {
if (bidWon.args && bidWon.args.adId && bidWon.args.adId === adId) {
auctionId = bidWon.args.auctionId;
auctionInfo.events.forEach(function(eventsInfo) {
if(eventsInfo.eventType === bidWonConst) {
if (eventsInfo.args && eventsInfo.args.adId && eventsInfo.args.adId === adId) {
auctionId = eventsInfo.args.auctionId;
adUnitCode = eventsInfo.args.adUnitCode;
}
});
}
}
});
}
});
return auctionId;
return {
auctionId: auctionId,
adUnitCode: adUnitCode
};
}

function getAllAdUnitCodesByAuctionId(auctionId) {
Expand Down Expand Up @@ -329,22 +328,31 @@ function onSlotLoaded({ slot }) {
const slotElementId = slot.getSlotElementId();
const adUnitPath = slot.getAdUnitPath();

let auctionId = getAuctionIdByAdId(adId);
if (!auctionId) {
auctionId = getAuctionIdByAdUnitCode(slotElementId);
// AdId will be present in `eventStack` only if winner is through prebid auction.
// Assuming either `adUnitPath` or `slotElementId` to be adUnitCode because there is no other way -
// to know for which ad unit the slot is rendered

let auctionId, adUnitCode;
let adUnitInfo = getAuctionIdByAdId(adId);
if(adUnitInfo && adUnitInfo.auctionId && adUnitInfo.adUnitCode) {
auctionId = adUnitInfo.auctionId;
adUnitCode = adUnitInfo.adUnitCode;
} else {
adUnitCode = slotElementId;
auctionId = getAuctionIdByAdUnitCode(adUnitCode);
if (!auctionId) {
adUnitCode = adUnitPath;
auctionId = getAuctionIdByAdUnitCode(adUnitPath);
}
}

let allSlotsLoaded = false;
if (auctionId) {
if (!loadedAdSlots[auctionId]) {
loadedAdSlots[auctionId] = []
}
loadedAdSlots[auctionId].push(slotElementId);
let adPosition = getAdPositionByElementId(slotElementId);
updateLoadedAdSlotsInfo(auctionId, adUnitCode, adPosition);
let loadedAdUnitCodes = getLoadedAdUnitCodes(auctionId);
let allAdUnitCodes = getAllAdUnitCodesByAuctionId(auctionId);
if (loadedAdSlots[auctionId].length === allAdUnitCodes.length) {
if (loadedAdUnitCodes.length === allAdUnitCodes.length) {
allSlotsLoaded = true;
}
}
Expand Down Expand Up @@ -601,6 +609,7 @@ function send(eventType, eventStack, auctionId) {
var sourceBrowser = detectBrowser();
var sourceOs = detectOS();
// utils.logInfo('OX: AuctionId', auctionId);
pushAdPositionData(auctionId);
var data = eventStack[auctionId];
var publisherPlatformId = eventStack[auctionId].options.publisherPlatformId;
var publisherAccountId = eventStack[auctionId].options.publisherAccountId;
Expand Down Expand Up @@ -655,6 +664,85 @@ function pushEvent(eventType, args, auctionId) {
}
}

function updateLoadedAdSlotsInfo(auctionId, adUnitCode, adPosition) {

if(auctionId && adUnitCode) {
if(!loadedAdSlots[auctionId]){
loadedAdSlots[auctionId] = {};
}
loadedAdSlots[auctionId][adUnitCode] = {};
if(adPosition) {
loadedAdSlots[auctionId][adUnitCode] = { adPosition: adPosition };
}
} else {
utils.logWarn("OX: Couldn't update loadedAdSlots information.");
}
}

function getLoadedAdUnitCodes(auctionId) {

return (!auctionId || !loadedAdSlots[auctionId] || typeof loadedAdSlots[auctionId] !== 'object')
? [] : Object.keys(loadedAdSlots[auctionId]);
}

function pushAdPositionData(auctionId) {

if(auctionId && eventStack[auctionId] && eventStack[auctionId].events) {

let adUnitPositionMap = loadedAdSlots[auctionId];
if(adUnitPositionMap && JSON.stringify(adUnitPositionMap) !== "{}") {

eventStack[auctionId].events.filter(function(event) {
return event.eventType === auctionEndConst;
}).forEach(function (auctionEndEvent) {

if(auctionEndEvent.args && auctionEndEvent.args.adUnits) {
auctionEndEvent.args.adUnits.forEach(function (adUnitInfo) {
if(adUnitPositionMap[adUnitInfo.code] && adUnitPositionMap[adUnitInfo.code]["adPosition"]) {
adUnitInfo["adPosition"] = adUnitPositionMap[adUnitInfo.code]["adPosition"];
} else {
adUnitInfo["adPosition"] = "";
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assigning the empty value if adPosition cannot be determined.

}
})
}
});
}
}
}

function getAdPositionByElementId(elementId) {

let elem = document.querySelector("#" + elementId);
let adPosition;
if (elem) {
let bounding = elem.getBoundingClientRect();
if (bounding) {
let windowWidth = (window.innerWidth || document.documentElement.clientWidth);
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tried doing using "DOMContentLoaded" event but the callback function is not getting called every time. So finding the window size on the fly every time.

let windowHeight = (window.innerHeight || document.documentElement.clientHeight);

// intersection coordinates
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Finding the coordinates of the overlapping area (intersection of window and ad slot) and calculating its area and then comparing it with the total ad slot area.

let left = Math.max(0, bounding.left);
let right = Math.min(windowWidth, bounding.right);
let bottom = Math.min(windowHeight, bounding.bottom);
let top = Math.max(0, bounding.top);

let intersectionWidth = right - left;
let intersectionHeight = bottom - top;

let intersectionArea = (intersectionHeight > 0 && intersectionWidth > 0) ? (intersectionHeight * intersectionWidth) : 0;
let adSlotArea = (bounding.right - bounding.left) * (bounding.bottom - bounding.top);

if(adSlotArea > 0) {
// Atleast 50% of intersection in window
adPosition = (intersectionArea * 2 >= adSlotArea) ? "ATF" : "BTF";
}
}
} else {
utils.logWarn("OX: DOM element not for id " + elementId);
}
return adPosition;
}

openxAdapter.reset = function() {
eventStack = {};
loadedAdSlots = {};
Expand Down