prebid.js 7.30.0 → 7.32.0

package/modules/appushBidAdapter.js

@@ -0,0 +1,188 @@
+import { isFn, deepAccess, logMessage, logError } from '../src/utils.js';
+import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
+
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
+import { config } from '../src/config.js';
+
+const BIDDER_CODE = 'appush';
+const AD_URL = 'https://hb.appush.com/pbjs';
+
+function isBidResponseValid(bid) {
+  if (!bid.requestId || !bid.cpm || !bid.creativeId || !bid.ttl || !bid.currency) {
+    return false;
+  }
+
+  switch (bid.mediaType) {
+    case BANNER:
+      return Boolean(bid.width && bid.height && bid.ad);
+    case VIDEO:
+      return Boolean(bid.vastUrl || bid.vastXml);
+    case NATIVE:
+      return Boolean(bid.native && bid.native.impressionTrackers && bid.native.impressionTrackers.length);
+    default:
+      return false;
+  }
+}
+
+function getPlacementReqData(bid) {
+  const { params, bidId, mediaTypes } = bid;
+  const schain = bid.schain || {};
+  const { placementId, endpointId } = params;
+  const bidfloor = getBidFloor(bid);
+
+  const placement = {
+    bidId,
+    schain,
+    bidfloor
+  };
+
+  if (placementId) {
+    placement.placementId = placementId;
+    placement.type = 'publisher';
+  } else if (endpointId) {
+    placement.endpointId = endpointId;
+    placement.type = 'network';
+  }
+
+  if (mediaTypes && mediaTypes[BANNER]) {
+    placement.adFormat = BANNER;
+    placement.sizes = mediaTypes[BANNER].sizes;
+  } else if (mediaTypes && mediaTypes[VIDEO]) {
+    placement.adFormat = VIDEO;
+    placement.playerSize = mediaTypes[VIDEO].playerSize;
+    placement.minduration = mediaTypes[VIDEO].minduration;
+    placement.maxduration = mediaTypes[VIDEO].maxduration;
+    placement.mimes = mediaTypes[VIDEO].mimes;
+    placement.protocols = mediaTypes[VIDEO].protocols;
+    placement.startdelay = mediaTypes[VIDEO].startdelay;
+    placement.placement = mediaTypes[VIDEO].placement;
+    placement.skip = mediaTypes[VIDEO].skip;
+    placement.skipafter = mediaTypes[VIDEO].skipafter;
+    placement.minbitrate = mediaTypes[VIDEO].minbitrate;
+    placement.maxbitrate = mediaTypes[VIDEO].maxbitrate;
+    placement.delivery = mediaTypes[VIDEO].delivery;
+    placement.playbackmethod = mediaTypes[VIDEO].playbackmethod;
+    placement.api = mediaTypes[VIDEO].api;
+    placement.linearity = mediaTypes[VIDEO].linearity;
+  } else if (mediaTypes && mediaTypes[NATIVE]) {
+    placement.native = mediaTypes[NATIVE];
+    placement.adFormat = NATIVE;
+  }
+
+  return placement;
+}
+
+function getBidFloor(bid) {
+  if (!isFn(bid.getFloor)) {
+    return deepAccess(bid, 'params.bidfloor', 0);
+  }
+
+  try {
+    const bidFloor = bid.getFloor({
+      currency: 'USD',
+      mediaType: '*',
+      size: '*',
+    });
+    return bidFloor.floor;
+  } catch (err) {
+    logError(err);
+    return 0;
+  }
+}
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, VIDEO, NATIVE],
+
+  isBidRequestValid: (bid = {}) => {
+    const { params, bidId, mediaTypes } = bid;
+    let valid = Boolean(bidId && params && (params.placementId || params.endpointId));
+
+    if (mediaTypes && mediaTypes[BANNER]) {
+      valid = valid && Boolean(mediaTypes[BANNER] && mediaTypes[BANNER].sizes);
+    } else if (mediaTypes && mediaTypes[VIDEO]) {
+      valid = valid && Boolean(mediaTypes[VIDEO] && mediaTypes[VIDEO].playerSize);
+    } else if (mediaTypes && mediaTypes[NATIVE]) {
+      valid = valid && Boolean(mediaTypes[NATIVE]);
+    } else {
+      valid = false;
+    }
+    return valid;
+  },
+
+  buildRequests: (validBidRequests = [], bidderRequest = {}) => {
+    // convert Native ORTB definition to old-style prebid native definition
+    validBidRequests = convertOrtbRequestToProprietaryNative(validBidRequests);
+
+    let deviceWidth = 0;
+    let deviceHeight = 0;
+
+    let winLocation;
+    try {
+      const winTop = window.top;
+      deviceWidth = winTop.screen.width;
+      deviceHeight = winTop.screen.height;
+      winLocation = winTop.location;
+    } catch (e) {
+      logMessage(e);
+      winLocation = window.location;
+    }
+
+    const refferUrl = bidderRequest.refererInfo && bidderRequest.refererInfo.page;
+    let refferLocation;
+    try {
+      refferLocation = refferUrl && new URL(refferUrl);
+    } catch (e) {
+      logMessage(e);
+    }
+    // TODO: does the fallback make sense here?
+    let location = refferLocation || winLocation;
+    const language = (navigator && navigator.language) ? navigator.language.split('-')[0] : '';
+    const host = location.host;
+    const page = location.pathname;
+    const secure = location.protocol === 'https:' ? 1 : 0;
+    const placements = [];
+    const request = {
+      deviceWidth,
+      deviceHeight,
+      language,
+      secure,
+      host,
+      page,
+      placements,
+      coppa: config.getConfig('coppa') === true ? 1 : 0,
+      ccpa: bidderRequest.uspConsent || undefined,
+      gdpr: bidderRequest.gdprConsent || undefined,
+      tmax: config.getConfig('bidderTimeout')
+    };
+
+    const len = validBidRequests.length;
+    for (let i = 0; i < len; i++) {
+      const bid = validBidRequests[i];
+      placements.push(getPlacementReqData(bid));
+    }
+
+    return {
+      method: 'POST',
+      url: AD_URL,
+      data: request
+    };
+  },
+
+  interpretResponse: (serverResponse) => {
+    let response = [];
+    for (let i = 0; i < serverResponse.body.length; i++) {
+      let resItem = serverResponse.body[i];
+      if (isBidResponseValid(resItem)) {
+        const advertiserDomains = resItem.adomain && resItem.adomain.length ? resItem.adomain : [];
+        resItem.meta = { ...resItem.meta, advertiserDomains };
+
+        response.push(resItem);
+      }
+    }
+    return response;
+  }
+};
+
+registerBidder(spec);

