prebid.js 7.10.0 → 7.13.0

package/modules/datawrkzBidAdapter.md

@@ -0,0 +1,160 @@
+# Overview
+
+```
+Module Name:  Datawrkz Bid Adapter
+Module Type:  Bidder Adapter
+Maintainer:  pubops@datawrkz.com
+```
+
+# Description
+
+Module that connects to Datawrkz's demand sources. 
+Datawrkz bid adapter supports Banner, Video (instream and outstream) and Native ad units.
+
+# Bid Parameters
+
+| Name | Scope | Type | Description | Example
+| ---- | ----- | ---- | ----------- | -------
+| `site_id` | required | String | Site id  | "test_site_id"
+| `deals` | optional | Array<Deal> | Array of deal objects | `[{id: "deal_1"},{id: "deal_2"}]`
+| `bidfloor` | optional | Float | Minimum bid for this impression expressed in CPM | `0.5`
+| `outstreamType` | optional | String | Type of outstream video to the played. Available options: inline, slider_top_left, slider_top_right, slider_bottom_left, slider_bottom_right, interstitial_close, and listicle | "inline"
+| `outstreamConfig` | optional | Object | Configuration settings for outstream ad unit | `{ad_unit_audio: 1, show_player_close_button_after: 5, hide_player_control: 0}`
+
+# Deal Object
+| Name | Scope | Type | Description | Example
+| ---- | ----- | ---- | ----------- | -------
+| `id` | required | String | Deal id  | "test_deal_id"
+
+# outstreamConfig
+| Name | Scope | Type | Description | Example
+| ---- | ----- | ---- | ----------- | -------
+| `ad_unit_audio` | optional | Integer | Set default audio option for the player. 0 to play audio on hover and 2 to mute | `0` or `2`
+| `show_player_close_button_after` | optional | Integer | Show player close button after specified seconds | `5`
+| `hide_player_control` | optional | Integer | Show/hide player controls. 0 to show player controls and 1 to hide | `1`
+
+# Test Parameters
+```
+var adUnits = [
+   // Banner adUnit
+   {
+      code: 'banner-div',
+      mediaTypes: {
+        banner: {
+          sizes: [[300, 250], [300,600]]
+        }
+      },
+      bids: [{
+         bidder: 'datawrkz',
+         params: {
+           site_id: 'site_id',
+           bidfloor: 0.5
+         }
+       }]
+   },
+   // Native adUnit
+   {
+      code: 'native-div',
+      sizes: [[1, 1]],
+      mediaTypes: {
+        native: {
+          title: {
+            required: true,
+            len: 80
+          },
+          image: {
+            required: true,
+            sizes: [300, 250]
+          },
+          icon: {
+            required: true,
+            sizes: [50, 50]
+          },
+          body: {
+            required: true,
+            len: 800
+          },
+          sponsoredBy: {
+            required: true
+          },
+          cta: {
+            required: true
+          }
+        }
+      },
+      bids: [{
+        bidder: 'datawrkz',
+        params: {
+          site_id: 'site_id',
+           bidfloor: 0.5
+        }
+      }]
+   },
+   // Video instream adUnit
+   {
+      code: 'video-instream',
+      sizes: [[640, 480]],
+      mediaTypes: {
+        video: {
+          playerSize: [[640, 480]],
+          context: 'instream',
+          api: [1, 2],
+          mimes: ["video/x-ms-wmv", "video/mp4"],
+          protocols: [1, 2, 3],
+          playbackmethod: [1, 2],
+          minduration: 20,
+          maxduration: 30,
+          startdelay: 5,
+          minbitrate: 300,
+          maxbitrate: 1500,
+          delivery: [2],
+          linearity: 1
+        },
+      },
+      bids: [{
+        bidder: 'datawrkz',
+        params: {
+          site_id: 'site_id',
+          bidfloor: 0.5
+        }
+      }]
+   },
+   // Video outstream adUnit
+   {
+     code: 'video-outstream',
+     sizes: [[300, 250]],
+     mediaTypes: {
+       video: {
+         playerSize: [[300, 250]],
+         context: 'outstream',
+         api: [1, 2],
+         mimes: ["video/mp4"],
+         protocols: [1, 2, 3],
+         playbackmethod: [1, 2],
+         minduration: 20,
+         maxduration: 30,
+         startdelay: 5,
+         minbitrate: 300,
+         maxbitrate: 1500,
+         delivery: [2],
+         linearity: 1
+       }
+     },
+     bids: [
+       {
+         bidder: 'datawrkz',
+         params: {
+           site_id: 'site_id',
+           bidfloor: 0.5,
+           outstreamType: 'slider_top_left',          //Supported types : inline, slider_top_left, slider_top_right, slider_bottom_left, slider_bottom_right, interstitial_close, listicle
+           outstreamConfig: {
+            ad_unit_audio: 1,                       // 0: audio on hover, 2: always muted
+            show_player_close_button_after: 5,     // show close button after 5 seconds
+            hide_player_control: 0                // 0 to show/ 1 to hide
+           }
+         }
+       }
+     ]
+   }
+];
+```

