prebid.js 6.7.0 → 6.11.0

package/modules/displayioBidAdapter.js

@@ -0,0 +1,157 @@
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+import {BANNER, VIDEO} from '../src/mediaTypes.js';
+
+const BIDDER_VERSION = '1.0.0';
+const BIDDER_CODE = 'displayio';
+const GVLID = 999;
+const BID_TTL = 300;
+const SUPPORTED_AD_TYPES = [BANNER, VIDEO];
+const DEFAULT_CURRENCY = 'USD';
+
+export const spec = {
+  code: BIDDER_CODE,
+  gvlid: GVLID,
+  supportedMediaTypes: SUPPORTED_AD_TYPES,
+  isBidRequestValid: function(bid) {
+    return !!(bid.params && bid.params.placementId && bid.params.siteId &&
+      bid.params.adsSrvDomain && bid.params.cdnDomain);
+  },
+  buildRequests: function (bidRequests, bidderRequest) {
+    return bidRequests.map(bid => {
+      let url = '//' + bid.params.adsSrvDomain + '/srv?method=getPlacement&app=' +
+        bid.params.siteId + '&placement=' + bid.params.placementId;
+      const data = this._getPayload(bid, bidderRequest);
+      return {
+        method: 'POST',
+        headers: {'Content-Type': 'application/json;charset=utf-8'},
+        url,
+        data
+      };
+    });
+  },
+  interpretResponse: function (serverResponse, serverRequest) {
+    const ads = serverResponse.body.data.ads;
+    const bidResponses = [];
+    const { data } = serverRequest.data;
+    if (ads.length) {
+      const adData = ads[0].ad.data;
+      const bidResponse = {
+        requestId: data.id,
+        cpm: adData.ecpm,
+        width: adData.w,
+        height: adData.h,
+        netRevenue: true,
+        ttl: BID_TTL,
+        creativeId: adData.adId || 0,
+        currency: DEFAULT_CURRENCY,
+        referrer: data.data.ref,
+        mediaType: ads[0].ad.subtype,
+        ad: adData.markup,
+        placement: data.placement,
+        adData: adData
+      };
+      if (bidResponse.vastUrl === 'videoVast') {
+        bidResponse.vastUrl = adData.videos[0].url
+      }
+      bidResponses.push(bidResponse);
+    }
+    return bidResponses;
+  },
+  _getPayload: function (bid, bidderRequest) {
+    const connection = navigator.connection || navigator.mozConnection || navigator.webkitConnection;
+    const userSession = 'us_web_xxxxxxxxxxxx'.replace(/[x]/g, c => {
+      let r = Math.random() * 16 | 0;
+      let v = c === 'x' ? r : (r & 0x3 | 0x8);
+      return v.toString(16);
+    });
+    const { params } = bid;
+    const { siteId, placementId } = params;
+    const { refererInfo, uspConsent, gdprConsent } = bidderRequest;
+    const mediation = {consent: '-1', gdpr: '-1'};
+    if (gdprConsent) {
+      if (gdprConsent.consentString !== undefined) {
+        mediation.consent = gdprConsent.consentString;
+      }
+      if (gdprConsent.gdprApplies !== undefined) {
+        mediation.gdpr = gdprConsent.gdprApplies ? '1' : '0';
+      }
+    }
+    const payload = {
+      userSession,
+      data: {
+        id: bid.bidId,
+        action: 'getPlacement',
+        app: siteId,
+        placement: placementId,
+        data: {
+          pagecat: params.pageCategory ? params.pageCategory.split(',').map(k => k.trim()) : [],
+          keywords: params.keywords ? params.keywords.split(',').map(k => k.trim()) : [],
+          lang_content: document.documentElement.lang,
+          lang: window.navigator.language,
+          domain: window.location.hostname,
+          page: window.location.href,
+          ref: refererInfo.referer,
+          userids: _getUserIDs(),
+          geo: '',
+        },
+        complianceData: {
+          child: '-1',
+          us_privacy: uspConsent,
+          dnt: window.navigator.doNotTrack,
+          iabConsent: {},
+          mediation: {
+            consent: mediation.consent,
+            gdpr: mediation.gdpr,
+          }
+        },
+        integration: 'JS',
+        omidpn: 'Displayio',
+        mediationPlatform: 0,
+        prebidVersion: BIDDER_VERSION,
+        device: {
+          w: window.screen.width,
+          h: window.screen.height,
+          connection_type: connection ? connection.effectiveType : '',
+        }
+      }
+    }
+    if (navigator.permissions) {
+      navigator.permissions.query({ name: 'geolocation' })
+        .then((result) => {
+          if (result.state === 'granted') {
+            payload.data.data.geo = _getGeoData();
+          }
+        });
+    }
+    return payload
+  }
+};
+
+function _getUserIDs () {
+  let ids = {};
+  try {
+    ids = window.owpbjs.getUserIdsAsEids();
+  } catch (e) {}
+  return ids;
+}
+
+async function _getGeoData () {
+  let geoData = null;
+  const getCurrentPosition = () => {
+    return new Promise((resolve, reject) =>
+      navigator.geolocation.getCurrentPosition(resolve, reject)
+    );
+  }
+  try {
+    const position = await getCurrentPosition();
+    let {latitude, longitude, accuracy} = position.coords;
+    geoData = {
+      'lat': latitude,
+      'lng': longitude,
+      'precision': accuracy
+    };
+  } catch (e) {}
+  return geoData
+}
+
+registerBidder(spec);

