UOE-7256: PrebidServerBidAdapatar to support banner profiles

src_new/adapters/prebid.js

@@ -28,6 +28,7 @@ var refThis = this;
 var onEventAdded = false;
 var isPrebidPubMaticAnalyticsEnabled = CONFIG.isPrebidPubMaticAnalyticsEnabled();
 var isSingleImpressionSettingEnabled = CONFIG.isSingleImpressionSettingEnabled();
+var defaultAliases = CONSTANTS.DEFAULT_ALIASES;
 
 /* start-test-block */
 exports.isSingleImpressionSettingEnabled = isSingleImpressionSettingEnabled;
@@ -365,7 +366,9 @@ function generatedKeyCallbackForPbAnalytics(adapterID, adUnits, adapterConfig, i
 	var mediaTypeConfig;
 	var partnerConfig;
 
-	if(CONFIG.isServerSideAdapter(adapterID)){
+	//If we are using PubMaticServerBidAdapatar then serverSideEabled: do not add config into adUnits. 
+	//If we are using PrebidServerBidAdapatar then we need to add config into adUnits.
+	if(CONFIG.isServerSideAdapter(adapterID) && CONFIG.usePBSAdapter() != true){
 		util.log("Not calling adapter: "+ adapterID + ", for " + generatedKey +", as it is serverSideEnabled.");
 		return;
 	}
@@ -479,8 +482,9 @@ function generatedKeyCallback(adapterID, adUnits, adapterConfig, impressionID, g
 		}
 	}
 
-	//serverSideEabled: do not add config into adUnits
-	if(CONFIG.isServerSideAdapter(adapterID)){
+	//If we are using PubMaticServerBidAdapatar then serverSideEabled: do not add config into adUnits. 
+	//If we are using PrebidServerBidAdapatar then we need to add config into adUnits.
+	if(CONFIG.isServerSideAdapter(adapterID) && CONFIG.usePBSAdapter() != true){
 		util.log("Not calling adapter: "+ adapterID + ", for " + generatedKey +", as it is serverSideEnabled.");
 		return;
 	}
@@ -542,14 +546,15 @@ function pushAdapterParamsInAdunits(adapterID, generatedKey, impressionID, keyCo
 	var slotParams = {};
 	var mediaTypeConfig = adUnits[code].mediaTypes;
 	var sizes = adUnits[code].sizes;
+	var isWiidRequired = false; 
 	if(mediaTypeConfig && util.isOwnProperty(mediaTypeConfig,"video") && adapterID != "telaria"){
 		slotParams["video"]= mediaTypeConfig.video;
 	}
 	util.forEachOnObject(keyConfig, function(key, value){
 		/* istanbul ignore next */
 		slotParams[key] = value;
 	});
-
+	
 	if(isPrebidPubMaticAnalyticsEnabled){
 		slotParams["kgpv"] = generatedKey; // TODO : Update this in case of video, change the size to 0x0 
 		slotParams["regexPattern"] = regexPattern;
@@ -580,6 +585,12 @@ function pushAdapterParamsInAdunits(adapterID, generatedKey, impressionID, keyCo
 			slotParams["video"]= mediaTypeConfig.video;
 		}
 	}
+	// for pubmaticServer partner we used to pass wiid when isPrebidPubMaticAnalyticsEnabled is false but now we do not 
+	// get pubmaticServer partner when usePBSAdapter flag is true so we will be adding wiid conditionally.
+	if(isPrebidPubMaticAnalyticsEnabled === false && CONFIG.usePBSAdapter()){
+		slotParams["wiid"] = impressionID;
+		isWiidRequired = true;
+	}
 
 	var adapterName = CONFIG.getAdapterNameForAlias(adapterID) || adapterID;
 
@@ -616,6 +627,19 @@ function pushAdapterParamsInAdunits(adapterID, generatedKey, impressionID, keyCo
 			if((adapterID != "pubmatic2" && adapterName != "pubmatic2") && window.PWT.udpv){
 				slotParams["verId"] = CONFIG.getProfileDisplayVersionID();
 			}
+
+		// If we will be using PrebidServerBidAdaptar add wrapper object with profile and version
+		if(CONFIG.usePBSAdapter() == true && CONFIG.isServerSideAdapter(adapterID)) {
+			slotParams["wrapper"] = {
+				profile: parseInt(CONF.pwt.pid),
+				version: parseInt(CONF.pwt.pdvid)
+			};
+			// If mapping is regex then we should pass hashedKey to adSlot params earlier it was handled on s2s side.
+			if(slotParams["hashedKey"]) {
+				slotParams["adSlot"] = slotParams["hashedKey"];
+			}
+		}
+
 			// We are removing mimes because it merges with the existing adUnit mimes
 			// if(slotParams["video"] && slotParams["video"]["mimes"]){
 			// 	delete slotParams["video"]["mimes"];
@@ -630,6 +654,9 @@ function pushAdapterParamsInAdunits(adapterID, generatedKey, impressionID, keyCo
 					slotParams[key] = value;
 				});
 				slotParams["cf"] = size[0] + "x" + size[1];
+				if(isWiidRequired) {
+					slotParams["wiid"] = impressionID;
+				}
 				adUnits[ code ].bids.push({	bidder: adapterID, params: slotParams });
 			});
 			break;
@@ -643,6 +670,9 @@ function pushAdapterParamsInAdunits(adapterID, generatedKey, impressionID, keyCo
 				});
 				slotParams["width"] = size[0];
 				slotParams["height"] = size[1];