package/modules/dfpAdServerVideo.js

@@ -91,7 +91,7 @@ export function buildDfpVideoUrl(options) {
   };
 
   const urlSearchComponent = urlComponents.search;
-  const urlSzParam = urlSearchComponent && urlSearchComponent.sz
+  const urlSzParam = urlSearchComponent && urlSearchComponent.sz;
   if (urlSzParam) {
     derivedParams.sz = urlSzParam + '|' + derivedParams.sz;
   }
@@ -186,7 +186,7 @@ export function buildAdpodVideoUrl({code, params, callback} = {}) {
     let initialValue = {
       [adpodUtils.TARGETING_KEY_PB_CAT_DUR]: undefined,
       [adpodUtils.TARGETING_KEY_CACHE_ID]: undefined
-    }
+    };
     let customParams = {};
     if (targeting[code]) {
       customParams = targeting[code].reduce((acc, curValue) => {

package/modules/dgkeywordRtdProvider.js

@@ -25,6 +25,15 @@ export function getDgKeywordsAndSet(reqBidsConfigObj, callback, moduleConfig, us
   const timeout = (moduleConfig && moduleConfig.params && moduleConfig.params.timeout && Number(moduleConfig.params.timeout) > 0) ? Number(moduleConfig.params.timeout) : PROFILE_TIMEOUT_MS;
   const url = (moduleConfig && moduleConfig.params && moduleConfig.params.url) ? moduleConfig.params.url : URL + encodeURIComponent(window.location.href);
   const adUnits = reqBidsConfigObj.adUnits || getGlobal().adUnits;
+  callback = (function(cb) {
+    let done = false;
+    return function () {
+      if (!done) {
+        done = true;
+        return cb.apply(this, arguments);
+      }
+    }
+  })(callback);
   let isFinish = false;
   logMessage('[dgkeyword sub module]', adUnits, timeout);
   let setKeywordTargetBidders = getTargetBidderOfDgKeywords(adUnits);
@@ -48,7 +57,7 @@ export function getDgKeywordsAndSet(reqBidsConfigObj, callback, moduleConfig, us
               keywords['opectx'] = res['t'];
             }
             if (Object.keys(keywords).length > 0) {
-              const targetBidKeys = {}
+              const targetBidKeys = {};
               for (let bid of setKeywordTargetBidders) {
                 // set keywords to params
                 bid.params.keywords = keywords;

package/modules/displayioBidAdapter.js

@@ -1,16 +1,16 @@
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER, VIDEO} from '../src/mediaTypes.js';
+import {Renderer} from '../src/Renderer.js';
+import {getWindowFromDocument, logWarn} from '../src/utils.js';
 
-const BIDDER_VERSION = '1.0.0';
+const ADAPTER_VERSION = '1.1.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 &&
@@ -20,7 +20,7 @@ export const spec = {
     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);
+      const data = getPayload(bid, bidderRequest);
       return {
         method: 'POST',
         headers: {'Content-Type': 'application/json;charset=utf-8'},
@@ -42,117 +42,112 @@ export const spec = {
         height: adData.h,
         netRevenue: true,
         ttl: BID_TTL,
-        creativeId: adData.adId || 0,
-        currency: DEFAULT_CURRENCY,
+        creativeId: adData.adId || 1,
+        currency: adData.cur || DEFAULT_CURRENCY,
         referrer: data.data.ref,
-        mediaType: ads[0].ad.subtype,
+        mediaType: ads[0].ad.subtype === 'videoVast' ? VIDEO : BANNER,
         ad: adData.markup,
-        placement: data.placement,
+        adUnitCode: data.adUnitCode,
+        renderURL: data.renderURL,
         adData: adData
       };
-      if (bidResponse.vastUrl === 'videoVast') {
-        bidResponse.vastUrl = adData.videos[0].url
+
+      if (bidResponse.mediaType === VIDEO) {
+        bidResponse.vastUrl = adData.videos[0] && adData.videos[0].url
+      }
+
+      if (bidResponse.renderURL) {
+        bidResponse.renderer = newRenderer(bidResponse);
       }
       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';
-      }
+  }
+};
+
+function getPayload (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, adUnitCode, bidId } = bid;
+  const { siteId, placementId, renderURL, pageCategory, keywords } = params;
+  const { refererInfo, uspConsent, gdprConsent } = bidderRequest;
+  const mediation = {consent: '-1', gdpr: '-1'};
+  if (gdprConsent && 'gdprApplies' in gdprConsent) {
+    if (gdprConsent.consentString !== undefined) {
+      mediation.consent = gdprConsent.consentString;
     }
-    const payload = {
-      userSession,
+    if (gdprConsent.gdprApplies !== undefined) {
+      mediation.gdpr = gdprConsent.gdprApplies ? '1' : '0';
+    }
+  }
+  return {
+    userSession,
+    data: {
+      id: bidId,
+      action: 'getPlacement',
+      app: siteId,
+      placement: placementId,
+      adUnitCode,
+      renderURL,
       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,
-          // TODO: are these the correct refererInfo values?
-          domain: refererInfo.domain,
-          page: refererInfo.page,
-          ref: refererInfo.ref,
-          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 : '',
+        pagecat: pageCategory ? pageCategory.split(',').map(k => k.trim()) : [],
+        keywords: keywords ? keywords.split(',').map(k => k.trim()) : [],
+        lang_content: document.documentElement.lang,
+        lang: window.navigator.language,
+        domain: refererInfo.domain,
+        page: refererInfo.page,
+        ref: refererInfo.referer,
+        userids: bid.userIdAsEids || {},
+        geo: '',
+      },
+      complianceData: {
+        child: '-1',
+        us_privacy: uspConsent,
+        dnt: window.doNotTrack === '1' || window.navigator.doNotTrack === '1' || false,
+        iabConsent: {},
+        mediation: {
+          consent: mediation.consent,
+          gdpr: mediation.gdpr,
         }
+      },
+      integration: 'JS',
+      omidpn: 'Displayio',
+      mediationPlatform: 0,
+      prebidVersion: ADAPTER_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 newRenderer(bid) {
+  const renderer = Renderer.install({
+    id: bid.requestId,
+    url: bid.renderURL,
+    adUnitCode: bid.adUnitCode
+  });
 
-function _getUserIDs () {
-  let ids = {};
   try {
-    ids = window.owpbjs.getUserIdsAsEids();
-  } catch (e) {}
-  return ids;
+    renderer.setRender(webisRender);
+  } catch (err) {
+    logWarn('Prebid Error calling setRender on renderer', err);
+  }
+
+  return renderer;
 }
 
-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
+function webisRender(bid, doc) {
+  bid.renderer.push(() => {
+    const win = getWindowFromDocument(doc) || window;
+    win.webis.init(bid.adData, bid.adUnitCode, bid.params);
+  })
 }
 
 registerBidder(spec);

package/modules/dspxBidAdapter.js

@@ -99,7 +99,7 @@ export const spec = {
         method: 'GET',
         url: endpoint,
         data: objectToQueryString(payload),
-      }
+      };
     });
   },
   interpretResponse: function(serverResponse, bidRequest) {

package/modules/e_volutionBidAdapter.js

@@ -72,7 +72,7 @@ export const spec = {
     let location;
     // TODO: this odd try-catch block was copied in several adapters; it doesn't seem to be correct for cross-origin
     try {
-      location = new URL(bidderRequest.refererInfo.page)
+      location = new URL(bidderRequest.refererInfo.page);
       winTop = window.top;
     } catch (e) {
       location = winTop.location;
@@ -93,7 +93,7 @@ export const spec = {
         request.ccpa = bidderRequest.uspConsent;
       }
       if (bidderRequest.gdprConsent) {
-        request.gdpr = bidderRequest.gdprConsent
+        request.gdpr = bidderRequest.gdprConsent;
       }
     }
     const len = validBidRequests.length;
@@ -106,7 +106,7 @@ export const spec = {
         bidId: bid.bidId,
         bidfloor: getBidFloor(bid),
         eids: []
-      }
+      };
 
       if (bid.userId) {
         getUserId(placement.eids, bid.userId.id5id, 'id5-sync.com');

package/modules/ebdrBidAdapter.js

@@ -31,7 +31,7 @@ export const spec = {
           h: whArr[1]
         },
         bidfloor: bidFloor
-      })
+      });
       ebdrReq[bid.bidId] = {mediaTypes: _mediaTypes,
         w: whArr[0],
         h: whArr[1]

package/modules/emx_digitalBidAdapter.js

@@ -287,7 +287,7 @@ export const spec = {
     emxData = emxAdapter.getGdpr(bidderRequest, Object.assign({}, emxData));
     emxData = emxAdapter.getSupplyChain(bidderRequest, Object.assign({}, emxData));
     if (bidderRequest && bidderRequest.uspConsent) {
-      emxData.us_privacy = bidderRequest.uspConsent
+      emxData.us_privacy = bidderRequest.uspConsent;
     }
 
     // adding eid support

package/modules/enrichmentFpdModule.js

@@ -124,6 +124,16 @@ function setKeywords() {
   if (keywords && keywords.content) mergeDeep(ortb2, { site: { keywords: keywords.content.replace(/\s/g, '') } });
 }
 
+/**
+ * Checks the Global Privacy Control status, and if exists and is true, merges into regs.ext.gpc
+ */
+function setGpc() {
+  const gpcValue = navigator.globalPrivacyControl;
+  if (gpcValue) {
+    mergeDeep(ortb2, { regs: { ext: { gpc: 1 } } })
+  }
+}
+
 /**
  * Resets modules global ortb2 data
  */
@@ -135,6 +145,7 @@ function runEnrichments() {
   setDomain();
   setDimensions();
   setKeywords();
+  setGpc();
 
   return ortb2;
 }

package/modules/fabrickIdSystem.js

@@ -70,7 +70,7 @@ export const fabrickIdSubmodule = {
           }
         }
         // pull off the trailing &
-        url = url.slice(0, -1)
+        url = url.slice(0, -1);
         const referer = _getRefererInfo(configParams);
         const refs = new Map();
         _setReferrer(refs, referer.topmostLocation);
@@ -174,7 +174,7 @@ export function appendUrl(url, paramName, s, configParams) {
         s = s.substring(0, thisMaxRefLen - 2);
       }
     }
