prebid.js 7.16.0 → 7.18.0

package/modules/growthCodeIdSystem.js

@@ -0,0 +1,164 @@
+/**
+ * This module adds GrowthCodeId to the User ID module
+ * The {@link module:modules/userId} module is required
+ * @module modules/growthCodeIdSystem
+ * @requires module:modules/userId
+ */
+
+import {logError, logInfo, tryAppendQueryString} from '../src/utils.js';
+import {ajax} from '../src/ajax.js';
+import { submodule } from '../src/hook.js'
+import { getStorageManager } from '../src/storageManager.js';
+
+const GCID_EXPIRY = 45;
+const MODULE_NAME = 'growthCodeId';
+const GC_DATA_KEY = '_gc_data';
+const ENDPOINT_URL = 'https://p2.gcprivacy.com/v1/pb?'
+
+export const storage = getStorageManager({ gvlid: undefined, moduleName: MODULE_NAME });
+
+/**
+ * Read GrowthCode data from cookie or local storage
+ * @param key
+ * @return {string}
+ */
+export function readData(key) {
+  try {
+    if (storage.hasLocalStorage()) {
+      return storage.getDataFromLocalStorage(key);
+    }
+    if (storage.cookiesAreEnabled()) {
+      return storage.getCookie(key);
+    }
+  } catch (error) {
+    logError(error);
+  }
+}
+
+/**
+ * Store GrowthCode data in either cookie or local storage
+ * expiration date: 45 days
+ * @param key
+ * @param {string} value
+ */
+function storeData(key, value) {
+  try {
+    logInfo(MODULE_NAME + ': storing data: key=' + key + ' value=' + value);
+
+    if (value) {
+      if (storage.hasLocalStorage()) {
+        storage.setDataInLocalStorage(key, value);
+      }
+      const expiresStr = (new Date(Date.now() + (GCID_EXPIRY * (60 * 60 * 24 * 1000)))).toUTCString();
+      if (storage.cookiesAreEnabled()) {
+        storage.setCookie(key, value, expiresStr, 'LAX');
+      }
+    }
+  } catch (error) {
+    logError(error);
+  }
+}
+
+/**
+ * Parse json if possible, else return null
+ * @param data
+ * @param {object|null}
+ */
+function tryParse(data) {
+  try {
+    return JSON.parse(data);
+  } catch (err) {
+    logError(err);
+    return null;
+  }
+}
+
+/** @type {Submodule} */
+export const growthCodeIdSubmodule = {
+  /**
+   * used to link submodule with config
+   * @type {string}
+   */
+  name: MODULE_NAME,
+  /**
+   * decode the stored id value for passing to bid requests
+   * @function
+   * @param {{string}} value
+   * @returns {{growthCodeId: {string}}|undefined}
+   */
+  decode(value) {
+    return value && value !== '' ? { 'growthCodeId': value } : undefined;
+  },
+  /**
+   * performs action to obtain id and return a value in the callback's response argument
+   * @function
+   * @param {SubmoduleConfig} [config]
+   * @returns {IdResponse|undefined}
+   */
+  getId(config, consentData) {
+    const configParams = (config && config.params) || {};
+    if (!configParams || typeof configParams.pid !== 'string') {
+      logError('User ID - GrowthCodeID submodule requires a valid Partner ID to be defined');
+      return;
+    }
+
+    const gdpr = (consentData && typeof consentData.gdprApplies === 'boolean' && consentData.gdprApplies) ? 1 : 0;
+    const consentString = gdpr ? consentData.consentString : '';
+    if (gdpr && !consentString) {
+      logInfo('Consent string is required to call GrowthCode id.');
+      return;
+    }
+
+    let publisherId = configParams.publisher_id ? configParams.publisher_id : '_sharedID';
+
+    let sharedId;
+    if (configParams.publisher_id_storage === 'html5') {
+      sharedId = storage.getDataFromLocalStorage(publisherId, null) ? (storage.getDataFromLocalStorage(publisherId, null)) : null;
+    } else {
+      sharedId = storage.getCookie(publisherId, null) ? (storage.getCookie(publisherId, null)) : null;
+    }
+    if (!sharedId) {
+      logError('User ID - Publisher ID is not correctly setup.');
+    }
+
+    const resp = function(callback) {
+      let gcData = tryParse(readData(GC_DATA_KEY));
+      if (gcData) {
+        callback(gcData);
+      } else {
+        let segment = window.location.pathname.substr(1).replace(/\/+$/, '');
+        if (segment === '') {
+          segment = 'home';
+        }
+
+        let url = configParams.url ? configParams.url : ENDPOINT_URL;
+        url = tryAppendQueryString(url, 'pid', configParams.pid);
+        url = tryAppendQueryString(url, 'uid', sharedId);
+        url = tryAppendQueryString(url, 'u', window.location.href);
+        url = tryAppendQueryString(url, 'h', window.location.hostname);
+        url = tryAppendQueryString(url, 's', segment);
+        url = tryAppendQueryString(url, 'r', document.referrer);
+
+        ajax(url, {
+          success: response => {
+            let respJson = tryParse(response);
+            // If response is a valid json and should save is true
+            if (respJson) {
+              storeData(GC_DATA_KEY, JSON.stringify(respJson))
+              callback(respJson);
+            } else {
+              callback();
+            }
+          },
+          error: error => {
+            logError(MODULE_NAME + ': ID fetch encountered an error', error);
+            callback();
+          }
+        }, undefined, {method: 'GET', withCredentials: true})
+      }
+    };
+    return { callback: resp };
+  }
+};
+
+submodule('userId', growthCodeIdSubmodule);