+				if(isWiidRequired) {
+					slotParams["wiid"] = impressionID;
+				}
 			if(!(refThis.isSingleImpressionSettingEnabled && isAdUnitsCodeContainBidder(adUnits, code, adapterID))){
 				adUnits[ code ].bids.push({	bidder: adapterID, params: slotParams });
 			}
@@ -657,6 +687,9 @@ function pushAdapterParamsInAdunits(adapterID, generatedKey, impressionID, keyCo
 					slotParams[key] = value;
 				});
 				slotParams["adSize"] = size[0] + "x" + size[1];
+				if(isWiidRequired) {
+					slotParams["wiid"] = impressionID;
+				}
 			if(!(refThis.isSingleImpressionSettingEnabled && isAdUnitsCodeContainBidder(adUnits, code, adapterID))){
 				adUnits[ code ].bids.push({	bidder: adapterID, params: slotParams });
 			}
@@ -681,6 +714,9 @@ function pushAdapterParamsInAdunits(adapterID, generatedKey, impressionID, keyCo
 				sltParams["id"] = keyConfig["id"];
 				}
 			sltParams["size"] = size;
+			if(isWiidRequired) {
+				sltParams["wiid"] = impressionID;
+			}
 			adUnits [code].bids.push({bidder: adapterID, params: sltParams});
 			});
 			break;
@@ -862,15 +898,23 @@ function generateAdUnitsArray(activeSlots, impressionID){
 		/* istanbul ignore else */
 		if(adapterID !== refThis.parentAdapterID){
 
-			//serverSideEabled: we do not want to throttle them at client-side
+			// If we will be using PrebidServerBidAdapatar then we need to check throttling for 
+			// serverEnabled partners at client-side
 			/* istanbul ignore if */
-			if(CONFIG.isServerSideAdapter(adapterID) || refThis.throttleAdapter(randomNumberBelow100, adapterID) == false){
-				util.forEachOnObject(activeSlots, function(j, slot){
-					bidManager.setCallInitTime(slot.getDivID(), adapterID);
-				});
-				refThis.generatePbConf(adapterID, adapterConfig, activeSlots, adUnits, impressionID);
-			}else{
-				util.log(adapterID+CONSTANTS.MESSAGES.M2);
+			if(CONFIG.usePBSAdapter() == true&& CONFIG.isServerSideAdapter(adapterID)) {
+				if(refThis.throttleAdapter(randomNumberBelow100, adapterID) == false) {
+					refThis.generateConfig(adapterID, adapterConfig, activeSlots, adUnits, impressionID);
+				} else {
+					util.log(adapterID+CONSTANTS.MESSAGES.M2);
+				}
+			} else {
+				// serverSideEabled: we do not want to throttle them at client-side
+				/* istanbul ignore if */
+				if(CONFIG.isServerSideAdapter(adapterID) || refThis.throttleAdapter(randomNumberBelow100, adapterID) == false){
+					refThis.generateConfig(adapterID, adapterConfig, activeSlots, adUnits, impressionID);
+				}else{
+					util.log(adapterID+CONSTANTS.MESSAGES.M2);
+				}
 			}
 		}
 	});
