prebid.js 5.18.0 → 6.1.0

package/modules/deepintentBidAdapter.md

@@ -8,7 +8,7 @@ Maintainer: prebid@deepintent.com
 
 # Description
 
-Deepintent currently supports the BANNER type ads through prebid js
+Deepintent currently supports the BANNER and VIDEO type ads through prebid js
 
 Module that connects to Deepintent's demand sources.
 
@@ -40,6 +40,41 @@ Module that connects to Deepintent's demand sources.
   ];
 ```
 
+# Sample Video Ad Unit
+```
+var adVideoAdUnits = [
+{
+    code: 'test-div-video',
+    mediaTypes: {
+        video: {
+            playerSize: [640, 480],           // required
+            context: 'instream'               //required
+        }
+    },
+    bids: [{
+      bidder: 'deepintent',
+      params: {
+        tagId: '1300',  // Required parameter                 // required
+        video: {
+          mimes: ['video/mp4','video/x-flv'],   // required
+          skippable: true,                      // optional
+          minduration: 5,                       // optional
+          maxduration: 30,                      // optional
+          startdelay: 5,                        // optional
+          playbackmethod: [1,3],                // optional
+          api: [ 1, 2 ],                        // optional
+          protocols: [ 2, 3 ],                  // optional
+          battr: [ 13, 14 ],                    // optional
+          linearity: 1,                         // optional
+          placement: 2,                         // optional
+          minbitrate: 10,                       // optional
+          maxbitrate: 10                        // optional
+        }
+      }
+    }]
+}]
+```
+
 ###Recommended User Sync Configuration
 
 ```javascript

package/modules/deltaprojectsBidAdapter.js