package/modules/growthCodeIdSystem.md

@@ -0,0 +1,37 @@
+## GrowthCode User ID Submodule
+
+GrowthCode provides Id Enrichment for requests. 
+
+## Building Prebid with GrowthCode Support
+
+First, make sure to add the GrowthCode submodule to your Prebid.js package with:
+
+```
+gulp build --modules=growthCodeIdSystem,userId
+```
+
+The following configuration parameters are available:
+
+```javascript
+pbjs.setConfig({
+  userSync: {
+    userIds: [{
+      name: 'growthCodeId',
+      params: {
+          pid: 'TEST01', // Set your Partner ID here for production (obtained from Growthcode)
+          publisher_id: '_sharedID',
+          publisher_id_storage: 'html5'
+      }
+    }]
+  }
+});
+```
+
+| Param under userSync.userIds[] | Scope    | Type   | Description | Example         |
+|--------------------------------|----------|--------| --- |-----------------|
+| name                           | Required | String | The name of this module. | `"growthCodeId"` |
+| params                         | Required | Object | Details of module params. |                 |
+| params.pid                     | Required | String | This is the Parter ID value obtained from GrowthCode | `"TEST01"`        |
+| params.url | Optional | String | Custom URL for server | |
+| params.publisher_id | Optional | String | Name if the variable that holds your publisher ID | `"_sharedID"` |
+| params.publisher_id_storage | Optional | String | Publisher ID storage (cookie, html5) | `"html5"` |

package/modules/improvedigitalBidAdapter.js

@@ -25,6 +25,7 @@ const BIDDER_CODE = 'improvedigital';
 const CREATIVE_TTL = 300;
 
 const AD_SERVER_URL = 'https://ad.360yield.com/pb';
+const BASIC_ADS_URL = 'https://ad.360yield-basic.com/pb';
 const EXTEND_URL = 'https://pbs.360yield.com/openrtb2/auction';
 const IFRAME_SYNC_URL = 'https://hb.360yield.com/prebid-universal-creative/load-cookie.html';
 
