prebid.js 6.1.0 → 6.5.0

package/modules/adkernelBidAdapter.js

@@ -1,6 +1,6 @@
 import {
   isStr, isArray, isPlainObject, deepSetValue, isNumber, deepAccess, getAdUnitSizes, parseGPTSingleSizeArrayToRtbSize,
-  cleanObj, contains, getDNT, parseUrl, createTrackPixelHtml, _each, isArrayOfNums
+  cleanObj, contains, getDNT, parseUrl, createTrackPixelHtml, _each, isArrayOfNums, mergeDeep, isEmpty, inIframe
 } from '../src/utils.js';
 import {BANNER, NATIVE, VIDEO} from '../src/mediaTypes.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
@@ -103,17 +103,16 @@ export const spec = {
    * @returns {ServerRequest[]}
    */
   buildRequests: function (bidRequests, bidderRequest) {
-    let impDispatch = dispatchImps(bidRequests, bidderRequest.refererInfo);
+    let impGroups = groupImpressionsByHostZone(bidRequests, bidderRequest.refererInfo);
     let requests = [];
     let schain = bidRequests[0].schain;
-    Object.keys(impDispatch).forEach(host => {
-      Object.keys(impDispatch[host]).forEach(zoneId => {
-        const request = buildRtbRequest(impDispatch[host][zoneId], bidderRequest, schain);
-        requests.push({
-          method: 'POST',
-          url: `https://${host}/hb?zone=${zoneId}&v=${VERSION}`,
-          data: JSON.stringify(request)
-        });
+    _each(impGroups, impGroup => {
+      let {host, zoneId, imps} = impGroup;
+      const request = buildRtbRequest(imps, bidderRequest, schain);
+      requests.push({
+        method: 'POST',
+        url: `https://${host}/hb?zone=${zoneId}&v=${VERSION}`,
+        data: JSON.stringify(request)
       });
     });
     return requests;
@@ -209,17 +208,19 @@ registerBidder(spec);
  * @param bidRequests {BidRequest[]}
  * @param refererInfo {refererInfo}
  */
-function dispatchImps(bidRequests, refererInfo) {
+function groupImpressionsByHostZone(bidRequests, refererInfo) {
   let secure = (refererInfo && refererInfo.referer.indexOf('https:') === 0);
-  return bidRequests.map(bidRequest => buildImp(bidRequest, secure))
-    .reduce((acc, curr, index) => {
-      let bidRequest = bidRequests[index];
-      let {zoneId, host} = bidRequest.params;
-      acc[host] = acc[host] || {};
-      acc[host][zoneId] = acc[host][zoneId] || [];
-      acc[host][zoneId].push(curr);
-      return acc;
-    }, {});
+  return Object.values(
+    bidRequests.map(bidRequest => buildImp(bidRequest, secure))
+      .reduce((acc, curr, index) => {
+        let bidRequest = bidRequests[index];
+        let {zoneId, host} = bidRequest.params;
+        let key = `${host}_${zoneId}`;
+        acc[key] = acc[key] || {host: host, zoneId: zoneId, imps: []};
+        acc[key].imps.push(curr);
+        return acc;
+      }, {})
+  );
 }
 
 function getBidFloor(bid, mediaType, sizes) {
@@ -365,57 +366,142 @@ function getAllowedSyncMethod(bidderCode) {
 }
 
 /**
- * Builds complete rtb request
- * @param imps {Object} Collection of rtb impressions
- * @param bidderRequest {BidderRequest}
- * @param schain {Object=} Supply chain config
- * @return {Object} Complete rtb request
+ * Create device object from fpd and host-collected data
+ * @param fpd {Object}
+ * @returns {{device: Object}}
  */
-function buildRtbRequest(imps, bidderRequest, schain) {
-  let {bidderCode, gdprConsent, auctionId, refererInfo, timeout, uspConsent} = bidderRequest;
-  let coppa = config.getConfig('coppa');
-  let req = {
-    'id': auctionId,
-    'imp': imps,
-    'site': createSite(refererInfo),
-    'at': 1,
-    'device': {
-      'ip': 'caller',
-      'ipv6': 'caller',
-      'ua': 'caller',
-      'js': 1,
-      'language': getLanguage()
-    },
-    'tmax': parseInt(timeout)
-  };
+function makeDevice(fpd) {
+  let device = mergeDeep({
+    'ip': 'caller',
+    'ipv6': 'caller',
+    'ua': 'caller',
+    'js': 1,
+    'language': getLanguage()
+  }, fpd.device || {});
   if (getDNT()) {
-    req.device.dnt = 1;
+    device.dnt = 1;
+  }
+  return {device: device};
+}
+
+/**
+ * Create site or app description object
+ * @param bidderRequest {BidderRequest}
+ * @param fpd {Object}
+ * @returns {{site: Object}|{app: Object}}
+ */
+function makeSiteOrApp(bidderRequest, fpd) {
+  let {refererInfo} = bidderRequest;
+  let appConfig = config.getConfig('app');
+  if (isEmpty(appConfig)) {
+    return {site: createSite(refererInfo, fpd)}
+  } else {
+    return {app: appConfig};
   }
+}
+
+/**
+ * Create user description object
+ * @param bidderRequest {BidderRequest}
+ * @param fpd {Object}
+ * @returns {{user: Object} | undefined}
+ */
+function makeUser(bidderRequest, fpd) {
+  let {gdprConsent} = bidderRequest;
+  let user = fpd.user || {};
+  if (gdprConsent && gdprConsent.consentString !== undefined) {
+    deepSetValue(user, 'ext.consent', gdprConsent.consentString);
+  }
+  let eids = getExtendedUserIds(bidderRequest);
+  if (eids) {
+    deepSetValue(user, 'ext.eids', eids);
+  }
+  if (!isEmpty(user)) { return {user: user}; }
+}
+
+/**
+ * Create privacy regulations object
+ * @param bidderRequest {BidderRequest}
+ * @returns {{regs: Object} | undefined}
+ */
+function makeRegulations(bidderRequest) {
+  let {gdprConsent, uspConsent} = bidderRequest;
+  let regs = {};
   if (gdprConsent) {
     if (gdprConsent.gdprApplies !== undefined) {
-      deepSetValue(req, 'regs.ext.gdpr', ~~gdprConsent.gdprApplies);
-    }
-    if (gdprConsent.consentString !== undefined) {
-      deepSetValue(req, 'user.ext.consent', gdprConsent.consentString);
+      deepSetValue(regs, 'regs.ext.gdpr', ~~gdprConsent.gdprApplies);
     }
   }
   if (uspConsent) {
-    deepSetValue(req, 'regs.ext.us_privacy', uspConsent);
+    deepSetValue(regs, 'regs.ext.us_privacy', uspConsent);
+  }
+  if (config.getConfig('coppa')) {
+    deepSetValue(regs, 'regs.coppa', 1);
   }
-  if (coppa) {
-    deepSetValue(req, 'regs.coppa', 1);
+  if (!isEmpty(regs)) {
+    return regs;
   }
+}
+
+/**
+ * Create top-level request object
+ * @param bidderRequest {BidderRequest}
+ * @param imps {Object} Impressions
+ * @param fpd {Object} First party data
+ * @returns
+ */
+function makeBaseRequest(bidderRequest, imps, fpd) {
+  let {auctionId, timeout} = bidderRequest;
+  let request = {
+    'id': auctionId,
+    'imp': imps,
+    'at': 1,
+    'tmax': parseInt(timeout)
+  };
+  if (!isEmpty(fpd.bcat)) {
+    request.bcat = fpd.bcat;
+  }
+  if (!isEmpty(fpd.badv)) {
+    request.badv = fpd.badv;
+  }
+  return request;
+}
+
+/**
+ * Initialize sync capabilities
+ * @param bidderRequest {BidderRequest}
+ */
+function makeSyncInfo(bidderRequest) {
+  let {bidderCode} = bidderRequest;
   let syncMethod = getAllowedSyncMethod(bidderCode);
   if (syncMethod) {
-    deepSetValue(req, 'ext.adk_usersync', syncMethod);
+    let res = {};
+    deepSetValue(res, 'ext.adk_usersync', syncMethod);
+    return res;
   }
+}
+
+/**
+ * Builds complete rtb request
+ * @param imps {Object} Collection of rtb impressions
+ * @param bidderRequest {BidderRequest}
+ * @param schain {Object=} Supply chain config
+ * @return {Object} Complete rtb request
+ */
+function buildRtbRequest(imps, bidderRequest, schain) {
+  let fpd = config.getConfig('ortb2') || {};
+
+  let req = mergeDeep(
+    makeBaseRequest(bidderRequest, imps, fpd),
+    makeDevice(fpd),
+    makeSiteOrApp(bidderRequest, fpd),
+    makeUser(bidderRequest, fpd),
+    makeRegulations(bidderRequest),
+    makeSyncInfo(bidderRequest)
+  );
   if (schain) {
     deepSetValue(req, 'source.ext.schain', schain);
   }
-  let eids = getExtendedUserIds(bidderRequest);
-  if (eids) {
-    deepSetValue(req, 'user.ext.eids', eids);
-  }
   return req;
 }
 
@@ -431,18 +517,17 @@ function getLanguage() {
 /**
  * Creates site description object
  */
-function createSite(refInfo) {
+function createSite(refInfo, fpd) {
   let url = parseUrl(refInfo.referer);
   let site = {
     'domain': url.hostname,
     'page': `${url.protocol}://${url.hostname}${url.pathname}`
   };
-  if (self === top && document.referrer) {
+  mergeDeep(site, fpd.site);
+  if (!inIframe() && document.referrer) {
     site.ref = document.referrer;
-  }
-  let keywords = document.getElementsByTagName('meta')['keywords'];
-  if (keywords && keywords.content) {
-    site.keywords = keywords.content;
+  } else {
+    delete site.ref;
   }
   return site;
 }

package/modules/adlooxAdServerVideo.js

@@ -9,7 +9,7 @@
 import { registerVideoSupport } from '../src/adServerManager.js';
 import { command as analyticsCommand, COMMAND } from './adlooxAnalyticsAdapter.js';
 import { ajax } from '../src/ajax.js';
-import { EVENTS } from '../src/constants.json';
+import CONSTANTS from '../src/constants.json';
 import { targeting } from '../src/targeting.js';
 import { logInfo, isFn, logError, isPlainObject, isStr, isBoolean, deepSetValue, deepClone, timestamp, logWarn } from '../src/utils.js';
 
@@ -74,7 +74,7 @@ function track(options, callback) {
   bid.ext.adloox.video.adserver = false;
 
   analyticsCommand(COMMAND.TRACK, {
-    eventType: EVENTS.BID_WON,
+    eventType: CONSTANTS.EVENTS.BID_WON,
     args: bid
   });
 }

package/modules/adlooxAnalyticsAdapter.js

@@ -9,7 +9,7 @@ import adapter from '../src/AnalyticsAdapter.js';
 import { loadExternalScript } from '../src/adloader.js';
 import { auctionManager } from '../src/auctionManager.js';
 import { AUCTION_COMPLETED } from '../src/auction.js';
-import { EVENTS } from '../src/constants.json';
+import CONSTANTS from '../src/constants.json';
 import find from 'core-js-pure/features/array/find.js';
 import {
   deepAccess, logInfo, isPlainObject, logError, isStr, isNumber, getGptSlotInfoForAdUnitCode,
@@ -199,9 +199,9 @@ analyticsAdapter.url = function(url, args, bid) {
   return url + a2qs(args);
 }
 
-analyticsAdapter[`handle_${EVENTS.AUCTION_END}`] = function(auctionDetails) {
+analyticsAdapter[`handle_${CONSTANTS.EVENTS.AUCTION_END}`] = function(auctionDetails) {
   if (!(auctionDetails.auctionStatus == AUCTION_COMPLETED && auctionDetails.bidsReceived.length > 0)) return;
-  analyticsAdapter[`handle_${EVENTS.AUCTION_END}`] = NOOP;
+  analyticsAdapter[`handle_${CONSTANTS.EVENTS.AUCTION_END}`] = NOOP;
 
   logMessage(MODULE, 'preloading verification JS');
 
@@ -214,7 +214,7 @@ analyticsAdapter[`handle_${EVENTS.AUCTION_END}`] = function(auctionDetails) {
   insertElement(link);
 }
 
-analyticsAdapter[`handle_${EVENTS.BID_WON}`] = function(bid) {
+analyticsAdapter[`handle_${CONSTANTS.EVENTS.BID_WON}`] = function(bid) {
   if (deepAccess(bid, 'ext.adloox.video.adserver')) {
     logMessage(MODULE, `measuring '${bid.mediaType}' ad unit code '${bid.adUnitCode}' via Ad Server module`);
     return;

package/modules/admanBidAdapter.js

@@ -108,6 +108,7 @@ export const spec = {
       }
       if (bid.userId) {
         getUserId(placement.eids, bid.userId.uid2 && bid.userId.uid2.id, 'uidapi.com');
+        getUserId(placement.eids, bid.userId.lotamePanoramaId, 'lotame.com');
       }
       if (traff === VIDEO) {
         placement.playerSize = bid.mediaTypes[VIDEO].playerSize;

package/modules/admixerBidAdapter.js

@@ -1,14 +1,15 @@
 import { logError } from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {config} from '../src/config.js';
+import {BANNER, VIDEO, NATIVE} from '../src/mediaTypes.js';
 
 const BIDDER_CODE = 'admixer';
-const ALIASES = ['go2net', 'adblender', 'adsyield'];
+const ALIASES = ['go2net', 'adblender', 'adsyield', 'futureads'];
 const ENDPOINT_URL = 'https://inv-nets.admixer.net/prebid.1.2.aspx';
 export const spec = {
   code: BIDDER_CODE,
   aliases: ALIASES,
-  supportedMediaTypes: ['banner', 'video'],
+  supportedMediaTypes: [BANNER, VIDEO, NATIVE],
   /**
    * Determines whether or not the given bid request is valid.
    */

package/modules/adnuntiusBidAdapter.js

@@ -37,7 +37,8 @@ const handleMeta = function () {
 }
 
 const getUsi = function (meta, ortb2, bidderRequest) {
-  const usi = (meta !== null) ? meta.usi : false;
+  let usi = (meta !== null && meta.usi) ? meta.usi : false;
+  if (ortb2 && ortb2.user && ortb2.user.id) { usi = ortb2.user.id }
   return usi
 }
 
@@ -55,6 +56,8 @@ export const spec = {
     const requests = [];
     const request = [];
     const ortb2 = config.getConfig('ortb2');
+    const bidderConfig = config.getConfig();
+
     const adnMeta = handleMeta()
     const usi = getUsi(adnMeta, ortb2, bidderRequest)
     const segments = getSegmentsFromOrtb(ortb2);
@@ -67,7 +70,7 @@ export const spec = {
     if (gdprApplies !== undefined) request.push('consentString=' + consentString);
     if (segments.length > 0) request.push('segments=' + segments.join(','));
     if (usi) request.push('userId=' + usi);
-
+    if (bidderConfig.useCookie === false) request.push('noCookies=true')
     for (var i = 0; i < validBidRequests.length; i++) {
       const bid = validBidRequests[i]
       const network = bid.params.network || 'network';

package/modules/adomikAnalyticsAdapter.js

@@ -76,6 +76,8 @@ adomikAdapter.sendTypedEvent = function() {
   const groupedTypedEvents = adomikAdapter.buildTypedEvents();
 
   const bulkEvents = {
+    testId: adomikAdapter.currentContext.testId,
+    testValue: adomikAdapter.currentContext.testValue,
     uid: adomikAdapter.currentContext.uid,
     ahbaid: adomikAdapter.currentContext.id,
     hostname: window.location.hostname,
@@ -126,6 +128,8 @@ adomikAdapter.sendTypedEvent = function() {
 };
 
 adomikAdapter.sendWonEvent = function (wonEvent) {
+  let keyValues = { testId: adomikAdapter.currentContext.testId, testValue: adomikAdapter.currentContext.testValue }
+  wonEvent = {...wonEvent, ...keyValues}
   const stringWonEvent = JSON.stringify(wonEvent)
   logInfo('Won event sent to adomik prebid analytic ' + stringWonEvent);
 
@@ -205,6 +209,8 @@ adomikAdapter.enableAnalytics = function (config) {
     adomikAdapter.currentContext = {
       uid: initOptions.id,
       url: initOptions.url,
+      testId: initOptions.testId,
+      testValue: initOptions.testValue,
       id: '',
       timeouted: false,
     }

package/modules/adplusBidAdapter.js

@@ -0,0 +1,203 @@
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import * as utils from '../src/utils.js';
+import { BANNER } from '../src/mediaTypes.js';
+import { getStorageManager } from '../src/storageManager.js';
+
+// #region Constants
+export const BIDDER_CODE = 'adplus';
+export const ADPLUS_ENDPOINT = 'https://ssp.ad-plus.com.tr/server/headerBidding';
+export const DGID_CODE = 'adplus_dg_id';
+export const SESSION_CODE = 'adplus_s_id';
+export const storage = getStorageManager(undefined, BIDDER_CODE);
+const COOKIE_EXP = 1000 * 60 * 60 * 24; // 1 day
+// #endregion
+
+// #region Helpers
+export function isValidUuid (uuid) {
+  return /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.test(
+    uuid
+  );
+}
+
+function getSessionId() {
+  let sid = storage.cookiesAreEnabled() && storage.getCookie(SESSION_CODE);
+
+  if (
+    !sid || !isValidUuid(sid)
+  ) {
+    sid = utils.generateUUID();
+    setSessionId(sid);
+  }
+
+  return sid;
+}
+
+function setSessionId(sid) {
+  if (storage.cookiesAreEnabled()) {
+    const expires = new Date(Date.now() + COOKIE_EXP).toISOString();
+
+    storage.setCookie(SESSION_CODE, sid, expires);
+  }
+}
+// #endregion
+
+// #region Bid request validation
+function isBidRequestValid(bid) {
+  if (!bid) {
+    utils.logError(BIDDER_CODE, 'bid, can not be empty', bid);
+    return false;
+  }
+
+  if (!bid.params) {
+    utils.logError(BIDDER_CODE, 'bid.params is required.');
+    return false;
+  }
+
+  if (!bid.params.adUnitId || typeof bid.params.adUnitId !== 'string') {
+    utils.logError(
+      BIDDER_CODE,
+      'bid.params.adUnitId is missing or has wrong type.'
+    );
+    return false;
+  }
+
+  if (!bid.params.inventoryId || typeof bid.params.inventoryId !== 'string') {
+    utils.logError(
+      BIDDER_CODE,
+      'bid.params.inventoryId is missing or has wrong type.'
+    );
+    return false;
+  }
+
+  if (
+    !bid.mediaTypes ||
+    !bid.mediaTypes[BANNER] ||
+    !utils.isArray(bid.mediaTypes[BANNER].sizes) ||
+    bid.mediaTypes[BANNER].sizes.length <= 0 ||
+    !utils.isArrayOfNums(bid.mediaTypes[BANNER].sizes[0])
+  ) {
+    utils.logError(BIDDER_CODE, 'Wrong or missing size parameters.');
+    return false;
+  }
+
+  return true;
+}
+// #endregion
+
+// #region Building the bid requests
+/**
+ *
+ * @param {object} bid
+ * @returns
+ */
+function createBidRequest(bid) {
+  // Developer Params
+  const {
+    inventoryId,
+    adUnitId,
+    extraData,
+    yearOfBirth,
+    gender,
+    categories,
+    latitude,
+    longitude,
+    sdkVersion,
+  } = bid.params;
+
+  return {
+    method: 'GET',
+    url: ADPLUS_ENDPOINT,
+    data: utils.cleanObj({
+      bidId: bid.bidId,
+      inventoryId,
+      adUnitId,
+      adUnitWidth: bid.mediaTypes[BANNER].sizes[0][0],
+      adUnitHeight: bid.mediaTypes[BANNER].sizes[0][1],
+      extraData,
+      yearOfBirth,
+      gender,
+      categories,
+      latitude,
+      longitude,
+      sdkVersion: sdkVersion || '1',
+      session: getSessionId(),
+      interstitial: 0,
+      token: typeof window.top === 'object' && window.top[DGID_CODE] ? window.top[DGID_CODE] : undefined,
+      secure: window.location.protocol === 'https:' ? 1 : 0,
+      screenWidth: screen.width,
+      screenHeight: screen.height,
+      language: window.navigator.language || 'en-US',
+      pageUrl: window.location.href,
+      domain: window.location.hostname,
+      referrer: window.location.referrer,
+    }),
+  };
+}
+
+function buildRequests(validBidRequests, bidderRequest) {
+  return validBidRequests.map((req) => createBidRequest(req));
+}
+// #endregion
+
+// #region Interpreting Responses
+/**
+ *
+ * @param {HeaderBiddingResponse} responseData
+ * @param { object } bidParams
+ * @returns
+ */
+function createAdResponse(responseData, bidParams) {
+  return {
+    requestId: responseData.requestID,
+    cpm: responseData.cpm,
+    currency: responseData.currency,
+    width: responseData.width,
+    height: responseData.height,
+    creativeId: responseData.creativeID,
+    dealId: responseData.dealID,
+    netRevenue: responseData.netRevenue,
+    ttl: responseData.ttl,
+    ad: responseData.ad,
+    mediaType: responseData.mediaType,
+    meta: {
+      advertiserDomains: responseData.advertiserDomains,
+      primaryCatId: utils.isArray(responseData.categoryIDs) && responseData.categoryIDs.length > 0
+        ? responseData.categoryIDs[0] : undefined,
+      secondaryCatIds: responseData.categoryIDs,
+    },
+  };
+}
+
+function interpretResponse(response, request) {
+  // In case of empty response
+  if (
+    response.body == null ||
+    !utils.isArray(response.body) ||
+    response.body.length === 0
+  ) {
+    return [];
+  }
+  const bids = response.body.map((bid) => createAdResponse(bid));
+  return bids;
+}
+// #endregion
+
+// #region Bidder
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER],
+  isBidRequestValid,
+  buildRequests,
+  interpretResponse,
+  onTimeout(timeoutData) {
+    utils.logError('Adplus adapter timed out for the auction.', timeoutData);
+  },
+  onBidWon(bid) {
+    utils.logInfo(
+      `Adplus adapter won the auction. Bid id: ${bid.bidId}, Ad Unit Id: ${bid.adUnitId}, Inventory Id: ${bid.inventoryId}`
+    );
+  },
+};
+
+registerBidder(spec);
+// #endregion

package/modules/adplusBidAdapter.md

@@ -0,0 +1,39 @@
+# Overview
+
+Module Name: AdPlus Bidder Adapter
+
+Module Type: Bidder Adapter
+
+Maintainer: adplus.destek@yaani.com.tr
+
+# Description
+
+AdPlus Prebid.js Bidder Adapter. Only banner formats are supported.
+
+About us : https://ssp.ad-plus.com.tr/
+
+# Test Parameters
+
+```javascript
+var adUnits = [
+  {
+    code: "div-adplus",
+    mediaTypes: {
+      banner: {
+        sizes: [
+          [300, 250],
+        ],
+      },
+    },
+    bids: [
+      {
+        bidder: "adplus",
+        params: {
+          inventoryId: "-1",
+          adUnitId: "-3",
+        },
+      },
+    ],
+  },
+];
+```