prebid.js 7.53.0 → 8.0.0

package/modules/captifyRtdProvider.md

@@ -1,68 +0,0 @@
-# Captify Real-Time Data Submodule
-
-# Overview
-
-    Module Name: Captify Rtd Provider
-    Module Type: Rtd Provider
-	Layout: integrationExamples/gpt/captifyRtdProvider_example.html
-    Maintainer: prebid@captify.tech
-
-# Description
-
-Captify uses publisher first-party on-site search data to power machine learning algorithms to create a suite of
-contextual based targeting solutions that activate in a cookieless environment.
-
-The RTD submodule allows bid requests to be classified by our live-classification service on the first ad call,
-maximising value for publishers by increasing scale for advertisers.
-
-Segments will be attached to bid request objects sent to different SSPs in order to optimize targeting.
-
-Contact prebid@captify.tech for information.
-
-### Publisher Usage
-
-Compile the Captify RTD module into your Prebid build:
-
-`npm ci && gulp build --modules=rtdModule,appnexusBidAdapter,captifyRtdProvider`
-
-Add the Captify RTD provider to your Prebid config.
-
-```javascript
-pbjs.setConfig({
-    realTimeData: {
-        auctionDelay: 1000,
-        dataProviders: [
-            {
-                name: "CaptifyRTDModule",
-                waitForIt: true,
-                params: {
-                    pubId: 123456,
-                    bidders: ['appnexus'],
-                }
-            }
-        ]
-    }
-});
-```
-
-### Parameter Description
-This module is configured as part of the `realTimeData.dataProviders` object.
-
-| Name           |Type           | Description                                                         |Mandatory | Notes  |
-| :------------- | :------------ | :------------------------------------------------------------------ |:---------|:------------ |
-| name           | String        | Real time data module name                                          | yes     | Always 'CaptifyRTDModule' |
-| waitForIt      | Boolean       | Should be `true` if there's an `auctionDelay` defined (recommended) | no      | Default `false` |
-| params         | Object        | |  | |
-| params.pubId   | Integer       | Partner ID, required to get results and provided by Captify         | yes      | Use 123456 for tests and speak to your Captify account manager to receive your pubId |
-| params.bidders | Array<String> | List of bidders for which you would like data to be set             | yes      | Currently only 'appnexus' supported |
-| params.url     | String        | Captify live-classification service url                             | no       | Defaults to `https://live-classification.cpx.to/prebid-segments`
-
-### Testing
-
-To view an example of available segments returned by Captify:
-
-`gulp serve --modules=rtdModule,captifyRtdProvider,appnexusBidAdapter`
-
-and then point your browser at:
-
-`http://localhost:9999/integrationExamples/gpt/captifyRtdProvider_example.html?pbjs_debug=true`

package/modules/conversantAnalyticsAdapter.md

@@ -1,46 +0,0 @@
-# Overview
-- Module Name: Epsilon Analytics Adapter
-- Module Type: Analytics Adapter
-- Maintainer: mediapsr@epsilon.com
-
-## Description
-
-Analytics adapter for Epsilon (formerly Conversant) is used to track performance of Prebid auctions.  See the usage below for how to 
-configure the adapter for your webpage. To enable analytics and gain access to the data publishers will need
- to contact their Epsilon representative (publishersupport@epsilon.com).
-
-## Setup
-
-Before any analytics are recorded for your website you will need to have an Epsilon representative turn
-on Prebid analytics for your website.  
-
-The simplest configuration to add Epsilon Prebid analytics to your page is as follows:
-
-```
-    pbjs.que.push(function() {
-        pbjs.enableAnalytics({
-            provider: 'conversant',
-            options: {
-                site_id: <YOUR_SITE_ID>
-            }
-        })
-    });
-```
-
-Additionally, the following options are supported:
-
-- **cnvr_sampling**: Sample rate for analytics data. Value should be between 0 and 1 (inclusive), 0 == never sample, 
-1 == always sample, 0.5 == send analytics 50% of the time.
-
-### Complete Example
-```
-    pbjs.que.push(function() {
-        pbjs.enableAnalytics({
-            provider: 'conversant',
-            options: {
-                site_id: 1234,
-                cnvr_sampling: 0.9
-            }
-        })
-    });
-```