package/modules/appushBidAdapter.md

@@ -0,0 +1,79 @@
+# Overview
+
+```
+Module Name: Appush Bidder Adapter
+Module Type: Appush Bidder Adapter
+Maintainer: support@appush.com
+```
+
+# Description
+
+Connects to Appush exchange for bids.
+Appush bid adapter supports Banner, Video (instream and outstream) and Native.
+
+# Test Parameters
+```
+    var adUnits = [
+                // Will return static test banner
+                {
+                    code: 'adunit1',
+                    mediaTypes: {
+                        banner: {
+                            sizes: [ [300, 250], [320, 50] ],
+                        }
+                    },
+                    bids: [
+                        {
+                            bidder: 'appush',
+                            params: {
+                                placementId: 'testBanner',
+                            }
+                        }
+                    ]
+                },
+                {
+                    code: 'addunit2',
+                    mediaTypes: {
+                        video: {
+                            playerSize: [ [640, 480] ],
+                            context: 'instream',
+                            minduration: 5,
+                            maxduration: 60,
+                        }
+                    },
+                    bids: [
+                        {
+                            bidder: 'appush',
+                            params: {
+                                placementId: 'testVideo',
+                            }
+                        }
+                    ]
+                },
+                {
+                    code: 'addunit3',
+                    mediaTypes: {
+                        native: {
+                            title: {
+                                required: true
+                            },
+                            body: {
+                                required: true
+                            },
+                            icon: {
+                                required: true,
+                                size: [64, 64]
+                            }
+                        }
+                    },
+                    bids: [
+                        {
+                            bidder: 'appush',
+                            params: {
+                                placementId: 'testNative',
+                            }
+                        }
+                    ]
+                }
+            ];
+```

package/modules/asoBidAdapter.js

@@ -10,11 +10,11 @@ import {
   parseSizesInput,
   tryAppendQueryString
 } from '../src/utils.js';
-import {registerBidder} from '../src/adapters/bidderFactory.js';
-import {config} from '../src/config.js';
-import {BANNER, VIDEO} from '../src/mediaTypes.js';
-import {Renderer} from '../src/Renderer.js';
-import {parseDomain} from '../src/refererDetection.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { config } from '../src/config.js';
+import { BANNER, VIDEO } from '../src/mediaTypes.js';
+import { Renderer } from '../src/Renderer.js';
+import { parseDomain } from '../src/refererDetection.js';
 
 const BIDDER_CODE = 'aso';
 const DEFAULT_SERVER_URL = 'https://srv.aso1.net';
