prebid.js 8.0.0 → 8.2.0

package/modules/consentManagementUsp.js

@@ -4,12 +4,13 @@
  * information and make it available for any USP (CCPA) supported adapters to
  * read/pass this information to their system.
  */
-import {deepSetValue, isFn, isNumber, isPlainObject, isStr, logError, logInfo, logWarn} from '../src/utils.js';
+import {deepSetValue, isNumber, isPlainObject, isStr, logError, logInfo, logWarn} from '../src/utils.js';
 import {config} from '../src/config.js';
 import adapterManager, {uspDataHandler} from '../src/adapterManager.js';
 import {timedAuctionHook} from '../src/utils/perfMetrics.js';
 import {getHook} from '../src/hook.js';
 import {enrichFPD} from '../src/fpd/enrichment.js';
+import {cmpClient} from '../libraries/cmp/cmpClient.js';
 
 const DEFAULT_CONSENT_API = 'iab';
 const DEFAULT_CONSENT_TIMEOUT = 50;
@@ -41,35 +42,6 @@ function lookupStaticConsentData({onSuccess, onError}) {
  * based on the appropriate result.
  */
 function lookupUspConsent({onSuccess, onError}) {
-  function findUsp() {
-    let f = window;
-    let uspapiFrame;
-    let uspapiFunction;
-
-    while (true) {
-      try {
-        if (typeof f.__uspapi === 'function') {
-          uspapiFunction = f.__uspapi;
-          uspapiFrame = f;
-          break;
-        }
-      } catch (e) {}
-
-      try {
-        if (f.frames['__uspapiLocator']) {
-          uspapiFrame = f;
-          break;
-        }
-      } catch (e) {}
-      if (f === window.top) break;
-      f = f.parent;
-    }
-    return {
-      uspapiFrame,
-      uspapiFunction,
-    };
-  }
-
   function handleUspApiResponseCallbacks() {
     const uspResponse = {};
 
@@ -92,86 +64,36 @@ function lookupUspConsent({onSuccess, onError}) {
   }
 
   let callbackHandler = handleUspApiResponseCallbacks();
-  let uspapiCallbacks = {};
 
-  let { uspapiFrame, uspapiFunction } = findUsp();
+  const cmp = cmpClient({
+    apiName: '__uspapi',
+    apiVersion: USPAPI_VERSION,
+    apiArgs: ['command', 'version', 'callback'],
+  });
 
-  if (!uspapiFrame) {
+  if (!cmp) {
     return onError('USP CMP not found.');
   }
 
-  function registerDataDelHandler(invoker, arg2) {
-    try {
-      invoker('registerDeletion', arg2, adapterManager.callDataDeletionRequest);
-    } catch (e) {
-      logError('Error invoking CMP `registerDeletion`:', e);
-    }
-  }
-
-  // to collect the consent information from the user, we perform a call to USPAPI
-  // to collect the user's consent choices represented as a string (via getUSPData)
-
-  // the following code also determines where the USPAPI is located and uses the proper workflow to communicate with it:
-  // - use the USPAPI locator code to see if USP's located in the current window or an ancestor window.
-  // - else assume prebid is in an iframe, and use the locator to see if the CMP is located in a higher parent window. This works in cross domain iframes.
-  // - if USPAPI is not found, the iframe function will call the uspError exit callback to abort the rest of the USPAPI workflow
-
-  if (isFn(uspapiFunction)) {
+  if (cmp.isDirect) {
     logInfo('Detected USP CMP is directly accessible, calling it now...');
-    uspapiFunction(
-      'getUSPData',
-      USPAPI_VERSION,
-      callbackHandler.consentDataCallback
-    );
-    registerDataDelHandler(uspapiFunction, USPAPI_VERSION);
   } else {
     logInfo(
       'Detected USP CMP is outside the current iframe where Prebid.js is located, calling it now...'
     );
-    callUspApiWhileInIframe(
-      'getUSPData',
-      uspapiFrame,
-      callbackHandler.consentDataCallback
-    );
-    registerDataDelHandler(callUspApiWhileInIframe, uspapiFrame);
   }
 
-  let listening = false;
-
-  function callUspApiWhileInIframe(commandName, uspapiFrame, moduleCallback) {
-    function callUsp(cmd, ver, callback) {
-      let callId = Math.random() + '';
-      let msg = {
-        __uspapiCall: {
-          command: cmd,
-          version: ver,
-          callId: callId,
-        },
-      };
-
-      uspapiCallbacks[callId] = callback;
-      uspapiFrame.postMessage(msg, '*');
-    };
-
-    /** when we get the return message, call the stashed callback */
-    if (!listening) {
-      window.addEventListener('message', readPostMessageResponse, false);
-      listening = true;
-    }
-
-    // call uspapi
-    callUsp(commandName, USPAPI_VERSION, moduleCallback);
+  cmp({
+    command: 'getUSPData',
+    callback: callbackHandler.consentDataCallback
+  });
 
-    function readPostMessageResponse(event) {
-      const res = event && event.data && event.data.__uspapiReturn;
-      if (res && res.callId) {
-        if (uspapiCallbacks.hasOwnProperty(res.callId)) {
-          uspapiCallbacks[res.callId](res.returnValue, res.success);
-          delete uspapiCallbacks[res.callId];
-        }
-      }
-    }
-  }
+  cmp({
+    command: 'registerDeletion',
+    callback: adapterManager.callDataDeletionRequest
+  }).catch(e => {
+    logError('Error invoking CMP `registerDeletion`:', e);
+  });
 }
 
 /**

package/modules/freepassBidAdapter.js

@@ -0,0 +1,98 @@
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+import {logMessage} from '../src/utils.js';
+import {BANNER} from '../src/mediaTypes.js';
+import {ortbConverter} from '../libraries/ortbConverter/converter.js'
+
+const BIDDER_SERVICE_URL = 'https://bidding-dsp.ad-m.asia/dsp/api/bid/s/s/freepass';
+
+const converter = ortbConverter({
+  context: {
+    netRevenue: true,
+    ttl: 30
+  }
+});
+
+function prepareUserInfo(user, freepassId) {
+  let userInfo = user || {};
+  let extendedUserInfo = userInfo.ext || {};
+
+  if (freepassId.userId) {
+    userInfo.id = freepassId.userId;
+  }
+
+  if (freepassId.commonId) {
+    extendedUserInfo.fuid = freepassId.commonId;
+  }
+  userInfo.ext = extendedUserInfo;
+
+  return userInfo;
+}
+
+function prepareDeviceInfo(device, freepassId) {
+  let deviceInfo = device || {};
+  let extendedDeviceInfo = deviceInfo.ext || {};
+
+  extendedDeviceInfo.is_accurate_ip = 0;
+  if (freepassId.userIp) {
+    deviceInfo.ip = freepassId.userIp;
+    extendedDeviceInfo.is_accurate_ip = 1;
+  }
+  deviceInfo.ext = extendedDeviceInfo;
+
+  return deviceInfo;
+}
+
+export const spec = {
+  code: 'freepass',
+  supportedMediaTypes: [BANNER],
+
+  isBidRequestValid(bid) {
+    logMessage('Validating bid: ', bid);
+    return !!bid.adUnitCode;
+  },
+
+  buildRequests(validBidRequests, bidderRequest) {
+    if (validBidRequests.length === 0) {
+      logMessage('FreePass BidAdapter has no valid bid requests');
+      return [];
+    }
+
+    logMessage('FreePass BidAdapter is preparing bid request: ', validBidRequests);
+    logMessage('FreePass BidAdapter is using bidder request: ', bidderRequest);
+
+    const data = converter.toORTB({
+      bidderRequest: bidderRequest,
+      bidRequests: validBidRequests,
+      context: { mediaType: BANNER }
+    });
+    logMessage('FreePass BidAdapter interpreted ORTB bid request as ', data);
+
+    // Only freepassId is supported
+    let freepassId = (validBidRequests[0].userId && validBidRequests[0].userId.freepassId) || {};
+    data.user = prepareUserInfo(data.user, freepassId);
+    data.device = prepareDeviceInfo(data.device, freepassId);
+
+    data.test = validBidRequests[0].test || 0;
+
+    logMessage('FreePass BidAdapter augmented ORTB bid request user: ', data.user);
+    logMessage('FreePass BidAdapter augmented ORTB bid request device: ', data.device);
+
+    return {
+      method: 'POST',
+      url: BIDDER_SERVICE_URL,
+      data,
+      options: { withCredentials: false }
+    };
+  },
+
+  interpretResponse(serverResponse, bidRequest) {
+    logMessage('FreePass BidAdapter is interpreting server response: ', serverResponse);
+    logMessage('FreePass BidAdapter is using bid request: ', bidRequest);
+    const bids = converter.fromORTB({response: serverResponse.body, request: bidRequest.data}).bids;
+    logMessage('FreePass BidAdapter interpreted ORTB bids as ', bids);
+
+    return bids;
+  },
+};
+
+registerBidder(spec);

package/modules/freepassBidAdapter.md

@@ -0,0 +1,31 @@
+# Overview
+
+```
+Module Name: FreePass Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: fp-hbidding@freebit.net
+```
+
+# Description
+
+Connects to FreePass service for bids. Only BANNER is currently supported. 
+
+This BidAdapter requires the FreePass IdSystem to be configured. Please contact FreePass for proper setup.
+
+# Test Parameters
+```javascript
+    let adUnits = [
+        {
+            code: 'ad-banner-1', // ad slot HTML element ID
+            mediaTypes: {
+                banner: {
+                    sizes: [[1024, 1024]]
+                }
+            },
+            bids: [{
+                bidder: 'freepass'
+            }]
+        }
+    ];
+```
+

package/modules/freepassIdSystem.md

@@ -9,7 +9,7 @@ Please contact FreePass before using this ID.
 ```
 Module Name: FreePass Id System
 Module Type: User Id System
-Maintainer: freepass-headerbidding@craid-inc.com
+Maintainer: fp-hbidding@freebit.net
 ```
 
 ## Building Prebid with FreePass ID Support

package/modules/gppControl_usnat.js

@@ -0,0 +1,11 @@
+import {config} from '../src/config.js';
+import {setupRules} from '../libraries/mspa/activityControls.js';
+
+let setupDone = false;
+
+config.getConfig('consentManagement', (cfg) => {
+  if (cfg?.consentManagement?.gpp != null && !setupDone) {
+    setupRules('usnat', [7]);
+    setupDone = true;
+  }
+})

package/modules/greenbidsAnalyticsAdapter.js

@@ -44,10 +44,6 @@ export const greenbidsAnalyticsAdapter = Object.assign(adapter({ANALYTICS_SERVER
       logError('"options.pbuid" is required.');
       return false;
     }
-    analyticsOptions.sampled = true;
-    if (typeof config.options.sampling === 'number') {
-      analyticsOptions.sampled = Math.random() < parseFloat(config.options.sampling);
-    }
 
     analyticsOptions.pbuid = config.options.pbuid
     analyticsOptions.server = ANALYTICS_SERVER;
@@ -149,15 +145,13 @@ export const greenbidsAnalyticsAdapter = Object.assign(adapter({ANALYTICS_SERVER
     });
   },
   track({eventType, args}) {
-    if (analyticsOptions.sampled) {
-      switch (eventType) {
-        case BID_TIMEOUT:
-          this.handleBidTimeout(args);
-          break;
-        case AUCTION_END:
-          this.handleAuctionEnd(args);
-          break;
-      }
+    switch (eventType) {
+      case BID_TIMEOUT:
+        this.handleBidTimeout(args);
+        break;
+      case AUCTION_END:
+        this.handleAuctionEnd(args);
+        break;
     }
   },
   getAnalyticsOptions() {

package/modules/gridBidAdapter.js

@@ -26,10 +26,9 @@ const RENDERER_URL = 'https://acdn.adnxs.com/video/outstream/ANOutstreamVideo.js
 export const storage = getStorageManager({ bidderCode: BIDDER_CODE });
 
 const LOG_ERROR_MESS = {
-  noAuid: 'Bid from response has no auid parameter - ',
+  noAdid: 'Bid from response has no adid parameter - ',
   noAdm: 'Bid from response has no adm parameter - ',
   noBid: 'Array of bid objects is empty',
-  noPlacementCode: 'Can\'t find in requested bids the bid with auid - ',
   emptyUids: 'Uids should be not empty',
   emptySeatbid: 'Seatbid array from response has empty item',
   emptyResponse: 'Response is empty',
@@ -507,7 +506,7 @@ function _getBidFromResponse(respItem) {
 function _addBidResponse(serverBid, bidRequest, bidResponses, RendererConst, bidderCode) {
   if (!serverBid) return;
   let errorMessage;
-  if (!serverBid.auid) errorMessage = LOG_ERROR_MESS.noAuid + JSON.stringify(serverBid);
+  if (!serverBid.adid) errorMessage = LOG_ERROR_MESS.noAdid + JSON.stringify(serverBid);
   if (!errorMessage && !serverBid.adm && !serverBid.nurl) errorMessage = LOG_ERROR_MESS.noAdm + JSON.stringify(serverBid);
   else {
     const bidObject = bidRequest.bidsMap ? bidRequest.bidsMap[serverBid.impid] : bidRequest.bidObject;
@@ -518,7 +517,7 @@ function _addBidResponse(serverBid, bidRequest, bidResponses, RendererConst, bid
         cpm: serverBid.price,
         width: serverBid.w,
         height: serverBid.h,
-        creativeId: serverBid.auid, // bid.bidId
+        creativeId: serverBid.adid,
         currency: 'USD',
         netRevenue: true,
         ttl: TIME_TO_LIVE,

package/modules/intentIqIdSystem.js

@@ -8,8 +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 {MODULE_TYPE_UID} from '../src/activities/modules.js';
+import { getStorageManager } from '../src/storageManager.js';
+import { MODULE_TYPE_UID } from '../src/activities/modules.js';
 
 const PCID_EXPIRY = 365;
 
@@ -59,7 +59,7 @@ export function readData(key) {
  * @param key
  * @param {string} value IntentIQ ID value to sintentIqIdSystem_spec.jstore
  */
-function storeData(key, value) {
+function storeData(key, value, cookieStorageEnabled = false) {
   try {
     logInfo(MODULE_NAME + ': storing data: key=' + key + ' value=' + value);
 
@@ -68,7 +68,7 @@ function storeData(key, value) {
         storage.setDataInLocalStorage(key, value);
       }
       const expiresStr = (new Date(Date.now() + (PCID_EXPIRY * (60 * 60 * 24 * 1000)))).toUTCString();
-      if (storage.cookiesAreEnabled()) {
+      if (storage.cookiesAreEnabled() && cookieStorageEnabled) {
         storage.setCookie(key, value, expiresStr, 'LAX');
       }
     }
@@ -119,15 +119,16 @@ export const intentIqIdSubmodule = {
       logError('User ID - intentIqId submodule requires a valid partner to be defined');
       return;
     }
+    const cookieStorageEnabled = typeof configParams.enableCookieStorage === 'boolean' ? configParams.enableCookieStorage : false
     if (!FIRST_PARTY_DATA_KEY.includes(configParams.partner)) { FIRST_PARTY_DATA_KEY += '_' + configParams.partner; }
     let rrttStrtTime = 0;
 
     // Read Intent IQ 1st party id or generate it if none exists
     let firstPartyData = tryParse(readData(FIRST_PARTY_KEY));
-    if (!firstPartyData || !firstPartyData.pcid) {
+    if (!firstPartyData || !firstPartyData.pcid || firstPartyData.pcidDate) {
       const firstPartyId = generateGUID();
-      firstPartyData = { 'pcid': firstPartyId };
-      storeData(FIRST_PARTY_KEY, JSON.stringify(firstPartyData));
+      firstPartyData = { 'pcid': firstPartyId, 'pcidDate': Date.now() };
+      storeData(FIRST_PARTY_KEY, JSON.stringify(firstPartyData), cookieStorageEnabled);
     }
 
     let partnerData = tryParse(readData(FIRST_PARTY_DATA_KEY));
@@ -141,6 +142,7 @@ export const intentIqIdSubmodule = {
     url += firstPartyData.pid ? '&pid=' + encodeURIComponent(firstPartyData.pid) : '';
     url += (partnerData.cttl) ? '&cttl=' + encodeURIComponent(partnerData.cttl) : '';
     url += (partnerData.rrtt) ? '&rrtt=' + encodeURIComponent(partnerData.rrtt) : '';
+    url += firstPartyData.pcidDate ? '&iiqpciddate=' + encodeURIComponent(firstPartyData.pcidDate) : '';
 
     const resp = function (callback) {
       const callbacks = {
@@ -171,8 +173,8 @@ export const intentIqIdSubmodule = {
             }
             if (shouldUpdateLs === true) {
               partnerData.date = Date.now();
-              storeData(FIRST_PARTY_KEY, JSON.stringify(firstPartyData));
-              storeData(FIRST_PARTY_DATA_KEY, JSON.stringify(partnerData));
+              storeData(FIRST_PARTY_KEY, JSON.stringify(firstPartyData), cookieStorageEnabled);
+              storeData(FIRST_PARTY_DATA_KEY, JSON.stringify(partnerData), cookieStorageEnabled);
             }
             callback(respJson.data);
           } else {