package/modules/displayioBidAdapter.md

@@ -0,0 +1,148 @@
+# Overview
+
+```
+Module Name: DisplayIO Bidder Adapter
+Module Type: Bidder Adapter
+```
+
+# Description
+
+Module that connects to display.io's demand sources.
+Web mobile (not relevant for web desktop).
+
+
+#Features
+| Feature       |                                                         | Feature               |     |
+|---------------|---------------------------------------------------------|-----------------------|-----|
+| Bidder Code   | displayio                                               | Prebid member         | no  |
+| Media Types   | Banner, video. <br/>Sizes (display 320x480 / vertical video) | GVL ID                | no  | 
+| GDPR Support  | yes                                                     | Prebid.js Adapter     | yes |
+| USP Support   | yes                                                     | Prebid Server Adapter | no  |
+
+
+#Global configuration
+```javascript
+<head>
+  <script src="https://cdn.display.io/webis/webis.min.js"></script>
+</head>
+<script>
+    ......................................  
+    var CMP_TIMEOUT = 8000;
+    var consentManagement = {
+    gdpr: {
+       cmpApi: 'iab',
+       timeout: CMP_TIMEOUT,
+       defaultGdprScope: true
+    },
+    usp: {
+       cmpApi: 'iab',
+       timeout: CMP_TIMEOUT
+     }
+    }
+    
+    if (typeof __tcfapi !== 'function') {
+       delete consentManagement.gdpr;
+    }
+    
+    pbjs.que.push(function() {
+       pbjs.setConfig({consentManagement})
+    });
+    
+    
+    ......................................
+    
+    function initAdserver(bidResponses) {
+      if (pbjs.initAdserverSet) return;
+      pbjs.initAdserverSet = true;
+    
+      ...........................
+    
+      const displayioBids = getDisplayioBid(bidResponses)
+      displayioBids.forEach(b => {
+          const {adData, placement} = b[1].bids[0];
+          webis.init(adData, b[0], {placement})
+      })
+    
+    }
+    
+    function getDisplayioBid(bidResponses) {
+      const codes = adUnits.map(u => u.code);
+      const bids = Object.entries(bidResponses);
+      bids.filter(([key, value]) => codes.includes(key) && value.bids[0].bidderCode === 'displayio');
+      return bids;
+    }
+
+    ......................................
+
+```
+
+
+# Bid Parameters
+
+| Name  | Scope | Type | Description                            | Example                       |
+|----------------| ----- | ---- |----------------------------------------|-------------------------------|
+| `siteId`       | required | Number | SiteId and PlacementID are your inventory IDs on the display.io platform (please ask your Account Manager for your site and placement IDs). | 7753                          |
+| `placementId`  | required | Number | SiteId and PlacementID are your inventory IDs on the display.io platform (please ask your Account Manager for your site and placement IDs).                                       | 5375                          |
+| `adsSrvDomain` | required | String |                                        | "appsrv.display.io"           |
+| `cdnDomain`    | required | String |                                        | "cdn.display.io"              |
+| `pageCategory` | optional | String | Comma-separated list of IAB content categories that describe the current page or view of the site, list of available values. | "pageCategory1, pageCategory2" |
+| `keywords`     | optional | String | Comma-separated list of keywords describing the content. | "keyword1, keyword2, keyword3" |
+| `custom`       | optional | Object | User-defined targeting key-value pairs. custom applies to a specific unit. | `{headerTextColor: "red", fixedHeaderSelector: '.site-header'}` |
+| `custom.headerText`| optional | String | Ad container header text. By default, text is "Scroll to continue with content". Limited to 50 characters. | "Our awesome advertisement"|
+| `custom.headerTextColor`| optional | String | Ad container header text color, "white" by default | "#2196f3"|
+| `custom.headerBackgroundColor`| optional | String | Ad container header background color, "black" by default | "#fff" |
+| `custom.adContainerBackgroundColor`| optional | String | Ad container body background color, "transparent" by default | "#000"|
+| `custom.fixedHeaderSelector`| optional | String | In case your webpage has a fixed header – the header Id attribute or header class attribute should be defined as a value for parameter fixedHeaderSelector. | ".site-header"|
+
+# adUnit configuration example
+```javascript
+var adUnits = [
+  {
+    code: 'ad-tag-1',
+    mediaTypes: {
+      banner: {
+        sizes: [[320, 480]]
+      },
+      video: {
+        sizes: [[360, 640]]
+      },
+    },
+    bids: [
+      {
+        bidder: 'displayio',
+        params: {
+          siteId: 1,
+          placementId: 1,
+          adsSrvDomain: 'appsrv.display.io',
+          cdnDomain: 'cdn.display.io',
+          pageCategory: 'pageCategory1, pageCategory2', //comma separated
+          keywords: 'keyword1, keyword2, keyword3', //comma separated
+          custom: {
+            headerText: 'Our awesome advertisement',
+            headerTextColor: '#2196f3',
+            headerBackgroundColor: 'black',
+            adContainerBackgroundColor: 'transparent',
+            fixedHeaderSelector: '.site-header',
+          },
+        }
+      }
+    ]
+  },
+  // minimal required options
+  {
+    code: 'ad-tag-2',
+    bids: [{
+      bidder: 'displayio',
+      params: {
+        siteId: 1,
+        placementId: 1,
+        adsSrvDomain: 'appsrv.display.io',
+        cdnDomain: 'cdn.display.io',
+      }
+    }]
+  }
+];
+```
+
+# Additional Details
+[Mobile web prebid.js integration](https://www.display.io/documentation/mobile-web-prebid-js-integration/)

package/modules/dspxBidAdapter.js

@@ -6,7 +6,6 @@ import { BANNER, VIDEO } from '../src/mediaTypes.js';
 const BIDDER_CODE = 'dspx';
 const ENDPOINT_URL = 'https://buyer.dspx.tv/request/';
 const ENDPOINT_URL_DEV = 'https://dcbuyer.dspx.tv/request/';
-const DEFAULT_VAST_FORMAT = 'vast2';
 const GVLID = 602;
 
 export const spec = {
@@ -26,37 +25,30 @@ export const spec = {
       const referrer = bidderRequest.refererInfo.referer;
       const bidId = bidRequest.bidId;
       const isDev = params.devMode || false;
+      const pbcode = bidRequest.adUnitCode || false; // div id
+      const auctionId = bidRequest.auctionId || false;
 
       let endpoint = isDev ? ENDPOINT_URL_DEV : ENDPOINT_URL;
-      let payload = {};
 
-      if (isBannerRequest(bidRequest)) {
-        let size = getBannerSizes(bidRequest)[0];
-        payload = {
-          _f: 'html',
-          alternative: 'prebid_js',
-          inventory_item_id: placementId,
-          srw: size.width,
-          srh: size.height,
-          idt: 100,
-          rnd: rnd,
-          ref: referrer,
-          bid_id: bidId,
-        };
-      } else {
-        let size = getVideoSizes(bidRequest)[0];
-        let vastFormat = params.vastFormat || DEFAULT_VAST_FORMAT;
-        payload = {
-          _f: vastFormat,
-          alternative: 'prebid_js',
-          inventory_item_id: placementId,
-          srw: size.width,
-          srh: size.height,
-          idt: 100,
-          rnd: rnd,
-          ref: referrer,
-          bid_id: bidId,
-        };
+      let mediaTypesInfo = getMediaTypesInfo(bidRequest);
+      let type = isBannerRequest(bidRequest) ? BANNER : VIDEO;
+      let sizes = mediaTypesInfo[type];
+
+      let payload = {
+        _f: 'auto',
+        alternative: 'prebid_js',
+        inventory_item_id: placementId,
+        srw: sizes ? sizes[0].width : 0,
+        srh: sizes ? sizes[0].height : 0,
+        idt: 100,
+        rnd: rnd,
+        ref: referrer,
+        bid_id: bidId,
+        pbver: '$prebid.version$'
+      };
+
+      if (mediaTypesInfo[VIDEO] !== undefined && params.vastFormat !== undefined) {
+        payload.vf = params.vastFormat;
       }
 
       if (params.pfilter !== undefined) {
@@ -94,6 +86,15 @@ export const spec = {
         payload.did_uid2 = bidRequest.userId.uid2;
       }
 
+      if (auctionId) {
+        payload.auctionId = auctionId;
+      }
+      if (pbcode) {
+        payload.pbcode = pbcode;
+      }
+
+      payload.media_types = convertMediaInfoForRequest(mediaTypesInfo);
+
       return {
         method: 'GET',
         url: endpoint,
@@ -256,4 +257,43 @@ function parseSizes(sizes) {
   return [parseSize(sizes)]; // or a single one ? (ie. [728,90])
 }
 
+/**
+ * Get MediaInfo object for server request
+ *
+ * @param mediaTypesInfo
+ * @returns {*}
+ */
+function convertMediaInfoForRequest(mediaTypesInfo) {
+  let requestData = {};
+  Object.keys(mediaTypesInfo).forEach(mediaType => {
+    requestData[mediaType] = mediaTypesInfo[mediaType].map(size => {
+      return size.width + 'x' + size.height;
+    }).join(',');
+  });
+  return requestData;
+}
+
+/**
+ * Get media types info
+ *
+ * @param bid
+ */
+function getMediaTypesInfo(bid) {
+  let mediaTypesInfo = {};
+
+  if (bid.mediaTypes) {
+    Object.keys(bid.mediaTypes).forEach(mediaType => {
+      if (mediaType === BANNER) {
+        mediaTypesInfo[mediaType] = getBannerSizes(bid);
+      }
+      if (mediaType === VIDEO) {
+        mediaTypesInfo[mediaType] = getVideoSizes(bid);
+      }
+    });
+  } else {
+    mediaTypesInfo[BANNER] = getBannerSizes(bid);
+  }
+  return mediaTypesInfo;
+}
+
 registerBidder(spec);

package/modules/dspxBidAdapter.md

@@ -57,7 +57,8 @@ DSPx adapter for Prebid.
             bids: [{
                 bidder: 'dspx',
                 params: {
-                    placement: '106'
+                    placement: '106',
+                    vastFormat: 'vast2|vast4' // set vast format
                 }
             }]
         }

package/modules/e_volutionBidAdapter.js

@@ -0,0 +1,158 @@
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
+import { isFn, deepAccess, logMessage } from '../src/utils.js';
+
+const BIDDER_CODE = 'e_volution';
+const AD_URL = 'https://service.e-volution.ai/?c=o&m=multi';
+const URL_SYNC = 'https://service.e-volution.ai/?c=o&m=sync';
+const NO_SYNC = true;
+
+function isBidResponseValid(bid) {
+  if (!bid.requestId || !bid.cpm || !bid.creativeId ||
+    !bid.ttl || !bid.currency) {
+    return false;
+  }
+  switch (bid.mediaType) {
+    case BANNER:
+      return Boolean(bid.width && bid.height && bid.ad);
+    case VIDEO:
+      return Boolean(bid.vastUrl);
+    case NATIVE:
+      return Boolean(bid.native && bid.native.title && bid.native.image && bid.native.impressionTrackers);
+    default:
+      return false;
+  }
+}
+
+function getBidFloor(bid) {
+  if (!isFn(bid.getFloor)) {
+    return deepAccess(bid, 'params.bidfloor', 0);
+  }
+
+  try {
+    const bidFloor = bid.getFloor({
+      currency: 'USD',
+      mediaType: '*',
+      size: '*',
+    });
+    return bidFloor.floor;
+  } catch (_) {
+    return 0
+  }
+}
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, VIDEO, NATIVE],
+  noSync: NO_SYNC,
+
+  isBidRequestValid: (bid) => {
+    return Boolean(bid.bidId && bid.params && !isNaN(parseInt(bid.params.placementId)));
+  },
+
+  buildRequests: (validBidRequests = [], bidderRequest) => {
+    let winTop = window;
+    let location;
+    try {
+      location = new URL(bidderRequest.refererInfo.referer)
+      winTop = window.top;
+    } catch (e) {
+      location = winTop.location;
+      logMessage(e);
+    };
+    let placements = [];
+    let request = {
+      'deviceWidth': winTop.screen.width,
+      'deviceHeight': winTop.screen.height,
+      'language': (navigator && navigator.language) ? navigator.language.split('-')[0] : '',
+      'secure': 1,
+      'host': location.host,
+      'page': location.pathname,
+      'placements': placements
+    };
+    if (bidderRequest) {
+      if (bidderRequest.uspConsent) {
+        request.ccpa = bidderRequest.uspConsent;
+      }
+      if (bidderRequest.gdprConsent) {
+        request.gdpr = bidderRequest.gdprConsent
+      }
+    }
+    const len = validBidRequests.length;
+
+    for (let i = 0; i < len; i++) {
+      let bid = validBidRequests[i];
+
+      const placement = {
+        placementId: bid.params.placementId,
+        bidId: bid.bidId,
+        bidfloor: getBidFloor(bid)
+      }
+
+      if (bid.mediaTypes && bid.mediaTypes[BANNER] && bid.mediaTypes[BANNER].sizes) {
+        placement.traffic = BANNER;
+        placement.sizes = bid.mediaTypes[BANNER].sizes;
+      } else if (bid.mediaTypes && bid.mediaTypes[VIDEO] && bid.mediaTypes[VIDEO].playerSize) {
+        placement.traffic = VIDEO;
+        placement.wPlayer = bid.mediaTypes[VIDEO].playerSize[0];
+        placement.hPlayer = bid.mediaTypes[VIDEO].playerSize[1];
+        placement.minduration = bid.mediaTypes[VIDEO].minduration;
+        placement.maxduration = bid.mediaTypes[VIDEO].maxduration;
+        placement.mimes = bid.mediaTypes[VIDEO].mimes;
+        placement.protocols = bid.mediaTypes[VIDEO].protocols;
+        placement.startdelay = bid.mediaTypes[VIDEO].startdelay;
+        placement.placement = bid.mediaTypes[VIDEO].placement;
+        placement.skip = bid.mediaTypes[VIDEO].skip;
+        placement.skipafter = bid.mediaTypes[VIDEO].skipafter;
+        placement.minbitrate = bid.mediaTypes[VIDEO].minbitrate;
+        placement.maxbitrate = bid.mediaTypes[VIDEO].maxbitrate;
+        placement.delivery = bid.mediaTypes[VIDEO].delivery;
+        placement.playbackmethod = bid.mediaTypes[VIDEO].playbackmethod;
+        placement.api = bid.mediaTypes[VIDEO].api;
+        placement.linearity = bid.mediaTypes[VIDEO].linearity;
+      } else if (bid.mediaTypes && bid.mediaTypes[NATIVE]) {
+        placement.traffic = NATIVE;
+        placement.native = bid.mediaTypes[NATIVE];
+      }
+
+      if (bid.schain) {
+        placements.schain = bid.schain;
+      }
+
+      placements.push(placement);
+    }
+    return {
+      method: 'POST',
+      url: AD_URL,
+      data: request
+    };
+  },
+
+  interpretResponse: (serverResponse) => {
+    let response = [];
+    for (let i = 0; i < serverResponse.body.length; i++) {
+      let resItem = serverResponse.body[i];
+      if (isBidResponseValid(resItem)) {
+        const advertiserDomains = resItem.adomain && resItem.adomain.length ? resItem.adomain : [];
+        resItem.meta = { ...resItem.meta, advertiserDomains };
+
+        response.push(resItem);
+      }
+    }
+    return response;
+  },
+
+  getUserSyncs: (syncOptions, serverResponses) => {
+    if (NO_SYNC) {
+      return false
+    } else {
+      return [{
+        type: 'image',
+        url: URL_SYNC
+      }];
+    }
+  }
+
+};
+
+registerBidder(spec);

package/modules/gridBidAdapter.js

@@ -1,4 +1,4 @@
-import { isEmpty, deepAccess, logError, parseGPTSingleSizeArrayToRtbSize, generateUUID, logWarn } from '../src/utils.js';
+import { isEmpty, deepAccess, logError, parseGPTSingleSizeArrayToRtbSize, generateUUID, mergeDeep, logWarn } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { Renderer } from '../src/Renderer.js';
 import { VIDEO, BANNER } from '../src/mediaTypes.js';
@@ -173,10 +173,24 @@ export const spec = {
       };
     }
 
+    const ortb2UserData = config.getConfig('ortb2.user.data');
+    if (ortb2UserData && ortb2UserData.length) {
+      if (!user) {
+        user = { data: [] };
+      }
+      user = mergeDeep(user, { data: ortb2UserData });
+    }
+
     if (gdprConsent && gdprConsent.consentString) {
       userExt = {consent: gdprConsent.consentString};
     }
 
+    const ortb2UserExtDevice = config.getConfig('ortb2.user.ext.device');
+    if (ortb2UserExtDevice) {
+      userExt = userExt || {};
+      userExt.device = { ...ortb2UserExtDevice };
+    }
+
     if (userIdAsEids && userIdAsEids.length) {
       userExt = userExt || {};
       userExt.eids = [...userIdAsEids];