@@ -27,6 +27,9 @@ export const spec = {
 
   code: BIDDER_CODE,
   supportedMediaTypes: [BANNER, VIDEO],
+  aliases: [
+    {code: 'bcmint'}
+  ],
 
   isBidRequestValid: bid => {
     return !!bid.params && !!bid.params.zone;

package/modules/confiantRtdProvider.js

@@ -0,0 +1,128 @@
+/**
+ * This module provides comprehensive detection of security, quality, and privacy threats by Confiant Inc,
+ * the industry leader in real-time detecting and blocking of bad ads
+ *
+ * The {@link module:modules/realTimeData} module is required
+ * The module will inject a Confiant Inc. script into the page to monitor ad impressions
+ * @module modules/confiantRtdProvider
+ * @requires module:modules/realTimeData
+ */
+
+import { submodule } from '../src/hook.js';
+import { logError, generateUUID } from '../src/utils.js';
+import { loadExternalScript } from '../src/adloader.js';
+import * as events from '../src/events.js';
+import CONSTANTS from '../src/constants.json';
+
+/**
+ * Injects the Confiant Inc. configuration script into the page, based on proprtyId provided
+ * @param {string} propertyId
+ */
+function injectConfigScript(propertyId) {
+  const scriptSrc = `https://cdn.confiant-integrations.net/${propertyId}/gpt_and_prebid/config.js`;
+
+  loadExternalScript(scriptSrc, 'confiant', () => {});
+}
+
+/**
+ * Set up page with Confiant integration
+ * @param {Object} config
+ */
+function setupPage(config) {
+  const propertyId = config?.params?.propertyId;
+  if (!propertyId) {
+    logError('Confiant pbjs module: no propertyId provided');
+    return false;
+  }
+
+  const confiant = window.confiant || Object.create(null);
+  confiant[propertyId] = confiant[propertyId] || Object.create(null);
+  confiant[propertyId].clientSettings = confiant[propertyId].clientSettings || Object.create(null);
+  confiant[propertyId].clientSettings.isMGBL = true;
+  confiant[propertyId].clientSettings.prebidExcludeBidders = config?.params?.prebidExcludeBidders;
+  confiant[propertyId].clientSettings.prebidNameSpace = config?.params?.prebidNameSpace;
+
+  if (config?.params?.shouldEmitBillableEvent) {
+    if (window.frames['cnftComm']) {
+      subscribeToConfiantCommFrame(window);
+    } else {
+      setUpMutationObserver();
+    }
+  }
+
+  injectConfigScript(propertyId);
+  return true;
+}
+
+/**
+ * Subscribe to window's message events to report Billable events
+ * @param {Window} targetWindow window instance to subscribe to
+ */
+function subscribeToConfiantCommFrame(targetWindow) {
+  targetWindow.addEventListener('message', reportBillableEvents);
+}
+
+let mutationObserver;
+/**
+ * Set up mutation observer to subscribe to Confiant's communication channel ASAP
+ */
+function setUpMutationObserver() {
+  mutationObserver = new MutationObserver((mutations) => {
+    mutations.forEach((mutation) => {
+      mutation.addedNodes.forEach((addedNode) => {
+        if (addedNode.nodeName === 'IFRAME' && addedNode.name === 'cnftComm' && !addedNode.pbjsModuleSubscribed) {
+          addedNode.pbjsModuleSubscribed = true;
+          mutationObserver.disconnect();
+          mutationObserver = null;
+          const iframeWindow = addedNode.contentWindow;
+          subscribeToConfiantCommFrame(iframeWindow);
+        }
+      });
+    });
+  });
+  mutationObserver.observe(document.head, { childList: true, subtree: true });
+}
+
+/**
+ * Emit billable event when Confiant integration reports that it has monitored an impression
+ */
+function reportBillableEvents (e) {
+  events.emit(CONSTANTS.EVENTS.BILLABLE_EVENT, {
+    auctionId: e.data.auctionId,
+    billingId: generateUUID(),
+    transactionId: e.data.transactionId,
+    type: 'impression',
+    vendor: 'confiant'
+  });
+}
+
+/**
+ * Confiant submodule registration
+ */
+function registerConfiantSubmodule() {
+  submodule('realTimeData', {
+    name: 'confiant',
+    init: (config) => {
+      try {
+        return setupPage(config);
+      } catch (err) {
+        logError(err.message);
+        if (mutationObserver) {
+          mutationObserver.disconnect();
+        }
+        return false;
+      }
+    }
+  });
+}
+
+registerConfiantSubmodule();
+
+export default {
+  injectConfigScript,
+  setupPage,
+  subscribeToConfiantCommFrame,
+  setUpMutationObserver,
+  reportBillableEvents,
+  registerConfiantSubmodule
+};

package/modules/confiantRtdProvider.md

@@ -0,0 +1,45 @@
+# Overview
+
+```
+Module Name: Confiant Inc. Rtd provider
+Module Type: Rtd Provider
+Maintainer: 
+```
+
+Confiant’s module provides comprehensive detection of security, quality, and privacy threats across your ad stack.
+Confiant is the industry leader in real-time detecting and blocking of bad ads when it comes to protecting your users and brand reputation.
+
+To start using this module, please contact [Confiant](https://www.confiant.com/contact) to get an account and customer key.
+
+
+# Integration
+
+1) Build Prebid bundle with Confiant module included:
+
+
+```
+gulp build --modules=confiantRtdProvider,...
+```
+
+2) Include the resulting bundle on your page.
+
+# Configuration
+
+Configuration of Confiant module is plain simple:
+
+```javascript
+pbjs.setConfig({
+    realTimeData: {
+        dataProviders: [{
+            name: 'confiant',
+            params: {
+                // so please get in touch with us so we could help you to set up the module with proper parameters
+                propertyId: '', // required, string param, obtained from Confiant Inc.
+                prebidExcludeBidders: '', // optional, comma separated list of bidders to exclude from Confiant's prebid.js integration
+                prebidNameSpace: '', // optional, string param, namespace for prebid.js integration
+                shouldEmitBillableEvent: false, // optional, boolean param, upon being set to true enables firing of the BillableEvent upon Confiant's impression scanning
+            }
+        }]
+    }
+});
+```

package/modules/connectIdSystem.js

@@ -66,6 +66,11 @@ export const connectIdSubmodule = {
       us_privacy: consentData && consentData.uspConsent ? consentData.uspConsent : ''
     };
 
+    if (connectIdSubmodule.isUnderGPPJurisdiction(consentData)) {
+      data.gpp = consentData.gppConsent.gppString;
+      data.gpp_sid = encodeURIComponent(consentData.gppConsent.applicableSections.join(','));
+    }
+
     INPUT_PARAM_KEYS.forEach(key => {
       if (typeof params[key] != 'undefined') {
         data[key] = params[key];
@@ -98,7 +103,7 @@ export const connectIdSubmodule = {
   },
 
   /**
-   * Utility function that returns a boolean flag indicating if the opporunity
+   * Utility function that returns a boolean flag indicating if the opportunity
    * is subject to GDPR
    * @returns {Boolean}
    */
@@ -106,6 +111,15 @@ export const connectIdSubmodule = {
     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);
+  },
+
   /**
    * Utility function that returns a boolean flag indicating if the user
    * has opeted out via the Yahoo easy-opt-out mechanism.

package/modules/datawrkzBidAdapter.js

@@ -1,4 +1,4 @@
-import { deepAccess, getBidIdParameter, isArray, getUniqueIdentifierStr, contains } from '../src/utils.js';
+import { deepAccess, getBidIdParameter, isArray, getUniqueIdentifierStr, contains, isFn, isPlainObject } from '../src/utils.js';
 import { config } from '../src/config.js';
 import { Renderer } from '../src/Renderer.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
@@ -84,7 +84,7 @@ export const spec = {
 
 /* Generate bid request for banner adunit */
 function buildBannerRequest(bidRequest, bidderRequest) {
-  let bidFloor = Number(getBidIdParameter('bidfloor', bidRequest.params));
+  let bidFloor = getBidFloor(bidRequest);
 
   let adW = 0;
   let adH = 0;
@@ -135,7 +135,7 @@ function buildNativeRequest(bidRequest, bidderRequest) {
   let counter = 0;
   let assets = [];
 
-  let bidFloor = Number(getBidIdParameter('bidfloor', bidRequest.params));
+  let bidFloor = getBidFloor(bidRequest);
 
   let title = deepAccess(bidRequest, 'mediaTypes.native.title');
   if (title && title.len) {
@@ -196,7 +196,7 @@ function buildNativeRequest(bidRequest, bidderRequest) {
 
 /* Generate bid request for video adunit */
 function buildVideoRequest(bidRequest, bidderRequest) {
-  let bidFloor = Number(getBidIdParameter('bidfloor', bidRequest.params));
+  let bidFloor = getBidFloor(bidRequest);
 
   let sizeObj = getVideoAdUnitSize(bidRequest);
 
@@ -414,6 +414,7 @@ function buildBannerResponse(bidRequest, bidResponse) {
       }
       let bidSizes = (deepAccess(bidRequest, 'mediaTypes.banner.sizes')) ? deepAccess(bidRequest, 'mediaTypes.banner.sizes') : bidRequest.sizes;
       bidResponse.requestId = bidRequest.bidId;
+      bidResponse.auctionId = bidRequest.auctionId;
       bidResponse.transactionId = bidRequest.transactionId;
       bidResponse.placementCode = placementCode;
       bidResponse.cpm = responseCPM;
@@ -455,6 +456,7 @@ function buildNativeResponse(bidRequest, response) {
         return;
       }
       bidResponse.requestId = bidRequest.bidId;
+      bidResponse.auctionId = bidRequest.auctionId;
       bidResponse.transactionId = bidRequest.transactionId;
       bidResponse.placementCode = placementCode;
       bidResponse.cpm = responseCPM;
@@ -507,6 +509,7 @@ function buildVideoResponse(bidRequest, response) {
       let context = bidRequest.mediaTypes.video.context;
 
       bidResponse.requestId = bidRequest.bidId;
+      bidResponse.auctionId = bidRequest.auctionId;
       bidResponse.transactionId = bidRequest.transactionId;
       bidResponse.placementCode = placementCode;
       bidResponse.cpm = responseCPM;
@@ -630,4 +633,21 @@ function getNativeAssestObj(obj, assets) {
   }
 }
 
+// BUILD REQUESTS: BIDFLOORS
+function getBidFloor(bid) {
+  if (!isFn(bid.getFloor)) {
+    return (bid.params.bidfloor) ? bid.params.bidfloor : null;
+  }
+
+  let floor = bid.getFloor({
+    currency: 'USD',
+    mediaType: '*',
+    size: '*'
+  });
+  if (isPlainObject(floor) && !isNaN(floor.floor) && floor.currency === 'USD') {
+    return floor.floor;
+  }
+  return null;
+}
+
 registerBidder(spec);

package/modules/feedadBidAdapter.js

@@ -7,7 +7,7 @@ import {ajax} from '../src/ajax.js';
  * Version of the FeedAd bid adapter
  * @type {string}
  */
-const VERSION = '1.0.3';
+const VERSION = '1.0.5';
 
 /**
  * @typedef {object} FeedAdApiBidRequest
@@ -16,7 +16,8 @@ const VERSION = '1.0.3';
  * @property {number} ad_type
  * @property {string} client_token
  * @property {string} placement_id
- * @property {string} sdk_version
+ * @property {string} prebid_adapter_version
+ * @property {string} prebid_sdk_version
  * @property {boolean} app_hybrid
  *
  * @property {string} [app_bundle_id]
@@ -181,7 +182,8 @@ function createApiBidRParams(request) {
     ad_type: 0,
     client_token: request.params.clientToken,
     placement_id: request.params.placementId,
-    sdk_version: `prebid_${VERSION}`,
+    prebid_adapter_version: VERSION,
+    prebid_sdk_version: '$prebid.version$',
     app_hybrid: false,
   });
 }
@@ -207,7 +209,6 @@ function buildRequests(validBidRequests, bidderRequest) {
     })
   });
   data.bids.forEach(bid => BID_METADATA[bid.bidId] = {
-    // TODO: is 'page' the right value here?
     referer: data.refererInfo.page,
     transactionId: bid.transactionId
   });
@@ -266,7 +267,8 @@ function createTrackingParams(data, klass) {
     prebid_bid_id: bidId,
     prebid_transaction_id: transactionId,
     referer,
-    sdk_version: VERSION
+    prebid_adapter_version: VERSION,
+    prebid_sdk_version: '$prebid.version$',
   };
 }
 
@@ -294,12 +296,20 @@ function trackingHandlerFactory(klass) {
 /**
  * Reads the user syncs off the server responses and converts them into Prebid.JS format
  * @param {SyncOptions} syncOptions
- * @param {FeedAdApiBidResponse[]} serverResponses
+ * @param {ServerResponse[]} serverResponses
  * @param gdprConsent
  * @param uspConsent
  */
 function getUserSyncs(syncOptions, serverResponses, gdprConsent, uspConsent) {
-  return serverResponses.map(response => response.ext)
+  return serverResponses.map(response => {
+    // validate response format
+    const ext = deepAccess(response, 'body.ext', []);
+    if (ext == null) {
+      return null;
+    }
+    return ext;
+  })
+    .filter(ext => ext != null)
     .flatMap(extension => {
       // extract user syncs from extension
       const pixels = syncOptions.pixelEnabled && extension.pixels ? extension.pixels : [];