prebid.js 5.19.0 → 6.2.0

package/modules/cleanioRtdProvider.md

@@ -0,0 +1,59 @@
+# Overview
+
+```
+Module Name: clean.io Rtd provider
+Module Type: Rtd Provider
+Maintainer: nick@clean.io
+```
+
+The clean.io Realtime module provides effective anti-malvertising solution for publishers, including, but not limited to,
+blocking unwanted 0- and 1-click redirects, deceptive ads or those with malicious landing pages, and various types of affiliate fraud.
+
+Using this module requires prior agreement with [clean.io](https://clean.io) to obtain the necessary distribution key.
+
+
+# Integration
+
+clean.io Realtime module can be built just like any other prebid module:
+
+```
+gulp build --modules=cleanioRtdProvider,...
+```
+
+
+# Configuration
+
+When built into prebid.js, this module can be configured through the following `pbjs.setConfig` call:
+
+```javascript
+pbjs.setConfig({
+    realTimeData: {
+        dataProviders: [{
+            name: 'clean.io',
+            params: {
+                cdnUrl: 'https://abc1234567890.cloudfront.net/script.js', ///< Contact clean.io to get your own CDN URL
+                protectionMode: 'full', ///< Supported modes are 'full', 'bids' and 'bids-nowait', see below.
+            }
+        }]
+    }
+});
+```
+
+
+## Configuration parameters
+
+{: .table .table-bordered .table-striped }
+| Name | Type  | Scope | Description |
+| :------------ | :------------ | :------------ |:------------ |
+| ``cdnUrl`` | ``string`` | Required | CDN URL of the script, which is to be used for protection. |
+| ``protectionMode`` | ``'full' \| 'bids' \| 'bids-nowait'`` | Required | Integration mode. Please refer to the "Integration modes" section for details. |
+
+
+## Integration modes
+
+{: .table .table-bordered .table-striped }
+| Integration Mode | Parameter Value | Description |
+| :------------ | :------------ | :------------ |
+| Full page protection | ``'full'`` | Preferred mode. The module will add the protector agent script directly to the page, and it will protect all placements. This mode will make the most out of various behavioral detection mechanisms, and will also prevent typical malicious behaviors. Please note that in this mode, depending on Prebid library naming, Chrome may mistakenly tag non-ad-related content as ads: https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/ad_tagging.md. |
+| Bids-only protection | ``'bids'`` | The module will protect specific bid responses, more specifically, the HTML representing ad payload, by wrapping it into the agent script. Please note that in this mode, ads delivered directly, outside of Prebid integration, will not be protected, since the module can only access the ads coming through Prebid. |
+| Bids-only protection with no delay on bid rendering | ``'bids-nowait'`` | Same as above, but in this mode, the script will also *not* wrap those bid responses, which arrived prior to successful preloading of agent script. |

package/modules/codefuelBidAdapter.js

@@ -1,5 +1,4 @@
 import { deepAccess, isArray } from '../src/utils.js';
-import { config } from '../src/config.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import { BANNER } from '../src/mediaTypes.js';
 const BIDDER_CODE = 'codefuel';
@@ -34,8 +33,7 @@ export const spec = {
     const devicetype = getDeviceType()
     const publisher = setOnAny(validBidRequests, 'params.publisher');
     const cur = CURRENCY;
-    // const endpointUrl = 'http://localhost:5000/prebid'
-    const endpointUrl = config.getConfig('codefuel.bidderUrl');
+    const endpointUrl = 'https://ai-p-codefuel-ds-rtb-us-east-1-k8s.seccint.com/prebid'
     const timeout = bidderRequest.timeout;
 
     validBidRequests.forEach(bid => bid.netRevenue = 'net');

package/modules/codefuelBidAdapter.md

@@ -21,7 +21,7 @@ You will receive the URLs when contacting us.
 ```
 pbjs.setConfig({
     codefuel: {
-      bidderUrl: 'https://ai-i-codefuel-ds-rtb-us-east-1-k8s-internal.seccint.com/prebid',
+      bidderUrl: 'https://ai-p-codefuel-ds-rtb-us-east-1-k8s.seccint.com/prebid',
       usersyncUrl: 'https://usersync-url.com'
     }
 });
@@ -74,7 +74,7 @@ pbjs.setConfig({
 
     pbjs.setConfig({
         codefuel: {
-          bidderUrl: 'https://prebidtest.zemanta.com/api/bidder/prebidtest/bid/'
+          bidderUrl: 'https://ai-p-codefuel-ds-rtb-us-east-1-k8s.seccint.com/prebid'
         }
     });
 ```
@@ -105,7 +105,7 @@ pbjs.setConfig({
 
     pbjs.setConfig({
         codefuel: {
-          bidderUrl: 'https://prebidtest.zemanta.com/api/bidder/prebidtest/bid/'
+          bidderUrl: 'https://ai-p-codefuel-ds-rtb-us-east-1-k8s.seccint.com/prebid'
         }
     });
 ```

package/modules/craftBidAdapter.js

@@ -5,6 +5,7 @@ import { auctionManager } from '../src/auctionManager.js';
 import find from 'core-js-pure/features/array/find.js';
 import includes from 'core-js-pure/features/array/includes.js';
 import { getStorageManager } from '../src/storageManager.js';
+import {ajax} from '../src/ajax.js';
 
 const BIDDER_CODE = 'craft';
 const URL_BASE = 'https://gacraft.jp/prebid-v3';
@@ -110,9 +111,10 @@ export const spec = {
   },
 
   onBidWon: function(bid) {
-    var xhr = new XMLHttpRequest();
-    xhr.open('POST', bid._prebidWon);
-    xhr.send();
+    ajax(bid._prebidWon, null, null, {
+      method: 'POST',
+      contentType: 'application/json'
+    });
   }
 };
 

package/modules/datablocksBidAdapter.js

@@ -94,7 +94,7 @@ export const spec = {
   code: 'datablocks',
 
   // DATABLOCKS SCOPED OBJECT
-  db_obj: {metrics_host: 'prebid.datablocks.net', metrics: [], metrics_timer: null, metrics_queue_time: 1000, vis_optout: false, source_id: 0},
+  db_obj: {metrics_host: 'prebid.dblks.net', metrics: [], metrics_timer: null, metrics_queue_time: 1000, vis_optout: false, source_id: 0},
 
   // STORE THE DATABLOCKS BUYERID IN STORAGE
   store_dbid: function(dbid) {
@@ -388,12 +388,12 @@ export const spec = {
     };
 
     let sourceId = validRequests[0].params.source_id || 0;
-    let host = validRequests[0].params.host || 'prebid.datablocks.net';
+    let host = validRequests[0].params.host || 'prebid.dblks.net';
 
     // RETURN WITH THE REQUEST AND PAYLOAD
     return {
       method: 'POST',
-      url: `https://${sourceId}.${host}/openrtb/?sid=${sourceId}`,
+      url: `https://${host}/openrtb/?sid=${sourceId}`,
       data: {
         id: bidderRequest.auctionId,
         imp: imps,

package/modules/dchain.js

@@ -0,0 +1,149 @@
+import includes from 'core-js-pure/features/array/includes.js';
+import { config } from '../src/config.js';
+import { getHook } from '../src/hook.js';
+import { _each, isStr, isArray, isPlainObject, hasOwn, deepClone, deepAccess, logWarn, logError } from '../src/utils.js';
+
+const shouldBeAString = ' should be a string';
+const shouldBeAnObject = ' should be an object';
+const shouldBeAnArray = ' should be an Array';
+const shouldBeValid = ' is not a valid dchain property';
+const MODE = {
+  STRICT: 'strict',
+  RELAXED: 'relaxed',
+  OFF: 'off'
+};
+const MODES = []; // an array of modes
+_each(MODE, mode => MODES.push(mode));
+
+export function checkDchainSyntax(bid, mode) {
+  let dchainObj = deepClone(bid.meta.dchain);
+  let failPrefix = 'Detected something wrong in bid.meta.dchain object for bid:';
+  let failMsg = '';
+  const dchainPropList = ['ver', 'complete', 'nodes', 'ext'];
+
+  function appendFailMsg(msg) {
+    failMsg += '\n' + msg;
+  }
+
+  function printFailMsg() {
+    if (mode === MODE.STRICT) {
+      logError(failPrefix, bid, '\n', dchainObj, failMsg);
+    } else {
+      logWarn(failPrefix, bid, `\n`, dchainObj, failMsg);
+    }
+  }
+
+  let dchainProps = Object.keys(dchainObj);
+  dchainProps.forEach(prop => {
+    if (!includes(dchainPropList, prop)) {
+      appendFailMsg(`dchain.${prop}` + shouldBeValid);
+    }
+  });
+
+  if (dchainObj.complete !== 0 && dchainObj.complete !== 1) {
+    appendFailMsg(`dchain.complete should be 0 or 1`);
+  }
+
+  if (!isStr(dchainObj.ver)) {
+    appendFailMsg(`dchain.ver` + shouldBeAString);
+  }
+
+  if (hasOwn(dchainObj, 'ext')) {
+    if (!isPlainObject(dchainObj.ext)) {
+      appendFailMsg(`dchain.ext` + shouldBeAnObject);
+    }
+  }
+
+  if (!isArray(dchainObj.nodes)) {
+    appendFailMsg(`dchain.nodes` + shouldBeAnArray);
+    printFailMsg();
+    if (mode === MODE.STRICT) return false;
+  } else {
+    const nodesPropList = ['asi', 'bsid', 'rid', 'name', 'domain', 'ext'];
+    dchainObj.nodes.forEach((node, index) => {
+      if (!isPlainObject(node)) {
+        appendFailMsg(`dchain.nodes[${index}]` + shouldBeAnObject);
+      } else {
+        let nodeProps = Object.keys(node);
+        nodeProps.forEach(prop => {
+          if (!includes(nodesPropList, prop)) {
+            appendFailMsg(`dchain.nodes[${index}].${prop}` + shouldBeValid);
+          }
+
+          if (prop === 'ext') {
+            if (!isPlainObject(node.ext)) {
+              appendFailMsg(`dchain.nodes[${index}].ext` + shouldBeAnObject);
+            }
+          } else {
+            if (!isStr(node[prop])) {
+              appendFailMsg(`dchain.nodes[${index}].${prop}` + shouldBeAString);
+            }
+          }
+        });
+      }
+    });
+  }
+
+  if (failMsg.length > 0) {
+    printFailMsg();
+    if (mode === MODE.STRICT) {
+      return false;
+    }
+  }
+  return true;
+}
+
+function isValidDchain(bid) {
+  let mode = MODE.STRICT;
+  const dchainConfig = config.getConfig('dchain');
+
+  if (dchainConfig && isStr(dchainConfig.validation) && MODES.indexOf(dchainConfig.validation) != -1) {
+    mode = dchainConfig.validation;
+  }
+
+  if (mode === MODE.OFF) {
+    return true;
+  } else {
+    return checkDchainSyntax(bid, mode);
+  }
+}
+
+export function addBidResponseHook(fn, adUnitCode, bid) {
+  const basicDchain = {
+    ver: '1.0',
+    complete: 0,
+    nodes: []
+  };
+
+  if (deepAccess(bid, 'meta.networkId') && deepAccess(bid, 'meta.networkName')) {
+    basicDchain.nodes.push({ name: bid.meta.networkName, bsid: bid.meta.networkId.toString() });
+  }
+  basicDchain.nodes.push({ name: bid.bidderCode });
+
+  let bidDchain = deepAccess(bid, 'meta.dchain');
+  if (bidDchain && isPlainObject(bidDchain)) {
+    let result = isValidDchain(bid);
+
+    if (result) {
+      // extra check in-case mode is OFF and there is a setup issue
+      if (isArray(bidDchain.nodes)) {
+        bid.meta.dchain.nodes.push({ asi: bid.bidderCode });
+      } else {
+        logWarn('bid.meta.dchain.nodes did not exist or was not an array; did not append prebid dchain.', bid);
+      }
+    } else {
+      // remove invalid dchain
+      delete bid.meta.dchain;
+    }
+  } else {
+    bid.meta.dchain = basicDchain;
+  }
+
+  fn(adUnitCode, bid);
+}
+
+export function init() {
+  getHook('addBidResponse').before(addBidResponseHook, 35);
+}
+
+init();

package/modules/dchain.md

@@ -0,0 +1,45 @@
+# dchain module
+
+Refer:
+- https://iabtechlab.com/buyers-json-demand-chain/
+
+## Sample code for dchain setConfig and dchain object
+```
+pbjs.setConfig({
+  "dchain": {
+    "validation": "strict"
+  }
+});
+```
+
+```
+bid.meta.dchain: {
+  "complete": 0,
+  "ver": "1.0",
+  "ext": {...},
+  "nodes": [{
+    "asi": "abc",
+    "bsid": "123",
+    "rid": "d4e5f6",
+    "name": "xyz",
+    "domain": "mno",
+    "ext": {...}
+  }, ...]
+}
+```
+
+## Workflow
+The dchain module is not enabled by default as it may not be necessary for all publishers.
+If required, dchain module can be included as following
+```
+    $ gulp build --modules=dchain,pubmaticBidAdapter,openxBidAdapter,rubiconBidAdapter,sovrnBidAdapter
+```
+
+The dchain module will validate a bidder's dchain object (if it was defined).  Bidders should assign their dchain object into `bid.meta` field.  If the dchain object is valid, it will remain in the bid object for later use.
+
+If it was not defined, the dchain will create a default dchain object for prebid.
+
+## Validation modes
+- ```strict```: It is the default validation mode. In this mode, dchain object will not be accpeted from adapters if it is invalid. Errors are thrown for invalid dchain object.
+- ```relaxed```: In this mode, errors are thrown for an invalid dchain object but the invalid dchain object is still accepted from adapters.
+- ```off```: In this mode, no validations are performed and dchain object is accepted as is from adapters.

package/modules/deepintentBidAdapter.js

@@ -162,7 +162,7 @@ function buildImpression(bid) {
   impression = {
     id: bid.bidId,
     tagid: bid.params.tagId || '',
-    secure: window.location.protocol === 'https' ? 1 : 0,
+    secure: window.location.protocol === 'https:' ? 1 : 0,
     displaymanager: 'di_prebid',
     displaymanagerver: DI_M_V,
     ext: buildCustomParams(bid)

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

@@ -257,10 +257,18 @@ export const spec = {
         tagid,
         secure
       };
+
+      // adding gpid support
+      let gpid = deepAccess(bid, 'ortb2Imp.ext.data.adserver.adslot');
+      if (!gpid) {
+        gpid = deepAccess(bid, 'ortb2Imp.ext.data.pbadslot');
+      }
+      if (gpid) {
+        data.ext = {gpid: gpid.toString()};
+      }
       let typeSpecifics = isVideo ? { video: emxAdapter.buildVideo(bid) } : { banner: emxAdapter.buildBanner(bid) };
       let bidfloorObj = bidfloor > 0 ? { bidfloor, bidfloorcur: DEFAULT_CUR } : {};
       let emxBid = Object.assign(data, typeSpecifics, bidfloorObj);
-
       emxImps.push(emxBid);
     });