prebid.js 6.4.0 → 6.5.0

package/modules/adyoulikeBidAdapter.js

@@ -180,11 +180,13 @@ function getCanonicalUrl() {
 
 /* Get mediatype from bidRequest */
 function getMediatype(bidRequest) {
+  if (deepAccess(bidRequest, 'mediaTypes.banner')) {
+    return BANNER;
+  }
   if (deepAccess(bidRequest, 'mediaTypes.video')) {
     return VIDEO;
-  } else if (deepAccess(bidRequest, 'mediaTypes.banner')) {
-    return BANNER;
-  } else if (deepAccess(bidRequest, 'mediaTypes.native')) {
+  }
+  if (deepAccess(bidRequest, 'mediaTypes.native')) {
     return NATIVE;
   }
 }
@@ -345,7 +347,7 @@ function getTrackers(eventsArray, jsTrackers) {
 
 function getVideoAd(response) {
   var adJson = {};
-  if (typeof response.Ad === 'string') {
+  if (typeof response.Ad === 'string' && response.Ad.indexOf('\/\*PREBID\*\/') > 0) {
     adJson = JSON.parse(response.Ad.match(/\/\*PREBID\*\/(.*)\/\*PREBID\*\//)[1]);
     return deepAccess(adJson, 'Content.MainVideo.Vast');
   }
@@ -478,13 +480,15 @@ function createBid(response, bidRequests) {
     meta: response.Meta || { advertiserDomains: [] }
   };
 
-  if (request && request.Native) {
+  // retreive video response if present
+  const vast64 = response.Vast || getVideoAd(response);
+  if (vast64) {
+    bid.vastXml = window.atob(vast64);
+    bid.mediaType = 'video';
+  } else if (request.Native) {
+    // format Native response if Native was requested
     bid.native = getNativeAssets(response, request.Native);
     bid.mediaType = 'native';
-  } else if (request && request.Video) {
-    const vast64 = response.Vast || getVideoAd(response);
-    bid.vastXml = vast64 ? window.atob(vast64) : '';
-    bid.mediaType = 'video';
   } else {
     bid.width = response.Width;
     bid.height = response.Height;

package/modules/bliinkBidAdapter.js

@@ -1,6 +1,6 @@
 // eslint-disable-next-line prebid/validate-imports
 // eslint-disable-next-line prebid/validate-imports
-import {registerBidder} from 'src/adapters/bidderFactory.js'
+import {registerBidder} from '../src/adapters/bidderFactory.js'
 
 export const BIDDER_CODE = 'bliink'
 export const BLIINK_ENDPOINT_ENGINE = 'https://engine.bliink.io/delivery'

package/modules/consentManagement.js

@@ -371,7 +371,13 @@ function processCmpData(consentObject, hookConfig) {
  * General timeout callback when interacting with CMP takes too long.
  */
 function cmpTimedOut(hookConfig) {
-  cmpFailed('CMP workflow exceeded timeout threshold.', hookConfig);
+  if (cmpVersion === 2) {
+    logWarn(`No response from CMP, continuing auction...`)
+    storeConsentData(undefined);
+    exitModule(null, hookConfig)
+  } else {
+    cmpFailed('CMP workflow exceeded timeout threshold.', hookConfig);
+  }
 }
 
 /**

package/modules/docereeBidAdapter.js

@@ -14,6 +14,13 @@ export const spec = {
     const { placementId } = bid.params;
     return !!placementId
   },
+  isGdprConsentPresent: (bid) => {
+    const { gdpr, gdprConsent } = bid.params;
+    if (gdpr == '1') {
+      return !!gdprConsent
+    }
+    return true
+  },
   buildRequests: (validBidRequests) => {
     const serverRequests = [];
     const { data } = config.getConfig('doceree.user')
@@ -21,7 +28,7 @@ export const spec = {
     const encodedUserInfo = window.btoa(encodeURIComponent(JSON.stringify(data)))
 
     validBidRequests.forEach(function(validBidRequest) {
-      const { publisherUrl, placementId } = validBidRequest.params;
+      const { publisherUrl, placementId, gdpr, gdprConsent } = validBidRequest.params;
       const url = publisherUrl || page
       let queryString = '';
       queryString = tryAppendQueryString(queryString, 'id', placementId);
@@ -32,6 +39,8 @@ export const spec = {
       queryString = tryAppendQueryString(queryString, 'prebidjs', true);
       queryString = tryAppendQueryString(queryString, 'token', token);
       queryString = tryAppendQueryString(queryString, 'requestId', validBidRequest.bidId);
+      queryString = tryAppendQueryString(queryString, 'gdpr', gdpr);
+      queryString = tryAppendQueryString(queryString, 'gdpr_consent', gdprConsent);
 
       serverRequests.push({
         method: 'GET',

package/modules/docereeBidAdapter.md

@@ -25,6 +25,8 @@ var adUnits = [
                params: {
                     placementId: 'DOC_7jm9j5eqkl0xvc5w', //required
                     publisherUrl: document.URL || window.location.href, //optional
+                    gdpr: '1', //optional
+                    gdprConsent:'CPQfU1jPQfU1jG0AAAENAwCAAAAAAAAAAAAAAAAAAAAA.IGLtV_T9fb2vj-_Z99_tkeYwf95y3p-wzhheMs-8NyZeH_B4Wv2MyvBX4JiQKGRgksjLBAQdtHGlcTQgBwIlViTLMYk2MjzNKJrJEilsbO2dYGD9Pn8HT3ZCY70-vv__7v3ff_3g', //optional
                }
             }
        ]

package/modules/gptPreAuction.js

@@ -48,10 +48,35 @@ const sanitizeSlotPath = (path) => {
   return path;
 }
 
+const defaultPreAuction = (adUnit, adServerAdSlot) => {
+  const context = adUnit.ortb2Imp.ext.data;
+
+  // use pbadslot if supplied
+  if (context.pbadslot) {
+    return context.pbadslot;
+  }
+
+  // confirm that GPT is set up
+  if (!isGptPubadsDefined()) {
+    return;
+  }
+
+  // find all GPT slots with this name
+  var gptSlots = window.googletag.pubads().getSlots().filter(slot => slot.getAdUnitPath() === adServerAdSlot);
+
+  if (gptSlots.length === 0) {
+    return; // should never happen
+  }
+
+  if (gptSlots.length === 1) {
+    return adServerAdSlot;
+  }
+
+  // else the adunit code must be div id. append it.
+  return `${adServerAdSlot}#${adUnit.code}`;
+}
+
 export const appendPbAdSlot = adUnit => {
-  adUnit.ortb2Imp = adUnit.ortb2Imp || {};
-  adUnit.ortb2Imp.ext = adUnit.ortb2Imp.ext || {};
-  adUnit.ortb2Imp.ext.data = adUnit.ortb2Imp.ext.data || {};
   const context = adUnit.ortb2Imp.ext.data;
   const { customPbAdSlot } = _currentConfig;
 
@@ -84,11 +109,32 @@ export const appendPbAdSlot = adUnit => {
 
 export const makeBidRequestsHook = (fn, adUnits, ...args) => {
   appendGptSlots(adUnits);
+  const { useDefaultPreAuction, customPreAuction } = _currentConfig;
   adUnits.forEach(adUnit => {
-    const usedAdUnitCode = appendPbAdSlot(adUnit);
-    // gpid should be set to itself if already set, or to what pbadslot was (as long as it was not adUnit code)
-    if (!adUnit.ortb2Imp.ext.gpid && !usedAdUnitCode) {
-      adUnit.ortb2Imp.ext.gpid = adUnit.ortb2Imp.ext.data.pbadslot;
+    // init the ortb2Imp if not done yet
+    adUnit.ortb2Imp = adUnit.ortb2Imp || {};
+    adUnit.ortb2Imp.ext = adUnit.ortb2Imp.ext || {};
+    adUnit.ortb2Imp.ext.data = adUnit.ortb2Imp.ext.data || {};
+    const context = adUnit.ortb2Imp.ext;
+
+    // if neither new confs set do old stuff
+    if (!customPreAuction && !useDefaultPreAuction) {
+      const usedAdUnitCode = appendPbAdSlot(adUnit);
+      // gpid should be set to itself if already set, or to what pbadslot was (as long as it was not adUnit code)
+      if (!context.gpid && !usedAdUnitCode) {
+        context.gpid = context.data.pbadslot;
+      }
+    } else {
+      let adserverSlot = deepAccess(context, 'data.adserver.adslot');
+      let result;
+      if (customPreAuction) {
+        result = customPreAuction(adUnit, adserverSlot);
+      } else if (useDefaultPreAuction) {
+        result = defaultPreAuction(adUnit, adserverSlot);
+      }
+      if (result) {
+        context.gpid = context.data.pbadslot = result;
+      }
     }
   });
   return fn.call(this, adUnits, ...args);
@@ -100,6 +146,8 @@ const handleSetGptConfig = moduleConfig => {
     'customGptSlotMatching', customGptSlotMatching =>
       typeof customGptSlotMatching === 'function' && customGptSlotMatching,
     'customPbAdSlot', customPbAdSlot => typeof customPbAdSlot === 'function' && customPbAdSlot,
+    'customPreAuction', customPreAuction => typeof customPreAuction === 'function' && customPreAuction,
+    'useDefaultPreAuction', useDefaultPreAuction => useDefaultPreAuction === true,
   ]);
 
   if (_currentConfig.enabled) {

package/modules/ixBidAdapter.js

@@ -53,7 +53,12 @@ const SOURCE_RTI_MAPPING = {
   'neustar.biz': 'fabrickId',
   'zeotap.com': 'zeotapIdPlus',
   'uidapi.com': 'UID2',
-  'adserver.org': 'TDID'
+  'adserver.org': 'TDID',
+  'id5-sync.com': '', // ID5 Universal ID, configured as id5Id
+  'crwdcntrl.net': '', // Lotame Panorama ID, lotamePanoramaId
+  'epsilon.com': '', // Publisher Link, publinkId
+  'audigent.com': '', // Halo ID from Audigent, haloId
+  'pubcid.org': '' // SharedID, pubcid
 };
 const PROVIDERS = [
   'britepoolid',
@@ -69,7 +74,8 @@ const PROVIDERS = [
   'quantcastId',
   'pubcid',
   'TDID',
-  'flocId'
+  'flocId',
+  'pubProvidedId'
 ];
 const REQUIRED_VIDEO_PARAMS = ['mimes', 'minduration', 'maxduration']; // note: protocol/protocols is also reqd
 const VIDEO_PARAMS_ALLOW_LIST = [
@@ -194,7 +200,7 @@ function bidToImp(bid) {
   imp.id = bid.bidId;
 
   imp.ext = {};
-  imp.ext.siteID = bid.params.siteId;
+  imp.ext.siteID = bid.params.siteId.toString();
 
   if (bid.params.hasOwnProperty('id') &&
     (typeof bid.params.id === 'string' || typeof bid.params.id === 'number')) {
@@ -444,16 +450,19 @@ function getEidInfo(allEids, flocData) {
   let seenSources = {};
   if (isArray(allEids)) {
     for (const eid of allEids) {
-      if (SOURCE_RTI_MAPPING[eid.source] && deepAccess(eid, 'uids.0')) {
+      if (SOURCE_RTI_MAPPING.hasOwnProperty(eid.source) && deepAccess(eid, 'uids.0')) {
         seenSources[eid.source] = true;
-        eid.uids[0].ext = {
-          rtiPartner: SOURCE_RTI_MAPPING[eid.source]
-        };
+        if (SOURCE_RTI_MAPPING[eid.source] != '') {
+          eid.uids[0].ext = {
+            rtiPartner: SOURCE_RTI_MAPPING[eid.source]
+          };
+        }
         delete eid.uids[0].atype;
         toSend.push(eid);
       }
     }
   }
+
   const isValidFlocId = flocData && flocData.id && flocData.version;
   if (isValidFlocId) {
     const flocEid = {
@@ -466,6 +475,7 @@ function getEidInfo(allEids, flocData) {
 
   return { toSend, seenSources };
 }
+
 /**
  * Builds a request object to be sent to the ad server based on bid requests.
  *
@@ -680,6 +690,7 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
 
     if (impressionObjects.length && BANNER in impressionObjects[0]) {
       const { id, banner: { topframe }, ext } = impressionObjects[0];
+      const gpid = impressions[transactionIds[adUnitIndex]].gpid;
       const _bannerImpression = {
         id,
         banner: {
@@ -688,10 +699,10 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
         },
       }
 
-      if (ext.dfp_ad_unit_code) {
-        _bannerImpression.ext = {
-          dfp_ad_unit_code: ext.dfp_ad_unit_code
-        }
+      if (ext.dfp_ad_unit_code || gpid) {
+        _bannerImpression.ext = {};
+        _bannerImpression.ext.dfp_ad_unit_code = ext.dfp_ad_unit_code;
+        _bannerImpression.ext.gpid = gpid;
       }
 
       if ('bidfloor' in impressionObjects[0]) {
@@ -911,6 +922,7 @@ function createBannerImps(validBidRequest, missingBannerSizes, bannerImps) {
       bannerImps[validBidRequest.transactionId].ixImps = []
     }
     bannerImps[validBidRequest.transactionId].ixImps.push(imp);
+    bannerImps[validBidRequest.transactionId].gpid = deepAccess(validBidRequest, 'ortb2Imp.ext.gpid');
   }
 
   if (ixConfig.hasOwnProperty('detectMissingSizes') && ixConfig.detectMissingSizes) {
@@ -1186,7 +1198,12 @@ export const spec = {
     }
 
     if (typeof bid.params.siteId !== 'string' && typeof bid.params.siteId !== 'number') {
-      logError('IX Bid Adapter: siteId must be string or number value.', { bidder: BIDDER_CODE, code: ERROR_CODES.SITE_ID_INVALID_VALUE });
+      logError('IX Bid Adapter: siteId must be string or number type.', { bidder: BIDDER_CODE, code: ERROR_CODES.SITE_ID_INVALID_VALUE });
+      return false;
+    }
+
+    if (typeof bid.params.siteId !== 'string' && isNaN(Number(bid.params.siteId))) {
+      logError('IX Bid Adapter: siteId must valid value', { bidder: BIDDER_CODE, code: ERROR_CODES.SITE_ID_INVALID_VALUE });
       return false;
     }
 

package/modules/limelightDigitalBidAdapter.js

@@ -159,7 +159,8 @@ function buildPlacement(bidRequest) {
         }
       }),
       type: bidRequest.params.adUnitType.toUpperCase(),
-      publisherId: bidRequest.params.publisherId
+      publisherId: bidRequest.params.publisherId,
+      userIdAsEids: bidRequest.userIdAsEids
     }
   }
 }

package/modules/livewrappedAnalyticsAdapter.js

@@ -114,6 +114,7 @@ let livewrappedAnalyticsAdapter = Object.assign(adapter({EMPTYURL, ANALYTICSTYPE
         let wonBid = cache.auctions[args.auctionId].bids[args.requestId];
         wonBid.won = true;
         wonBid.floorData = args.floorData;
+        wonBid.rUp = args.rUp;
         if (wonBid.sendStatus != 0) {
           livewrappedAnalyticsAdapter.sendEvents();
         }
@@ -288,7 +289,8 @@ function getWins(gdpr, auctionIds) {
           auctionId: auctionIdPos,
           auc: bid.auc,
           buc: bid.buc,
-          lw: bid.lw
+          lw: bid.lw,
+          rUp: bid.rUp
         });
       }
     });

package/modules/loglyliftBidAdapter.js

@@ -0,0 +1,79 @@
+import { config } from '../src/config.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { NATIVE } from '../src/mediaTypes.js';
+
+const BIDDER_CODE = 'loglylift';
+const ENDPOINT_URL = 'https://bid.logly.co.jp/prebid/client/v1';
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [NATIVE],
+
+  isBidRequestValid: function (bid) {
+    return !!(bid.params && bid.params.adspotId);
+  },
+
+  buildRequests: function (bidRequests, bidderRequest) {
+    const requests = [];
+    for (let i = 0, len = bidRequests.length; i < len; i++) {
+      const request = {
+        method: 'POST',
+        url: ENDPOINT_URL + '?adspot_id=' + bidRequests[i].params.adspotId,
+        data: JSON.stringify(newBidRequest(bidRequests[i], bidderRequest)),
+        options: {},
+        bidderRequest
+      };
+      requests.push(request);
+    }
+    return requests;
+  },
+
+  interpretResponse: function (serverResponse, { bidderRequest }) {
+    serverResponse = serverResponse.body;
+    const bidResponses = [];
+    if (!serverResponse || serverResponse.error) {
+      return bidResponses;
+    }
+    serverResponse.bids.forEach(function (bid) {
+      bidResponses.push(bid);
+    })
+    return bidResponses;
+  },
+
+  getUserSyncs: function (syncOptions, serverResponses) {
+    const syncs = [];
+
+    if (syncOptions.iframeEnabled && serverResponses.length > 0) {
+      syncs.push({
+        type: 'iframe',
+        url: 'https://sync.logly.co.jp/sync/sync.html'
+      });
+    }
+    return syncs;
+  }
+
+};
+
+function newBidRequest(bid, bidderRequest) {
+  const currencyObj = config.getConfig('currency');
+  const currency = (currencyObj && currencyObj.adServerCurrency) || 'USD';
+
+  return {
+    auctionId: bid.auctionId,
+    bidderRequestId: bid.bidderRequestId,
+    transactionId: bid.transactionId,
+    adUnitCode: bid.adUnitCode,
+    bidId: bid.bidId,
+    mediaTypes: bid.mediaTypes,
+    params: bid.params,
+    prebidJsVersion: '$prebid.version$',
+    url: window.location.href,
+    domain: config.getConfig('publisherDomain'),
+    referer: bidderRequest.refererInfo.referer,
+    auctionStartTime: bidderRequest.auctionStart,
+    currency: currency,
+    timeout: config.getConfig('bidderTimeout')
+  };
+}
+
+registerBidder(spec);

package/modules/loglyliftBidAdapter.md

@@ -0,0 +1,55 @@
+# Overview
+```
+Module Name: LOGLY lift for Publisher
+Module Type: Bidder Adapter
+Maintainer: dev@logly.co.jp
+```
+
+# Description
+Module that connects to Logly's demand sources.
+Currently module supports only native mediaType.
+
+# Test Parameters
+```
+var adUnits = [
+  // Native adUnit
+  {
+    code: 'test-native-code',
+    sizes: [[1, 1]],
+    mediaTypes: {
+      native: {
+        title: {
+          required: true
+        },
+        image: {
+          required: true
+        },
+        sponsoredBy: {
+          required: true
+        }
+      }
+    },
+    bids: [{
+      bidder: 'loglylift',
+      params: {
+        adspotId: 4302078
+      }
+    }]
+  }
+];
+```
+
+# UserSync example
+
+```
+pbjs.setConfig({
+  userSync: {
+    filterSettings: {
+      iframe: {
+        bidders: '*', // '*' represents all bidders
+        filter: 'include'
+      }
+    }
+  }
+});
+```

package/modules/optimeraRtdProvider.js

@@ -173,7 +173,9 @@ export function setScoresURL() {
 }
 
 /**
- * Set the scores for the divice if given.
+ * Set the scores for the device if given.
+ * Add any any insights to the winddow.optimeraInsights object.
+ *
  * @param {*} result
  * @returns {string} JSON string of Optimera Scores.
  */
@@ -184,6 +186,11 @@ export function setScores(result) {
     if (device !== 'default' && scores.device[device]) {
       scores = scores.device[device];
     }
+    logInfo(scores);
+    if (scores.insights) {
+      window.optimeraInsights = window.optimeraInsights || {};
+      window.optimeraInsights.data = scores.insights;
+    }
   } catch (e) {
     logError('Optimera score file could not be parsed.');
   }