@@ -282,9 +283,10 @@ const ID_REQUEST = {
       if (transactionId) {
         deepSetValue(request, 'source.tid', transactionId);
       }
+      const adServerUrl = hasPurpose1Consent(bidderRequest?.gdprConsent) ? AD_SERVER_URL : BASIC_ADS_URL;
       return {
         method: 'POST',
-        url: extendMode ? EXTEND_URL : AD_SERVER_URL,
+        url: extendMode ? EXTEND_URL : adServerUrl,
         data: JSON.stringify(request),
         bidderRequest
       }

package/modules/ixBidAdapter.js

@@ -13,7 +13,6 @@ import {
   logError,
   logWarn,
   mergeDeep,
-  parseGPTSingleSizeArray,
   parseQueryStringParameters
 } from '../src/utils.js';
 import {BANNER, VIDEO, NATIVE} from '../src/mediaTypes.js';
@@ -127,10 +126,6 @@ function bidToBannerImp(bid) {
   if (impSize) {
     imp.banner.w = impSize[0];
     imp.banner.h = impSize[1];
-    // populate sid with size if not id
-    if (!deepAccess(imp, 'ext.sid')) {
-      imp.ext.sid = parseGPTSingleSizeArray(impSize);
-    }
   }
 
   imp.banner.topframe = inIframe() ? 0 : 1;
@@ -197,9 +192,6 @@ function bidToVideoImp(bid) {
     if (impSize) {
       imp.video.w = impSize[0];
       imp.video.h = impSize[1];
-      if (!(deepAccess(imp, 'ext.sid'))) {
-        imp.ext.sid = parseGPTSingleSizeArray(impSize);
-      }
     } else {
       logWarn('IX Bid Adapter: Video size is missing in [mediaTypes.video]');
       return {};
@@ -253,8 +245,8 @@ function bidToImp(bid) {
   imp.ext = {};
   imp.ext.siteID = bid.params.siteId.toString();
 
-  if (bid.params.hasOwnProperty('id') &&
-    (typeof bid.params.id === 'string' || typeof bid.params.id === 'number')) {
+  // populate imp level sid
+  if (bid.params.hasOwnProperty('id') && (typeof bid.params.id === 'string' || typeof bid.params.id === 'number')) {
     imp.ext.sid = String(bid.params.id);
   }
 
@@ -758,6 +750,7 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
     const gpid = impressions[transactionIds[adUnitIndex]].gpid;
     const dfpAdUnitCode = impressions[transactionIds[adUnitIndex]].dfp_ad_unit_code;
     const tid = impressions[transactionIds[adUnitIndex]].tid;
+    const sid = impressions[transactionIds[adUnitIndex]].sid
 
     if (impressionObjects.length && BANNER in impressionObjects[0]) {
       const { id, banner: { topframe } } = impressionObjects[0];
@@ -769,16 +762,24 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
         },
       };
 
+      // We add sid in imp.ext.sid therefore, remove from banner.format[].ext
+      for (let bannerFormat of _bannerImpression.banner.format) {
+        if (bannerFormat.ext != null && bannerFormat.ext.sid != null) {
+          delete bannerFormat.ext.sid;
+        }
+      }
+
       const position = impressions[transactionIds[adUnitIndex]].pos;
       if (isInteger(position)) {
         _bannerImpression.banner.pos = position;
       }
 
-      if (dfpAdUnitCode || gpid || tid) {
+      if (dfpAdUnitCode || gpid || tid || sid) {
         _bannerImpression.ext = {};
         _bannerImpression.ext.dfp_ad_unit_code = dfpAdUnitCode;
         _bannerImpression.ext.gpid = gpid;
         _bannerImpression.ext.tid = tid;
+        _bannerImpression.ext.sid = sid;
       }
 
       if ('bidfloor' in impressionObjects[0]) {
@@ -1040,6 +1041,11 @@ function createBannerImps(validBidRequest, missingBannerSizes, bannerImps) {
   bannerImps[validBidRequest.transactionId].tagId = deepAccess(validBidRequest, 'params.tagId');
   bannerImps[validBidRequest.transactionId].pos = deepAccess(validBidRequest, 'mediaTypes.banner.pos');
 
+  const sid = deepAccess(validBidRequest, 'params.id');
+  if (sid && (typeof sid === 'string' || typeof sid === 'number')) {
+    bannerImps[validBidRequest.transactionId].sid = String(sid);
+  }
+
   const adUnitCode = validBidRequest.adUnitCode;
   const divId = document.getElementById(adUnitCode) ? adUnitCode : getGptSlotInfoForAdUnitCode(adUnitCode).divId;
   bannerImps[validBidRequest.transactionId].adUnitCode = adUnitCode;
@@ -1094,7 +1100,6 @@ function updateMissingSizes(validBidRequest, missingBannerSizes, imp) {
  */
 function createMissingBannerImp(bid, imp, newSize) {
   const newImp = deepClone(imp);
-  newImp.ext.sid = parseGPTSingleSizeArray(newSize);
   newImp.banner.w = newSize[0];
   newImp.banner.h = newSize[1];
 

package/modules/mediagoBidAdapter.js

@@ -293,14 +293,19 @@ function getItems(validBidRequests, bidderRequest) {
  */
 function getParam(validBidRequests, bidderRequest) {
   const pubcid = utils.deepAccess(validBidRequests[0], 'crumbs.pubcid');
-  // console.log('wjh getParam', validBidRequests, bidderRequest);
+  const sharedid =
+    utils.deepAccess(validBidRequests[0], 'userId.sharedid.id') ||
+    utils.deepAccess(validBidRequests[0], 'userId.pubcid');
   let isMobile = isMobileAndTablet() ? 1 : 0;
   let isTest = 0;
   let auctionId = getProperty(bidderRequest, 'auctionId');
   let items = getItems(validBidRequests, bidderRequest);
 
-  const domain = document.domain;
-  const location = utils.deepAccess(bidderRequest, 'refererInfo.referer');
+  const domain =
+    utils.deepAccess(bidderRequest, 'refererInfo.domain') || document.domain;
+  const location = utils.deepAccess(bidderRequest, 'refererInfo.location');
+  const page = utils.deepAccess(bidderRequest, 'refererInfo.page');
+  const referer = utils.deepAccess(bidderRequest, 'refererInfo.ref');
 
   const timeout = bidderRequest.timeout || 2000;
 
@@ -323,14 +328,13 @@ function getParam(validBidRequests, bidderRequest) {
       },
       ext: {},
       user: {
-        buyeruid: getUserID(),
-        id: pubcid,
+        id: sharedid || pubcid || getUserID(),
       },
       site: {
         name: domain,
         domain: domain,
-        page: location,
-        ref: location,
+        page: page || location,
+        ref: referer,
         mobile: isMobile,
         cat: [], // todo
         publisher: {
@@ -454,9 +458,9 @@ export const spec = {
    * Register bidder specific code, which will execute when the adserver targeting has been set for a bid from this bidder
    * @param {Bid} The bid of which the targeting has been set
    */
-//   onSetTargeting: function (bid) {
-//     // console.log('onSetTargeting', bid);
-//     // Bidder specific code
-//   },
+  //   onSetTargeting: function (bid) {
+  //     // console.log('onSetTargeting', bid);
+  //     // Bidder specific code
+  //   },
 };
 registerBidder(spec);

package/modules/mediasquareBidAdapter.js

@@ -164,7 +164,7 @@ export const spec = {
     // fires a pixel to confirm a winning bid
     let params = {'pbjs': '$prebid.version$'};
     let endpoint = document.location.search.match(/msq_test=true/) ? BIDDER_URL_TEST : BIDDER_URL_PROD;
-    let paramsToSearchFor = ['cpm', 'size', 'mediaType', 'currency', 'creativeId', 'adUnitCode', 'timeToRespond', 'requestId', 'auctionId']
+    let paramsToSearchFor = ['cpm', 'size', 'mediaType', 'currency', 'creativeId', 'adUnitCode', 'timeToRespond', 'requestId', 'auctionId', 'originalCpm', 'originalCurrency'];
     if (bid.hasOwnProperty('mediasquare')) {
       if (bid['mediasquare'].hasOwnProperty('bidder')) { params['bidder'] = bid['mediasquare']['bidder']; }
       if (bid['mediasquare'].hasOwnProperty('code')) { params['code'] = bid['mediasquare']['code']; }

package/modules/nativoBidAdapter.js

@@ -465,8 +465,9 @@ export function parseFloorPriceData(bidRequest) {
     // Setup price floor data per media type
     let mediaTypeData = bidMediaTypes[mediaType]
     let mediaTypeFloorPriceData = {}
+    let mediaTypeSizes = mediaTypeData.sizes || mediaTypeData.playerSize || [];
     // Step through each size of the media type so we can get floor data for each size per media type
-    mediaTypeData.sizes.forEach((size) => {
+    mediaTypeSizes.forEach((size) => {
       // Get floor price data per the getFloor method and respective media type / size combination
       const priceFloorData = bidRequest.getFloor({
         currency: FLOOR_PRICE_CURRENCY,

package/modules/nextMillenniumBidAdapter.js

@@ -8,6 +8,8 @@ import {
   logMessage,
   parseUrl,
   triggerPixel,
+  getDefinedParams,
+  parseGPTSingleSizeArrayToRtbSize,
 } from '../src/utils.js';
 
 import CONSTANTS from '../src/constants.json';
@@ -22,6 +24,10 @@ const ENDPOINT = 'https://pbs.nextmillmedia.com/openrtb2/auction';
 const TEST_ENDPOINT = 'https://test.pbs.nextmillmedia.com/openrtb2/auction';
 const SYNC_ENDPOINT = 'https://statics.nextmillmedia.com/load-cookie.html?v=4';
 const TIME_TO_LIVE = 360;
+const VIDEO_PARAMS = [
+  'api', 'linearity', 'maxduration', 'mimes', 'minduration', 'placement',
+  'playbackmethod', 'protocols', 'startdelay'
+];
 
 const EXPIRENCE_WURL = 20 * 60000;
 const wurlMap = {};
@@ -72,21 +78,38 @@ export const spec = {
 
         device,
         site,
-        'imp': [{
-          'banner': {
-            'format': (sizes || []).map(s => { return {w: s[0], h: s[1]} })
-          },
+        imp: []
+      };
 
-          'ext': {
-            'prebid': {
-              'storedrequest': {
-                'id': id
-              }
-            }
+      const imp = {
+        ext: {
+          prebid: {
+            storedrequest: {id}
           }
-        }]
+        }
+      };
+
+      if (deepAccess(bid, 'mediaTypes.banner')) {
+        imp.banner = {
+          format: (sizes || []).map(s => { return {w: s[0], h: s[1]} })
+        };
       };
 
+      const video = deepAccess(bid, 'mediaTypes.video');
+      if (video) {
+        imp.video = getDefinedParams(video, VIDEO_PARAMS);
+        if (video.playerSize) {
+          imp.video = Object.assign(
+            imp.video, parseGPTSingleSizeArrayToRtbSize(video.playerSize[0]) || {}
+          );
+        } else if (video.w && video.h) {
+          imp.video.w = video.w;
+          imp.video.h = video.h;
+        };
+      };
+
+      postBody.imp.push(imp);
+
       const gdprConsent = bidderRequest && bidderRequest.gdprConsent;
       const uspConsent = bidderRequest && bidderRequest.uspConsent;
 

package/modules/rubiconAnalyticsAdapter.js

@@ -124,9 +124,9 @@ function formatSource(src) {
 }
 
 function getBillingPayload(event) {
-  // for now we are mapping all events to type "general", later we will expand support for specific types
   let billingEvent = deepClone(event);
-  billingEvent.type = 'general';
+  // Pass along type if is string and not empty else general
+  billingEvent.type = (typeof event.type === 'string' && event.type) || 'general';
   billingEvent.accountId = accountId;
   // mark as sent
   deepSetValue(cache.billing, `${event.vendor}.${event.billingId}`, true);

package/modules/rubiconBidAdapter.js

@@ -1109,15 +1109,25 @@ function mapSizes(sizes) {
 
 /**
  * Test if bid has mediaType or mediaTypes set for video.
- * Also makes sure the video object is present in the rubicon bidder params
+ * Also checks if the video object is present in the rubicon bidder params
  * @param {BidRequest} bidRequest
  * @returns {boolean}
  */
-export function hasVideoMediaType(bidRequest) {
-  if (typeof deepAccess(bidRequest, 'params.video') !== 'object') {
-    return false;
+export function classifiedAsVideo(bidRequest) {
+  let isVideo = typeof deepAccess(bidRequest, `mediaTypes.${VIDEO}`) !== 'undefined';
+  let isBanner = typeof deepAccess(bidRequest, `mediaTypes.${BANNER}`) !== 'undefined';
+  let isMissingVideoParams = typeof deepAccess(bidRequest, 'params.video') !== 'object';
+  // If an ad has both video and banner types, a legacy implementation allows choosing video over banner
+  // based on whether or not there is a video object defined in the params
+  // Given this legacy implementation, other code depends on params.video being defined
+
+  if (isBanner && isMissingVideoParams) {
+    isVideo = false;
   }
-  return (typeof deepAccess(bidRequest, `mediaTypes.${VIDEO}`) !== 'undefined');
+  if (isVideo && isMissingVideoParams) {
+    deepSetValue(bidRequest, 'params.video', {});
+  }
+  return isVideo;
 }
 
 /**
@@ -1128,7 +1138,7 @@ export function hasVideoMediaType(bidRequest) {
  */
 function bidType(bid, log = false) {
   // Is it considered video ad unit by rubicon
-  if (hasVideoMediaType(bid)) {
+  if (classifiedAsVideo(bid)) {
     // Removed legacy mediaType support. new way using mediaTypes.video object is now required
     // We require either context as instream or outstream
     if (['outstream', 'instream'].indexOf(deepAccess(bid, `mediaTypes.${VIDEO}.context`)) === -1) {

package/modules/seedtagBidAdapter.js

@@ -240,6 +240,10 @@ export const spec = {
       payload['uspConsent'] = bidderRequest.uspConsent
     }
 
+    if (validBidRequests[0].schain) {
+      payload.schain = validBidRequests[0].schain;
+    }
+
     const payloadString = JSON.stringify(payload)
     return {
       method: 'POST',

package/modules/taboolaBidAdapter.js

@@ -60,14 +60,10 @@ export const userData = {
 
 export const internal = {
   getPageUrl: (refererInfo = {}) => {
-    return refererInfo.page || getWindowSelf().location.href;
+    return refererInfo?.page || getWindowSelf().location.href;
   },
   getReferrer: (refererInfo = {}) => {
-    if (refererInfo.ref) {
-      return refererInfo.ref;
-    } else {
-      return getWindowSelf().document.referrer;
-    }
+    return refererInfo?.ref || getWindowSelf().document.referrer;
   }
 }
 
@@ -160,7 +156,7 @@ function getSiteProperties({publisherId, bcat = []}, refererInfo) {
   return {
     id: publisherId,
     name: publisherId,
-    domain: refererInfo?.domain || window.location.host,
+    domain: refererInfo?.domain || window.location?.host,
     page: getPageUrl(refererInfo),
     ref: getReferrer(refererInfo),
     publisher: {

package/modules/userId/eids.js

@@ -5,6 +5,25 @@ export const USER_IDS_CONFIG = {
 
   // key-name : {config}
 
+  // GrowthCode
+  'growthCodeId': {
+    getValue: function(data) {
+      return data.gc_id
+    },
+    source: 'growthcode.io',
+    atype: 1,
+    getUidExt: function(data) {
+      const extendedData = pick(data, [
+        'h1',
+        'h2',
+        'h3',
+      ]);
+      if (Object.keys(extendedData).length) {
+        return extendedData;
+      }
+    }
+  },
+
   // trustpid
   'trustpid': {
     source: 'trustpid.com',

package/modules/vidazooBidAdapter.js

@@ -10,7 +10,7 @@ const BIDDER_VERSION = '1.0.0';
 const CURRENCY = 'USD';
 const TTL_SECONDS = 60 * 5;
 const DEAL_ID_EXPIRY = 1000 * 60 * 15;
-const UNIQUE_DEAL_ID_EXPIRY = 1000 * 60 * 15;
+const UNIQUE_DEAL_ID_EXPIRY = 1000 * 60 * 60;
 const SESSION_ID_KEY = 'vidSid';
 export const SUPPORTED_ID_SYSTEMS = {
   'britepoolid': 1,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prebid.js",
-  "version": "7.16.0",
+  "version": "7.18.0",
   "description": "Header Bidding Management Library",
   "main": "src/prebid.js",
   "scripts": {