prebid.js 7.44.0 → 7.45.0

package/modules/connectIdSystem.js

@@ -8,14 +8,86 @@
 import {ajax} from '../src/ajax.js';
 import {submodule} from '../src/hook.js';
 import {includes} from '../src/polyfill.js';
-import {formatQS, logError} from '../src/utils.js';
+import {getRefererInfo} from '../src/refererDetection.js';
+import {getStorageManager} from '../src/storageManager.js';
+import {formatQS, isPlainObject, logError, parseUrl} from '../src/utils.js';
+import {uspDataHandler} from '../src/adapterManager.js';
+import {MODULE_TYPE_UID} from '../src/activities/modules.js';
 
 const MODULE_NAME = 'connectId';
+const STORAGE_EXPIRY_DAYS = 14;
 const VENDOR_ID = 25;
 const PLACEHOLDER = '__PIXEL_ID__';
 const UPS_ENDPOINT = `https://ups.analytics.yahoo.com/ups/${PLACEHOLDER}/fed`;
 const OVERRIDE_OPT_OUT_KEY = 'connectIdOptOut';
 const INPUT_PARAM_KEYS = ['pixelId', 'he', 'puid'];
+export const storage = getStorageManager({moduleType: MODULE_TYPE_UID, moduleName: MODULE_NAME});
+
+/**
+ * @function
+ * @param {Object} obj
+ */
+function storeObject(obj) {
+  const expires = Date.now() + (60 * 60 * 24 * 1000 * STORAGE_EXPIRY_DAYS);
+  if (storage.cookiesAreEnabled()) {
+    setEtldPlusOneCookie(MODULE_NAME, JSON.stringify(obj), new Date(expires), getSiteHostname());
+  } else if (storage.localStorageIsEnabled()) {
+    obj.__expires = expires;
+    storage.setDataInLocalStorage(MODULE_NAME, obj);
+  }
+}
+
+/**
+ * Attempts to store a cookie on eTLD + 1
+ *
+ * @function
+ * @param {String} key
+ * @param {String} value
+ * @param {Date} expirationDate
+ * @param {String} hostname
+ */
+function setEtldPlusOneCookie(key, value, expirationDate, hostname) {
+  const subDomains = hostname.split('.');
+  for (let i = 0; i < subDomains.length; ++i) {
+    const domain = subDomains.slice(subDomains.length - i - 1, subDomains.length).join('.');
+    try {
+      storage.setCookie(key, value, expirationDate.toUTCString(), null, '.' + domain);
+      const storedCookie = storage.getCookie(key);
+      if (storedCookie && storedCookie === value) {
+        break;
+      }
+    } catch (error) {}
+  }
+}
+
+function getIdFromCookie() {
+  if (storage.cookiesAreEnabled()) {
+    try {
+      return JSON.parse(storage.getCookie(MODULE_NAME));
+    } catch {}
+  }
+  return null;
+}
+
+function getIdFromLocalStorage() {
+  if (storage.localStorageIsEnabled()) {
+    const storedIdData = storage.getDataFromLocalStorage(MODULE_NAME);
+    if (storedIdData) {
+      if (isPlainObject(storedIdData) && storedIdData.__expires &&
+          storedIdData.__expires <= Date.now()) {
+        storage.removeDataFromLocalStorage(MODULE_NAME);
+        return null;
+      }
+      return storedIdData;
+    }
+  }
+  return null;
+}
+
+function getSiteHostname() {
+  const pageInfo = parseUrl(getRefererInfo().page);
+  return pageInfo.hostname;
+}
 
 /** @type {Submodule} */
 export const connectIdSubmodule = {
@@ -37,8 +109,8 @@ export const connectIdSubmodule = {
     if (connectIdSubmodule.userHasOptedOut()) {
       return undefined;
     }
-    return (typeof value === 'object' && value.connectid)
-      ? {connectId: value.connectid} : undefined;
+    return (isPlainObject(value) && (value.connectId || value.connectid))
+      ? {connectId: value.connectId || value.connectid} : undefined;
   },
   /**
    * Gets the Yahoo ConnectID
@@ -54,21 +126,28 @@ export const connectIdSubmodule = {
     const params = config.params || {};
     if (!params || (typeof params.he !== 'string' && typeof params.puid !== 'string') ||
         (typeof params.pixelId === 'undefined' && typeof params.endpoint === 'undefined')) {
-      logError('The connectId submodule requires the \'pixelId\' and at least one of the \'he\' ' +
-               'or \'puid\' parameters to be defined.');
+      logError(`${MODULE_NAME} module: configurataion requires the 'pixelId' and at ` +
+                `least one of the 'he' or 'puid' parameters to be defined.`);
       return;
     }
 
+    const storedId = getIdFromCookie() || getIdFromLocalStorage();
+    if (storedId) {
+      return {id: storedId};
+    }
+
+    const uspString = uspDataHandler.getConsentData() || '';
     const data = {
+      v: '1',
       '1p': includes([1, '1', true], params['1p']) ? '1' : '0',
       gdpr: connectIdSubmodule.isEUConsentRequired(consentData) ? '1' : '0',
-      gdpr_consent: connectIdSubmodule.isEUConsentRequired(consentData) ? consentData.gdpr.consentString : '',
-      us_privacy: consentData && consentData.uspConsent ? consentData.uspConsent : ''
+      gdpr_consent: connectIdSubmodule.isEUConsentRequired(consentData) ? consentData.consentString : '',
+      us_privacy: uspString
     };
 
-    if (connectIdSubmodule.isUnderGPPJurisdiction(consentData)) {
-      data.gpp = consentData.gppConsent.gppString;
-      data.gpp_sid = encodeURIComponent(consentData.gppConsent.applicableSections.join(','));
+    let topmostLocation = getRefererInfo().topmostLocation;
+    if (typeof topmostLocation === 'string') {
+      data.url = topmostLocation.split('?')[0];
     }
 
     INPUT_PARAM_KEYS.forEach(key => {
@@ -84,6 +163,11 @@ export const connectIdSubmodule = {
           if (response) {
             try {
               responseObj = JSON.parse(response);
+              if (isPlainObject(responseObj) && Object.keys(responseObj).length > 0) {
+                storeObject(responseObj);
+              } else {
+                logError(`${MODULE_NAME} module: UPS response returned an invalid payload ${response}`);
+              }
             } catch (error) {
               logError(error);
             }
@@ -91,7 +175,7 @@ export const connectIdSubmodule = {
           callback(responseObj);
         },
         error: error => {
-          logError(`${MODULE_NAME}: ID fetch encountered an error`, error);
+          logError(`${MODULE_NAME} module: ID fetch encountered an error`, error);
           callback();
         }
       };
@@ -108,16 +192,7 @@ export const connectIdSubmodule = {
    * @returns {Boolean}
    */
   isEUConsentRequired(consentData) {
-    return !!(consentData && consentData.gdpr && consentData.gdpr.gdprApplies);
-  },
-
-  /**
-   * Utility function that returns a boolean flag indicating if the opportunity
-   * is subject to GPP jurisdiction.
-   * @returns {Boolean}
-   */
-  isUnderGPPJurisdiction(consentData) {
-    return !!(consentData && consentData.gppConsent && consentData.gppConsent.gppString);
+    return !!(consentData?.gdprApplies);
   },
 
   /**

package/modules/connectIdSystem.md

@@ -27,8 +27,9 @@ The below parameters apply only to the Yahoo ConnectID user ID Module.
 
 | Param under usersync.userIds[] | Scope | Type | Description | Example |
 | --- | --- | --- | --- | --- |
-| name | Required | String | ID value for the Yahoo ConnectID module - `"connectId"` | `"connectId"` |
-| params | Required | Object | Data for Yahoo ConnectID initialization. | |
-| params.pixelId | Required | Number | The Yahoo supplied publisher specific pixel Id.  | `8976` |
-| params.he | Optional | String | The SHA-256 hashed user email address. One of either the `he` parameter or the `puid` parameter must be supplied. | `"529cb86de31e9547a712d9f380146e98bbd39beec"` |
-| params.puid | Optional | String | The publisher-supplied user identifier. One of either the `he` parameter or the `puid` parameter must be supplied. | `"P-975484817"` |
+| name | Required | String | The name of this module. | `"connectId"` |
+| params | Required | Object | Container of all module params. ||
+| params.pixelId | Required | Number |
+The Yahoo-supplied publisher-specific pixel ID. | `"0000"` |
+| params.he | Optional | String | The SHA-256 hashed user email address which has been lowercased prior to hashing. Pass both `he` and `puid` params if present, otherwise pass either of the two that is available. |`"ed8ddbf5a171981db8ef938596ca297d5e3f84bcc280041c5880dba3baf9c1d4"`|
+| params.puid | Optional | String | The publisher supplied user identifier such as a first-party cookie. Pass both `he` and `puid` params if present, otherwise pass either of the two that is available. | `"ab9iibf5a231ii1db8ef911596ca297d5e3f84biii00041c5880dba3baf9c1da"` |

package/modules/contentexchangeBidAdapter.js

@@ -157,7 +157,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/freewheel-sspBidAdapter.js

@@ -424,6 +424,14 @@ export const spec = {
         requestParams.playerSize = playerSize[0] + 'x' + playerSize[1];
       }
 
+      // Add video context and placement in requestParams
+      if (currentBidRequest.mediaTypes.video) {
+        var videoContext = currentBidRequest.mediaTypes.video.context ? currentBidRequest.mediaTypes.video.context : 'instream';
+        var videoPlacement = currentBidRequest.mediaTypes.video.placement ? currentBidRequest.mediaTypes.video.placement : 1;
+        requestParams.video_context = videoContext;
+        requestParams.video_placement = videoPlacement;
+      }
+
       return {
         method: 'GET',
         url: FREEWHEEL_ADSSETUP,

package/modules/glimpseBidAdapter.js

@@ -1,5 +1,4 @@
 import { registerBidder } from '../src/adapters/bidderFactory.js';
-import { config } from '../src/config.js';
 import { BANNER } from '../src/mediaTypes.js';
 import { getStorageManager } from '../src/storageManager.js';
 import {
@@ -99,7 +98,7 @@ function getReferer(bidderRequest) {
 function buildQuery(bidderRequest) {
   let url = appendQueryParam(ENDPOINT, 'ver', '$prebid.version$');
 
-  const timeout = config.getConfig('bidderTimeout');
+  const timeout = bidderRequest.timeout;
   url = appendQueryParam(url, 'tmax', timeout);
 
   if (gdprApplies(bidderRequest)) {

package/modules/globalsunBidAdapter.js

@@ -155,7 +155,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/gridBidAdapter.js

@@ -93,7 +93,7 @@ export const spec = {
     let {bidderRequestId, auctionId, gdprConsent, uspConsent, timeout, refererInfo, gppConsent} = bidderRequest || {};
 
     const referer = refererInfo ? encodeURIComponent(refererInfo.page) : '';
-    const tmax = timeout || config.getConfig('bidderTimeout');
+    const tmax = timeout;
     const imp = [];
     const bidsMap = {};
     const requests = [];

package/modules/gridNMBidAdapter.js

@@ -135,7 +135,7 @@ export const spec = {
         reqSource.ext.schain = schain;
       }
 
-      const bidderTimeout = config.getConfig('bidderTimeout') || timeout;
+      const bidderTimeout = timeout;
       const tmax = timeout ? Math.min(bidderTimeout, timeout) : bidderTimeout;
 
       const request = {

package/modules/growthCodeIdSystem.js

@@ -11,9 +11,9 @@ import { submodule } from '../src/hook.js'
 import {getStorageManager} from '../src/storageManager.js';
 import {MODULE_TYPE_UID} from '../src/activities/modules.js';
 
-const GCID_EXPIRY = 7;
 const MODULE_NAME = 'growthCodeId';
 const GC_DATA_KEY = '_gc_data';
+const GCID_KEY = 'gcid';
 const ENDPOINT_URL = 'https://p2.gcprivacy.com/v1/pb?'
 
 export const storage = getStorageManager({ moduleType: MODULE_TYPE_UID, moduleName: MODULE_NAME });
@@ -26,14 +26,16 @@ export const storage = getStorageManager({ moduleType: MODULE_TYPE_UID, moduleNa
 export function readData(key) {
   try {
     let payload
-    if (storage.cookiesAreEnabled()) {
-      payload = tryParse(storage.getCookie(key))
+    if (storage.cookiesAreEnabled(null)) {
+      payload = tryParse(storage.getCookie(key, null))
     }
     if (storage.hasLocalStorage()) {
-      payload = tryParse(storage.getDataFromLocalStorage(key))
+      payload = tryParse(storage.getDataFromLocalStorage(key, null))
     }
-    if ((payload.expire_at !== undefined) && (payload.expire_at > (Date.now() / 1000))) {
-      return payload
+    if (payload !== undefined) {
+      if (payload.expire_at > (Date.now() / 1000)) {
+        return payload
+      }
     }
   } catch (error) {
     logError(error);
@@ -51,12 +53,8 @@ function storeData(key, value) {
     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');
+      if (storage.hasLocalStorage(null)) {
+        storage.setDataInLocalStorage(key, value, null);
       }
     }
   } catch (error) {
@@ -70,11 +68,15 @@ function storeData(key, value) {
  * @param {object|null}
  */
 function tryParse(data) {
+  let payload;
   try {
-    return JSON.parse(data);
+    payload = JSON.parse(data);
+    if (payload == null) {
+      return undefined
+    }
+    return payload
   } catch (err) {
-    logError(err);
-    return null;
+    return undefined;
   }
 }
 
@@ -150,6 +152,7 @@ export const growthCodeIdSubmodule = {
             // If response is a valid json and should save is true
             if (respJson) {
               storeData(GC_DATA_KEY, JSON.stringify(respJson))
+              storeData(GCID_KEY, respJson.gc_id);
               callback(respJson);
             } else {
               callback();

package/modules/gumgumBidAdapter.js

@@ -284,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 => {

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
+                    }
+                }
+            ]
+        }
+    ];
+```