@@ -0,0 +1,252 @@
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER } from '../src/mediaTypes.js';
+import {
+  _each, _map, isFn, isNumber, createTrackPixelHtml, deepAccess, parseUrl, logWarn, logError
+} from '../src/utils.js';
+import {config} from '../src/config.js';
+
+export const BIDDER_CODE = 'deltaprojects';
+export const BIDDER_ENDPOINT_URL = 'https://d5p.de17a.com/dogfight/prebid';
+export const USERSYNC_URL = 'https://userservice.de17a.com/getuid/prebid';
+
+/** -- isBidRequestValid --**/
+function isBidRequestValid(bid) {
+  if (!bid) return false;
+
+  if (bid.bidder !== BIDDER_CODE) return false;
+
+  // publisher id is required
+  const publisherId = deepAccess(bid, 'params.publisherId')
+  if (!publisherId) {
+    logError('Invalid bid request, missing publisher id in params');
+    return false;
+  }
+
+  return true;
+}
+
+/** -- Build requests --**/
+function buildRequests(validBidRequests, bidderRequest) {
+  /** == shared ==**/
+  // -- build id
+  const id = bidderRequest.auctionId;
+
+  // -- build site
+  const loc = parseUrl(bidderRequest.refererInfo.referer);
+  const publisherId = setOnAny(validBidRequests, 'params.publisherId');
+  const siteId = setOnAny(validBidRequests, 'params.siteId');
+  const site = {
+    id: siteId,
+    domain: loc.hostname,
+    page: loc.href,
+    ref: loc.href,
+    publisher: { id: publisherId },
+  };
+
+  // -- build device
+  const ua = navigator.userAgent;
+  const device = {
+    ua,
+    w: screen.width,
+    h: screen.height
+  }
+
+  // -- build user, reg
+  let user = { ext: {} };
+  const regs = { ext: {} };
+  const gdprConsent = bidderRequest && bidderRequest.gdprConsent;
+  if (gdprConsent) {
+    user.ext = { consent: gdprConsent.consentString };
+    if (typeof gdprConsent.gdprApplies == 'boolean') {
+      regs.ext.gdpr = gdprConsent.gdprApplies ? 1 : 0
+    }
+  }
+
+  // -- build tmax
+  let tmax = (bidderRequest && bidderRequest.timeout > 0) ? bidderRequest.timeout : undefined;
+
+  // build bid specific
+  return validBidRequests.map(validBidRequest => {
+    const openRTBRequest = buildOpenRTBRequest(validBidRequest, id, site, device, user, tmax, regs);
+    return {
+      method: 'POST',
+      url: BIDDER_ENDPOINT_URL,
+      data: openRTBRequest,
+      options: { contentType: 'application/json' },
+      bids: [validBidRequest],
+    };
+  });
+}
+
+function buildOpenRTBRequest(validBidRequest, id, site, device, user, tmax, regs) {
+  // build cur
+  const currency = config.getConfig('currency.adServerCurrency') || deepAccess(validBidRequest, 'params.currency');
+  const cur = currency && [currency];
+
+  // build impression
+  const impression = buildImpression(validBidRequest, currency);
+
+  // build test
+  const test = deepAccess(validBidRequest, 'params.test') ? 1 : 0
+
+  const at = 1
+
+  // build source
+  const source = {
+    tid: validBidRequest.transactionId,
+    fd: 1,
+  }
+
+  return {
+    id,
+    at,
+    imp: [impression],
+    site,
+    device,
+    user,
+    test,
+    tmax,
+    cur,
+    source,
+    regs,
+    ext: {},
+  };
+}
+
+function buildImpression(bid, currency) {
+  const impression = {
+    id: bid.bidId,
+    tagid: bid.params.tagId,
+    ext: {},
+  };
+
+  const bannerMediaType = deepAccess(bid, `mediaTypes.${BANNER}`);
+  impression.banner = buildImpressionBanner(bid, bannerMediaType);
+
+  // bid floor
+  const bidFloor = getBidFloor(bid, BANNER, '*', currency);
+  if (bidFloor) {
+    impression.bidfloor = bidFloor.floor;
+    impression.bidfloorcur = bidFloor.currency;
+  }
+
+  return impression;
+}
+
+function buildImpressionBanner(bid, bannerMediaType) {
+  const bannerSizes = (bannerMediaType && bannerMediaType.sizes) || bid.sizes;
+  return {
+    format: _map(bannerSizes, ([width, height]) => ({ w: width, h: height })),
+  };
+}
+
+/** -- Interpret response --**/
+function interpretResponse(serverResponse) {
+  if (!serverResponse.body) {
+    logWarn('Response body is invalid, return !!');
+    return [];
+  }
+
+  const { body: { id, seatbid, cur } } = serverResponse;
+  if (!id || !seatbid) {
+    logWarn('Id / seatbid of response is invalid, return !!');
+    return [];
+  }
+
+  const bidResponses = [];
+
+  _each(seatbid, seatbid => {
+    _each(seatbid.bid, bid => {
+      const bidObj = {
+        requestId: bid.impid,
+        cpm: parseFloat(bid.price),
+        width: parseInt(bid.w),
+        height: parseInt(bid.h),
+        creativeId: bid.crid || bid.id,
+        dealId: bid.dealid || null,
+        currency: cur,
+        netRevenue: true,
+        ttl: 60,
+      };
+
+      bidObj.mediaType = BANNER;
+      bidObj.ad = bid.adm;
+      if (bid.nurl) {
+        bidObj.ad += createTrackPixelHtml(decodeURIComponent(bid.nurl));
+      }
+      if (bid.ext) {
+        bidObj[BIDDER_CODE] = bid.ext;
+      }
+      bidResponses.push(bidObj);
+    });
+  });
+  return bidResponses;
+}
+
+/** -- On Bid Won -- **/
+function onBidWon(bid) {
+  let cpm = bid.cpm;
+  if (bid.currency && bid.currency !== bid.originalCurrency && typeof bid.getCpmInNewCurrency === 'function') {
+    cpm = bid.getCpmInNewCurrency(bid.originalCurrency);
+  }
+  const wonPrice = Math.round(cpm * 1000000);
+  const wonPriceMacroPatten = /\$\{AUCTION_PRICE:B64\}/g;
+  bid.ad = bid.ad.replace(wonPriceMacroPatten, wonPrice);
+}
+
+/** -- Get user syncs --**/
+function getUserSyncs(syncOptions, serverResponses, gdprConsent) {
+  const syncs = []
+
+  if (syncOptions.pixelEnabled) {
+    let gdprParams;
+    if (gdprConsent) {
+      if (typeof gdprConsent.gdprApplies === 'boolean') {
+        gdprParams = `?gdpr=${Number(gdprConsent.gdprApplies)}&gdpr_consent=${gdprConsent.consentString}`;
+      } else {
+        gdprParams = `?gdpr_consent=${gdprConsent.consentString}`;
+      }
+    } else {
+      gdprParams = '';
+    }
+    syncs.push({
+      type: 'image',
+      url: USERSYNC_URL + gdprParams
+    });
+  }
+  return syncs;
+}
+
+/** -- Get bid floor --**/
+export function getBidFloor(bid, mediaType, size, currency) {
+  if (isFn(bid.getFloor)) {
+    const bidFloorCurrency = currency || 'USD';
+    const bidFloor = bid.getFloor({currency: bidFloorCurrency, mediaType: mediaType, size: size});
+    if (isNumber(bidFloor.floor)) {
+      return bidFloor;
+    }
+  }
+}
+
+/** -- Helper methods --**/
+function setOnAny(collection, key) {
+  for (let i = 0, result; i < collection.length; i++) {
+    result = deepAccess(collection[i], key);
+    if (result) {
+      return result;
+    }
+  }
+}
+
+/** -- Register -- */
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER],
+  isBidRequestValid,
+  buildRequests,
+  interpretResponse,
+  onBidWon,
+  getUserSyncs,
+};
+
+registerBidder(spec);

