prebid.js 7.8.0 → 7.11.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

@@ -48,7 +48,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/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/eplanningAnalyticsAdapter.js

@@ -1,6 +1,6 @@
 import { logError } from '../src/utils.js';
 import {ajax} from '../src/ajax.js';
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
 import CONSTANTS from '../src/constants.json';
 

package/modules/eplanningBidAdapter.js

@@ -38,14 +38,14 @@ export const spec = {
     const spaces = getSpaces(bidRequests, urlConfig.ml);
     // TODO: do the fallbacks make sense here?
     const pageUrl = bidderRequest.refererInfo.page || bidderRequest.refererInfo.topmostLocation;
-    const domain = bidderRequest.refererInfo.domain || window.location.host
+    const domain = bidderRequest.refererInfo.domain || window.location.host;
     if (urlConfig.t) {
       url = 'https://' + urlConfig.isv + '/layers/t_pbjs_2.json';
       params = {};
     } else {
       url = 'https://' + (urlConfig.sv || DEFAULT_SV) + '/pbjs/1/' + urlConfig.ci + '/' + dfpClientId + '/' + domain + '/' + sec;
       // TODO: does the fallback make sense here?
-      const referrerUrl = bidderRequest.refererInfo.ref || bidderRequest.refererInfo.topmostLocation
+      const referrerUrl = bidderRequest.refererInfo.ref || bidderRequest.refererInfo.topmostLocation;
 
       if (storage.hasLocalStorage()) {
         registerViewabilityAllBids(bidRequests);
@@ -150,7 +150,7 @@ export const spec = {
 
     return syncs;
   },
-}
+};
 
 function getUserAgent() {
   return window.navigator.userAgent;

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

@@ -1,6 +1,6 @@
 import { parseUrl, logError } from '../src/utils.js';
 import { ajax } from '../src/ajax.js';
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
 import { getStorageManager } from '../src/storageManager.js';
 import CONSTANTS from '../src/constants.json';
@@ -181,7 +181,7 @@ function initSession() {
       !checkSessionByExpires() ||
       !checkSessionByReferer() ||
       !checkSessionByDay()) {
-    sessionId = '' + timestamp + getRandAsStr(SESSION_RAND_PART);
+    sessionId = '' + timestamp + getRandAsStr(SESSION_RAND_PART); // lgtm [js/insecure-randomness]
     begin = timestamp;
 
     isNew = true;

package/modules/freewheel-sspBidAdapter.js

@@ -189,7 +189,7 @@ function formatAdHTML(bid, size) {
   var libUrl = '';
   if (integrationType && integrationType !== 'inbanner') {
     libUrl = PRIMETIME_URL + getComponentId(bid.params.format) + '.min.js';
-    script = getOutstreamScript(bid, size);
+    script = getOutstreamScript(bid);
   } else {
     libUrl = MUSTANG_URL;
     script = getInBannerScript(bid, size);

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;

package/modules/gridBidAdapter.js

@@ -282,7 +282,7 @@ export const spec = {
         ext: {
           gdpr: gdprConsent.gdprApplies ? 1 : 0
         }
-      }
+      };
     }
 
     if (uspConsent) {

package/modules/gridNMBidAdapter.js

@@ -208,7 +208,7 @@ export const spec = {
           ext: {
             gdpr: gdprConsent.gdprApplies ? 1 : 0
           }
-        }
+        };
       }
 
       if (uspConsent) {

package/modules/gumgumBidAdapter.js

@@ -321,7 +321,7 @@ function buildRequests(validBidRequests, bidderRequest) {
     data.to = to;
 
     // ADTS-169 add adUnitCode to requests
-    if (adUnitCode) data.aun = adUnitCode
+    if (adUnitCode) data.aun = adUnitCode;
 
     // ADTS-134 Retrieve ID envelopes
     for (const eid in eids) data[eid] = eids[eid];
@@ -374,7 +374,7 @@ function buildRequests(validBidRequests, bidderRequest) {
         data.pi = 8;
       }
     } else { // legacy params
-      data = { ...data, ...handleLegacyParams(params, sizes) }
+      data = { ...data, ...handleLegacyParams(params, sizes) };
     }
 
     if (gdprConsent) {
@@ -400,7 +400,7 @@ function buildRequests(validBidRequests, bidderRequest) {
       url: BID_ENDPOINT,
       method: 'GET',
       data: Object.assign(data, _getBrowserParams(topWindowUrl), _getDigiTrustQueryParams(userId))
-    })
+    });
   });
   return bids;
 }

