prebid.js 7.43.0 → 7.45.0

package/modules/gumgumBidAdapter.js

@@ -6,13 +6,13 @@ import {getStorageManager} from '../src/storageManager.js';
 import {includes} from '../src/polyfill.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 
-const BIDDER_CODE = 'gumgum'
+const BIDDER_CODE = 'gumgum';
 const storage = getStorageManager({bidderCode: BIDDER_CODE});
-const ALIAS_BIDDER_CODE = ['gg']
-const BID_ENDPOINT = `https://g2.gumgum.com/hbid/imp`
+const ALIAS_BIDDER_CODE = ['gg'];
+const BID_ENDPOINT = `https://g2.gumgum.com/hbid/imp`;
 const JCSI = { t: 0, rq: 8, pbv: '$prebid.version$' }
-const SUPPORTED_MEDIA_TYPES = [BANNER, VIDEO]
-const TIME_TO_LIVE = 60
+const SUPPORTED_MEDIA_TYPES = [BANNER, VIDEO];
+const TIME_TO_LIVE = 60;
 const DELAY_REQUEST_TIME = 1800000; // setting to 30 mins
 
 let invalidRequestIds = {};
@@ -99,17 +99,6 @@ function getWrapperCode(wrapper, data) {
   return wrapper.replace('AD_JSON', window.btoa(JSON.stringify(data)))
 }
 
-function _getDigiTrustQueryParams(userId) {
-  let digiTrustId = userId.digitrustid && userId.digitrustid.data;
-  // Verify there is an ID and this user has not opted out
-  if (!digiTrustId || (digiTrustId.privacy && digiTrustId.privacy.optout)) {
-    return {};
-  }
-  return {
-    dt: digiTrustId.id
-  };
-}
-
 /**
  * Serializes the supply chain object according to IAB standards
  * @see https://github.com/InteractiveAdvertisingBureau/openrtb/blob/master/supplychainobject.md
@@ -295,7 +284,7 @@ function buildRequests(validBidRequests, bidderRequest) {
   const gdprConsent = bidderRequest && bidderRequest.gdprConsent;
   const uspConsent = bidderRequest && bidderRequest.uspConsent;
   const gppConsent = bidderRequest && bidderRequest.gppConsent;
-  const timeout = config.getConfig('bidderTimeout');
+  const timeout = bidderRequest && bidderRequest.timeout
   const coppa = config.getConfig('coppa') === true ? 1 : 0;
   const topWindowUrl = bidderRequest && bidderRequest.refererInfo && bidderRequest.refererInfo.page;
   _each(validBidRequests, bidRequest => {
@@ -416,7 +405,7 @@ function buildRequests(validBidRequests, bidderRequest) {
       sizes,
       url: BID_ENDPOINT,
       method: 'GET',
-      data: Object.assign(data, _getBrowserParams(topWindowUrl), _getDigiTrustQueryParams(userId))
+      data: Object.assign(data, _getBrowserParams(topWindowUrl))
     });
   });
   return bids;
@@ -596,6 +585,7 @@ function getUserSyncs(syncOptions, serverResponses) {
 
 export const spec = {
   code: BIDDER_CODE,
+  gvlid: 61,
   aliases: ALIAS_BIDDER_CODE,
   isBidRequestValid,
   buildRequests,

package/modules/hadronAnalyticsAdapter.js

@@ -3,8 +3,9 @@ import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
 import * as utils from '../src/utils.js';
 import CONSTANTS from '../src/constants.json';
-import { getStorageManager } from '../src/storageManager.js';
+import {getStorageManager} from '../src/storageManager.js';
 import {getRefererInfo} from '../src/refererDetection.js';
+import {MODULE_TYPE_ANALYTICS} from '../src/activities/modules.js';
 
 /**
  * hadronAnalyticsAdapter.js - Audigent Hadron Analytics Adapter
@@ -14,8 +15,9 @@ const HADRON_ANALYTICS_URL = 'https://analytics.hadron.ad.gt/api/v1/analytics';
 const HADRONID_ANALYTICS_VER = 'pbadgt0';
 const DEFAULT_PARTNER_ID = 0;
 const AU_GVLID = 561;
+const MODULE_CODE = 'hadronAnalytics';
 
-export const storage = getStorageManager();
+export const storage = getStorageManager({moduleType: MODULE_TYPE_ANALYTICS, moduleName: MODULE_CODE});
 
 var viewId = utils.generateUUID();
 
@@ -191,7 +193,7 @@ function sendEvent(event) {
 
 adapterManager.registerAnalyticsAdapter({
   adapter: hadronAnalyticsAdapter,
-  code: 'hadronAnalytics',
+  code: MODULE_CODE,
   gvlid: AU_GVLID
 });
 

package/modules/hadronIdSystem.js

@@ -9,13 +9,14 @@ import {ajax} from '../src/ajax.js';
 import {getStorageManager} from '../src/storageManager.js';
 import {submodule} from '../src/hook.js';
 import {isFn, isStr, isPlainObject, logError, logInfo} from '../src/utils.js';
+import {MODULE_TYPE_UID} from '../src/activities/modules.js';
 
 const HADRONID_LOCAL_NAME = 'auHadronId';
 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'});
+export const storage = getStorageManager({moduleType: MODULE_TYPE_UID, moduleName: 'hadron'});
 
 /**
  * Param or default.
@@ -48,6 +49,7 @@ export const hadronIdSubmodule = {
    * @type {string}
    */
   name: MODULE_NAME,