package/modules/deltaprojectsBidAdapter.md

@@ -0,0 +1,32 @@
+# Overview
+
+```
+Module Name:  Delta Projects Bid Adapter
+Module Type:  Bidder Adapter
+Maintainer:   dev@deltaprojects.com
+```
+
+# Description
+
+Connects to Delta Projects DSP for bids.
+
+# Test Parameters
+```
+// define banner unit
+var bannerUnit = {
+  code: 'div-gpt-ad-1460505748561-0',
+  mediaTypes: {
+    banner: {
+      sizes: [[300, 250], [300,600]],
+    }
+  },
+  // Replace this object to test a new Adapter!
+  bids: [{
+    bidder: 'deltaprojects',
+    params: {
+      publisherId: '4'   //required
+    }
+  }]
+};
+```
+

package/modules/engageyaBidAdapter.js

@@ -0,0 +1,171 @@
+import { BANNER, NATIVE } from '../src/mediaTypes.js';
+import { createTrackPixelHtml } from '../src/utils.js';
+
+const {
+  registerBidder
+} = require('../src/adapters/bidderFactory.js');
+const BIDDER_CODE = 'engageya';
+const ENDPOINT_URL = 'https://recs.engageya.com/rec-api/getrecs.json';
+const ENDPOINT_METHOD = 'GET';
+const SUPPORTED_SIZES = [
+  [100, 75], [236, 202], [100, 100], [130, 130], [200, 200], [250, 250], [300, 272], [300, 250], [300, 230], [300, 214], [300, 187], [300, 166], [300, 150], [300, 133], [300, 120], [400, 200], [300, 200], [250, 377], [620, 410], [207, 311], [310, 166], [310, 333], [190, 106], [228, 132], [300, 174], [80, 60], [600, 500], [600, 600], [1080, 610], [1080, 610], [624, 350], [650, 1168], [1080, 1920], [300, 374]
+];
+
+function getPageUrl(bidRequest, bidderRequest) {
+  if (bidRequest.params.pageUrl && bidRequest.params.pageUrl != '[PAGE_URL]') {
+    return bidRequest.params.pageUrl;
+  }
+  if (bidderRequest && bidderRequest.refererInfo && bidderRequest.refererInfo.referer) {
+    return bidderRequest.refererInfo.referer;
+  }
+  const pageUrl = (isInIframe() && document.referrer)
+    ? document.referrer
+    : window.location.href;
+  return encodeURIComponent(pageUrl);
+}
+
+function isInIframe() {
+  try {
+    var isInIframe = (window.self !== window.top);
+  } catch (e) {
+    isInIframe = true;
+  }
+  return isInIframe;
+}
+
+function getImageSrc(rec) {
+  return rec.thumbnail_path.indexOf('http') === -1 ? 'https:' + rec.thumbnail_path : rec.thumbnail_path;
+}
+
+function getImpressionTrackers(rec, response) {
+  const responseTrackers = [response.viewPxl];
+  if (!rec.trackers) {
+    return responseTrackers;
+  }
+  const impressionTrackers = rec.trackers.impressionPixels || [];
+  const viewTrackers = rec.trackers.viewPixels || [];
+  return [...impressionTrackers, ...viewTrackers, ...responseTrackers];
+}
+
+function parseNativeResponse(rec, response) {
+  return {
+    title: rec.title,
+    body: '',
+    image: {
+      url: getImageSrc(rec),
+      width: response.imageWidth,
+      height: response.imageHeight
+    },
+    privacyLink: '',
+    clickUrl: rec.clickUrl,
+    displayUrl: rec.url,
+    cta: '',
+    sponsoredBy: rec.displayName,
+    impressionTrackers: getImpressionTrackers(rec, response),
+  };
+}
+
+function parseBannerResponse(rec, response) {
+  if (rec.tag) {
+    return rec.tag;
+  }
+  let style;
+  try {
+    let additionalData = JSON.parse(response.widget.additionalData);
+    const css = additionalData.css || '';
+    style = css ? `<style>${css}</style>` : '';
+  } catch (e) {
+    style = '';
+  }
+  const title = rec.title && rec.title.trim() ? `<div class="eng_tag_ttl" style="display: none">${rec.title}</div>` : '';
+  const displayName = rec.displayName && title ? `<div class="eng_tag_brnd" style="display: none">${rec.displayName}</div>` : '';
+  const trackers = getImpressionTrackers(rec, response)
+    .map(createTrackPixelHtml)
+    .join('');
+  return `<html><body>${style}<div id="ENG_TAG"><a href="${rec.clickUrl}" target=_blank><img class="eng_tag_img" src="${getImageSrc(rec)}" style="width:${response.imageWidth}px;height:${response.imageHeight}px;" alt="${rec.title}"/>${displayName}${title}</a>${trackers}</div></body></html>`;
+}
+
+function getImageSize(bidRequest) {
+  if (bidRequest.sizes && bidRequest.sizes.length > 0) {
+    return bidRequest.sizes[0];
+  } else if (bidRequest.nativeParams && bidRequest.nativeParams.image && bidRequest.nativeParams.image.sizes) {
+    return bidRequest.nativeParams.image.sizes;
+  }
+  return [-1, -1];
+}
+
+function isValidSize([width, height]) {
+  if (!width || !height) {
+    return false;
+  }
+  return SUPPORTED_SIZES.some(([supportedWidth, supportedHeight]) => supportedWidth === width && supportedHeight === height);
+}
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, NATIVE],
+
+  isBidRequestValid: function (bidRequest) {
+    return bidRequest &&
+      bidRequest.params &&
+      bidRequest.params.hasOwnProperty('widgetId') &&
+      bidRequest.params.hasOwnProperty('websiteId') &&
+      !isNaN(bidRequest.params.widgetId) &&
+      !isNaN(bidRequest.params.websiteId) &&
+      isValidSize(getImageSize(bidRequest));
+  },
+
+  buildRequests: function (validBidRequests, bidderRequest) {
+    if (!validBidRequests) {
+      return [];
+    }
+    return validBidRequests.map(bidRequest => {
+      if (bidRequest.params) {
+        const mediaType = bidRequest.hasOwnProperty('nativeParams') ? 1 : 2;
+        const [imageWidth, imageHeight] = getImageSize(bidRequest);
+        const widgetId = bidRequest.params.widgetId;
+        const websiteId = bidRequest.params.websiteId;
+        const pageUrl = getPageUrl(bidRequest, bidderRequest);
+        const bidId = bidRequest.bidId;
+        let finalUrl = ENDPOINT_URL + '?pubid=0&webid=' + websiteId + '&wid=' + widgetId + '&url=' + pageUrl + '&ireqid=' + bidId + '&pbtpid=' + mediaType + '&imw=' + imageWidth + '&imh=' + imageHeight;
+        if (bidderRequest && bidderRequest.gdprConsent && bidderRequest.gdprApplies && bidderRequest.consentString) {
+          finalUrl += '&is_gdpr=1&gdpr_consent=' + bidderRequest.consentString;
+        }
+        return {
+          url: finalUrl,
+          method: ENDPOINT_METHOD,
+          data: ''
+        };
+      }
+    }).filter(Boolean);
+  },
+
+  interpretResponse: function (serverResponse, bidRequest) {
+    if (!serverResponse.body || !serverResponse.body.recs || !serverResponse.body.recs.length) {
+      return [];
+    }
+    var response = serverResponse.body;
+    var isNative = response.pbtypeId == 1;
+    return response.recs.map(rec => {
+      let bid = {
+        requestId: response.ireqId,
+        width: response.imageWidth,
+        height: response.imageHeight,
+        creativeId: rec.postId,
+        cpm: rec.pecpm || (rec.ecpm / 100),
+        currency: 'USD',
+        netRevenue: !!rec.pecpm,
+        ttl: 360,
+        meta: { advertiserDomains: rec.domain ? [rec.domain] : [] },
+      }
+      if (isNative) {
+        bid.native = parseNativeResponse(rec, response);
+      } else {
+        bid.ad = parseBannerResponse(rec, response);
+      }
+      return bid;
+    });
+  }
+};
+
+registerBidder(spec);