package/modules/conversantBidAdapter.md

@@ -1,46 +0,0 @@
-# Overview
-
-- Module Name: Epsilon Bidder Adapter
-- Module Type: Bidder Adapter
-- Maintainer: mediapsr@epsilon.com
-
-# Description
-
-Module that connects to Epsilon's (formerly Conversant) demand sources.  Supports banners and videos.
-
-# Test Parameters
-```
-var adUnits = [
-    {
-        code: 'banner-test-div',
-        mediaTypes: {
-            banner: {        
-                sizes: [[300, 250],[300,600]]
-            }
-        },
-        bids: [{
-            bidder: "conversant",
-            params: {
-                site_id: '108060'
-            }
-        }]
-    },{
-        code: 'video-test-div',
-        mediaTypes: {
-            video: {
-                context: 'instream',
-                playerSize: [640, 480],
-                api: [2],
-                protocols: [1, 2],
-                mimes: ['video/mp4']
-            }
-        },
-        bids: [{
-            bidder: "conversant",
-            params: {
-                site_id: '108060',
-                white_label_url: 'https://web.hb.ad.cpe.dotomi.com/s2s/header/24'
-            }
-        }]
-    }];
-```

package/modules/glimpseBidAdapter.js

@@ -1,198 +0,0 @@
-import { registerBidder } from '../src/adapters/bidderFactory.js';
-import { BANNER } from '../src/mediaTypes.js';
-import { getStorageManager } from '../src/storageManager.js';
-import {
-  isArray,
-  isEmpty,
-  isEmptyStr,
-  isStr,
-  isPlainObject,
-} from '../src/utils.js';
-
-const GVLID = 1012;
-const BIDDER_CODE = 'glimpse';
-const storageManager = getStorageManager({bidderCode: BIDDER_CODE});
-const ENDPOINT = 'https://market.glimpsevault.io/public/v1/prebid';
-const LOCAL_STORAGE_KEY = {
-  vault: {
-    jwt: 'gp_vault_jwt',
-  },
-};
-
-export const spec = {
-  gvlid: GVLID,
-  code: BIDDER_CODE,
-  supportedMediaTypes: [BANNER],
-
-  /**
-   * Determines if the bid request is valid
-   * @param bid {BidRequest} The bid to validate
-   * @return {boolean}
-   */
-  isBidRequestValid: (bid) => {
-    const pid = bid?.params?.pid;
-    return isStr(pid) && !isEmptyStr(pid);
-  },
-
-  /**
-   * Builds the http request
-   * @param validBidRequests {BidRequest[]}
-   * @param bidderRequest {BidderRequest}
-   * @returns {ServerRequest}
-   */
-  buildRequests: (validBidRequests, bidderRequest) => {
-    const url = buildQuery(bidderRequest);
-    const auth = getVaultJwt();
-    const referer = getReferer(bidderRequest);
-    const imp = validBidRequests.map(processBidRequest);
-    const fpd = getFirstPartyData(bidderRequest.ortb2);
-
-    const data = {
-      auth,
-      data: {
-        referer,
-        imp,
-        fpd,
-      },
-    };
-
-    return {
-      method: 'POST',
-      url,
-      data: JSON.stringify(data),
-      options: {},
-    };
-  },
-
-  /**
-   * Parse http response
-   * @param response {ServerResponse}
-   * @returns {Bid[]}
-   */
-  interpretResponse: (response) => {
-    if (isValidResponse(response)) {
-      const { auth, data } = response.body;
-      setVaultJwt(auth);
-      const bids = data.bids.map(processBidResponse);
-      return bids;
-    }
-    return [];
-  },
-};
-
-function setVaultJwt(auth) {
-  storageManager.setDataInLocalStorage(LOCAL_STORAGE_KEY.vault.jwt, auth);
-}
-
-function getVaultJwt() {
-  return (
-    storageManager.getDataFromLocalStorage(LOCAL_STORAGE_KEY.vault.jwt) || ''
-  );
-}
-
-function getReferer(bidderRequest) {
-  // TODO: is 'page' the right value here?
-  return bidderRequest?.refererInfo?.page || '';
-}
-
-function buildQuery(bidderRequest) {
-  let url = appendQueryParam(ENDPOINT, 'ver', '$prebid.version$');
-
-  const timeout = bidderRequest.timeout;
-  url = appendQueryParam(url, 'tmax', timeout);
-
-  if (gdprApplies(bidderRequest)) {
-    const consentString = bidderRequest.gdprConsent.consentString;
-    url = appendQueryParam(url, 'gdpr', consentString);
-  }
-
-  if (ccpaApplies(bidderRequest)) {
-    url = appendQueryParam(url, 'ccpa', bidderRequest.uspConsent);
-  }
-
-  return url;
-}
-
-function appendQueryParam(url, key, value) {
-  if (!value) {
-    return url;
-  }
-  const prefix = url.includes('?') ? '&' : '?';
-  return `${url}${prefix}${key}=${encodeURIComponent(value)}`;
-}
-
-function gdprApplies(bidderRequest) {
-  return Boolean(bidderRequest?.gdprConsent?.gdprApplies);
-}
-
-function ccpaApplies(bidderRequest) {
-  return (
-    isStr(bidderRequest.uspConsent) &&
-    !isEmptyStr(bidderRequest.uspConsent) &&
-    bidderRequest.uspConsent?.substr(1, 3) !== '---'
-  );
-}
-
-function processBidRequest(bid) {
-  const sizes = normalizeSizes(bid.sizes);
-
-  return {
-    bid: bid.bidId,
-    pid: bid.params.pid,
-    sizes,
-  };
-}
-
-function normalizeSizes(sizes) {
-  const isSingleSize =
-    isArray(sizes) &&
-    sizes.length === 2 &&
-    !isArray(sizes[0]) &&
-    !isArray(sizes[1]);
-
-  if (isSingleSize) {
-    return [sizes];
-  }
-
-  return sizes;
-}
-
-function getFirstPartyData(ortb2) {
-  let fpd = ortb2 || {};
-  optimizeObject(fpd);
-  return fpd;
-}
-
-function optimizeObject(obj) {
-  if (!isPlainObject(obj)) {
-    return;
-  }
-  for (const [key, value] of Object.entries(obj)) {
-    optimizeObject(value);
-    // only delete empty object, array, or string
-    if (
-      (isPlainObject(value) || isArray(value) || isStr(value)) &&
-      isEmpty(value)
-    ) {
-      delete obj[key];
-    }
-  }
-}
-
-function isValidResponse(bidResponse) {
-  const auth = bidResponse?.body?.auth;
-  const bids = bidResponse?.body?.data?.bids;
-  return isStr(auth) && isArray(bids) && !isEmpty(bids);
-}
-
-function processBidResponse(bid) {
-  const meta = bid.meta || {};
-  meta.advertiserDomains = bid.meta?.advertiserDomains || [];
-
-  return {
-    ...bid,
-    meta,
-  };
-}
-
-registerBidder(spec);