-    return `${url}${s}`
+    return `${url}${s}`;
   } else {
     return url;
   }

package/modules/gamoshiBidAdapter.js

@@ -259,7 +259,7 @@ export const spec = {
     let gdpr = gdprApplies ? 1 : 0;
 
     if (gdprApplies && gdprConsent.consentString) {
-      consentString = encodeURIComponent(gdprConsent.consentString)
+      consentString = encodeURIComponent(gdprConsent.consentString);
     }
 
     if (uspConsent) {

package/modules/getintentBidAdapter.js

@@ -97,7 +97,7 @@ export const spec = {
     return bids;
   }
 
-}
+};
 
 function buildUrl(bid) {
   return 'https://' + BID_HOST + (bid.is_video ? BID_VIDEO_PATH : BID_BANNER_PATH);

package/modules/gjirafaBidAdapter.js

@@ -74,7 +74,7 @@ export const spec = {
       placements: placements,
       contents: contents,
       data: data
-    }
+    };
 
     return [{
       method: 'POST',
@@ -113,7 +113,7 @@ export const spec = {
     }
     return bidResponses;
   }
-}
+};
 
 /**
 * Generate size param for bid request using sizes array

package/modules/goldbachBidAdapter.js

@@ -207,7 +207,7 @@ export const spec = {
       payload['iab_support'] = {
         omidpn: 'Appnexus',
         omidpv: '$prebid.version$'
-      }
+      };
     }
 
     if (member > 0) {
@@ -215,7 +215,7 @@ export const spec = {
     }
 
     if (appDeviceObjBid) {
-      payload.device = appDeviceObj
+      payload.device = appDeviceObj;
     }
     if (appIdObjBid) {
       payload.app = appIdObj;
@@ -246,7 +246,7 @@ export const spec = {
     }
 
     if (bidderRequest && bidderRequest.uspConsent) {
-      payload.us_privacy = bidderRequest.uspConsent
+      payload.us_privacy = bidderRequest.uspConsent;
     }
 
     if (bidderRequest && bidderRequest.refererInfo) {
@@ -256,7 +256,7 @@ export const spec = {
         rd_top: bidderRequest.refererInfo.reachedTop,
         rd_ifs: bidderRequest.refererInfo.numIframes,
         rd_stk: bidderRequest.refererInfo.stack.map((url) => encodeURIComponent(url)).join(',')
-      }
+      };
       payload.referrer_detection = refererinfo;
     }
 
@@ -441,7 +441,7 @@ export const spec = {
       reloadViewabilityScriptWithCorrectParameters(bid);
     }
   }
-}
+};
 
 function isPopulatedArray(arr) {
   return !!(isArray(arr) && arr.length > 0);
@@ -459,7 +459,7 @@ function reloadViewabilityScriptWithCorrectParameters(bid) {
   if (viewJsPayload) {
     let prebidParams = 'pbjs_adid=' + bid.adId + ';pbjs_auc=' + bid.adUnitCode;
 
-    let jsTrackerSrc = getViewabilityScriptUrlFromPayload(viewJsPayload)
+    let jsTrackerSrc = getViewabilityScriptUrlFromPayload(viewJsPayload);
 
     let newJsTrackerSrc = jsTrackerSrc.replace('dom_id=%native_dom_id%', prebidParams);
 
@@ -553,7 +553,7 @@ function formatRequest(payload, bidderRequest) {
   if (getParameterByName('apn_test').toUpperCase() === 'TRUE' || config.getConfig('apn_test') === true) {
     options.customHeaders = {
       'X-Is-Test': 1
-    }
+    };
   }
 
   if (payload.tags.length > MAX_IMPS_PER_REQUEST) {
@@ -766,7 +766,7 @@ function bidToTag(bid) {
     tag.code = bid.params.invCode;
   }
   tag.allow_smaller_sizes = bid.params.allowSmallerSizes || false;
-  tag.use_pmt_rule = bid.params.usePaymentRule || false
+  tag.use_pmt_rule = bid.params.usePaymentRule || false;
   tag.prebid = true;
   tag.disable_psa = true;
   let bidFloor = getBidFloor(bid);

package/modules/gothamadsBidAdapter.js

@@ -139,7 +139,7 @@ export const spec = {
    * @return {Bid[]} An array of bids which were nested inside the server.
    */
   interpretResponse: (serverResponse) => {
-    if (!serverResponse || !serverResponse.body) return []
+    if (!serverResponse || !serverResponse.body) return [];
     let GothamAdsResponse = serverResponse.body;
 
     let bids = [];
@@ -273,7 +273,7 @@ const addNativeParameters = bidRequest => {
         hmin = sizes[1];
       }
 
-      asset[props.name] = {}
+      asset[props.name] = {};
 
       if (bidParams.len) asset[props.name]['len'] = bidParams.len;
       if (props.type) asset[props.name]['type'] = props.type;