package/modules/glimpseBidAdapter.js

@@ -1,19 +1,22 @@
 import { BANNER } from '../src/mediaTypes.js'
+import { config } from '../src/config.js'
 import { getStorageManager } from '../src/storageManager.js'
 import { isArray } from '../src/utils.js'
 import { registerBidder } from '../src/adapters/bidderFactory.js'
 
 const storageManager = getStorageManager()
 
+const GVLID = 1012
 const BIDDER_CODE = 'glimpse'
 const ENDPOINT = 'https://api.glimpsevault.io/ads/serving/public/v1/prebid'
 const LOCAL_STORAGE_KEY = {
-  glimpse: {
+  vault: {
     jwt: 'gp_vault_jwt',
   },
 }
 
 export const spec = {
+  gvlid: GVLID,
   code: BIDDER_CODE,
   supportedMediaTypes: [BANNER],
 
@@ -37,20 +40,28 @@ export const spec = {
    * @returns {ServerRequest}
    */
   buildRequests: (validBidRequests, bidderRequest) => {
-    const networkId = window.networkId || -1
-    const bids = validBidRequests.map(processBidRequest)
+    const demo = config.getConfig('glimpse.demo') || false
+    const account = config.getConfig('glimpse.account') || -1
+    const demand = config.getConfig('glimpse.demand') || 'glimpse'
+    const keywords = config.getConfig('glimpse.keywords') || {}
+
+    const auth = getVaultJwt()
     const referer = getReferer(bidderRequest)
     const gdprConsent = getGdprConsentChoice(bidderRequest)
-    const jwt = getVaultJwt()
+    const bids = validBidRequests.map((bidRequest) => {
+      return processBidRequest(bidRequest, keywords)
+    })
 
     const data = {
-      auth: jwt,
+      auth,
       data: {
         bidderCode: spec.code,
-        networkId,
-        bids,
+        demo,
+        account,
+        demand,
         referer,
         gdprConsent,
+        bids,
       }
     }
 
@@ -65,10 +76,9 @@ export const spec = {
   /**
    * Parse response from Glimpse server
    * @param bidResponse {ServerResponse}
-   * @param bidRequest {BidRequest}
    * @returns {Bid[]}
    */
-  interpretResponse: (bidResponse, bidRequest) => {
+  interpretResponse: (bidResponse) => {
     const isValidResponse = isValidBidResponse(bidResponse)
 
     if (isValidResponse) {
@@ -81,16 +91,20 @@ export const spec = {
   },
 }
 
-function processBidRequest(bidRequest) {
+function processBidRequest(bidRequest, globalKeywords) {
   const sizes = normalizeSizes(bidRequest.sizes)
-  const keywords = bidRequest.params.keywords || []
+  const bidKeywords = bidRequest.params.keywords || {}
+  const keywords = {
+    ...globalKeywords,
+    ...bidKeywords,
+  }
 
   return {
+    unitCode: bidRequest.adUnitCode,
     bidId: bidRequest.bidId,
     placementId: bidRequest.params.placementId,
-    unitCode: bidRequest.adUnitCode,
-    sizes,
     keywords,
+    sizes,
   }
 }
 
@@ -124,7 +138,8 @@ function getReferer(bidderRequest) {
 function getGdprConsentChoice(bidderRequest) {
   const hasGdprConsent =
     hasValue(bidderRequest) &&
-    hasValue(bidderRequest.gdprConsent)
+    hasValue(bidderRequest.gdprConsent) &&
+    hasStringValue(bidderRequest.gdprConsent.consentString)
 
   if (hasGdprConsent) {
     return bidderRequest.gdprConsent
@@ -138,11 +153,11 @@ function getGdprConsentChoice(bidderRequest) {
 }
 
 function setVaultJwt(auth) {
-  storageManager.setDataInLocalStorage(LOCAL_STORAGE_KEY.glimpse.jwt, auth)
+  storageManager.setDataInLocalStorage(LOCAL_STORAGE_KEY.vault.jwt, auth)
 }
 
 function getVaultJwt() {
-  return storageManager.getDataFromLocalStorage(LOCAL_STORAGE_KEY.glimpse.jwt) || ''
+  return storageManager.getDataFromLocalStorage(LOCAL_STORAGE_KEY.vault.jwt) || ''
 }
 
 function isValidBidResponse(bidResponse) {

package/modules/gptPreAuction.js

@@ -55,15 +55,16 @@ export const appendPbAdSlot = adUnit => {
   const context = adUnit.ortb2Imp.ext.data;
   const { customPbAdSlot } = _currentConfig;
 
-  if (customPbAdSlot) {
-    context.pbadslot = customPbAdSlot(adUnit.code, deepAccess(context, 'adserver.adslot'));
+  // use context.pbAdSlot if set (if someone set it already, it will take precedence over others)
+  if (context.pbadslot) {
     return;
   }
 
-  // use context.pbAdSlot if set
-  if (context.pbadslot) {
+  if (customPbAdSlot) {
+    context.pbadslot = customPbAdSlot(adUnit.code, deepAccess(context, 'adserver.adslot'));
     return;
   }
+
   // use data attribute 'data-adslotid' if set
   try {
     const adUnitCodeDiv = document.getElementById(adUnit.code);
@@ -78,12 +79,17 @@ export const appendPbAdSlot = adUnit => {
     return;
   }
   context.pbadslot = adUnit.code;
+  return true;
 };
 
 export const makeBidRequestsHook = (fn, adUnits, ...args) => {
   appendGptSlots(adUnits);
   adUnits.forEach(adUnit => {
-    appendPbAdSlot(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;
+    }
   });
   return fn.call(this, adUnits, ...args);
 };

package/modules/gridBidAdapter.js

@@ -29,6 +29,7 @@ let hasSynced = false;
 
 export const spec = {
   code: BIDDER_CODE,
+  aliases: ['playwire', 'adlivetech'],
   supportedMediaTypes: [ BANNER, VIDEO ],
   /**
    * Determines whether or not the given bid request is valid.

package/modules/gumgumBidAdapter.js

@@ -294,6 +294,14 @@ function buildRequests(validBidRequests, bidderRequest) {
     let data = {};
     let gpid = '';
 
+    const date = new Date();
+    const lt = date && date.getTime();
+    const to = date && date.getTimezoneOffset();
+    if (to) {
+      lt && (data.lt = lt);
+      data.to = to;
+    }
+
     // ADTS-134 Retrieve ID envelopes
     for (const eid in eids) data[eid] = eids[eid];