npm - prebid.js - Versions diffs - 6.8.0 → 6.12.0 - Mend

prebid.js 6.8.0 → 6.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2020) hide show

package/modules/sspBCBidAdapter.js CHANGED Viewed

@@ -8,8 +8,10 @@ const BIDDER_CODE = 'sspBC';
 const BIDDER_URL = 'https://ssp.wp.pl/bidder/';
 const SYNC_URL = 'https://ssp.wp.pl/bidder/usersync';
 const NOTIFY_URL = 'https://ssp.wp.pl/bidder/notify';
+const TRACKER_URL = 'https://bdr.wpcdn.pl/tag/jstracker.js';
+const GVLID = 676;
 const TMAX = 450;
-const BIDDER_VERSION = '5.3';
+const BIDDER_VERSION = '5.41';
 const W = window;
 const { navigator } = W;
 const oneCodeDetection = {};
@@ -29,8 +31,8 @@ const getNotificationPayload = bidData => {
       const result = {
         requestId: undefined,
         siteId: [],
-        adUnit: [],
         slotId: [],
+        tagid: [],
       }
       bids.forEach(bid => {
         let params = isArray(bid.params) ? bid.params[0] : bid.params;
@@ -55,7 +57,7 @@ const getNotificationPayload = bidData => {
           result.adomain = meta.advertiserDomains && meta.advertiserDomains[0];
           result.networkName = meta.networkName;
         }
-        result.adUnit.push(bid.adUnitCode)
+        result.tagid.push(bid.adUnitCode);
         result.requestId = bid.auctionId || result.requestId;
         result.timeout = bid.timeout || result.timeout;
       })
@@ -123,7 +125,16 @@ const applyClientHints = ortbRequest => {
       ]
     }];
-  ortbRequest.user = Object.assign(ortbRequest.user, { data });
+  const ch = { data };
+  ortbRequest.user = { ...ortbRequest.user, ...ch };
+};
+const applyUserIds = (validBidRequest, ortbRequest) => {
+  const eids = validBidRequest.userIdAsEids
+  if (eids && eids.length) {
+    const ids = { eids };
+    ortbRequest.user = { ...ortbRequest.user, ...ids };
+  }
 };
 /**
@@ -135,8 +146,8 @@ const applyGdpr = (bidderRequest, ortbRequest) => {
   if (gdprConsent) {
     const { apiVersion, gdprApplies, consentString } = gdprConsent;
     consentApiVersion = apiVersion;
-    ortbRequest.regs = Object.assign(ortbRequest.regs, { '[ortb_extensions.gdpr]': gdprApplies ? 1 : 0 });
-    ortbRequest.user = Object.assign(ortbRequest.user, { '[ortb_extensions.consent]': consentString });
+    ortbRequest.regs = Object.assign(ortbRequest.regs, { 'gdpr': gdprApplies ? 1 : 0 });
+    ortbRequest.user = Object.assign(ortbRequest.user, { 'consent': consentString });
   }
 }
@@ -299,7 +310,7 @@ const mapImpression = slot => {
   ext.data = Object.assign({ pbsize: adUnitsCalled[adUnitCode] }, ext.data);
   const imp = {
-    id: id && siteId ? id : 'bidid-' + bidId,
+    id: id && siteId ? id.padStart(3, '0') : 'bidid-' + bidId,
     banner: mapBanner(slot),
     native: mapNative(slot),
     video: mapVideo(slot),
@@ -342,7 +353,7 @@ const isVideoAd = bid => {
 const isNativeAd = bid => {
   const xmlTester = new RegExp(/^{['"]native['"]/);
-  return bid.adm && bid.adm.match(xmlTester);
+  return bid.admNative || (bid.adm && bid.adm.match(xmlTester));
 }
 const parseNative = nativeData => {
@@ -450,12 +461,10 @@ const renderCreative = (site, auctionId, bid, seat, request) => {
   window.gdpr = ${JSON.stringify(request.gdprConsent)};
   window.page = "${site.page}";
   window.ref = "${site.ref}";
+  window.adlabel = "${site.adLabel ? site.adLabel : ''}";
+  window.pubid = "${site.publisherId ? site.publisherId : ''}";
   `;
-  if (gam) {
-    adcode += `window.gam = ${JSON.stringify(gam)};`;
-  }
   adcode += `</script>
     </head>
     <body>
@@ -469,6 +478,7 @@ const renderCreative = (site, auctionId, bid, seat, request) => {
 const spec = {
   code: BIDDER_CODE,
+  gvlid: GVLID,
   aliases: [],
   supportedMediaTypes: [BANNER, NATIVE, VIDEO],
   isBidRequestValid(bid) {
@@ -513,6 +523,7 @@ const spec = {
     applyGdpr(bidderRequest, payload);
     applyClientHints(payload);
+    applyUserIds(validBidRequests[0], payload);
     return {
       method: 'POST',
@@ -558,10 +569,14 @@ const spec = {
             /*
               bid response might include ext object containing siteId / slotId, as detected by OneCode
               update site / slot data in this case
+              ext also might contain publisherId and custom ad label
             */