@@ -889,6 +933,14 @@ function generateAdUnitsArray(activeSlots, impressionID){
 
 exports.generateAdUnitsArray = generateAdUnitsArray;
 
+function generateConfig(adapterID, adapterConfig, activeSlots, adUnits, impressionID) {
+	util.forEachOnObject(activeSlots, function(j, slot){
+		bidManager.setCallInitTime(slot.getDivID(), adapterID);
+	});
+	refThis.generatePbConf(adapterID, adapterConfig, activeSlots, adUnits, impressionID);
+}
+exports.generateConfig = generateConfig;
+
 // removeIf(removeLegacyAnalyticsRelatedCode)
 function addOnBidResponseHandler(){
 	if(util.isFunction(window[pbNameSpace].onEvent)){
@@ -950,6 +1002,10 @@ function setPrebidConfig(){
 		refThis.assignCurrencyConfigIfRequired(prebidConfig);
 		refThis.assignSchainConfigIfRequired(prebidConfig);
 		refThis.assignSingleRequestConfigForBidders(prebidConfig);
+		// if usePBSAdapter is 1 then add s2sConfig
+		if(CONFIG.usePBSAdapter()) {
+			refThis.gets2sConfig(prebidConfig);
+		}
 		// Check for yahoossp bidder and add property {mode: 'all'} to setConfig
 		refThis.checkForYahooSSPBidder(prebidConfig);
 		// Adding a hook for publishers to modify the Prebid Config we have generated
@@ -964,6 +1020,43 @@ function setPrebidConfig(){
 
 exports.setPrebidConfig = setPrebidConfig;
 
+function gets2sConfig(prebidConfig){
+	var bidderParams = {};
+	var s2sBidders = CONFIG.getServerEnabledAdaptars();
+	for(var key in CONF.alias) {
+		defaultAliases[key] = CONF.alias[key];
+	}
+	var pubmaticAndAliases = CONFIG.getPubMaticAndAlias(s2sBidders);
+	if(pubmaticAndAliases.length) {
+		pubmaticAndAliases.forEach(function(bidder) {
+			bidderParams[bidder] = {};
+		})
+	}
+
+	prebidConfig["s2sConfig"] = {
+		accountId: CONFIG.getPublisherId(),
+		adapter: CONSTANTS.PBSPARAMS.adapter,
+		enabled: true,
+		bidders: s2sBidders,
+		endpoint: CONSTANTS.PBSPARAMS.endpoint,
+		syncEndpoint: CONSTANTS.PBSPARAMS.syncEndpoint,
+		timeout: CONFIG.getTimeoutForPBSRequest(),
+		secure: 1,// request needs secure assets pass 1
+		extPrebid: {
+			aliases: defaultAliases,
+			bidderparams: bidderParams,
+			targeting: {
+				pricegranularity: CONFIG.getPriceGranularity()
+			},
+			isPrebidPubMaticAnalyticsEnabled: CONFIG.isPrebidPubMaticAnalyticsEnabled(),
+			isUsePrebidKeysEnabled: CONFIG.isUsePrebidKeysEnabled(),
+			macros: CONFIG.createMacros()
+		}	
+	}
+}
+
+exports.gets2sConfig = gets2sConfig;
+
 function getFloorsConfiguration(prebidConfig){
 	if(CONFIG.isFloorPriceModuleEnabled() == true){
 		prebidConfig["floors"]={

src_new/bid.js

@@ -329,7 +329,10 @@ Bid.prototype.setMi = function(mi){
 // endRemoveIf(removeLegacyAnalyticsRelatedCode)
 
 // removeIf(removeLegacyAnalyticsRelatedCode)
-Bid.prototype.getMi = function(){
+Bid.prototype.getMi = function(partnerName){
+	if(UTIL.isUndefined(this.mi)) {
+		this.mi = window.matchedimpressions && window.matchedimpressions[partnerName];
+	}
 	return this.mi;
 };
 // endRemoveIf(removeLegacyAnalyticsRelatedCode)

src_new/bidManager.js

@@ -520,10 +520,12 @@ function getAdDomain(bidResponse) {
 
 // removeIf(removeLegacyAnalyticsRelatedCode)
 function analyticalPixelCallback(slotID, bmEntry, impressionIDMap) { // TDD, i/o : done
+	var usePBSAdapter = CONFIG.usePBSAdapter();
 	var startTime = bmEntry.getCreationTime() || 0;
-	var pslTime = undefined;
+	var pslTime = (usePBSAdapter && window.pbsLatency) ? 0 : undefined;
 	var impressionID = bmEntry.getImpressionID();
 	var adUnitInfo = refThis.getAdUnitInfo(slotID);
+	var latencyValue = {};
 	const isAnalytics = true; // this flag is required to get grossCpm and netCpm in dollars instead of adserver currency
 	/* istanbul ignore else */
 	if (bmEntry.getAnalyticEnabledStatus() && !bmEntry.getExpiredStatus()) {
@@ -545,6 +547,24 @@ function analyticalPixelCallback(slotID, bmEntry, impressionIDMap) { // TDD, i/o
             }
 
 			util.forEachOnObject(adapterEntry.bids, function(bidID, theBid) {
+				if(usePBSAdapter) {
+					// In PrebidServerBidAdapater we are capturing start and end time of request
+					// fetching these values here to calculate psl time for logger call
+					latencyValue = window.pbsLatency && window.pbsLatency[impressionID];
+					if(latencyValue && latencyValue['endTime'] && latencyValue['startTime']) {
+						pslTime = latencyValue['endTime'] - latencyValue['startTime'];
+					}
+					// When we use PrebidServerBidAdapter we do not get seatbid for zero bid / no bid partners 
+					// as we need to log PubMatic partner in logger will be changing db = 0. 
+					if((adapterID === "pubmatic" || adapterID === "pubmatic2") && (util.isOwnProperty(window.partnersWithoutErrorAndBids, impressionID) && window.partnersWithoutErrorAndBids[impressionID].includes(adapterID))) {
+						theBid.defaultBid = 0;
+					} else if(util.isOwnProperty(window.partnersWithoutErrorAndBids, impressionID) &&
+							window.partnersWithoutErrorAndBids[impressionID].includes(adapterID) &&
+							CONFIG.getAdapterNameForAlias(adapterID).includes('pubmatic')) {
+						theBid.defaultBid = 0;		
+					}
+				}
+
 				var endTime = theBid.getReceivedTime();
 				if (adapterID === "pubmaticServer") {
 					if ((util.isOwnProperty(window.PWT.owLatency, impressionID)) &&
@@ -612,7 +632,7 @@ function analyticalPixelCallback(slotID, bmEntry, impressionIDMap) { // TDD, i/o
 					"ss": theBid.getServerSideStatus(),
                     "t": theBid.getPostTimeoutStatus() === false ? 0 : 1,
                     "wb": theBid.getWinningBidStatus() === true ? 1 : 0,
-					"mi": theBid.getServerSideStatus() ? theBid.getMi() : undefined,
+					"mi": theBid.getServerSideStatus() ? theBid.getMi(adapterID) : undefined,
 					"af": theBid.getAdFormat(),
 					"ocpm": CONFIG.getAdServerCurrency() ? theBid.getOriginalCpm() : theBid.getGrossEcpm(),
 					"ocry": CONFIG.getAdServerCurrency() ? theBid.getOriginalCurrency() : CONSTANTS.COMMON.ANALYTICS_CURRENCY,
@@ -623,6 +643,11 @@ function analyticalPixelCallback(slotID, bmEntry, impressionIDMap) { // TDD, i/o
         });
 
         impressionIDMap[impressionID].push(slotObject);
+		// special handling when all media types are disabled for adunit and
+		// if we are using PrebidServerBidAdapter with 
+		if(usePBSAdapter && CONFIG.getServerEnabledAdaptars().length && pslTime == undefined && !window.pbsLatency) {
+			pslTime = 0;
+		}
 		if (pslTime !== undefined) {
 			impressionIDMap[impressionID].psl = pslTime;
 		}

src_new/config.js

@@ -394,4 +394,49 @@ exports.getAdapterNameForAlias = function(aliasName){
 
 exports.isSSOEnabled = function() {
 	return parseInt(config[CONSTANTS.CONFIG.COMMON][CONSTANTS.CONFIG.SSO_ENABLED]) === 1;
+}
+
+exports.getServerEnabledAdaptars = function() {
+	var s2sBidders = Object.keys(config.adapters).filter(function(adapter){
+		if(config.adapters[adapter]["serverSideEnabled"] == "1") {
+			return adapter;
+		}
+	});	
+	return s2sBidders;
+}
+
+exports.getTimeoutForPBSRequest = function() {
+	var ssTimeOut = parseInt(config.pwt.ssTimeout);
+	var maxTimeout = CONSTANTS.TIMEOUT_CONFIG.MaxTimeout;
+	var minTimeout = CONSTANTS.TIMEOUT_CONFIG.MinTimeout;
+	if(ssTimeOut >= minTimeout && ssTimeOut <= maxTimeout) {
+		return ssTimeOut;
+	} else if(ssTimeOut >= minTimeout) {
+		return maxTimeout;
+	}
+	return minTimeout;
+}
+
+exports.getPubMaticAndAlias = function(s2sBidders) {
+	var pubMaticaliases = s2sBidders.filter(function(adapter) {
+		if(config.alias && config.alias[adapter] && config.alias[adapter].includes("pubmatic") || adapter.includes("pubmatic")) {
+			return adapter;
+		}
+	});
+	return pubMaticaliases;
+}
+
+exports.usePBSAdapter = function() {
+	if(config.pwt.usePBSAdapter == "1") {
+		return true;
+	}
+	return false;
+}
+
+exports.createMacros = function() {
+	return {
+		"[PLATFORM]": util.getDevicePlatform().toString(),
+		"[PROFILE_ID]": refThis.getProfileID().toString(),
+		"[PROFILE_VERSION]": refThis.getProfileDisplayVersionID().toString()
+	}
 }

src_new/constants.js

@@ -289,4 +289,21 @@ exports.BID_STATUS =  {
 // Add list of PubMatic aliases here.
 exports.PUBMATIC_ALIASES = ["pubmatic2"];
 
-exports.YAHOOSSP = "yahoossp";
+exports.PBSPARAMS = {
+	adapter: "prebidServer",
+	endpoint: "https://ow.pubmatic.com/pbs/openrtb2/auction",
+	syncEndpoint: "https://ow.pubmatic.com/cookie_sync/?sec=1"
+}
+
+exports.TIMEOUT_CONFIG = {
+	MaxTimeout: 500,
+	MinTimeout: 200
+}
+
+exports.DEFAULT_ALIASES = {
+	adg: "adgeneration",
+	districtm: "appnexus",
+	districtmDMX: "dmx",
+	pubmatic2: "pubmatic"
+}
+exports.YAHOOSSP = "yahoossp";