prebid.js 7.46.0 → 7.48.0

package/modules/emtvBidAdapter.js

@@ -0,0 +1,211 @@
+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 = 'emtv';
+const AD_URL = 'https://us-east-ep.engagemedia.tv/pbjs';
+const SYNC_URL = 'https://cs.engagemedia.tv';
+
+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);
+    }
+    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;
+  },
+
+  getUserSyncs: (syncOptions, serverResponses, gdprConsent, uspConsent) => {
+    let syncType = syncOptions.iframeEnabled ? 'iframe' : 'image';
+    let syncUrl = SYNC_URL + `/${syncType}?pbjs=1`;
+    if (gdprConsent && gdprConsent.consentString) {
+      if (typeof gdprConsent.gdprApplies === 'boolean') {
+        syncUrl += `&gdpr=${Number(gdprConsent.gdprApplies)}&gdpr_consent=${gdprConsent.consentString}`;
+      } else {
+        syncUrl += `&gdpr=0&gdpr_consent=${gdprConsent.consentString}`;
+      }
+    }
+    if (uspConsent && uspConsent.consentString) {
+      syncUrl += `&ccpa_consent=${uspConsent.consentString}`;
+    }
+
+    const coppa = config.getConfig('coppa') ? 1 : 0;
+    syncUrl += `&coppa=${coppa}`;
+
+    return [{
+      type: syncType,
+      url: syncUrl
+    }];
+  }
+};
+
+registerBidder(spec);

package/modules/emtvBidAdapter.md