package/modules/glimpseBidAdapter.md

@@ -1,37 +0,0 @@
-# Overview
-
-```
-Module Name:  Glimpse Protocol Bid Adapter
-Module Type:  Bidder Adapter
-Maintainer:   publisher@glimpseprotocol.io
-```
-
-# Description
-
-This module connects publishers to Glimpse Protocol's demand sources via Prebid.js. Our innovative marketplace protects
-consumer privacy while allowing precise targeting. It is compliant with GDPR, DPA and CCPA.
-
-The Glimpse Adapter supports banner formats.
-
-# Test Parameters
-
-```javascript
-const adUnits = [
-  {
-    code: 'banner-div-a',
-    mediaTypes: {
-      banner: {
-        sizes: [[300, 250]],
-      },
-    },
-    bids: [
-      {
-        bidder: 'glimpse',
-        params: {
-          pid: 'e53a7f564f8f44cc913b',
-        },
-      },
-    ],
-  },
-];
-```

package/modules/googleAnalyticsAdapter.js

@@ -1,298 +0,0 @@
-/**
- * ga.js - analytics adapter for google analytics
- */
-
-import { _each, logMessage } from '../src/utils.js';
-import * as events from '../src/events.js';
-import CONSTANTS from '../src/constants.json';
-import adapterManager from '../src/adapterManager.js';
-
-var BID_REQUESTED = CONSTANTS.EVENTS.BID_REQUESTED;
-var BID_TIMEOUT = CONSTANTS.EVENTS.BID_TIMEOUT;
-var BID_RESPONSE = CONSTANTS.EVENTS.BID_RESPONSE;
-var BID_WON = CONSTANTS.EVENTS.BID_WON;
-
-var _disableInteraction = { nonInteraction: true };
-var _analyticsQueue = [];
-var _gaGlobal = null;
-var _enableCheck = true;
-var _category = 'Prebid.js Bids';
-var _eventCount = 0;
-var _enableDistribution = false;
-var _cpmDistribution = null;
-var _trackerSend = null;
-var _sampled = true;
-var _sendFloors = false;
-
-let adapter = {};
-
-/**
- * This will enable sending data to google analytics. Only call once, or duplicate data will be sent!
- * @param  {object} provider use to set GA global (if renamed);
- * @param  {object} options use to configure adapter;
- * @return {[type]}    [description]
- */
-adapter.enableAnalytics = function ({ provider, options }) {
-  _gaGlobal = provider || 'ga';
-  _trackerSend = options && options.trackerName ? options.trackerName + '.send' : 'send';
-  _sampled = typeof options === 'undefined' || typeof options.sampling === 'undefined' ||
-             Math.random() < parseFloat(options.sampling);
-
-  if (options && typeof options.global !== 'undefined') {
-    _gaGlobal = options.global;
-  }
-  if (options && typeof options.enableDistribution !== 'undefined') {
-    _enableDistribution = options.enableDistribution;
-  }
-  if (options && typeof options.cpmDistribution === 'function') {
-    _cpmDistribution = options.cpmDistribution;
-  }
-  if (options && typeof options.sendFloors !== 'undefined') {
-    _sendFloors = options.sendFloors;
-  }
-
-  var bid = null;
-
-  if (_sampled) {
-    // first send all events fired before enableAnalytics called
-
-    var existingEvents = events.getEvents();
-
-    _each(existingEvents, function (eventObj) {
-      if (typeof eventObj !== 'object') {
-        return;
-      }
-      var args = eventObj.args;
-
-      if (eventObj.eventType === BID_REQUESTED) {
-        bid = args;
-        sendBidRequestToGa(bid);
-      } else if (eventObj.eventType === BID_RESPONSE) {
-        // bid is 2nd args
-        bid = args;
-        sendBidResponseToGa(bid);
-      } else if (eventObj.eventType === BID_TIMEOUT) {
-        const bidderArray = args;
-        sendBidTimeouts(bidderArray);
-      } else if (eventObj.eventType === BID_WON) {
-        bid = args;
-        sendBidWonToGa(bid);
-      }
-    });
-
-    // Next register event listeners to send data immediately
-
-    // bidRequests
-    events.on(BID_REQUESTED, function (bidRequestObj) {
-      sendBidRequestToGa(bidRequestObj);
-    });
-
-    // bidResponses
-    events.on(BID_RESPONSE, function (bid) {
-      sendBidResponseToGa(bid);
-    });
-
-    // bidTimeouts
-    events.on(BID_TIMEOUT, function (bidderArray) {
-      sendBidTimeouts(bidderArray);
-    });
-
-    // wins
-    events.on(BID_WON, function (bid) {
-      sendBidWonToGa(bid);
-    });
-  } else {
-    logMessage('Prebid.js google analytics disabled by sampling');
-  }
-
-  // finally set this function to return log message, prevents multiple adapter listeners
-  this.enableAnalytics = function _enable() {
-    return logMessage(`Analytics adapter already enabled, unnecessary call to \`enableAnalytics\`.`);
-  };
-};
-
-adapter.getTrackerSend = function getTrackerSend() {
-  return _trackerSend;
-};
-
-/**
- * Check if gaGlobal or window.ga is defined on page. If defined execute all the GA commands
- */
-function checkAnalytics() {
-  if (_enableCheck && typeof window[_gaGlobal] === 'function') {
-    for (var i = 0; i < _analyticsQueue.length; i++) {
-      _analyticsQueue[i].call();
-    }
-
-    // override push to execute the command immediately from now on
-    _analyticsQueue.push = function (fn) {
-      fn.call();
-    };
-
-    // turn check into NOOP
-    _enableCheck = false;
-  }
-
-  logMessage('event count sent to GA: ' + _eventCount);
-}
-
-function convertToCents(dollars) {
-  if (dollars) {
-    return Math.floor(dollars * 100);
-  }
-
-  return 0;
-}
-
-function getLoadTimeDistribution(time) {
-  var distribution;
-  if (time >= 0 && time < 200) {
-    distribution = '0-200ms';
-  } else if (time >= 200 && time < 300) {
-    distribution = '0200-300ms';
-  } else if (time >= 300 && time < 400) {
-    distribution = '0300-400ms';
-  } else if (time >= 400 && time < 500) {
-    distribution = '0400-500ms';
-  } else if (time >= 500 && time < 600) {
-    distribution = '0500-600ms';
-  } else if (time >= 600 && time < 800) {
-    distribution = '0600-800ms';
-  } else if (time >= 800 && time < 1000) {
-    distribution = '0800-1000ms';
-  } else if (time >= 1000 && time < 1200) {
-    distribution = '1000-1200ms';
-  } else if (time >= 1200 && time < 1500) {
-    distribution = '1200-1500ms';
-  } else if (time >= 1500 && time < 2000) {
-    distribution = '1500-2000ms';
-  } else if (time >= 2000) {
-    distribution = '2000ms above';
-  }
-
-  return distribution;
-}
-
-function getCpmDistribution(cpm) {
-  if (_cpmDistribution) {
-    return _cpmDistribution(cpm);
-  }
-  var distribution;
-  if (cpm >= 0 && cpm < 0.5) {
-    distribution = '$0-0.5';
-  } else if (cpm >= 0.5 && cpm < 1) {
-    distribution = '$0.5-1';
-  } else if (cpm >= 1 && cpm < 1.5) {
-    distribution = '$1-1.5';
-  } else if (cpm >= 1.5 && cpm < 2) {
-    distribution = '$1.5-2';
-  } else if (cpm >= 2 && cpm < 2.5) {
-    distribution = '$2-2.5';
-  } else if (cpm >= 2.5 && cpm < 3) {
-    distribution = '$2.5-3';
-  } else if (cpm >= 3 && cpm < 4) {
-    distribution = '$3-4';
-  } else if (cpm >= 4 && cpm < 6) {
-    distribution = '$4-6';
-  } else if (cpm >= 6 && cpm < 8) {
-    distribution = '$6-8';
-  } else if (cpm >= 8) {
-    distribution = '$8 above';
-  }
-
-  return distribution;
-}
-
-function sendBidRequestToGa(bid) {
-  if (bid && bid.bidderCode) {
-    _analyticsQueue.push(function () {
-      _eventCount++;
-      if (_sendFloors) {
-        var floor = 'No Floor';
-        if (bid.floorData) {
-          floor = bid.floorData.floorValue;
-        } else if (bid.bids.length) {
-          floor = bid.bids[0].getFloor().floor;
-        }
-        window[_gaGlobal](_trackerSend, 'event', _category, 'Requests by Floor=' + floor, bid.bidderCode, 1, _disableInteraction);
-      } else {
-        window[_gaGlobal](_trackerSend, 'event', _category, 'Requests', bid.bidderCode, 1, _disableInteraction);
-      }
-    });
-  }
-
-  // check the queue
-  checkAnalytics();
-}
-
-function sendBidResponseToGa(bid) {
-  if (bid && bid.bidderCode) {
-    _analyticsQueue.push(function () {
-      var cpmCents = convertToCents(bid.cpm);
-      var bidder = bid.bidderCode;
-      if (typeof bid.timeToRespond !== 'undefined' && _enableDistribution) {
-        _eventCount++;
-        var dis = getLoadTimeDistribution(bid.timeToRespond);
-        window[_gaGlobal](_trackerSend, 'event', 'Prebid.js Load Time Distribution', dis, bidder, 1, _disableInteraction);
-      }
-
-      if (bid.cpm > 0) {
-        _eventCount = _eventCount + 2;
-        var cpmDis = getCpmDistribution(bid.cpm);
-        if (_enableDistribution) {
-          _eventCount++;
-          window[_gaGlobal](_trackerSend, 'event', 'Prebid.js CPM Distribution', cpmDis, bidder, 1, _disableInteraction);
-        }
-        if (_sendFloors) {
-          var floor = (bid.floorData) ? bid.floorData.floorValue : 'No Floor';
-          window[_gaGlobal](_trackerSend, 'event', _category, 'Bids by Floor=' + floor, 'Size=' + bid.size + ',' + bidder, cpmCents, _disableInteraction);
-        } else {
-          window[_gaGlobal](_trackerSend, 'event', _category, 'Bids', bidder, cpmCents, _disableInteraction);
-        }
-        window[_gaGlobal](_trackerSend, 'event', _category, 'Bid Load Time', bidder, bid.timeToRespond, _disableInteraction);
-      }
-    });
-  }
-
-  // check the queue
-  checkAnalytics();
-}
-
-function sendBidTimeouts(timedOutBidders) {
-  _analyticsQueue.push(function () {
-    _each(timedOutBidders, function (bidderCode) {
-      _eventCount++;
-      var bidderName = bidderCode.bidder;
-      window[_gaGlobal](_trackerSend, 'event', _category, 'Timeouts', bidderName, _disableInteraction);
-    });
-  });
-
-  checkAnalytics();
-}
-
-function sendBidWonToGa(bid) {
-  var cpmCents = convertToCents(bid.cpm);
-  _analyticsQueue.push(function () {
-    _eventCount++;
-    if (_sendFloors) {
-      var floor = (bid.floorData) ? bid.floorData.floorValue : 'No Floor';
-      window[_gaGlobal](_trackerSend, 'event', _category, 'Wins by Floor=' + floor, 'Size=' + bid.size + ',' + bid.bidderCode, cpmCents, _disableInteraction);
-    } else {
-      window[_gaGlobal](_trackerSend, 'event', _category, 'Wins', bid.bidderCode, cpmCents, _disableInteraction);
-    }
-  });
-
-  checkAnalytics();
-}
-
-/**
- * Exposed for testing purposes
- */
-adapter.getCpmDistribution = getCpmDistribution;
-
-adapterManager.registerAnalyticsAdapter({
-  adapter,
-  code: 'ga'
-});
-
-export default adapter;