prebid.js 7.2.0 → 7.5.0

package/modules/dianomiBidAdapter.md

@@ -0,0 +1,73 @@
+# Overview
+
+```
+Module Name: Dianomi Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: eng@dianomi.com
+```
+
+# Description
+
+Module that connects to Dianomi's demand sources. Both Native and Banner formats supported. Using oRTB standard.
+
+# Test Parameters
+
+```js
+    var adUnits = [
+        {
+            code: 'test-div-1',
+            mediaTypes: {
+                native: {
+                    rendererUrl: "https://dev.dianomi.com/chris/prebid/dianomiRenderer.js",
+                    image: {
+                        required: true,
+                        sizes: [360, 360]
+                    },
+                    title: {
+                        required: true,
+                        len: 800
+                    },
+                    sponsoredBy: {
+                        required: true
+                    },
+                    clickUrl: {
+                        required: true
+                    },
+                    privacyLink: {
+                        required: false
+                    },
+                    body: {
+                        required: false
+                    },
+                    icon: {
+                        required: false,
+                        sizes: [75, 75]
+                    },
+                }
+            },
+            bids: [
+                {
+                    bidder: "dianomi",
+                    params: {
+                        smartadId: 12345   // required, provided by Account Manager
+                    }
+                }
+            ]
+        },{
+            code: 'test-div-2',
+            mediaTypes: {
+                banner: {
+                    sizes: [750, 650],   // a below-article size
+                }
+            },
+            bids: [
+                {
+                    bidder: "dianomi",
+                    params: {
+                        smartadId: 23456,  // required provided by Account Manager
+                    }
+                }
+            ]
+        }
+    ];
+```

package/modules/finativeBidAdapter.js