+  gvlid: AU_GVLID,
   /**
    * decode the stored id value for passing to bid requests
    * @function

package/modules/hadronRtdProvider.js

@@ -12,6 +12,7 @@ import {getStorageManager} from '../src/storageManager.js';
 import {submodule} from '../src/hook.js';
 import {isFn, isStr, isArray, deepEqual, isPlainObject, logError, logInfo} from '../src/utils.js';
 import {loadExternalScript} from '../src/adloader.js';
+import {MODULE_TYPE_RTD} from '../src/activities/modules.js';
 
 const LOG_PREFIX = 'User ID - HadronRtdProvider submodule: ';
 const MODULE_NAME = 'realTimeData';
@@ -21,7 +22,7 @@ const HADRON_ID_DEFAULT_URL = 'https://id.hadron.ad.gt/api/v1/hadronid?_it=prebi
 const HADRON_SEGMENT_URL = 'https://id.hadron.ad.gt/api/v1/rtd';
 export const HALOID_LOCAL_NAME = 'auHadronId';
 export const RTD_LOCAL_NAME = 'auHadronRtd';
-export const storage = getStorageManager({gvlid: AU_GVLID, moduleName: SUBMODULE_NAME});
+export const storage = getStorageManager({moduleType: MODULE_TYPE_RTD, moduleName: SUBMODULE_NAME});
 
 /**
  * @param {string} url
@@ -251,7 +252,8 @@ function init(provider, userConsent) {
 export const hadronSubmodule = {
   name: SUBMODULE_NAME,
   getBidRequestData: getRealTimeData,
-  init: init
+  init: init,
+  gvlid: AU_GVLID,
 };
 
 submodule(MODULE_NAME, hadronSubmodule);

package/modules/id5IdSystem.js

@@ -20,6 +20,7 @@ import {submodule} from '../src/hook.js';
 import {getRefererInfo} from '../src/refererDetection.js';
 import {getStorageManager} from '../src/storageManager.js';
 import {uspDataHandler} from '../src/adapterManager.js';
+import {MODULE_TYPE_UID} from '../src/activities/modules.js';
 
 const MODULE_NAME = 'id5Id';
 const GVLID = 131;
@@ -34,7 +35,7 @@ const ID5_API_CONFIG_URL = 'https://id5-sync.com/api/config/prebid';
 // cookie in the array is the most preferred to use
 const LEGACY_COOKIE_NAMES = ['pbjs-id5id', 'id5id.1st', 'id5id'];
 
-export const storage = getStorageManager({gvlid: GVLID, moduleName: MODULE_NAME});
+export const storage = getStorageManager({moduleType: MODULE_TYPE_UID, moduleName: MODULE_NAME});
 
 /** @type {Submodule} */
 export const id5IdSubmodule = {
@@ -263,7 +264,8 @@ class IdFetchFlow {
       'top': referer.reachedTop ? 1 : 0,
       'u': referer.stack[0] || window.location.href,
       'v': '$prebid.version$',
-      'storage': this.submoduleConfig.storage
+      'storage': this.submoduleConfig.storage,
+      'localStorage': storage.localStorageIsEnabled() ? 1 : 0
     };
 
     // pass in optional data, but only if populated

package/modules/idWardRtdProvider.js

@@ -8,11 +8,12 @@
 import {getStorageManager} from '../src/storageManager.js';
 import {submodule} from '../src/hook.js';
 import {isPlainObject, mergeDeep, logMessage, logError} from '../src/utils.js';
+import {MODULE_TYPE_RTD} from '../src/activities/modules.js';
 
 const MODULE_NAME = 'realTimeData';
 const SUBMODULE_NAME = 'idWard';
 
-export const storage = getStorageManager({moduleName: SUBMODULE_NAME});
+export const storage = getStorageManager({moduleType: MODULE_TYPE_RTD, moduleName: SUBMODULE_NAME});
 /**
  * Add real-time data & merge segments.
  * @param ortb2 object to merge into

package/modules/identityLinkIdSystem.js

@@ -9,8 +9,11 @@ import * as utils from '../src/utils.js'
 import { ajax } from '../src/ajax.js';
 import { submodule } from '../src/hook.js';
 import {getStorageManager} from '../src/storageManager.js';
+import {MODULE_TYPE_UID} from '../src/activities/modules.js';
 
-export const storage = getStorageManager();
+const MODULE_NAME = 'identityLink';
+
+export const storage = getStorageManager({moduleType: MODULE_TYPE_UID, moduleName: MODULE_NAME});
 
 /** @type {Submodule} */
 export const identityLinkSubmodule = {
@@ -18,7 +21,7 @@ export const identityLinkSubmodule = {
    * used to link submodule with config
    * @type {string}
    */
-  name: 'identityLink',
+  name: MODULE_NAME,
   /**
    * used to specify vendor id
    * @type {number}

package/modules/idxIdSystem.js

@@ -6,11 +6,12 @@
  */
 import { isStr, isPlainObject, logError } from '../src/utils.js';
 import { submodule } from '../src/hook.js';
-import { getStorageManager } from '../src/storageManager.js';
+import {getStorageManager} from '../src/storageManager.js';
+import {MODULE_TYPE_UID} from '../src/activities/modules.js';
 
 const IDX_MODULE_NAME = 'idx';
 const IDX_COOKIE_NAME = '_idx';
-export const storage = getStorageManager();
+export const storage = getStorageManager({moduleType: MODULE_TYPE_UID, moduleName: IDX_MODULE_NAME});
 
 function readIDxFromCookie() {
   return storage.cookiesAreEnabled ? storage.getCookie(IDX_COOKIE_NAME) : null;

package/modules/imRtdProvider.js

@@ -18,16 +18,18 @@ import {
   isFn
 } from '../src/utils.js'
 import {submodule} from '../src/hook.js';
+import {MODULE_TYPE_RTD} from '../src/activities/modules.js';
 
 export const imUidLocalName = '__im_uid';
 export const imVidCookieName = '_im_vid';
 export const imRtdLocalName = '__im_sids';
-export const storage = getStorageManager();
 const submoduleName = 'im';
 const segmentsMaxAge = 3600000; // 1 hour (30 * 60 * 1000)
 const uidMaxAge = 1800000; // 30 minites (30 * 60 * 1000)
 const vidMaxAge = 97200000000; // 37 months ((365 * 3 + 30) * 24 * 60 * 60 * 1000)
 
+export const storage = getStorageManager({moduleType: MODULE_TYPE_RTD, moduleName: submoduleName});
+
 function setImDataInCookie(value) {
   storage.setCookie(
     imVidCookieName,

package/modules/impactifyBidAdapter.js

@@ -2,7 +2,6 @@ import { deepAccess, deepSetValue, generateUUID } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { config } from '../src/config.js';
 import { ajax } from '../src/ajax.js';
-import { createEidsArray } from './userId/eids.js';
 
 const BIDDER_CODE = 'impactify';
 const BIDDER_ALIAS = ['imp'];
@@ -63,9 +62,8 @@ const createOpenRtbRequest = (validBidRequests, bidderRequest) => {
   if (schain) request.source.ext = { schain: schain };
 
   // Set eids
-  let bidUserId = deepAccess(validBidRequests, '0.userId');
-  let eids = createEidsArray(bidUserId);
-  if (eids.length) {
+  let eids = deepAccess(validBidRequests, '0.userIdAsEids');
+  if (eids && eids.length) {
     deepSetValue(request, 'user.ext.eids', eids);
   }
 

package/modules/imuIdSystem.js

@@ -8,9 +8,12 @@
 import { timestamp, logError } from '../src/utils.js';
 import { ajax } from '../src/ajax.js'
 import { submodule } from '../src/hook.js';
-import { getStorageManager } from '../src/storageManager.js';
+import {getStorageManager} from '../src/storageManager.js';
+import {MODULE_TYPE_UID} from '../src/activities/modules.js';
 
-export const storage = getStorageManager();
+const MODULE_NAME = 'imuid';
+
+export const storage = getStorageManager({moduleType: MODULE_TYPE_UID, moduleName: MODULE_NAME});
 
 export const storageKey = '__im_uid';
 export const storagePpKey = '__im_ppid';
@@ -112,7 +115,7 @@ export const imuIdSubmodule = {
    * used to link submodule with config
    * @type {string}
    */
-  name: 'imuid',
+  name: MODULE_NAME,
   /**
    * decode the stored id value for passing to bid requests
    * @function

package/modules/insticatorBidAdapter.js

@@ -12,7 +12,7 @@ const USER_ID_COOKIE_EXP = 2592000000; // 30 days
 const BID_TTL = 300; // 5 minutes
 const GVLID = 910;
 
-export const storage = getStorageManager({gvlid: GVLID, bidderCode: BIDDER_CODE});
+export const storage = getStorageManager({bidderCode: BIDDER_CODE});
 
 config.setDefaults({
   insticator: {

package/modules/intentIqIdSystem.js

@@ -8,7 +8,8 @@
 import { logError, logInfo } from '../src/utils.js';
 import { ajax } from '../src/ajax.js';
 import { submodule } from '../src/hook.js'
-import { getStorageManager } from '../src/storageManager.js';
+import {getStorageManager} from '../src/storageManager.js';
+import {MODULE_TYPE_UID} from '../src/activities/modules.js';
 
 const PCID_EXPIRY = 365;
 
@@ -16,7 +17,7 @@ const MODULE_NAME = 'intentIqId';
 export const FIRST_PARTY_KEY = '_iiq_fdata';
 export var FIRST_PARTY_DATA_KEY = '_iiq_fdata';
 
-export const storage = getStorageManager({ gvlid: undefined, moduleName: MODULE_NAME });
+export const storage = getStorageManager({ moduleType: MODULE_TYPE_UID, moduleName: MODULE_NAME });
 
 const INVALID_ID = 'INVALID_ID';
 

package/modules/invibesBidAdapter.js

@@ -17,7 +17,7 @@ const CONSTANTS = {
   DISABLE_USER_SYNC: true
 };
 
-const storage = getStorageManager({gvlid: CONSTANTS.INVIBES_VENDOR_ID, bidderCode: CONSTANTS.BIDDER_CODE});
+const storage = getStorageManager({bidderCode: CONSTANTS.BIDDER_CODE});
 
 export const spec = {
   code: CONSTANTS.BIDDER_CODE,

package/modules/iqzoneBidAdapter.js

@@ -154,7 +154,7 @@ export const spec = {
       coppa: config.getConfig('coppa') === true ? 1 : 0,
       ccpa: bidderRequest.uspConsent || undefined,
       gdpr: bidderRequest.gdprConsent || undefined,
-      tmax: config.getConfig('bidderTimeout')
+      tmax: bidderRequest.timeout
     };
 
     const len = validBidRequests.length;

package/modules/ivsBidAdapter.js

@@ -0,0 +1,85 @@
+import { ortbConverter } from '../libraries/ortbConverter/converter.js';
+import { deepAccess, deepSetValue, getBidIdParameter, logError } from '../src/utils.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { VIDEO } from '../src/mediaTypes.js';
+import { INSTREAM } from '../src/video.js';
+
+const BIDDER_CODE = 'ivs';
+const ENDPOINT_URL = 'https://a.ivstracker.net/prod/openrtb/2.5';
+
+export const converter = ortbConverter({
+  context: {
+    mediaType: VIDEO,
+    ttl: 360,
+    netRevenue: true
+  }
+});
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [VIDEO],
+
+  /**
+   * Determines whether or not the given bid request is valid.
+   *
+   * @param {BidRequest} bid The bid params to validate.
+   * @return boolean True if this is a valid bid, and false otherwise.
+   */
+  isBidRequestValid: function(bid) {
+    if (bid && typeof bid.params !== 'object') {
+      logError(BIDDER_CODE + ': params is not defined or is incorrect in the bidder settings.');
+      return false;
+    }
+
+    if (!deepAccess(bid, 'mediaTypes.video')) {
+      logError(BIDDER_CODE + ': mediaTypes.video is not present in the bidder settings.');
+      return false;
+    }
+
+    if (deepAccess(bid, 'mediaTypes.video.context') !== INSTREAM) {
+      logError(BIDDER_CODE + ': only instream video context is allowed.');
+      return false;
+    }
+
+    if (!getBidIdParameter('publisherId', bid.params)) {
+      logError(BIDDER_CODE + ': publisherId is not present in bidder params.');
+      return false;
+    }
+
+    return true;
+  },
+
+  /**
+   * Make a server request from the list of BidRequests.
+   *
+   * @param {validBidRequests[]} - an array of bids
+   * @param {bidderRequest} - master bidRequest object
+   * @return ServerRequest Info describing the request to the server.
+   */
+  buildRequests: function(validBidRequests, bidderRequest) {
+    const data = converter.toORTB({ bidderRequest, validBidRequests, context: {mediaType: 'video'} });
+    deepSetValue(data.site, 'publisher.id', validBidRequests[0].params.publisherId);
+
+    return {
+      method: 'POST',
+      url: ENDPOINT_URL,
+      data: data,
+      options: {
+        contentType: 'application/json'
+      },
+    };
+  },
+
+  /**
+   * Unpack the response from the server into a list of bids.
+   *
+   * @param {ServerResponse} serverResponse A successful response from the server.
+   * @return {Bid[]} An array of bids which were nested inside the server.
+   */
+  interpretResponse: function(serverResponse, bidRequest) {
+    if (!serverResponse.body) return;
+    return converter.fromORTB({ response: serverResponse.body, request: bidRequest.data }).bids;
+  },
+}
+
+registerBidder(spec);

package/modules/ivsBidAdapter.md

@@ -0,0 +1,34 @@
+# Overview
+
+```
+Module Name: IVS Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: prebid@ivs.tv
+```
+
+# Description
+
+Module that connects to IVS's demand sources
+
+# Test Parameters
+```
+    var adUnits = [
+        {
+            code: 'test-div',
+            mediaTypes: {
+                video: {
+                    playerSize: [640, 480],
+                    context: 'instream'
+                }
+            },
+            bids: [
+                {
+                    bidder: 'ivs',
+                    params: {
+                        publisherId: '3001234' // required
+                    }
+                }
+            ]
+        }
+    ];
+```