-            const { siteid, slotid } = ext;
+            const { siteid, slotid, pubid, adlabel } = ext;
             site.id = siteid || site.id;
             site.slot = slotid || site.slot;
+            site.publisherId = pubid;
+            site.adLabel = adlabel;
           }
           if (bidRequest && site.id && !strIncludes(site.id, 'bidid')) {
@@ -598,10 +613,28 @@ const spec = {
               bid.mediaType = 'native';
               // check native object
               try {
-                const nativeData = JSON.parse(serverBid.adm).native;
+                const nativeData = serverBid.admNative || JSON.parse(serverBid.adm).native;
                 bid.native = parseNative(nativeData);
                 bid.width = 1;
                 bid.height = 1;
+                // append viewability tracker
+                const jsData = {
+                  rid: bidRequest.auctionId,
+                  crid: bid.creativeId,
+                  adunit: bidRequest.adUnitCode,
+                  url: bid.native.clickUrl,
+                  vendor: seat,
+                  site: site.id,
+                  slot: site.slot,
+                  cpm: bid.cpm.toPrecision(4),
+                }
+                const jsTracker = '<script type="text/javascript" async="true" src="' + TRACKER_URL + '" ' + Object.keys(jsData).reduce((acc, current) => { return acc + ` data-wpar-${current}="${jsData[current]}"` }, '') + '><\/script>';
+                if (bid.native.javascriptTrackers) {
+                  bid.native.javascriptTrackers.push(jsTracker);
+                } else {
+                  bid.native.javascriptTrackers = [jsTracker];
+                }
               } catch (err) {
                 logWarn('Could not parse native data', serverBid.adm);
                 bid.cpm = 0;
@@ -624,15 +657,15 @@ const spec = {
     return bids;
   },
-  getUserSyncs(syncOptions) {
+  getUserSyncs(syncOptions, serverResponses, gdprConsent) {
+    let mySyncs = [];
     if (syncOptions.iframeEnabled && consentApiVersion != 1) {
-      return [{
+      mySyncs.push({
         type: 'iframe',
         url: `${SYNC_URL}?tcf=${consentApiVersion}`,
-      }];
-    } else {
-      logWarn('sspBC adapter requires iframe based user sync.');
-    }
+      });
+    };
+    return mySyncs;
   },
   onTimeout(timeoutData) {

package/modules/telariaBidAdapter.js CHANGED Viewed

@@ -1,8 +1,6 @@
 import { logError, isEmpty, deepAccess, triggerPixel, logWarn, isArray } from '../src/utils.js';
-import {createBid as createBidFactory} from '../src/bidfactory.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {VIDEO} from '../src/mediaTypes.js';
-import CONSTANTS from '../src/constants.json';
 const BIDDER_CODE = 'telaria';
 const DOMAIN = 'tremorhub.com';
@@ -86,7 +84,9 @@ export const spec = {
       logError(errorMessage);
     } else if (!isEmpty(bidResult.seatbid)) {
       bidResult.seatbid[0].bid.forEach(tag => {
-        bids.push(createBid(CONSTANTS.STATUS.GOOD, bidderRequest, tag, width, height, BIDDER_CODE));
+        if (tag) {
+          bids.push(createBid(bidderRequest, tag, width, height));
+        }
       });
     }
@@ -253,38 +253,31 @@ function generateUrl(bid, bidderRequest) {
 }
 /**
- * Create and return a bid object based on status and tag
- * @param status
+ * Create and return a bid response
  * @param reqBid
  * @param response
  * @param width
  * @param height
- * @param bidderCode
  */
-function createBid(status, reqBid, response, width, height, bidderCode) {
-  let bid = createBidFactory(status, reqBid);
+function createBid(reqBid, response, width, height) {
   // TTL 5 mins by default, future support for extended imp wait time
-  if (response) {
-    Object.assign(bid, {
-      requestId: reqBid.bidId,
-      cpm: response.price,
-      creativeId: response.crid || '-1',
-      vastXml: response.adm,
-      vastUrl: reqBid.vastUrl,
-      mediaType: 'video',
-      width: width,
-      height: height,
-      bidderCode: bidderCode,
-      currency: 'USD',
-      netRevenue: true,
-      ttl: 300,
-      ad: response.adm
-    });
-  }
-  bid.meta = bid.meta || {};
-  if (response && response.adomain && response.adomain.length > 0) {
+  const bid = {
+    requestId: reqBid.bidId,
+    cpm: response.price,
+    creativeId: response.crid || '-1',
+    vastXml: response.adm,
+    vastUrl: reqBid.vastUrl,
+    mediaType: 'video',
+    width: width,
+    height: height,
+    currency: 'USD',
+    netRevenue: true,
+    ttl: 300,
+    ad: response.adm,
+    meta: {}
+  };
+  if (response.adomain && response.adomain.length > 0) {
     bid.meta.advertiserDomains = response.adomain;
   }

package/modules/trustpidSystem.js ADDED Viewed

@@ -0,0 +1,197 @@
+/**
+ * This module adds TrustPid provided by Vodafone Sales and Services Limited to the User ID module
+ * The {@link module:modules/userId} module is required
+ * @module modules/trustpidSystem
+ * @requires module:modules/userId
+ */
+import { logInfo, logError } from '../src/utils.js';
+import { submodule } from '../src/hook.js';
+import { getStorageManager } from '../src/storageManager.js';
+const MODULE_NAME = 'trustpid';
+const LOG_PREFIX = 'Trustpid module'
+let mnoAcronym = '';
+let mnoDomain = '';
+export const storage = getStorageManager(null, MODULE_NAME);
+/**
+ * Handle an event for an iframe.
+ * Takes the body.url parameter from event and returns the string domain.
+ * i.e.: "fc.vodafone.de"
+ * @param event
+ */
+function messageHandler(event) {
+  let msg;
+  try {
+    if (event && event.data && typeof event.data === 'string' && event.data) {
+      msg = JSON.parse(event.data);
+      if (msg.msgType === 'MNOSELECTOR' && msg.body && msg.body.url) {
+        let URL = msg.body.url.split('//');
+        let domainURL = URL[1].split('/');
+        mnoDomain = domainURL[0];
+        logInfo(`${LOG_PREFIX}: Message handler set domain to ${mnoDomain}`);
+        getDomainAcronym(mnoDomain);
+      }
+    }
+  } catch (e) {
+    logError(e);
+  }
+}
+/**
+ * Properly sets the trustpid acronym depending on the domain value.
+ * @param domain
+ */
+function getDomainAcronym(domain) {
+  let acronym = '';
+  const prefix = '-';
+  switch (domain) {
+    case 'tmi.mno.link':
+      acronym = 'ndye';
+      break;
+    case 'tmi.vodafone.de':
+      acronym = 'pqnx';
+      break;
+    case 'tmi.telekom.de':
+      acronym = 'avgw';
+      break;
+    case 'tmi.tmid.es':
+      acronym = 'kjws';
+      break;
+    case 'uat.mno.link':
+      acronym = 'xxxx';
+      break;
+    case 'es.tmiservice.orange.com':
+      acronym = 'aplw';
+      break;
+    default:
+      return 'none';
+  }
+  return mnoAcronym = prefix + acronym;
+}
+// Set a listener to handle the iframe response message.
+window.addEventListener('message', messageHandler, false);
+/**
+ * Get the "umid" from html5 local storage to make it available to the UserId module.
+ * @param config
+ * @returns {{trustpid: (*|string), acr: (string)}}
+ */
+function getTrustpidFromStorage() {
+  // Get the domain either from localStorage or global
+  let domain = JSON.parse(storage.getDataFromLocalStorage('fcIdConnectDomain')) || mnoDomain;
+  logInfo(`${LOG_PREFIX}: Local storage domain: ${domain}`);
+  if (!domain) {
+    logInfo(`${LOG_PREFIX}: Local storage domain not found, returning null`);
+    return {
+      trustpid: null,
+      acr: null,
+    };
+  }
+  // Get the acronym from global
+  let acronym = mnoAcronym;
+  // if acronym is empty, but "domain" is available, get the acronym from domain
+  if (!acronym) {
+    getDomainAcronym(domain);
+    acronym = mnoAcronym;
+  }
+  logInfo(`${LOG_PREFIX}: Domain acronym found: ${acronym}`);
+  // Domain is correct in both local storage and idGraph, but no acronym is existing for the domain
+  if (domain && !acronym) {
+    return {
+      trustpid: null,
+      acr: null
+    }
+  }
+  let fcIdConnectObject;
+  let fcIdConnectData = JSON.parse(storage.getDataFromLocalStorage('fcIdConnectData'));
+  logInfo(`${LOG_PREFIX}: Local storage fcIdConnectData: ${JSON.stringify(fcIdConnectData)}`);
+  if (fcIdConnectData &&
+    fcIdConnectData.connectId &&
+    Array.isArray(fcIdConnectData.connectId.idGraph) &&
+    fcIdConnectData.connectId.idGraph.length > 0) {
+    fcIdConnectObject = fcIdConnectData.connectId.idGraph.find(item => {
+      return item.domain === domain;
+    });
+  }
+  logInfo(`${LOG_PREFIX}: Local storage fcIdConnectObject for domain: ${JSON.stringify(fcIdConnectObject)}`);
+  return {
+    trustpid: (fcIdConnectObject && fcIdConnectObject.umid)
+      ? fcIdConnectObject.umid
+      : null,
+    acr: acronym,
+  };
+}
+/** @type {Submodule} */
+export const trustpidSubmodule = {
+  /**
+   * Used to link submodule with config
+   * @type {string}
+   */
+  name: MODULE_NAME,
+  /**
+   * Decodes the stored id value for passing to bid requests.
+   * @function
+   * @returns {{trustpid: string} | null}
+   */
+  decode(bidId) {
+    logInfo(`${LOG_PREFIX}: Decoded ID value ${JSON.stringify(bidId)}`);
+    return bidId.trustpid ? bidId : null;
+  },
+  /**
+   * Get the id from helper function and initiate a new user sync.
+   * @param config
+   * @returns {{callback: result}|{id: {trustpid: string}}}
+   */
+  getId: function(config) {
+    const data = getTrustpidFromStorage();
+    if (data.trustpid) {
+      logInfo(`${LOG_PREFIX}: Local storage ID value ${JSON.stringify(data)}`);
+      return {id: {trustpid: data.trustpid + data.acr}};
+    } else {
+      if (!config) {
+        config = {};
+      }
+      if (!config.params) {
+        config.params = {};
+      }
+      if (typeof config.params.maxDelayTime === 'undefined' || config.params.maxDelayTime === null) {
+        config.params.maxDelayTime = 1000;
+      }
+      // Current delay and delay step in milliseconds
+      let currentDelay = 0;
+      const delayStep = 50;
+      const result = (callback) => {
+        const data = getTrustpidFromStorage();
+        if (!data.trustpid) {
+          if (currentDelay > config.params.maxDelayTime) {
+            logInfo(`${LOG_PREFIX}: No trustpid value set after ${config.params.maxDelayTime} max allowed delay time`);
+            callback(null);
+          } else {
+            currentDelay += delayStep;
+            setTimeout(() => {
+              result(callback);
+            }, delayStep);
+          }
+        } else {
+          const dataToReturn = { trustpid: data.trustpid + data.acr };
+          logInfo(`${LOG_PREFIX}: Returning ID value data of ${JSON.stringify(dataToReturn)}`);
+          callback(dataToReturn);
+        }
+      };
+      return { callback: result };
+    }
+  },
+};
+submodule('userId', trustpidSubmodule);

package/modules/trustpidSystem.md ADDED Viewed

@@ -0,0 +1,45 @@
+## trustpid User Id Submodule
+trustpid User Id Module.
+First, make sure to add the trustpid submodule to your Prebid.js package with:
+```
+gulp build --modules=userId,adfBidAdapter,trustpidSystem
+```
+The following configuration parameters are available:
+```
+pbjs.setConfig({
+  userSync: {
+    userIds: [
+      {
+        name: 'trustpid',
+        params: {
+          maxDelayTime: 1000,
+        },
+        bidders: ["adf"],
+        storage: {
+          type: "html5",
+          name: "trustpid",
+          expires: 1, //days
+        },
+      }
+    ],
+  }
+});
+```
+## Parameter Descriptions
+| Param under userSync.userIds[] | Scope | Type | Description | Example |
+| --- | --- | --- | --- | --- |
+| name | Required | String | The name of the module | `"trustpid"`
+| params | Required | Object | Object with configuration parameters for trustpid User Id submodule | - |
+| params.maxDelayTime | Required | Integer | Max amount of time (in seconds) before looking into storage for data | 2500 |
+| bidders | Required | Array of Strings | An array of bidder codes to which this user ID may be sent. Currently required and supporting AdformOpenRTB | `["adf"]` |
+| storage | Required | Object | Local storage configuration object | - |
+| storage.type | Required | String | Type of the storage that would be used to store user ID. Must be `"html5"` to utilise HTML5 local storage. | `"html5"` |
+| storage.name | Required | String | The name of the key in local storage where the user ID will be stored. | `"trustpid"` |
+| storage.expires | Required | Integer | How long (in days) the user ID information will be stored. For safety reasons, this information is required.| `1` |

package/modules/trustxBidAdapter.js CHANGED Viewed

@@ -101,12 +101,17 @@ export const spec = {
         }
       };
-      if (ortb2Imp && ortb2Imp.ext && ortb2Imp.ext.data) {
-        impObj.ext.data = ortb2Imp.ext.data;
-        if (impObj.ext.data.adserver && impObj.ext.data.adserver.adslot) {
-          impObj.ext.gpid = impObj.ext.data.adserver.adslot.toString();
-        } else {
-          impObj.ext.gpid = ortb2Imp.ext.data.pbadslot && ortb2Imp.ext.data.pbadslot.toString();
+      if (ortb2Imp) {
+        if (ortb2Imp.instl) {
+          impObj.instl = ortb2Imp.instl;
+        }
+        if (ortb2Imp.ext && ortb2Imp.ext.data) {
+          impObj.ext.data = ortb2Imp.ext.data;
+          if (impObj.ext.data.adserver && impObj.ext.data.adserver.adslot) {
+            impObj.ext.gpid = impObj.ext.data.adserver.adslot.toString();
+          } else {
+            impObj.ext.gpid = ortb2Imp.ext.data.pbadslot && ortb2Imp.ext.data.pbadslot.toString();
+          }
         }
       }

package/modules/userId/eids.js CHANGED Viewed

@@ -5,6 +5,15 @@ const USER_IDS_CONFIG = {
   // key-name : {config}
+  // trustpid
+  'trustpid': {
+    source: 'trustpid.com',
+    atype: 1,
+    getValue: function (data) {
+      return data;
+    },
+  },
   // intentIqId
   'intentIqId': {
     source: 'intentiq.com',
@@ -17,6 +26,12 @@ const USER_IDS_CONFIG = {
     atype: 1
   },
+  // justId
+  'justId': {
+    source: 'justtag.com',
+    atype: 1
+  },
   // pubCommonId
   'pubcid': {
     source: 'pubcid.org',
@@ -146,7 +161,13 @@ const USER_IDS_CONFIG = {
     atype: 1
   },
-  // haloId
+  // hadronId
+  'hadronId': {
+    source: 'audigent.com',
+    atype: 1
+  },
+  // haloId (deprecated in 7.0, use hadronId)
   'haloId': {
     source: 'audigent.com',
     atype: 1

package/modules/userId/eids.md CHANGED Viewed

@@ -2,6 +2,14 @@
 ```
 userIdAsEids = [
+    {
+        source: 'trustpid.com',
+        uids: [{
+            id: 'some-random-id-value',
+            atype: 1
+        }]
+    },
     {
         source: 'pubcid.org',
         uids: [{
@@ -28,7 +36,15 @@ userIdAsEids = [
             atype: 1
         }]
     },
+    {
+        source: 'justtag.com',
+        uids: [{
+            id: 'justId',
+            atype: 1
+        }]
+    },
     {
         source: 'neustar.biz',
         uids: [{
@@ -203,7 +219,7 @@ userIdAsEids = [
             id: 'some-random-id-value',
             atype: 3
         }]
-    },
+    },
     {
          source: 'kpuid.com',
          uids: [{

package/modules/userId/userId.md CHANGED Viewed

@@ -1,6 +1,7 @@
 ## User ID Example Configuration
 Example showing `cookie` storage for user id data for each of the submodules
 ```
 pbjs.setConfig({
     userSync: {
@@ -147,10 +148,23 @@ pbjs.setConfig({
 ```
 Example showing `localStorage` for user id data for some submodules
 ```
 pbjs.setConfig({
     userSync: {
-        userIds: [{
+        userIds: [
+            {
+            name: 'trustpid',
+            params: {
+              maxDelayTime: 2500
+            },
+            bidders: ['adform'],
+            storage: {
+              type: 'html5',
+              name: 'trustpid',
+              expires: 60
+            }
+        }, {
             name: "unifiedId",
             params: {
                 partner: "prebid",
@@ -278,7 +292,7 @@ pbjs.setConfig({
                  name: "knssoId",
                  expires: 30
                   },
-        }
+        }
         },
         {
             name: 'imuid',
@@ -312,6 +326,7 @@ pbjs.setConfig({
 ```
 Example showing how to configure a `value` object to pass directly to bid adapters
 ```
 pbjs.setConfig({
     userSync: {