@@ -0,0 +1,235 @@
+// jshint esversion: 6, es3: false, node: true
+'use strict';
+
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { NATIVE } from '../src/mediaTypes.js';
+import { _map, deepSetValue, isEmpty, deepAccess } from '../src/utils.js';
+import { config } from '../src/config.js';
+
+const BIDDER_CODE = 'finative';
+const DEFAULT_CUR = 'EUR';
+const ENDPOINT_URL = 'https://b.finative.cloud/cds/rtb/bid?format=openrtb2.5&ssp=pb';
+
+const NATIVE_ASSET_IDS = {0: 'title', 1: 'body', 2: 'sponsoredBy', 3: 'image', 4: 'cta', 5: 'icon'};
+
+const NATIVE_PARAMS = {
+  title: {
+    id: 0,
+    name: 'title'
+  },
+
+  body: {
+    id: 1,
+    name: 'data',
+    type: 2
+  },
+
+  sponsoredBy: {
+    id: 2,
+    name: 'data',
+    type: 1
+  },
+
+  image: {
+    id: 3,
+    type: 3,
+    name: 'img'
+  },
+
+  cta: {
+    id: 4,
+    type: 12,
+    name: 'data'
+  },
+
+  icon: {
+    id: 5,
+    type: 1,
+    name: 'img'
+  }
+};
+
+export const spec = {
+  code: BIDDER_CODE,
+
+  supportedMediaTypes: [NATIVE],
+
+  isBidRequestValid: function(bid) {
+    return !!bid.params.adUnitId;
+  },
+
+  buildRequests: (validBidRequests, bidderRequest) => {
+    const pt = setOnAny(validBidRequests, 'params.pt') || setOnAny(validBidRequests, 'params.priceType') || 'net';
+    const tid = validBidRequests[0].transactionId;
+    const cur = [config.getConfig('currency.adServerCurrency') || DEFAULT_CUR];
+    let url = bidderRequest.refererInfo.referer;
+
+    const imp = validBidRequests.map((bid, id) => {
+      const assets = _map(bid.nativeParams, (bidParams, key) => {
+        const props = NATIVE_PARAMS[key];
+
+        const asset = {
+          required: bidParams.required & 1
+        };
+
+        if (props) {
+          asset.id = props.id;
+
+          let w, h;
+
+          if (bidParams.sizes) {
+            w = bidParams.sizes[0];
+            h = bidParams.sizes[1];
+          }
+
+          asset[props.name] = {
+            len: bidParams.len,
+            type: props.type,
+            w,
+            h
+          };
+
+          return asset;
+        }
+      })
+        .filter(Boolean);
+
+      if (bid.params.url) {
+        url = bid.params.url;
+      }
+
+      return {
+        id: String(id + 1),
+        tagid: bid.params.adUnitId,
+        tid: tid,
+        pt: pt,
+        native: {
+          request: {
+            assets
+          }
+        }
+      };
+    });
+
+    const request = {
+      id: bidderRequest.auctionId,
+      site: {
+        page: url
+      },
+      device: {
+        ua: navigator.userAgent
+      },
+      cur,
+      imp,
+      user: {},
+      regs: {
+        ext: {
+          gdpr: 0,
+          pb_ver: '$prebid.version$'
+        }
+      }
+    };
+
+    if (bidderRequest && bidderRequest.gdprConsent) {
+      deepSetValue(request, 'user.ext.consent', bidderRequest.gdprConsent.consentString);
+      deepSetValue(request, 'regs.ext.gdpr', (typeof bidderRequest.gdprConsent.gdprApplies === 'boolean' && bidderRequest.gdprConsent.gdprApplies) ? 1 : 0);
+    }
+
+    return {
+      method: 'POST',
+      url: ENDPOINT_URL,
+      data: JSON.stringify(request),
+      options: {
+        contentType: 'application/json'
+      },
+      bids: validBidRequests
+    };
+  },
+
+  interpretResponse: function(serverResponse, { bids }) {
+    if (isEmpty(serverResponse.body)) {
+      return [];
+    }
+
+    const { seatbid, cur } = serverResponse.body;
+
+    const bidResponses = (typeof seatbid != 'undefined') ? flatten(seatbid.map(seat => seat.bid)).reduce((result, bid) => {
+      result[bid.impid - 1] = bid;
+      return result;
+    }, []) : [];
+
+    return bids
+      .map((bid, id) => {
+        const bidResponse = bidResponses[id];
+
+        if (bidResponse) {
+          return {
+            requestId: bid.bidId,
+            cpm: bidResponse.price,
+            creativeId: bidResponse.crid,
+            ttl: 1000,
+            netRevenue: (!bid.netRevenue || bid.netRevenue === 'net'),
+            currency: cur,
+            mediaType: NATIVE,
+            bidderCode: BIDDER_CODE,
+            native: parseNative(bidResponse),
+            meta: {
+              advertiserDomains: bidResponse.adomain && bidResponse.adomain.length > 0 ? bidResponse.adomain : []
+            }
+          };
+        }
+      })
+      .filter(Boolean);
+  }
+};
+
+registerBidder(spec);
+
+function parseNative(bid) {
+  const {assets, link, imptrackers} = bid.adm.native;
+
+  let clickUrl = link.url.replace(/\$\{AUCTION_PRICE\}/g, bid.price);
+
+  if (link.clicktrackers) {
+    link.clicktrackers.forEach(function (clicktracker, index) {
+      link.clicktrackers[index] = clicktracker.replace(/\$\{AUCTION_PRICE\}/g, bid.price);
+    });
+  }
+
+  if (imptrackers) {
+    imptrackers.forEach(function (imptracker, index) {
+      imptrackers[index] = imptracker.replace(/\$\{AUCTION_PRICE\}/g, bid.price);
+    });
+  }
+
+  const result = {
+    url: clickUrl,
+    clickUrl: clickUrl,
+    clickTrackers: link.clicktrackers || undefined,
+    impressionTrackers: imptrackers || undefined
+  };
+
+  assets.forEach(asset => {
+    const kind = NATIVE_ASSET_IDS[asset.id];
+    const content = kind && asset[NATIVE_PARAMS[kind].name];
+
+    if (content) {
+      result[kind] = content.text || content.value || { url: content.url, width: content.w, height: content.h };
+    }
+  });
+
+  return result;
+}
+
+function setOnAny(collection, key) {
+  for (let i = 0, result; i < collection.length; i++) {
+    result = deepAccess(collection[i], key);
+    if (result) {
+      return result;
+    }
+  }
+}
+
+function flatten(arr) {
+  return [].concat(...arr);
+}

