prebid.js 5.16.0 → 5.20.0

package/modules/deepintentBidAdapter.js

@@ -1,13 +1,38 @@
-import { generateUUID, deepSetValue, deepAccess, isArray } from '../src/utils.js';
+import { generateUUID, deepSetValue, deepAccess, isArray, isInteger, logError, logWarn } from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
-import {BANNER} from '../src/mediaTypes.js';
+import {BANNER, VIDEO} from '../src/mediaTypes.js';
 const BIDDER_CODE = 'deepintent';
 const BIDDER_ENDPOINT = 'https://prebid.deepintent.com/prebid';
 const USER_SYNC_URL = 'https://cdn.deepintent.com/syncpixel.html';
 const DI_M_V = '1.0.0';
+export const ORTB_VIDEO_PARAMS = {
+  'mimes': (value) => Array.isArray(value) && value.length > 0 && value.every(v => typeof v === 'string'),
+  'minduration': (value) => isInteger(value),
+  'maxduration': (value) => isInteger(value),
+  'protocols': (value) => Array.isArray(value) && value.every(v => v >= 1 && v <= 10),
+  'w': (value) => isInteger(value),
+  'h': (value) => isInteger(value),
+  'startdelay': (value) => isInteger(value),
+  'placement': (value) => Array.isArray(value) && value.every(v => v >= 1 && v <= 5),
+  'linearity': (value) => [1, 2].indexOf(value) !== -1,
+  'skip': (value) => [0, 1].indexOf(value) !== -1,
+  'skipmin': (value) => isInteger(value),
+  'skipafter': (value) => isInteger(value),
+  'sequence': (value) => isInteger(value),
+  'battr': (value) => Array.isArray(value) && value.every(v => v >= 1 && v <= 17),
+  'maxextended': (value) => isInteger(value),
+  'minbitrate': (value) => isInteger(value),
+  'maxbitrate': (value) => isInteger(value),
+  'boxingallowed': (value) => [0, 1].indexOf(value) !== -1,
+  'playbackmethod': (value) => Array.isArray(value) && value.every(v => v >= 1 && v <= 6),
+  'playbackend': (value) => [1, 2, 3].indexOf(value) !== -1,
+  'delivery': (value) => [1, 2, 3].indexOf(value) !== -1,
+  'pos': (value) => [0, 1, 2, 3, 4, 5, 6, 7].indexOf(value) !== -1,
+  'api': (value) => Array.isArray(value) && value.every(v => v >= 1 && v <= 6)
+};
 export const spec = {
   code: BIDDER_CODE,
-  supportedMediaTypes: [BANNER],
+  supportedMediaTypes: [BANNER, VIDEO],
   aliases: [],
 
   // tagId is mandatory param
@@ -15,16 +40,38 @@ export const spec = {
     let valid = false;
     if (bid && bid.params && bid.params.tagId) {
       if (typeof bid.params.tagId === 'string' || bid.params.tagId instanceof String) {
-        valid = true;
+        if (bid.hasOwnProperty('mediaTypes') && bid.mediaTypes.hasOwnProperty(VIDEO)) {
+          if (bid.mediaTypes[VIDEO].hasOwnProperty('context')) {
+            valid = true;
+          }
+        } else {
+          valid = true;
+        }
       }
     }
     return valid;
   },
-  interpretResponse: function(bidResponse, request) {
+  interpretResponse: function(bidResponse, bidRequest) {
     let responses = [];
     if (bidResponse && bidResponse.body) {
-      let bids = bidResponse.body.seatbid && bidResponse.body.seatbid[0] ? bidResponse.body.seatbid[0].bid : [];
-      responses = bids.map(bid => formatResponse(bid))
+      try {
+        let bids = bidResponse.body.seatbid && bidResponse.body.seatbid[0] ? bidResponse.body.seatbid[0].bid : [];
+        if (bids) {
+          bids.forEach(bidObj => {
+            let newBid = formatResponse(bidObj);
+            let mediaType = _checkMediaType(bidObj);
+            if (mediaType === BANNER) {
+              newBid.mediaType = BANNER;
+            } else if (mediaType === VIDEO) {
+              newBid.mediaType = VIDEO;
+              newBid.vastXml = bidObj.adm;
+            }
+            responses.push(newBid);
+          });
+        }
+      } catch (err) {
+        logError(err);
+      }
     }
     return responses;
   },
@@ -73,6 +120,17 @@ export const spec = {
   }
 
 };
+function _checkMediaType(bid) {
+  let videoRegex = new RegExp(/VAST\s+version/);
+  let mediaType;
+  if (bid.adm && bid.adm.indexOf('deepintent_wrapper') >= 0) {
+    mediaType = BANNER;
+  } else if (videoRegex.test(bid.adm)) {
+    mediaType = VIDEO;
+  }
+  return mediaType;
+}
+
 function clean(obj) {
   for (let propName in obj) {
     if (obj[propName] === null || obj[propName] === undefined) {
@@ -100,16 +158,55 @@ function formatResponse(bid) {
 }
 
 function buildImpression(bid) {
-  return {
+  let impression = {};
+  impression = {
     id: bid.bidId,
     tagid: bid.params.tagId || '',
     secure: window.location.protocol === 'https' ? 1 : 0,
-    banner: buildBanner(bid),
     displaymanager: 'di_prebid',
     displaymanagerver: DI_M_V,
     ext: buildCustomParams(bid)
   };
+  if (deepAccess(bid, 'mediaTypes.banner')) {
+    impression['banner'] = buildBanner(bid);
+  }
+  if (deepAccess(bid, 'mediaTypes.video')) {
+    impression['video'] = _buildVideo(bid);
+  }
+  return impression;
 }
+
+function _buildVideo(bid) {
+  const videoObj = {};
+  const videoAdUnitParams = deepAccess(bid, 'mediaTypes.video', {});
+  const videoBidderParams = deepAccess(bid, 'params.video', {});
+  const computedParams = {};
+
+  if (Array.isArray(videoAdUnitParams.playerSize)) {
+    const tempSize = (Array.isArray(videoAdUnitParams.playerSize[0])) ? videoAdUnitParams.playerSize[0] : videoAdUnitParams.playerSize;
+    computedParams.w = tempSize[0];
+    computedParams.h = tempSize[1];
+  }
+
+  const videoParams = {
+    ...computedParams,
+    ...videoAdUnitParams,
+    ...videoBidderParams
+  };
+
+  Object.keys(ORTB_VIDEO_PARAMS).forEach(paramName => {
+    if (videoParams.hasOwnProperty(paramName)) {
+      if (ORTB_VIDEO_PARAMS[paramName](videoParams[paramName])) {
+        videoObj[paramName] = videoParams[paramName];
+      } else {
+        logWarn(`The OpenRTB video param ${paramName} has been skipped due to misformating. Please refer to OpenRTB 2.5 spec.`);
+      }
+    }
+  });
+
+  return videoObj;
+};
+
 function buildCustomParams(bid) {
   if (bid.params && bid.params.custom) {
     return {

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/dgkeywordRtdProvider.js

@@ -78,7 +78,6 @@ export function getDgKeywordsAndSet(reqBidsConfigObj, callback, moduleConfig, us
       }
     }, null, {
       withCredentials: true,
-      contentType: 'application/json',
     });
     setTimeout(function () {
       if (!isFinish) {

package/modules/engageyaBidAdapter.js

@@ -0,0 +1,157 @@
+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';
+
+function getPageUrl() {
+  var pUrl = window.location.href;
+  if (isInIframe()) {
+    pUrl = document.referrer ? document.referrer : pUrl;
+  }
+  pUrl = encodeURIComponent(pUrl);
+  return pUrl;
+}
+
+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) {
+  if (!rec.trackers) {
+    return [];
+  }
+  const impressionTrackers = rec.trackers.impressionPixels || [];
+  const viewTrackers = rec.trackers.viewPixels || [];
+  return [...impressionTrackers, ...viewTrackers];
+}
+
+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),
+  };
+}
+
+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)
+    .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>`;
+}
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, NATIVE],
+  isBidRequestValid: function (bid) {
+    return bid && bid.params && bid.params.hasOwnProperty('widgetId') && bid.params.hasOwnProperty('websiteId') && !isNaN(bid.params.widgetId) && !isNaN(bid.params.websiteId);
+  },
+
+  buildRequests: function (validBidRequests, bidderRequest) {
+    var bidRequests = [];
+    if (validBidRequests && validBidRequests.length > 0) {
+      validBidRequests.forEach(function (bidRequest) {
+        if (bidRequest.params) {
+          var mediaType = bidRequest.hasOwnProperty('nativeParams') ? 1 : 2;
+          var imageWidth = -1;
+          var imageHeight = -1;
+          if (bidRequest.sizes && bidRequest.sizes.length > 0) {
+            imageWidth = bidRequest.sizes[0][0];
+            imageHeight = bidRequest.sizes[0][1];
+          } else if (bidRequest.nativeParams && bidRequest.nativeParams.image && bidRequest.nativeParams.image.sizes) {
+            imageWidth = bidRequest.nativeParams.image.sizes[0];
+            imageHeight = bidRequest.nativeParams.image.sizes[1];
+          }
+
+          var widgetId = bidRequest.params.widgetId;
+          var websiteId = bidRequest.params.websiteId;
+          var pageUrl = (bidRequest.params.pageUrl && bidRequest.params.pageUrl != '[PAGE_URL]') ? bidRequest.params.pageUrl : '';
+          if (!pageUrl) {
+            pageUrl = (bidderRequest && bidderRequest.refererInfo && bidderRequest.refererInfo.referer) ? bidderRequest.refererInfo.referer : getPageUrl();
+          }
+          var bidId = bidRequest.bidId;
+          var 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;
+          }
+          bidRequests.push({
+            url: finalUrl,
+            method: ENDPOINT_METHOD,
+            data: ''
+          });
+        }
+      });
+    }
+
+    return bidRequests;
+  },
+
+  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,
+        cpm: rec.ecpm,
+        width: response.imageWidth,
+        height: response.imageHeight,
+        creativeId: rec.postId,
+        currency: 'USD',
+        netRevenue: false,
+        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);