prebid.js 6.1.0 → 6.5.0

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

@@ -14,6 +14,13 @@ export const spec = {
     const { placementId } = bid.params;
     return !!placementId
   },
+  isGdprConsentPresent: (bid) => {
+    const { gdpr, gdprConsent } = bid.params;
+    if (gdpr == '1') {
+      return !!gdprConsent
+    }
+    return true
+  },
   buildRequests: (validBidRequests) => {
     const serverRequests = [];
     const { data } = config.getConfig('doceree.user')
@@ -21,7 +28,7 @@ export const spec = {
     const encodedUserInfo = window.btoa(encodeURIComponent(JSON.stringify(data)))
 
     validBidRequests.forEach(function(validBidRequest) {
-      const { publisherUrl, placementId } = validBidRequest.params;
+      const { publisherUrl, placementId, gdpr, gdprConsent } = validBidRequest.params;
       const url = publisherUrl || page
       let queryString = '';
       queryString = tryAppendQueryString(queryString, 'id', placementId);
@@ -32,6 +39,8 @@ export const spec = {
       queryString = tryAppendQueryString(queryString, 'prebidjs', true);
       queryString = tryAppendQueryString(queryString, 'token', token);
       queryString = tryAppendQueryString(queryString, 'requestId', validBidRequest.bidId);
+      queryString = tryAppendQueryString(queryString, 'gdpr', gdpr);
+      queryString = tryAppendQueryString(queryString, 'gdpr_consent', gdprConsent);
 
       serverRequests.push({
         method: 'GET',

package/modules/docereeBidAdapter.md

@@ -25,6 +25,8 @@ var adUnits = [
                params: {
                     placementId: 'DOC_7jm9j5eqkl0xvc5w', //required
                     publisherUrl: document.URL || window.location.href, //optional
+                    gdpr: '1', //optional
+                    gdprConsent:'CPQfU1jPQfU1jG0AAAENAwCAAAAAAAAAAAAAAAAAAAAA.IGLtV_T9fb2vj-_Z99_tkeYwf95y3p-wzhheMs-8NyZeH_B4Wv2MyvBX4JiQKGRgksjLBAQdtHGlcTQgBwIlViTLMYk2MjzNKJrJEilsbO2dYGD9Pn8HT3ZCY70-vv__7v3ff_3g', //optional
                }
             }
        ]

package/modules/dspxBidAdapter.js

@@ -12,7 +12,7 @@ const GVLID = 602;
 export const spec = {
   code: BIDDER_CODE,
   gvlid: GVLID,
-  aliases: ['dspx'],
+  aliases: [],
   supportedMediaTypes: [BANNER, VIDEO],
   isBidRequestValid: function(bid) {
     return !!(bid.params.placement);

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);
     });
 

package/modules/engageyaBidAdapter.js

@@ -8,7 +8,7 @@ const BIDDER_CODE = 'engageya';
 const ENDPOINT_URL = 'https://recs.engageya.com/rec-api/getrecs.json';
 const ENDPOINT_METHOD = 'GET';
 const SUPPORTED_SIZES = [
-  [100, 75], [236, 202], [100, 100], [130, 130], [200, 200], [250, 250], [300, 272], [300, 250], [300, 230], [300, 214], [300, 187], [300, 166], [300, 150], [300, 133], [300, 120], [400, 200], [300, 200], [250, 377], [620, 410], [207, 311], [310, 166], [310, 333], [190, 106], [228, 132], [300, 174], [80, 60], [600, 500], [600, 600], [1080, 610], [1080, 610], [624, 350], [650, 1168], [1080, 1920], [300, 374]
+  [100, 75], [236, 202], [100, 100], [130, 130], [200, 200], [250, 250], [300, 272], [300, 250], [300, 230], [300, 214], [300, 187], [300, 166], [300, 150], [300, 133], [300, 120], [400, 200], [300, 200], [250, 377], [620, 410], [207, 311], [310, 166], [310, 333], [190, 106], [228, 132], [300, 174], [80, 60], [600, 500], [600, 600], [1080, 610], [1080, 610], [624, 350], [650, 1168], [1080, 1920], [300, 374], [336, 280]
 ];
 
 function getPageUrl(bidRequest, bidderRequest) {

package/modules/feedadBidAdapter.js

@@ -176,13 +176,13 @@ function isMediaTypesEmpty(mediaTypes) {
  * @return {FeedAdApiBidRequest}
  */
 function createApiBidRParams(request) {
-  return {
+  return Object.assign({}, request.params, {
     ad_type: 0,
     client_token: request.params.clientToken,
     placement_id: request.params.placementId,
     sdk_version: `prebid_${VERSION}`,
     app_hybrid: false,
-  };
+  });
 }
 
 /**

package/modules/feedadBidAdapter.md

@@ -26,6 +26,7 @@ Prebid.JS adapter that connects to the FeedAd demand sources.
                     params: {
                         clientToken: 'your-client-token' // see below for more info
                         placementId: 'your-placement-id' // see below for more info
+                        decoration: 'decoration parameters' // optional, see below for info
                     }
                 }
             ]
@@ -35,7 +36,8 @@ Prebid.JS adapter that connects to the FeedAd demand sources.
 
 # Required Parameters
 
-| Parameter | Description |
-| --------- | ----------- |
+| Parameter     | Description |
+|---------------| ----------- |
 | `clientToken` | Your FeedAd web client token. You can view your client token inside the FeedAd admin panel. |
 | `placementId` | You can choose placement IDs yourself. A placement ID should be named after the ad position inside your product. For example, if you want to display an ad inside a list of news articles, you could name it "ad-news-overview".<br> A placement ID may consist of lowercase `a-z`, `0-9`, `-` and `_`. You do not have to manually create the placement IDs before using them. Just specify them within the code, and they will appear in the FeedAd admin panel after the first request. <br> [Learn more](/concept/feed_ad/index.html) about Placement IDs and how they are grouped to play the same Creative. |
+| `decoration`  | Optional. If you want to apply a [decoration](https://docs.feedad.com/web/feed_ad/#decorations) to the ad.

package/modules/freewheel-sspBidAdapter.js

@@ -312,6 +312,12 @@ export const spec = {
         requestParams._fw_us_privacy = bidderRequest.uspConsent;
       }
 
+      // Add schain object
+      var schain = currentBidRequest.schain;
+      if (schain) {
+        requestParams.schain = schain;
+      }
+
       var vastParams = currentBidRequest.params.vastUrlParams;
       if (typeof vastParams === 'object') {
         for (var key in vastParams) {

package/modules/futureads.md

@@ -0,0 +1,48 @@
+# Overview
+Module Name: Future Ads Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: contact@futureads.io
+# Description
+Connects to Future Ads demand source to fetch bids.
+Banner and Video formats are supported.
+Please use ```futureads``` as the bidder code.
+# Test Parameters
+```
+var adUnits = [
+    {
+        code: 'desktop-banner-ad-div',
+        sizes: [[300, 250]], // a display size
+        bids: [
+            {
+                bidder: "futureads",
+                params: {
+                    zone: '2eb6bd58-865c-47ce-af7f-a918108c3fd2'
+                }
+            }
+        ]
+    },{
+        code: 'mobile-banner-ad-div',
+        sizes: [[300, 50]], // a mobile size
+        bids: [
+            {
+                bidder: "futureads",
+                params: {
+                    zone: '62211486-c50b-4356-9f0f-411778d31fcc'
+                }
+            }
+        ]
+    },{
+        code: 'video-ad',
+        sizes: [[300, 50]],
+        mediaType: 'video',
+        bids: [
+            {
+                bidder: "futureads",
+                params: {
+                    zone: 'ebeb1e79-8cb4-4473-b2d0-2e24b7ff47fd'
+                }
+            }
+        ]
+    },
+];
+```

package/modules/glimpseBidAdapter.js

@@ -138,11 +138,17 @@ function getReferer(bidderRequest) {
 function getGdprConsentChoice(bidderRequest) {
   const hasGdprConsent =
     hasValue(bidderRequest) &&
-    hasValue(bidderRequest.gdprConsent) &&
-    hasStringValue(bidderRequest.gdprConsent.consentString)
+    hasValue(bidderRequest.gdprConsent)
 
   if (hasGdprConsent) {
-    return bidderRequest.gdprConsent
+    const gdprConsent = bidderRequest.gdprConsent
+    const hasGdprApplies = hasBooleanValue(gdprConsent.gdprApplies)
+
+    return {
+      consentString: gdprConsent.consentString || '',
+      vendorData: gdprConsent.vendorData || {},
+      gdprApplies: hasGdprApplies ? gdprConsent.gdprApplies : true,
+    }
   }
 
   return {
@@ -177,6 +183,13 @@ function hasValue(value) {
   )
 }
 
+function hasBooleanValue(value) {
+  return (
+    hasValue(value) &&
+    typeof value === 'boolean'
+  )
+}
+
 function hasStringValue(value) {
   return (
     hasValue(value) &&