package/modules/finativeBidAdapter.md

@@ -0,0 +1,45 @@
+# Overview
+Module Name: Finative Bidder Adapter
+Type: Finative Adapter
+Maintainer: tech@finative.cloud
+
+# Description
+Finative Bidder Adapter for Prebid.js.
+
+# Test Parameters
+```
+var adUnits = [{
+    code: 'test-div',
+
+    mediaTypes: {
+        native: {
+            title: {
+                required: true,
+                len: 50
+            },
+            body: {
+                required: true,
+                len: 350
+            },
+            url: {
+                required: true
+            },
+            image: {
+                required: true,
+                sizes : [300, 175]
+            },
+            sponsoredBy: {
+                required: true
+            }
+        }
+    },
+    bids: [{
+        bidder: 'finative',
+        params: {
+	    	url  : "https://mockup.finative.cloud",
+	    	adUnitId: "1uyo"
+        }
+    }]
+}];
+```
+

package/modules/fpdModule/index.js

@@ -7,13 +7,14 @@ import { module, getHook } from '../../src/hook.js';
 
 let submodules = [];
 
-/**
- * enable submodule in User ID
- */
 export function registerSubmodules(submodule) {
   submodules.push(submodule);
 }
 
+export function reset() {
+  submodules.length = 0;
+}
+
 export function processFpd({global = {}, bidder = {}} = {}) {
   let modConf = config.getConfig('firstPartyData') || {};
 
@@ -26,8 +27,8 @@ export function processFpd({global = {}, bidder = {}} = {}) {
   return {global, bidder};
 }
 
-function startAuctionHook(fn, req) {
-  Object.assign(req, processFpd({global: req.ortb2, bidder: req.bidderOrtb2}));
+export function startAuctionHook(fn, req) {
+  Object.assign(req.ortb2Fragments, processFpd(req.ortb2Fragments));
   fn.call(this, req);
 }
 

package/modules/gdprEnforcement.js

@@ -18,8 +18,6 @@ const TCF2 = {
   'purpose7': { id: 7, name: 'measurement' }
 }
 
-const VENDORLESS_MODULE_TYPES = ['fpid-module'];
-
 /*
   These rules would be used if `consentManagement.gdpr.rules` is undefined by the publisher.
 */
@@ -125,10 +123,9 @@ function getGvlidForAnalyticsAdapter(code) {
  * @param {Object} consentData - gdpr consent data
  * @param {string=} currentModule - Bidder code of the current module
  * @param {number=} gvlId - GVL ID for the module
- * @param {string=} moduleType module type
  * @returns {boolean}
  */
-export function validateRules(rule, consentData, currentModule, gvlId, moduleType) {
+export function validateRules(rule, consentData, currentModule, gvlId) {
   const purposeId = TCF2[Object.keys(TCF2).filter(purposeName => TCF2[purposeName].name === rule.purpose)[0]].id;
 
   // return 'true' if vendor present in 'vendorExceptions'
@@ -141,14 +138,12 @@ export function validateRules(rule, consentData, currentModule, gvlId, moduleTyp
   const vendorConsent = deepAccess(consentData, `vendorData.vendor.consents.${gvlId}`);
   const liTransparency = deepAccess(consentData, `vendorData.purpose.legitimateInterests.${purposeId}`);
 
-  const vendorlessModule = includes(VENDORLESS_MODULE_TYPES, moduleType);
-
   /*
     Since vendor exceptions have already been handled, the purpose as a whole is allowed if it's not being enforced
     or the user has consented. Similar with vendors.
   */
   const purposeAllowed = rule.enforcePurpose === false || purposeConsent === true;
-  const vendorAllowed = rule.enforceVendor === false || vendorConsent === true || vendorlessModule === true;
+  const vendorAllowed = rule.enforceVendor === false || vendorConsent === true;
 
   /*
     Few if any vendors should be declaring Legitimate Interest for Device Access (Purpose 1), but some are claiming
@@ -167,16 +162,15 @@ export function validateRules(rule, consentData, currentModule, gvlId, moduleTyp
  * @param {Function} fn reference to original function (used by hook logic)
  * @param {Number=} gvlid gvlid of the module
  * @param {string=} moduleName name of the module
- * @param {string=} moduleType module type
  */
-export function deviceAccessHook(fn, gvlid, moduleName, moduleType, result) {
+export function deviceAccessHook(fn, gvlid, moduleName, result) {
   result = Object.assign({}, {
     hasEnforcementHook: true
   });
   if (!hasDeviceAccess()) {
     logWarn('Device access is disabled by Publisher');
     result.valid = false;
-    fn.call(this, gvlid, moduleName, moduleType, result);
+    fn.call(this, gvlid, moduleName, result);
   } else {
     const consentData = gdprDataHandler.getConsentData();
     if (consentData && consentData.gdprApplies) {
@@ -188,19 +182,19 @@ export function deviceAccessHook(fn, gvlid, moduleName, moduleType, result) {
         gvlid = getGvlid(moduleName) || gvlid;
       }
       const curModule = moduleName || curBidder;
-      let isAllowed = validateRules(purpose1Rule, consentData, curModule, gvlid, moduleType);
+      let isAllowed = validateRules(purpose1Rule, consentData, curModule, gvlid);
       if (isAllowed) {
         result.valid = true;
-        fn.call(this, gvlid, moduleName, moduleType, result);
+        fn.call(this, gvlid, moduleName, result);
       } else {
         curModule && logWarn(`TCF2 denied device access for ${curModule}`);
         result.valid = false;
         storageBlocked.push(curModule);
-        fn.call(this, gvlid, moduleName, moduleType, result);
+        fn.call(this, gvlid, moduleName, result);
       }
     } else {
       result.valid = true;
-      fn.call(this, gvlid, moduleName, moduleType, result);
+      fn.call(this, gvlid, moduleName, result);
     }
   }
 }

package/modules/gumgumBidAdapter.js

@@ -370,6 +370,8 @@ function buildRequests(validBidRequests, bidderRequest) {
         data.pi = 5;
       } else if (mediaTypes.video) {
         data.pi = mediaTypes.video.linearity === 2 ? 6 : 7; // invideo : video
+      } else if (params.product && params.product.toLowerCase() === 'skin') {
+        data.pi = 8;
       }
     } else { // legacy params
       data = { ...data, ...handleLegacyParams(params, sizes) }

package/modules/gumgumBidAdapter.md

@@ -10,7 +10,7 @@ Maintainer: engineering@gumgum.com
 
 GumGum adapter for Prebid.js
 Please note that both video and in-video products require a mediaType of video. 
-In-screen and slot products should have a mediaType of banner.
+In-screen, slot, and skin products should have a mediaType of banner.
 
 # Test Parameters
 ```
@@ -50,6 +50,24 @@ var adUnits = [
         }
       }
     ]
+  },{
+    code: 'skin-placement',
+    sizes: [[300, 50]],
+    mediaTypes: {
+        banner: {
+          sizes: [[1, 1]],
+        }
+    },
+    bids: [
+      {
+        bidder: 'gumgum',
+        params: {
+          zone: 'dc9d6be1', // GumGum Zone ID given to the client
+          product: 'skin',
+          bidfloor: 0.03 // CPM bid floor
+        }
+      }
+    ]
   },{
     code: 'video-placement',
     sizes: [[300, 50]],

package/modules/hadronAnalyticsAdapter.md

@@ -33,7 +33,7 @@ The following configuration parameters are available:
 
 ```javascript
 pbjs.enableAnalytics({
-    provider: 'hadron',
+    provider: 'hadronAnalytics',
     options: {
         partnerId: 1234, // change to the Partner ID you got from Audigent
         eventsToTrack: ['auctionEnd','bidWon']
@@ -41,8 +41,8 @@ pbjs.enableAnalytics({
 });
 ```
 
-| Parameter | Scope | Type | Description                                             | Example |
-| --- | --- | --- |---------------------------------------------------------| --- |
-| provider | Required | String | The name of this module: `hadronAnalytics`              | `hadronAnalytics` |
-| options.partnerId | Required | Number | This is the Audigent Partner ID obtained from Audigent. | `1234` |
+| Parameter             | Scope    | Type             | Description                                             | Example                   |
+|-----------------------|----------|------------------|---------------------------------------------------------|---------------------------|
+| provider              | Required | String           | The name of this module: `hadronAnalytics`              | `hadronAnalytics`         |
+| options.partnerId     | Required | Number           | This is the Audigent Partner ID obtained from Audigent. | `1234`                    |
 | options.eventsToTrack | Optional | Array of strings | Overrides the set of tracked events                     | `['auctionEnd','bidWon']` |

package/modules/hadronIdSystem.js

@@ -12,6 +12,7 @@ import { isFn, isStr, isPlainObject, logError } from '../src/utils.js';
 
 const MODULE_NAME = 'hadronId';
 const AU_GVLID = 561;
+const DEFAULT_HADRON_URL_ENDPOINT = 'https://id.hadron.ad.gt/api/v1/pbhid';
 
 export const storage = getStorageManager({gvlid: AU_GVLID, moduleName: 'hadron'});
 
@@ -29,6 +30,15 @@ function paramOrDefault(param, defaultVal, arg) {
   return defaultVal;
 }
 
+/**
+ * @param {string} url
+ * @param {string} params
+ * @returns {string}
+ */
+const urlAddParams = (url, params) => {
+  return url + (url.indexOf('?') > -1 ? '&' : '?') + params
+}
+
 /** @type {Submodule} */
 export const hadronIdSubmodule = {
   /**
@@ -39,8 +49,8 @@ export const hadronIdSubmodule = {
   /**
    * decode the stored id value for passing to bid requests
    * @function
-   * @param {{value:string}} value
-   * @returns {{hadronId:Object}}
+   * @param {string} value
+   * @returns {Object}
    */
   decode(value) {
     let hadronId = storage.getDataFromLocalStorage('auHadronId');
@@ -59,9 +69,12 @@ export const hadronIdSubmodule = {
     if (!isPlainObject(config.params)) {
       config.params = {};
     }
-    const url = paramOrDefault(config.params.url,
-      `https://id.hadron.ad.gt/api/v1/pbhid`,
-      config.params.urlArg);
+    const partnerId = config.params.partnerId | 0;
+
+    const url = urlAddParams(
+      paramOrDefault(config.params.url, DEFAULT_HADRON_URL_ENDPOINT, config.params.urlArg),
+      `partner_id=${partnerId}&_it=prebid`
+    );
 
     const resp = function (callback) {
       let hadronId = storage.getDataFromLocalStorage('auHadronId');

package/modules/hadronIdSystem.md

@@ -11,6 +11,9 @@ pbjs.setConfig({
     usersync: {
         userIds: [{
             name: 'hadronId',
+            params: {
+                partnerId: 1234   // change it to the Partner ID you'll get from Audigent
+            },
             storage: {
                 name: 'hadronId',
                 type: 'html5'
@@ -22,14 +25,15 @@ pbjs.setConfig({
 ## Parameter Descriptions for the `usersync` Configuration Section
 The below parameters apply only to the HadronID User ID Module integration.
 
-| Param under usersync.userIds[] | Scope | Type | Description | Example |
-| --- | --- | --- | --- | --- |
-| name | Required | String | ID value for the HadronID module - `"hadronId"` | `"hadronId"` |
-| storage | Required | Object | The publisher must specify the local storage in which to store the results of the call to get the user ID. This can be either cookie or HTML5 storage. | |
-| storage.type | Required | String | This is where the results of the user ID will be stored. The recommended method is `localStorage` by specifying `html5`. | `"html5"` |
-| storage.name | Required | String | The name of the cookie or html5 local storage where the user ID will be stored. | `"hadronid"` |
-| storage.expires | Optional | Integer | How long (in days) the user ID information will be stored. | `365` |
-| value | Optional | Object | Used only if the page has a separate mechanism for storing the Hadron ID. The value is an object containing the values to be sent to the adapters. In this scenario, no URL is called and nothing is added to local storage | `{"hadronId": "eb33b0cb-8d35-4722-b9c0-1a31d4064888"}` |
-| params | Optional | Object | Used to store params for the id system |
-| params.url | Optional | String | Set an alternate GET url for HadronId with this parameter |
-| params.urlArg | Optional | Object | Optional url parameter for params.url |
+| Param under usersync.userIds[] | Scope    | Type    | Description                                                                                                                                                                                                                 | Example                                                |
+|--------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------|
+| name                           | Required | String  | ID value for the HadronID module - `"hadronId"`                                                                                                                                                                             | `"hadronId"`                                           |
+| storage                        | Required | Object  | The publisher must specify the local storage in which to store the results of the call to get the user ID. This can be either cookie or HTML5 storage.                                                                      |                                                        |
+| storage.type                   | Required | String  | This is where the results of the user ID will be stored. The recommended method is `localStorage` by specifying `html5`.                                                                                                    | `"html5"`                                              |
+| storage.name                   | Required | String  | The name of the cookie or html5 local storage where the user ID will be stored.                                                                                                                                             | `"hadronid"`                                           |
+| storage.expires                | Optional | Integer | How long (in days) the user ID information will be stored.                                                                                                                                                                  | `365`                                                  |
+| value                          | Optional | Object  | Used only if the page has a separate mechanism for storing the Hadron ID. The value is an object containing the values to be sent to the adapters. In this scenario, no URL is called and nothing is added to local storage | `{"hadronId": "eb33b0cb-8d35-4722-b9c0-1a31d4064888"}` |
+| params                         | Optional | Object  | Used to store params for the id system                                                                                                                                                                                      |
+| params.partnerId               | Required | Number  | This is the Audigent Partner ID obtained from Audigent.                                                                                                                                                                     | `1234`                                                 |
+| params.url                     | Optional | String  | Set an alternate GET url for HadronId with this parameter                                                                                                                                                                   |
+| params.urlArg                  | Optional | Object  | Optional url parameter for params.url                                                                                                                                                                                       |

package/modules/hadronRtdProvider.js

@@ -23,6 +23,15 @@ export const HALOID_LOCAL_NAME = 'auHadronId';
 export const RTD_LOCAL_NAME = 'auHadronRtd';
 export const storage = getStorageManager({gvlid: AU_GVLID, moduleName: SUBMODULE_NAME});
 
+/**
+ * @param {string} url
+ * @param {string} params
+ * @returns {string}
+ */
+const urlAddParams = (url, params) => {
+  return url + (url.indexOf('?') > -1 ? '&' : '?') + params
+}
+
 /**
  * Deep set an object unless value present.
  * @param {Object} obj
@@ -165,8 +174,12 @@ export function getRealTimeData(bidConfig, onDone, rtdConfig, userConsent) {
       userIds.hadronId = hadronId;
       getRealTimeDataAsync(bidConfig, onDone, rtdConfig, userConsent, userIds);
     }
+    const partnerId = rtdConfig.params.partnerId | 0;
     const hadronIdUrl = rtdConfig.params && rtdConfig.params.hadronIdUrl;
-    const scriptUrl = paramOrDefault(hadronIdUrl, HADRON_ID_DEFAULT_URL, userIds);
+    const scriptUrl = urlAddParams(
+      paramOrDefault(hadronIdUrl, HADRON_ID_DEFAULT_URL, userIds),
+      `partner_id=${partnerId}&_it=prebid`
+    );
     loadExternalScript(scriptUrl, 'hadron', () => {
       logInfo(LOG_PREFIX, 'hadronIdTag loaded', scriptUrl);
     })