@@ -0,0 +1,79 @@
+# Overview
+
+```
+Module Name: EMTV Bidder Adapter
+Module Type: EMTV Bidder Adapter
+Maintainer: support@engagemedia.tv
+```
+
+# Description
+
+Connects to EMTV exchange for bids.
+EMTV 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: 'emtv',
+                            params: {
+                                placementId: 'testBanner',
+                            }
+                        }
+                    ]
+                },
+                {
+                    code: 'addunit2',
+                    mediaTypes: {
+                        video: {
+                            playerSize: [ [640, 480] ],
+                            context: 'instream',
+                            minduration: 5,
+                            maxduration: 60,
+                        }
+                    },
+                    bids: [
+                        {
+                            bidder: 'emtv',
+                            params: {
+                                placementId: 'testVideo',
+                            }
+                        }
+                    ]
+                },
+                {
+                    code: 'addunit3',
+                    mediaTypes: {
+                        native: {
+                            title: {
+                                required: true
+                            },
+                            body: {
+                                required: true
+                            },
+                            icon: {
+                                required: true,
+                                size: [64, 64]
+                            }
+                        }
+                    },
+                    bids: [
+                        {
+                            bidder: 'emtv',
+                            params: {
+                                placementId: 'testNative',
+                            }
+                        }
+                    ]
+                }
+            ];
+```

package/modules/freewheel-sspBidAdapter.js

@@ -1,4 +1,4 @@
-import { logWarn, isArray, isFn, deepAccess } from '../src/utils.js';
+import { logWarn, isArray, isFn, deepAccess, formatQS } from '../src/utils.js';
 import { BANNER, VIDEO } from '../src/mediaTypes.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { config } from '../src/config.js';
@@ -372,6 +372,15 @@ export const spec = {
         requestParams._fw_us_privacy = bidderRequest.uspConsent;
       }
 
+      // Add GPP consent
+      if (bidderRequest && bidderRequest.gppConsent) {
+        requestParams.gpp = bidderRequest.gppConsent.gppString;
+        requestParams.gpp_sid = bidderRequest.gppConsent.applicableSections;
+      } else if (bidderRequest && bidderRequest.ortb2 && bidderRequest.ortb2.regs && bidderRequest.ortb2.regs.gpp) {
+        requestParams.gpp = bidderRequest.ortb2.regs.gpp;
+        requestParams.gpp_sid = bidderRequest.ortb2.regs.gpp_sid;
+      }
+
       // Add schain object
       var schain = currentBidRequest.schain;
       if (schain) {
@@ -526,26 +535,42 @@ export const spec = {
     return bidResponses;
   },
 
-  getUserSyncs: function(syncOptions, responses, gdprConsent, usPrivacy) {
-    var gdprParams = '';
+  getUserSyncs: function(syncOptions, responses, gdprConsent, usPrivacy, gppConsent) {
+    const params = {};
+
     if (gdprConsent) {
       if (typeof gdprConsent.gdprApplies === 'boolean') {
-        gdprParams = `?gdpr=${Number(gdprConsent.gdprApplies)}&gdpr_consent=${gdprConsent.consentString}`;
+        params.gdpr = Number(gdprConsent.gdprApplies);
+        params.gdpr_consent = gdprConsent.consentString;
       } else {
-        gdprParams = `?gdpr_consent=${gdprConsent.consentString}`;
+        params.gdpr_consent = gdprConsent.consentString;
       }
     }
 
+    if (gppConsent) {
+      if (typeof gppConsent.gppString === 'string') {
+        params.gpp = gppConsent.gppString;
+      }
+      if (gppConsent.applicableSections) {
+        params.gpp_sid = gppConsent.applicableSections;
+      }
+    }
+
+    var queryString = '';
+    if (params) {
+      queryString = '?' + `${formatQS(params)}`;
+    }
+
     const syncs = [];
     if (syncOptions && syncOptions.pixelEnabled) {
       syncs.push({
         type: 'image',
-        url: USER_SYNC_URL + gdprParams
+        url: USER_SYNC_URL + queryString
       });
     } else if (syncOptions.iframeEnabled) {
       syncs.push({
         type: 'iframe',
-        url: USER_SYNC_URL + gdprParams
+        url: USER_SYNC_URL + queryString
       });
     }
 

package/modules/greenbidsRtdProvider.js

@@ -0,0 +1,110 @@
+import { logError } from '../src/utils.js';
+import { ajax } from '../src/ajax.js';
+import { submodule } from '../src/hook.js';
+
+const MODULE_NAME = 'greenbidsRtdProvider';
+const MODULE_VERSION = '1.0.0';
+const ENDPOINT = 'https://europe-west1-greenbids-357713.cloudfunctions.net/partner-selection';
+
+const auctionInfo = {};
+const rtdOptions = {};
+
+function init(moduleConfig) {
+  let params = moduleConfig?.params;
+  if (!params?.pbuid) {
+    logError('Greenbids pbuid is not set!');
+    return false;
+  } else {
+    rtdOptions.pbuid = params?.pbuid;
+    rtdOptions.targetTPR = params?.targetTPR || 0.99;
+    rtdOptions.timeout = params?.timeout || 200;
+    return true;
+  }
+}
+
+function onAuctionInitEvent(auctionDetails) {
+  auctionInfo.auctionId = auctionDetails.auctionId;
+}
+
+function getBidRequestData(reqBidsConfigObj, callback, config, userConsent) {
+  let promise = createPromise(reqBidsConfigObj);
+  promise.then(callback);
+}
+
+function createPromise(reqBidsConfigObj) {
+  return new Promise((resolve) => {
+    const timeoutId = setTimeout(() => {
+      resolve(reqBidsConfigObj);
+    }, rtdOptions.timeout);
+    ajax(
+      ENDPOINT,
+      {
+        success: (response) => {
+          processSuccessResponse(response, timeoutId, reqBidsConfigObj);
+          resolve(reqBidsConfigObj);
+        },
+        error: () => {
+          clearTimeout(timeoutId);
+          resolve(reqBidsConfigObj);
+        },
+      },
+      createPayload(reqBidsConfigObj),
+      { contentType: 'application/json' }
+    );
+  });
+}
+
+function processSuccessResponse(response, timeoutId, reqBidsConfigObj) {
+  clearTimeout(timeoutId);
+  const responseAdUnits = JSON.parse(response);
+
+  updateAdUnitsBasedOnResponse(reqBidsConfigObj.adUnits, responseAdUnits);
+}
+
+function updateAdUnitsBasedOnResponse(adUnits, responseAdUnits) {
+  adUnits.forEach((adUnit) => {
+    const matchingAdUnit = findMatchingAdUnit(responseAdUnits, adUnit.code);
+    if (matchingAdUnit) {
+      removeFalseBidders(adUnit, matchingAdUnit);
+    }
+  });
+}
+
+function findMatchingAdUnit(responseAdUnits, adUnitCode) {
+  return responseAdUnits.find((responseAdUnit) => responseAdUnit.code === adUnitCode);
+}
+
+function removeFalseBidders(adUnit, matchingAdUnit) {
+  const falseBidders = getFalseBidders(matchingAdUnit.bidders);
+  adUnit.bids = adUnit.bids.filter((bidRequest) => !falseBidders.includes(bidRequest.bidder));
+}
+
+function getFalseBidders(bidders) {
+  return Object.entries(bidders)
+    .filter(([bidder, shouldKeep]) => !shouldKeep)
+    .map(([bidder]) => bidder);
+}
+
+function createPayload(reqBidsConfigObj) {
+  return JSON.stringify({
+    auctionId: auctionInfo.auctionId,
+    version: MODULE_VERSION,
+    referrer: window.location.href,
+    prebid: '$prebid.version$',
+    rtdOptions: rtdOptions,
+    adUnits: reqBidsConfigObj.adUnits,
+  });
+}
+
+export const greenbidsSubmodule = {
+  name: MODULE_NAME,
+  init: init,
+  onAuctionInitEvent: onAuctionInitEvent,
+  getBidRequestData: getBidRequestData,
+  updateAdUnitsBasedOnResponse: updateAdUnitsBasedOnResponse,
+  findMatchingAdUnit: findMatchingAdUnit,
+  removeFalseBidders: removeFalseBidders,
+  getFalseBidders: getFalseBidders,
+};
+
+submodule('realTimeData', greenbidsSubmodule);

package/modules/greenbidsRtdProvider.md

@@ -0,0 +1,65 @@
+# Overview
+
+```
+Module Name: Greenbids RTD Provider
+Module Type: RTD Provider
+Maintainer: jb@greenbids.ai
+```
+
+# Description
+
+The Greenbids RTD adapter allows to dynamically filter calls to SSP to reduce outgoing call to the programmatics chain, reducing ad serving carbon impact
+
+## Configuration
+
+This module is configured as part of the `realTimeData.dataProviders` object.
+
+{: .table .table-bordered .table-striped }
+| Name       | Scope    | Description                            | Example       | Type     |
+|------------|----------|----------------------------------------|---------------|----------|
+| `name `     | required | Real time data module name | `'greenbidsRtdProvider'`   | `string` |
+| `waitForIt `     | required (mandatory true value) | Tells prebid auction to wait for the result of this module | `'true'`   | `boolean` |
+| `params`      | required |  | | `Object` |
+| `params.pbuid`      | required | The client site id provided by Greenbids. | `'TEST_FROM_GREENBIDS'` | `string` |
+| `params.targetTPR`      | optional (default 0.95) | Target True positive rate for the throttling model | `0.99` | `[0-1]` |
+| `params.timeout`      | optional (default 200) | Maximum amount of milliseconds allowed for module to finish working (has to be <= to the realTimeData.auctionDelay property) | `200` | `number` |
+
+#### Example
+
+```javascript
+const greenbidsDataProvider = {
+  name: 'greenbidsRtdProvider',
+  waitForIt: true,
+  params: {
+    pbuid: 'TEST_FROM_GREENBIDS',
+    timeout: 200
+  }
+};
+
+pbjs.setConfig({
+  realTimeData: {
+    auctionDelay: 200,
+    dataProviders: [greenbidsDataProvider]
+  }
+});
+```
+
+## Integration
+To install the module, follow these instructions:
+
+#### Step 1: Contact Greenbids to get a pbuid and account
+
+#### Step 2: Integrate the Greenbids Analytics Adapter 
+
+Greenbids RTD module works hand in hand with Greenbids Analytics module
+See prebid Analytics modules -> Greenbids Analytics module
+
+#### Step 3: Prepare the base Prebid file
+
+- Option 1: Use Prebid [Download](/download.html) page to build the prebid package. Ensure that you do check *Greenbids RTD Provider* module
+
+- Option 2: From the command line, run `gulp build --modules=greenbidsRtdProvider,...`
+
+#### Step 4: Set configuration
+
+Enable Greenbids Real Time Module using `pbjs.setConfig`. Example is provided in Configuration section.

package/modules/impactifyBidAdapter.js

@@ -91,7 +91,6 @@ const createOpenRtbRequest = (validBidRequests, bidderRequest) => {
 
   if (bidderRequest.uspConsent) {
     deepSetValue(request, 'regs.ext.us_privacy', bidderRequest.uspConsent);
-    this.syncStore.uspConsent = bidderRequest.uspConsent;
   }
 
   if (GETCONFIG('coppa') == true) deepSetValue(request, 'regs.coppa', 1);

package/modules/iqmBidAdapter.js

@@ -1,6 +1,5 @@
 import {_each, deepAccess, getBidIdParameter, isArray} 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 {INSTREAM} from '../src/video.js';
 
@@ -155,7 +154,7 @@ export const spec = {
               auctionId: bidRequest.data.auctionId,
               mediaType: bidRequest.data.imp.mediatype,
 
-              ttl: bid.ttl || config.getConfig('_bidderTimeout')
+              ttl: bid.ttl || 60
             };
 
             if (bidRequest.data.imp.mediatype === VIDEO) {

package/modules/missenaBidAdapter.js

@@ -8,7 +8,7 @@ const EVENTS_DOMAIN = 'events.missena.io';
 const EVENTS_DOMAIN_DEV = 'events.staging.missena.xyz';
 
 export const spec = {
-  aliases: [BIDDER_CODE],
+  aliases: ['msna'],
   code: BIDDER_CODE,
   gvlid: 687,
   supportedMediaTypes: [BANNER],

package/modules/nextMillenniumBidAdapter.js

@@ -31,6 +31,7 @@ const VIDEO_PARAMS = [
   'api', 'linearity', 'maxduration', 'mimes', 'minduration', 'placement',
   'playbackmethod', 'protocols', 'startdelay'
 ];
+const GVLID = 1060;
 
 const sendingDataStatistic = initSendingDataStatistic();
 events.on(CONSTANTS.EVENTS.AUCTION_INIT, auctionInitHandler);
@@ -44,6 +45,7 @@ events.on(CONSTANTS.EVENTS.BID_WON, bidWonHandler);
 export const spec = {
   code: BIDDER_CODE,
   supportedMediaTypes: [BANNER, VIDEO],
+  gvlid: GVLID,
 
   isBidRequestValid: function(bid) {
     return !!(

package/modules/orbitsoftBidAdapter.js

@@ -1,6 +1,5 @@
 import * as utils from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
-import {config} from '../src/config.js';
 
 const BIDDER_CODE = 'orbitsoft';
 let styleParamsMap = {
@@ -122,7 +121,7 @@ export const spec = {
     const HEIGHT = serverBody.height;
     const CREATIVE = serverBody.content_url;
     const CALLBACK_UID = serverBody.callback_uid;
-    const TIME_TO_LIVE = config.getConfig('_bidderTimeout');
+    const TIME_TO_LIVE = 60;
     const REFERER = utils.getWindowTop();
     let bidRequest = request.bidRequest;
     if (CPM > 0 && WIDTH > 0 && HEIGHT > 0) {

package/modules/radsBidAdapter.js

@@ -1,7 +1,6 @@
-import { deepAccess } from '../src/utils.js';
-import {config} from '../src/config.js';
+import {deepAccess} from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
-import { BANNER, VIDEO } from '../src/mediaTypes.js';
+import {BANNER, VIDEO} from '../src/mediaTypes.js';
 
 const BIDDER_CODE = 'rads';
 const ENDPOINT_URL = 'https://rads.recognified.net/md.request.php';
@@ -86,7 +85,7 @@ export const spec = {
         dealId: dealId,
         currency: currency,
         netRevenue: netRevenue,
-        ttl: config.getConfig('_bidderTimeout'),
+        ttl: 60,
         meta: {
           advertiserDomains: response.adomain || []
         }