package/modules/h12mediaBidAdapter.js

@@ -198,7 +198,7 @@ function getIsHidden(elem) {
     } catch (o) {
       return false;
     }
-  } while ((m < 250) && (lastElem != null) && (elemHidden === false))
+  } while ((m < 250) && (lastElem != null) && (elemHidden === false));
   return elemHidden;
 }
 

package/modules/hadronAnalyticsAdapter.js

@@ -1,5 +1,5 @@
 import { ajax } from '../src/ajax.js';
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
 import * as utils from '../src/utils.js';
 import CONSTANTS from '../src/constants.json';
@@ -10,7 +10,7 @@ import {getRefererInfo} from '../src/refererDetection.js';
  * hadronAnalyticsAdapter.js - Audigent Hadron Analytics Adapter
  */
 
-const HADRON_ANALYTICS_URL = 'https://analytics.hadron.ad.gt/api/v1/analytics'
+const HADRON_ANALYTICS_URL = 'https://analytics.hadron.ad.gt/api/v1/analytics';
 const HADRONID_ANALYTICS_VER = 'pbadgt0';
 const DEFAULT_PARTNER_ID = 0;
 const AU_GVLID = 561;
@@ -152,7 +152,7 @@ hadronAnalyticsAdapter.enableAnalytics = function(conf = {}) {
   }
 
   hadronAnalyticsAdapter.originEnableAnalytics(conf);
-}
+};
 
 function flush() {
   // Don't send anything if no partner id was declared

package/modules/hadronRtdProvider.js

@@ -30,7 +30,7 @@ export const storage = getStorageManager({gvlid: AU_GVLID, moduleName: SUBMODULE
  */
 const urlAddParams = (url, params) => {
   return url + (url.indexOf('?') > -1 ? '&' : '?') + params
-}
+};
 
 /**
  * Deep set an object unless value present.

package/modules/id5AnalyticsAdapter.js

@@ -1,4 +1,4 @@
-import buildAdapter from '../src/AnalyticsAdapter.js';
+import buildAdapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import CONSTANTS from '../src/constants.json';
 import adapterManager from '../src/adapterManager.js';
 import { ajax } from '../src/ajax.js';
@@ -141,7 +141,7 @@ const ENABLE_FUNCTION = (config) => {
     logInfo('id5Analytics: Tracking events', _this.eventsToTrack);
     if (sampling > 0 && _this.random() < (1 / sampling)) {
       // Init the module only if we got lucky
-      logInfo('id5Analytics: Selected by sampling. Starting up!')
+      logInfo('id5Analytics: Selected by sampling. Starting up!');
 
       // Clean start
       _this.eventBuffer = {};

package/modules/impactifyBidAdapter.js

@@ -25,7 +25,7 @@ const getDeviceType = () => {
     return 4;
   }
   return 2;
-}
+};
 
 const createOpenRtbRequest = (validBidRequests, bidderRequest) => {
   // Create request and set imp bids inside

package/modules/improvedigitalBidAdapter.js

@@ -123,7 +123,7 @@ export const spec = {
 
     if (bidderRequest) {
       // GDPR
-      const gdprConsent = deepAccess(bidderRequest, 'gdprConsent')
+      const gdprConsent = deepAccess(bidderRequest, 'gdprConsent');
       if (gdprConsent) {
         if (typeof gdprConsent.gdprApplies === 'boolean') {
           deepSetValue(request, 'regs.ext.gdpr', Number(gdprConsent.gdprApplies));
@@ -434,6 +434,9 @@ const ID_REQUEST = {
       return null;
     }
     const request = {
+      eventtrackers: [
+        {event: 1, methods: [1, 2]}
+      ],
       assets: [],
     }
     for (let i of Object.keys(nativeParams)) {
@@ -505,7 +508,7 @@ const ID_REQUEST = {
       const url = deepAccess(bidderRequest, 'refererInfo.page');
       if (url) {
         site.page = url;
-        site.domain = bidderRequest.refererInfo.domain
+        site.domain = bidderRequest.refererInfo.domain;
       }
       const configSiteSettings = config.getConfig('site') || {};
       const fpdSiteSettings = deepAccess(bidderRequest, 'ortb2.site') || {};