prebid.js 7.53.0 → 8.0.0

package/modules/googleAnalyticsAdapter.md

@@ -1,38 +0,0 @@
-# Google Analytics Adapter
-
-The google analytics adapter pushes prebid events into google analytics.
-
-## Usage
-
-The simplest way to enable the analytics adapter is this
-
-```javascript
-pbjs.enableAnalytics([{
-  provider: 'ga'
-}]);
-```
-
-Defaults will be used and you should see events being pushed to analytics.
-
-You can customize the adapter with various `options` like this
-
-```javascript
-pbjs.enableAnalytics([{
-  provider: 'ga',
-  options: { ... }
-}]);
-
-Here is a full list of settings available
-
-- `global` (string) - name of the global analytics object. Default is `ga`
-- `trackerName` (string) - use another tracker for prebid events. Default is the default tracker
-- `sampling` (number) - choose a value from `0` to `1`, where `0` means 0% and `1` means 100% tracked
-- `enableDistribution` (boolean) - enables additional events that track load time and cpm distribution
-  by creating buckets for load time and cpm
-- `cpmDistribution` (cpm: number => string) - customize the cpm buckets for the cpm distribution
-- `sendFloors` (boolean) - if set, will include floor data in the eventCategory field and include ad unit code in eventAction field
-
-
-## Additional resources
-
-- [Prebid GA Analytics](http://prebid.org/overview/ga-analytics.html)

package/modules/inmarBidAdapter.js

@@ -1,132 +0,0 @@
-import {logError, mergeDeep} from '../src/utils.js';
-import { config } from '../src/config.js';
-import { registerBidder } from '../src/adapters/bidderFactory.js';
-import { BANNER, VIDEO } from '../src/mediaTypes.js';
-
-const BIDDER_CODE = 'inmar';
-
-export const spec = {
-  code: BIDDER_CODE,
-  aliases: ['inm'],
-  supportedMediaTypes: [BANNER, VIDEO],
-
-  /**
-   * Determines whether or not the given bid request is valid
-   *
-   * @param {bidRequest} bid The bid params to validate.
-   * @returns {boolean} True if this is a valid bid, and false otherwise
-   */
-  isBidRequestValid: function(bid) {
-    return !!(bid.params && bid.params.partnerId);
-  },
-
-  /**
-   * Build a server request from the list of valid BidRequests
-   * @param {validBidRequests} is an array of the valid bids
-   * @param {bidderRequest} bidder request object
-   * @returns {ServerRequest} Info describing the request to the server
-   */
-  buildRequests: function(validBidRequests, bidderRequest) {
-    var payload = {
-      bidderCode: bidderRequest.bidderCode,
-      auctionId: bidderRequest.auctionId,
-      bidderRequestId: bidderRequest.bidderRequestId,
-      bidRequests: validBidRequests,
-      auctionStart: bidderRequest.auctionStart,
-      timeout: bidderRequest.timeout,
-      // TODO: please do not send internal data structures over the network
-      refererInfo: bidderRequest.refererInfo.legacy,
-      start: bidderRequest.start,
-      gdprConsent: bidderRequest.gdprConsent,
-      uspConsent: bidderRequest.uspConsent,
-      currencyCode: config.getConfig('currency.adServerCurrency'),
-      coppa: config.getConfig('coppa'),
-      firstPartyData: getLegacyFpd(bidderRequest.ortb2),
-      prebidVersion: '$prebid.version$'
-    };
-
-    var payloadString = JSON.stringify(payload);
-
-    return {
-      method: 'POST',
-      url: 'https://prebid.owneriq.net:8443/bidder/pb/bid',
-      data: payloadString,
-    };
-  },
-
-  /**
-   * Read the response from the server and build a list of bids
-   * @param {serverResponse} Response from the server.
-   * @param {bidRequest} Bid request object
-   * @returns {bidResponses} Array of bids which were nested inside the server
-   */
-  interpretResponse: function(serverResponse, bidRequest) {
-    const bidResponses = [];
-    var response = serverResponse.body;
-
-    try {
-      if (response) {
-        var bidResponse = {
-          requestId: response.requestId,
-          cpm: response.cpm,
-          currency: response.currency,
-          width: response.width,
-          height: response.height,
-          ad: response.ad,
-          ttl: response.ttl,
-          creativeId: response.creativeId,
-          netRevenue: response.netRevenue,
-          vastUrl: response.vastUrl,
-          dealId: response.dealId,
-          meta: response.meta
-        };
-
-        bidResponses.push(bidResponse);
-      }
-    } catch (error) {
-      logError('Error while parsing inmar response', error);
-    }
-    return bidResponses;
-  },
-
-  /**
-   * User Syncs
-   *
-   * @param {syncOptions} Publisher prebid configuration
-   * @param {serverResponses} Response from the server
-   * @returns {Array}
-   */
-  getUserSyncs: function(syncOptions, serverResponses) {
-    const syncs = [];
-    if (syncOptions.pixelEnabled) {
-      syncs.push({
-        type: 'image',
-        url: 'https://px.owneriq.net/eucm/p/pb'
-      });
-    }
-    return syncs;
-  }
-};
-
-function getLegacyFpd(ortb2) {
-  if (typeof ortb2 !== 'object') return;
-
-  let duplicate = {};
-
-  Object.keys(ortb2).forEach((type) => {
-    let prop = (type === 'site') ? 'context' : type;
-    duplicate[prop] = (prop === 'context' || prop === 'user') ? Object.keys(ortb2[type]).filter(key => key !== 'data').reduce((result, key) => {
-      if (key === 'ext') {
-        mergeDeep(result, ortb2[type][key]);
-      } else {
-        mergeDeep(result, {[key]: ortb2[type][key]});
-      }
-
-      return result;
-    }, {}) : ortb2[type];
-  });
-
-  return duplicate;
-}
-
-registerBidder(spec);

package/modules/inmarBidAdapter.md

@@ -1,44 +0,0 @@
-# Overview
-
-```
-Module Name: Inmar Bidder Adapter
-Module Type: Bidder Adapter
-Maintainer: oiq_rtb@inmar.com
-```
-
-# Description
-
-Connects to Inmar for bids. This adapter supports Display and Video.
-
-The Inmar adapter requires setup and approval from the Inmar team.
-Please reach out to your account manager for more information.
-
-# Test Parameters
-
-## Web
-```
-    var adUnits = [
-                {
-                    code: 'test-div1',
-                    sizes: [[300, 250],[300, 600]],
-                    bids: [{
-                        bidder: 'inmar',
-                        params: {
-                            partnerId: 12345,
-                            position: 1
-                        }
-                    }]
-                },
-                {
-                    code: 'test-div2',
-                    sizes: [[728, 90],[970, 250]],
-                    bids: [{
-                        bidder: 'inmar',
-                        params: {
-                            partnerId: 12345,
-                            position: 0
-                        }
-                    }]
-                }
-            ];
-```

package/modules/inskinBidAdapter.js

@@ -1,391 +0,0 @@
-import { createTrackPixelHtml } from '../src/utils.js';
-import { loadExternalScript } from '../src/adloader.js';
-import { registerBidder } from '../src/adapters/bidderFactory.js';
-
-const BIDDER_CODE = 'inskin';
-
-const CONFIG = {
-  BASE_URI: 'https://mfad.inskinad.com/api/v2'
-};
-
-export const spec = {
-  code: BIDDER_CODE,
-
-  /**
-   * 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) {
-    return !!(bid.params.networkId && bid.params.siteId);
-  },
-
-  /**
-   * Make a server request from the list of BidRequests.
-   *
-   * @param {validBidRequests[]} - an array of bids
-   * @param {bidderRequest} - the full bidder request object
-   * @return ServerRequest Info describing the request to the server.
-   */
-
-  buildRequests: function(validBidRequests, bidderRequest) {
-    // Do we need to group by bidder? i.e. to make multiple requests for
-    // different endpoints.
-
-    let ret = {
-      method: 'POST',
-      url: '',
-      data: '',
-      bidRequest: []
-    };
-
-    if (validBidRequests.length < 1) {
-      return ret;
-    }
-
-    let ENDPOINT_URL;
-
-    const data = Object.assign({
-      placements: [],
-      time: Date.now(),
-      user: {},
-      url: bidderRequest.refererInfo.page,
-      enableBotFiltering: true,
-      includePricingData: true,
-      parallel: true
-    }, validBidRequests[0].params);
-
-    if (validBidRequests[0].schain) {
-      data.rtb = {
-        schain: validBidRequests[0].schain
-      };
-    } else if (data.publisherId) {
-      data.rtb = {
-        schain: {
-          ext: {
-            sid: String(data.publisherId)
-          }
-        }
-      };
-    }
-
-    delete data.publisherId;
-
-    data.keywords = data.keywords || [];
-    const restrictions = [];
-
-    if (bidderRequest && bidderRequest.gdprConsent) {
-      data.consent = {
-        gdprVendorId: 150,
-        gdprConsentString: bidderRequest.gdprConsent.consentString,
-        // will check if the gdprApplies field was populated with a boolean value (ie from page config).  If it's undefined, then default to true
-        gdprConsentRequired: (typeof bidderRequest.gdprConsent.gdprApplies === 'boolean') ? bidderRequest.gdprConsent.gdprApplies : true
-      };
-
-      const purposes = [
-        {id: 1, kw: 'nocookies'},
-        {id: 2, kw: 'nocontext'},
-        {id: 3, kw: 'nodmp'},
-        {id: 4, kw: 'nodata'},
-        {id: 7, kw: 'noclicks'},
-        {id: 9, kw: 'noresearch'}
-      ];
-
-      const d = bidderRequest.gdprConsent.vendorData;
-
-      if (d) {
-        if (d.purposeOneTreatment) {
-          data.keywords.push('cst-nodisclosure');
-          restrictions.push('nodisclosure');
-        }
-
-        purposes.map(p => {
-          if (!checkConsent(p.id, d)) {
-            data.keywords.push('cst-' + p.kw);
-            restrictions.push(p.kw);
-          }
-        });
-      }
-    }
-
-    validBidRequests.map(bid => {
-      ENDPOINT_URL = CONFIG.BASE_URI;
-
-      const placement = Object.assign({
-        divName: bid.bidId,
-        adTypes: bid.adTypes || getSize(bid.sizes),
-        eventIds: [40, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 261, 262, 263, 264, 265, 266, 267, 268, 269, 270, 271, 272, 273, 274, 275, 276, 277, 278, 279, 280, 281, 282, 283, 284, 285, 286, 287, 288, 289, 290, 291, 292, 293, 294, 295]
-      }, bid.params);
-
-      placement.adTypes.push(5, 9, 163, 2163, 3006);
-
-      placement.properties = placement.properties || {};
-
-      placement.properties.screenWidth = screen.width;
-      placement.properties.screenHeight = screen.height;
-
-      if (restrictions.length) {
-        placement.properties.restrictions = restrictions;
-      }
-
-      if (placement.networkId && placement.siteId) {
-        data.placements.push(placement);
-      }
-    });
-
-    ret.data = JSON.stringify(data);
-    ret.bidRequest = validBidRequests;
-    ret.url = ENDPOINT_URL;
-
-    return ret;
-  },
-
-  /**
-   * Unpack the response from the server into a list of bids.
-   *
-   * @param {*} serverResponse A successful response from the server.
-   * @return {Bid[]} An array of bids which were nested inside the server.
-   */
-  interpretResponse: function(serverResponse, bidRequest) {
-    let bid;
-    let bids;
-    let bidId;
-    let bidObj;
-    let bidResponses = [];
-    let bidsMap = {};
-
-    bids = bidRequest.bidRequest;
-
-    serverResponse = (serverResponse || {}).body;
-    for (let i = 0; i < bids.length; i++) {
-      bid = {};
-      bidObj = bids[i];
-      bidId = bidObj.bidId;
-
-      bidsMap[bidId] = bidObj;
-
-      if (serverResponse) {
-        const decision = serverResponse.decisions && serverResponse.decisions[bidId];
-        const data = decision && decision.contents && decision.contents[0] && decision.contents[0].data;
-        const pubCPM = data && data.customData && data.customData.pubCPM;
-        const clearPrice = decision && decision.pricing && decision.pricing.clearPrice;
-        const price = pubCPM || clearPrice;
-
-        if (decision && price) {
-          decision.impressionUrl += ('&property:pubcpm=' + price);
-          bidObj.price = price;
-
-          bid.requestId = bidId;
-          bid.cpm = price;
-          bid.width = decision.width;
-          bid.height = decision.height;
-          bid.ad = retrieveAd(bidId, decision);
-          bid.currency = 'USD';
-          bid.creativeId = decision.adId;
-          bid.ttl = 360;
-          bid.meta = { advertiserDomains: decision.adomain ? decision.adomain : [] };
-          bid.netRevenue = true;
-
-          bidResponses.push(bid);
-        }
-      }
-    }
-
-    if (bidResponses.length) {
-      window.addEventListener('message', function(e) {
-        if (!e.data || e.data.from !== 'ism-bid') {
-          return;
-        }
-
-        const decision = serverResponse.decisions && serverResponse.decisions[e.data.bidId];
-        if (!decision) {
-          return;
-        }
-
-        const id = 'ism_tag_' + Math.floor((Math.random() * 10e16));
-        window[id] = {
-          plr_AdSlot: e.source && e.source.frameElement,
-          bidId: e.data.bidId,
-          bidPrice: bidsMap[e.data.bidId].price,
-          serverResponse
-        };
-
-        const url = 'https://cdn.inskinad.com/isfe/publishercode/' + bidsMap[e.data.bidId].params.siteId + '/default.js?autoload&id=' + id;
-        loadExternalScript(url, BIDDER_CODE);
-      });
-    }
-
-    return bidResponses;
-  },
-
-  getUserSyncs: function(syncOptions) {
-    const userSyncs = [];
-
-    if (syncOptions.pixelEnabled) {
-      userSyncs.push({
-        type: 'image',
-        url: 'https://e.serverbid.com/udb/9969/match?redir=https%3A%2F%2Fmfad.inskinad.com%2Fudb%2F9874%2Fpool%2Fset%2Fi.gif%3FpoolId%3D9969%26poolKey%3D'
-      });
-      userSyncs.push({
-        type: 'image',
-        url: 'https://ssum.casalemedia.com/usermatchredir?s=185638&cb=https%3A%2F%2Fmfad.inskinad.com%2Fudb%2F9874%2Fsync%2Fi.gif%3FpartnerId%3D1%26userId%3D'
-      });
-    }
-
-    if (syncOptions.iframeEnabled) {
-      userSyncs.push({
-        type: 'iframe',
-        url: 'https://ssum-sec.casalemedia.com/usermatch?s=184665&cb=https%3A%2F%2Fmfad.inskinad.com%2Fudb%2F9874%2Fsync%2Fi.gif%3FpartnerId%3D1%26userId%3D'
-      });
-    }
-
-    return userSyncs;
-  }
-};
-
-const sizeMap = [
-  null,
-  '120x90',
-  '120x90',
-  '468x60',
-  '728x90',
-  '300x250',
-  '160x600',
-  '120x600',
-  '300x100',
-  '180x150',
-  '336x280',
-  '240x400',
-  '234x60',
-  '88x31',
-  '120x60',
-  '120x240',
-  '125x125',
-  '220x250',
-  '250x250',
-  '250x90',
-  '0x0',
-  '200x90',
-  '300x50',
-  '320x50',
-  '320x480',
-  '185x185',
-  '620x45',
-  '300x125',
-  '800x250'
-];
-
-sizeMap[77] = '970x90';
-sizeMap[123] = '970x250';
-sizeMap[43] = '300x600';
-
-function getSize(sizes) {
-  const result = [];
-  sizes.forEach(function(size) {
-    const index = sizeMap.indexOf(size[0] + 'x' + size[1]);
-    if (index >= 0) {
-      result.push(index);
-    }
-  });
-  return result;
-}
-
-function retrieveAd(bidId, decision) {
-  return "<script>window.top.postMessage({from: 'ism-bid', bidId: '" + bidId + "'}, '*');\x3c/script>" + createTrackPixelHtml(decision.impressionUrl);
-}
-
-function checkConsent(P, d) {
-  const GVL = {'150': {'id': 150, 'name': 'Inskin Media LTD', 'purposes': {'1': 1, '3': 3, '4': 4, '9': 9, '10': 10}, 'legIntPurposes': {'2': 2, '7': 7}, 'flexiblePurposes': {'2': 2, '7': 7}, 'specialPurposes': {'1': 1, '2': 2}, 'features': {'3': 3}, 'specialFeatures': {}, 'policyUrl': 'http://www.inskinmedia.com/privacy-policy.html'}};
-  const V = 150;
-
-  // vendor claims (inflexible) consent as their basis, publisher doesn't
-  // restrict the purpose, user consents to the purpose and user consents
-  // to the vendor
-  try {
-    if (
-      GVL[V].purposes[P] && !GVL[V].flexiblePurposes[P] &&
-      d.purpose.consents[P] &&
-      d.vendor.consents[V]
-    ) {
-      return true;
-    }
-  } catch (e) {}
-
-  // vendor claims (inflexible) legitimate interest as their basis,
-  // publisher doesn't restrict the purpose, user was provided notice of the
-  // legitimate interest basis for this purpose and user was provided notice
-  // for the LI basis for this vendor
-  try {
-    if (
-      GVL[V].legIntPurposes[P] && !GVL[V].flexiblePurposes[P] &&
-      d.purpose.legitimateInterests[P] &&
-      d.vendor.legitimateInterests[V]
-    ) {
-      return true;
-    }
-  } catch (e) {}
-
-  // vendor claims flexible legal basis with legitimate interest as the
-  // default, publisher restriction doesn't require consent, and ((user was
-  // provided notice of the legitimate interest basis for this
-  // purpose + vendor) OR (user consents to purpose + vendor))
-  try {
-    if (
-      GVL[V].legIntPurposes[P] && GVL[V].flexiblePurposes[P] &&
-      (
-        (d.purpose.legitimateInterests[P] && d.vendor.legitimateInterests[V]) ||
-        (d.purpose.consents[P] && d.vendor.consents[V])
-      )
-    ) {
-      return true;
-    }
-  } catch (e) {}
-
-  // vendor claims flexible legal basis with legitimate interest as the
-  // default, publisher restriction does require consent, and user consents
-  // to purpose + vendor
-  try {
-    if (
-      GVL[V].legIntPurposes[P] && GVL[V].flexiblePurposes[P] &&
-      d.purpose.consents[P] &&
-      d.vendor.consents[V]
-    ) {
-      return true;
-    }
-  } catch (e) {}
-
-  // vendor claims flexible legal basis with consent as the default,
-  // publisher restriction doesn't require legitimate interest, and ((user
-  // was provided notice of the legitimate interest basis for this purpose +
-  // vendor) OR (user consents to purpose + vendor))
-  try {
-    if (
-      GVL[V].purposes[P] && GVL[V].flexiblePurposes[P] &&
-      (
-        (d.purpose.legitimateInterests[P] && d.vendor.legitimateInterests[V]) ||
-        (d.purpose.consents[P] && d.vendor.consents[V])
-      )
-    ) {
-      return true;
-    }
-  } catch (e) {}
-
-  // vendor claims flexible legal basis with consent as the default,
-  // publisher restriction does require legitimate interest, and user was
-  // provided notice for the legitimate interest basis for this purpose +
-  // vendor
-  try {
-    if (
-      GVL[V].purposes[P] && GVL[V].flexiblePurposes[P] &&
-      d.purpose.legitimateInterests[P] &&
-      d.vendor.legitimateInterests[V]
-    ) {
-      return true;
-    }
-  } catch (e) {}
-
-  return false;
-}
-
-registerBidder(spec);

package/modules/inskinBidAdapter.md

@@ -1,31 +0,0 @@
-# Overview
-
-Module Name: Inskin Bid Adapter
-
-Module Type: Bid Adapter
-
-Maintainer: tech@inskinmedia.com
-
-# Description
-
-Connects to Inskin Media for receiving bids from configured demand sources.
-
-# Test Parameters
-```javascript
-    var adUnits = [
-        {
-            code: 'test-ad-1',
-            sizes: [[300, 250]],
-            bids: [
-                {
-                    bidder: 'inskin',
-                    params: {
-                        networkId: '9874',
-                        siteId: '983808',
-                        publisherId: '123456'
-                    }
-                }
-            ]
-        }
-    ];
-```