prebid.js 7.53.0 → 8.0.0

package/modules/mass.md

@@ -1,137 +0,0 @@
-## Overview
-
-This module enables the MASS protocol for Prebid. To use it, you'll need to
-work with a MASS enabled provider.
-
-This module scans incoming bids for the presence of a "mass" flag being set to 
-true in the bid meta or a publisher specified DealID pattern and uses 
-external resources to decypher and process the MASS:// URI found within the ad markup.
-This modules is designed to work with MASS enabled Exchanges and DSP's.
-
-This module only loads external JavaScript resources if the publisher ad server has 
-selected a MASS enabled bid as a winner. 
-
-Find out more [here](https://massplatform.net).
-
-{: .alert.alert-warning :}
-## Disclosure
-
-This module loads external JavaScript to render creatives
-
-## Custom Mode
-
-You can specify your own `dealIdPattern` and `renderUrl` by adding one or more entries into the `custom` configuration option (see [Configuration Parameters](#configuration-parameters) below). When specifying a custom renderer, quality assurance is your responsibility.
-
-## Integration
-
-Build the MASS module into the Prebid.js package with:
-
-```
-gulp build --modules=mass,...
-```
-
-
-## Module Configuration
-
-```js
-pbjs.que.push(function() {
-  pbjs.setConfig({
-    mass: {
-      enabled: true,
-      renderUrl: 'https://cdn.massplatform.net/bootloader.js',
-      dealIdPattern: /^MASS/i,
-      custom: [
-        {
-          dealIdPattern: /xyz/,
-          renderUrl: 'https://my.domain.com/render.js',
-          namespace: 'xyz'
-        }
-      ]
-    }
-  });
-});
-```
-
-### Configuration Parameters
-
-|Name |Type |Description |Notes |
-| :------------ | :------------ | :------------ |:------------ |
-|enabled | Boolean |Enable/disable the module |Defaults to `true` |
-|dealIdPattern | RegExp |The pattern used to identify MASS deal IDs |Defaults to `/^MASS/i` |
-|renderUrl | String |The MASS render script to load |`https://cdn.massplatform.net/bootloader.js` |
-|custom | Array |Add custom renderers | |
-|custom[].dealIdPattern | RegExp |A pattern used to identify matching deal IDs |Either this parameter or `custom[].match` must be specified |
-|custom[].renderUrl | String |The render script to load |Either this parameter or `custom[].render` must be specified |
-|custom[].namespace | String |The namespace (i.e.: object) created on `window` to pass parameters to the render script |Required with `custom[].renderUrl` |
-|custom[].match | Function(bid) |A custom function to identify matching bids |Either this parameter or `custom[].dealIdPattern` must be specified |
-|custom[].render | Function(payload) |A custom function to render the matchig/winning bid |Either this parameter or `custom[].renderUrl` must be specified. The `payload` parameter contains: `payload.bid`, `payload.bidRequest`, `payload.adm` |
-
-### Example Configurations
-
-### Only (official) MASS support enabled
-
-```js
-pbjs.que.push(function() {
-  pbjs.setConfig({
-    mass: {
-      renderUrl: 'https://cdn.massplatform.net/bootloader.js'
-    }
-  });
-});
-```
-
-### MASS support disabled, custom renderer enabled
-
-```js
-pbjs.que.push(function() {
-  pbjs.setConfig({
-    mass: {
-      custom: [
-        {
-          dealIdPattern: /xyz/,
-          renderUrl: 'https://my.domain.com/render.js',
-          namespace: 'xyz'
-        }
-      ]
-    }
-  });
-});
-```
-
-### Custom `match` and `render`
-
-```js
-pbjs.que.push(function() {
-  pbjs.setConfig({
-    mass: {
-      custom: [
-        {
-          match: function(bid) {
-            // return true/false if matching/non-matching bid
-          },
-
-          render: function(payload) {
-            console.log(payload);
-          }
-        }
-      ]
-    }
-  });
-});
-```
-
-## Integration Example
-
-To view the integration example:
- 
-1) in your cli run:
-
-```
-gulp serve --modules=ixBidAdapter,mass
-```
-
-2) in your browser, navigate to:
-
-```
-http://localhost:9999/integrationExamples/mass/index.html
-```

package/modules/openxAnalyticsAdapter.js

@@ -1,27 +0,0 @@
-import {
-  logWarn
-} from '../src/utils.js';
-import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
-import adapterManager from '../src/adapterManager.js';
-
-let openxAdapter = Object.assign(adapter({ urlParam: '', analyticsType: 'endpoint' }));
-
-openxAdapter.originEnableAnalytics = openxAdapter.enableAnalytics;
-
-openxAdapter.enableAnalytics = function(adapterConfig = {options: {}}) {
-  logWarn('OpenX Analytics has been deprecated, this adapter will be removed in Prebid 8');
-
-  openxAdapter.track = prebidAnalyticsEventHandler;
-
-  openxAdapter.originEnableAnalytics(adapterConfig);
-};
-
-adapterManager.registerAnalyticsAdapter({
-  adapter: openxAdapter,
-  code: 'openx'
-});
-
-export default openxAdapter;
-
-function prebidAnalyticsEventHandler({eventType, args}) {
-}

package/modules/openxAnalyticsAdapter.md

@@ -1,135 +0,0 @@
-
-# OpenX Analytics Adapter to Prebid.js
-## Implementation Guide
-#### Internal use only
-
----
-
-# NOTE: OPENX NO LONGER OFFERS ANALYTICS
-# THIS ADAPTER NO LONGER FUNCTIONS AND 
-# WILL BE REMOVED IN PREBID 8
-
-# About this Guide
-This implementation guide walks through the flow of onboarding an alpha Publisher to test OpenX’s new Analytics Adapter.
-
-- [Adding OpenX Analytics Adapter to Prebid.js](#adding-openx-analytics-adapter-to-prebidjs)
-  - [Publisher Builds Prebid.js File Flow](#publisher-builds-prebidjs-file-flow)
-  - [OpenX Builds Prebid.js File Flow](#openx-builds-prebidjs-file-flow)
-- [Website Configuration](#website-configuration)
-- [Configuration Options](#configuration-options)
-- [Viewing Data](#viewing-data)
-
----
-
-# Adding OpenX Analytics Adapter to Prebid.js
-A Publisher has two options to add the OpenX Analytics Adapter to Prebid.js:
-
-1. [Publisher builds the Prebid.js file](#publisher-builds-prebid.js-file-flow): If the Publisher is familiar with building Prebid.js (through the command line and not through the download site), OpenX can provide to the Publisher only the Analytics Adapter code.
-
-2. [OpenX builds the Prebid.js file](#openx-builds-prebid.js-file-flow): If the Publisher is unfamiliar with building Prebid.js, the Publisher should advise OpenX which modules to include by going to the [Prebid download site](http://prebid.org/download.html) and selecting all the desired items (adapters and modules) for OpenX.
-
----
-
-## Publisher Builds Prebid.js File Flow
-Use this option if the Publisher is building the Prebid.js file.
-
-1. OpenX sends Publisher the new Analytics Adapter code.
-
-2. Publisher replaces the file in `<path_to_prebid.js_folder>/modules/openxAnalyticsAdapter.js` with the file provided by OpenX.
-
-3. Publisher runs the build command in `<path_to_prebid.js_folder>` and includes `openxAnalyticsAdapter` as one of the modules to include.
-
-    For example:
-
-    ```shell
-    gulp build --modules=openxBidAdapter,rubiconBidAdapter,sovrnBidAdapter,openxBidAdapter,openxAnalyticsAdapter,dfpAdServerVideo
-    ```
-
-4. Publisher deploys the Prebid.js file from `<path_to_prebid.js_folder>/build/dist/prebid.js` to a website.
-
----
-
-## OpenX Builds Prebid.js File Flow
-Use this option if OpenX is building the Prebid.js file on behalf of the Publisher.
-
-1. Publisher refers to the [Prebid download site](http://prebid.org/download.html) and sends a list of adapters and modules to OpenX.
-
-    >Note: The Publisher must be aware that only Prebid 3.0+ is supported.
-
-    For example (does not have to follow exact format):
-
-    ```yaml
-    Prebid Version: 3.10+
-    Modules:
-      Bidders
-        OpenX
-        Rubicon
-        Sovrn
-      Consent Management
-        US Privacy
-      User ID
-        IdentityLink ID
-      DFP Video
-      Supply Chain Object
-      Currency
-    ```
-
-2. OpenX uses the information to build a package to the user’s specification and includes `openxAnalyticsAdapter` as an additional module.
-
-3. OpenX sends the built package to the Publisher.
-
-4. Publisher deploys the modified Prebid.js to a website.
-
----
-
-# Website Configuration
-To configure your website, add the following code snippet to your website:
-
-```javascript
-pbjs.que.push(function () {
-  pbjs.enableAnalytics([{
-    provider: "openx",
-    options: {
-        publisherPlatformId: "OPENX_PROVIDED_PLATFORM_ID", // eg: "a3aece0c-9e80-4316-8deb-faf804779bd1"
-        publisherAccountId: PUBLISHER_ACCOUNT_ID, // eg: 537143056
-        sampling: 0.05, // 5% sample rate
-        testCode: 'test-code-1'
-    }
-  }]);
-});
-```
-
----
-
-## Configuration Options
-Configuration options are a follows:
-
-| Property | Type | Required? | Description | Example |
-|:---|:---|:---|:---|:---|
-| `orgId` | `string` | Yes | Used to determine ownership of data. | `aa1bb2cc-3dd4-4316-8deb-faf804779bd1` |
-| `publisherPlatformId` | `string` | No <br> **__Deprecated.  Please use orgId__** | Used to determine ownership of data. | `a3aece0c-9e80-4316-8deb-faf804779bd1` |
-| `publisherAccountId` | `number` | No <br> **__Deprecated.  Please use orgId__** | Used to determine ownership of data. | `1537143056` |
-| `sampling` | `number` | Yes | Sampling rate | Undefined or `1.00` - No sampling. Analytics is sent all the time.<br>0.5 - 50% of users will send analytics data. |
-| `testCode` | `string` | No | Used to label analytics data for the purposes of tests.<br>This label is treated as a dimension and can be compared against other labels. | `timeout_config_1`<br>`timeout_config_2`<br>`timeout_default` |
-| `campaign` | `Object` | No | Object with 5 parameters: <ul><li>content</li><li>medium</li><li>name</li><li>source</li><li>term</li></ul> Each parameter is a free-form string. Refer to metrics doc on when to use these fields.  By setting a value to one of these properties, you override the associated url utm query parameter. | |
-| `payloadWaitTime` | `number` | No | Delay after all slots of an auction renders before the payload is sent. <br> Defaults to 100ms | 1000 |
----
-
-# Viewing Data
-The Prebid Report available in the Reporting in the Cloud tool, allows you to view your data.
-
-**To view your data:**
-
-1. Log in to [OpenX Reporting](https://openx.sigmoid.io/app).
-
-2. In the top right, click on the **View** list and then select **Prebidreport**.
-
-3. On the left icon bar, click on the dimensions icon.
-
-4. Add the dimensions that you need.
-
-5. On the left icon bar, click on the metrics icon.
-
-6. Add the metrics (graphs) that you need.
-
-   The data appears on the Analyze screen.

package/modules/openxOrtbBidAdapter.js

@@ -1,238 +0,0 @@
-import {config} from '../src/config.js';
-import {registerBidder} from '../src/adapters/bidderFactory.js';
-import * as utils from '../src/utils.js';
-import {mergeDeep} from '../src/utils.js';
-import {BANNER, VIDEO} from '../src/mediaTypes.js';
-import {ortbConverter} from '../libraries/ortbConverter/converter.js';
-
-const bidderConfig = 'hb_pb_ortb';
-const bidderVersion = '1.0';
-export const REQUEST_URL = 'https://rtb.openx.net/openrtbb/prebidjs';
-export const SYNC_URL = 'https://u.openx.net/w/1.0/pd';
-export const DEFAULT_PH = '2d1251ae-7f3a-47cf-bd2a-2f288854a0ba';
-export const spec = {
-  code: 'openx',
-  supportedMediaTypes: [BANNER, VIDEO],
-  isBidRequestValid,
-  buildRequests,
-  interpretResponse,
-  getUserSyncs,
-  transformBidParams
-};
-
-registerBidder(spec);
-
-const converter = ortbConverter({
-  context: {
-    netRevenue: true,
-    ttl: 300
-  },
-  imp(buildImp, bidRequest, context) {
-    const imp = buildImp(bidRequest, context);
-    mergeDeep(imp, {
-      tagid: bidRequest.params.unit,
-      ext: {
-        divid: bidRequest.adUnitCode
-      }
-    });
-    if (bidRequest.params.customParams) {
-      utils.deepSetValue(imp, 'ext.customParams', bidRequest.params.customParams);
-    }
-    if (bidRequest.params.customFloor && !imp.bidfloor) {
-      imp.bidfloor = bidRequest.params.customFloor;
-    }
-    return imp;
-  },
-  request(buildRequest, imps, bidderRequest, context) {
-    const req = buildRequest(imps, bidderRequest, context);
-    mergeDeep(req, {
-      at: 1,
-      ext: {
-        bc: `${bidderConfig}_${bidderVersion}`
-      }
-    })
-    const bid = context.bidRequests[0];
-    if (bid.params.coppa) {
-      utils.deepSetValue(req, 'regs.coppa', 1);
-    }
-    if (bid.params.doNotTrack) {
-      utils.deepSetValue(req, 'device.dnt', 1);
-    }
-    if (bid.params.platform) {
-      utils.deepSetValue(req, 'ext.platform', bid.params.platform);
-    }
-    if (bid.params.delDomain) {
-      utils.deepSetValue(req, 'ext.delDomain', bid.params.delDomain);
-    }
-    if (bid.params.response_template_name) {
-      utils.deepSetValue(req, 'ext.response_template_name', bid.params.response_template_name);
-    }
-    if (bid.params.test) {
-      req.test = 1
-    }
-    return req;
-  },
-  bidResponse(buildBidResponse, bid, context) {
-    const bidResponse = buildBidResponse(bid, context);
-    if (bid.ext) {
-      bidResponse.meta.networkId = bid.ext.dsp_id;
-      bidResponse.meta.advertiserId = bid.ext.buyer_id;
-      bidResponse.meta.brandId = bid.ext.brand_id;
-    }
-    const {ortbResponse} = context;
-    if (ortbResponse.ext && ortbResponse.ext.paf) {
-      bidResponse.meta.paf = Object.assign({}, ortbResponse.ext.paf);
-      bidResponse.meta.paf.content_id = utils.deepAccess(bid, 'ext.paf.content_id');
-    }
-    return bidResponse;
-  },
-  response(buildResponse, bidResponses, ortbResponse, context) {
-    // pass these from request to the responses for use in userSync
-    const {ortbRequest} = context;
-    if (ortbRequest.ext) {
-      if (ortbRequest.ext.delDomain) {
-        utils.deepSetValue(ortbResponse, 'ext.delDomain', ortbRequest.ext.delDomain);
-      }
-      if (ortbRequest.ext.platform) {
-        utils.deepSetValue(ortbResponse, 'ext.platform', ortbRequest.ext.platform);
-      }
-    }
-    const response = buildResponse(bidResponses, ortbResponse, context);
-    // TODO: we may want to standardize this and move fledge logic to ortbConverter
-    let fledgeAuctionConfigs = utils.deepAccess(ortbResponse, 'ext.fledge_auction_configs');
-    if (fledgeAuctionConfigs) {
-      fledgeAuctionConfigs = Object.entries(fledgeAuctionConfigs).map(([bidId, cfg]) => {
-        return {
-          bidId,
-          config: Object.assign({
-            auctionSignals: {},
-          }, cfg)
-        }
-      });
-      return {
-        bids: response.bids,
-        fledgeAuctionConfigs,
-      }
-    } else {
-      return response.bids
-    }
-  },
-  overrides: {
-    imp: {
-      bidfloor(setBidFloor, imp, bidRequest, context) {
-        // enforce floors should always be in USD
-        // TODO: does it make sense that request.cur can be any currency, but request.imp[].bidfloorcur must be USD?
-        const floor = {};
-        setBidFloor(floor, bidRequest, {...context, currency: 'USD'});
-        if (floor.bidfloorcur === 'USD') {
-          Object.assign(imp, floor);
-        }
-      },
-      video(orig, imp, bidRequest, context) {
-        if (FEATURES.VIDEO) {
-          // `orig` is the video imp processor, which looks at bidRequest.mediaTypes[VIDEO]
-          // to populate imp.video
-          // alter its input `bidRequest` to also pick up parameters from `bidRequest.params`
-          let videoParams = bidRequest.mediaTypes[VIDEO];
-          if (videoParams) {
-            videoParams = Object.assign({}, videoParams, bidRequest.params.video);
-            bidRequest = {...bidRequest, mediaTypes: {[VIDEO]: videoParams}}
-          }
-          orig(imp, bidRequest, context);
-          if (imp.video && videoParams?.context === 'outstream') {
-            imp.video.placement = imp.video.placement || 4;
-          }
-        }
-      }
-    }
-  }
-});
-
-function transformBidParams(params, isOpenRtb) {
-  return utils.convertTypes({
-    'unit': 'string',
-    'customFloor': 'number'
-  }, params);
-}
-
-function isBidRequestValid(bidRequest) {
-  const hasDelDomainOrPlatform = bidRequest.params.delDomain ||
-    bidRequest.params.platform;
-
-  if (utils.deepAccess(bidRequest, 'mediaTypes.banner') &&
-    hasDelDomainOrPlatform) {
-    return !!bidRequest.params.unit ||
-      utils.deepAccess(bidRequest, 'mediaTypes.banner.sizes.length') > 0;
-  }
-
-  return !!(bidRequest.params.unit && hasDelDomainOrPlatform);
-}
-
-function buildRequests(bids, bidderRequest) {
-  let videoBids = bids.filter(bid => isVideoBid(bid));
-  let bannerBids = bids.filter(bid => isBannerBid(bid));
-  let requests = bannerBids.length ? [createRequest(bannerBids, bidderRequest, BANNER)] : [];
-  videoBids.forEach(bid => {
-    requests.push(createRequest([bid], bidderRequest, VIDEO));
-  });
-  return requests;
-}
-
-function createRequest(bidRequests, bidderRequest, mediaType) {
-  return {
-    method: 'POST',
-    url: config.getConfig('openxOrtbUrl') || REQUEST_URL,
-    data: converter.toORTB({bidRequests, bidderRequest, context: {mediaType}})
-  }
-}
-
-function isVideoBid(bid) {
-  return utils.deepAccess(bid, 'mediaTypes.video');
-}
-
-function isBannerBid(bid) {
-  return utils.deepAccess(bid, 'mediaTypes.banner') || !isVideoBid(bid);
-}
-
-function interpretResponse(resp, req) {
-  if (!resp.body) {
-    resp.body = {nbr: 0};
-  }
-  return converter.fromORTB({request: req.data, response: resp.body});
-}
-
-/**
- * @param syncOptions
- * @param responses
- * @param gdprConsent
- * @param uspConsent
- * @return {{type: (string), url: (*|string)}[]}
- */
-function getUserSyncs(syncOptions, responses, gdprConsent, uspConsent) {
-  if (syncOptions.iframeEnabled || syncOptions.pixelEnabled) {
-    let pixelType = syncOptions.iframeEnabled ? 'iframe' : 'image';
-    let queryParamStrings = [];
-    let syncUrl = SYNC_URL;
-    if (gdprConsent) {
-      queryParamStrings.push('gdpr=' + (gdprConsent.gdprApplies ? 1 : 0));
-      queryParamStrings.push('gdpr_consent=' + encodeURIComponent(gdprConsent.consentString || ''));
-    }
-    if (uspConsent) {
-      queryParamStrings.push('us_privacy=' + encodeURIComponent(uspConsent));
-    }
-    if (responses.length > 0 && responses[0].body && responses[0].body.ext) {
-      const ext = responses[0].body.ext;
-      if (ext.delDomain) {
-        syncUrl = `https://${ext.delDomain}/w/1.0/pd`
-      } else if (ext.platform) {
-        queryParamStrings.push('ph=' + ext.platform)
-      }
-    } else {
-      queryParamStrings.push('ph=' + DEFAULT_PH)
-    }
-    return [{
-      type: pixelType,
-      url: `${syncUrl}${queryParamStrings.length > 0 ? '?' + queryParamStrings.join('&') : ''}`
-    }];
-  }
-}

package/modules/openxOrtbBidAdapter.md

@@ -1,108 +0,0 @@
-# Overview
-
-```
-Module Name: OpenX Bidder Adapter
-Module Type: Bidder Adapter
-Maintainer: team-openx@openx.com
-```
-
-# Description
-DEPRECATED. Use openxBidAdapter.
-
-This adapter was originally an adapter used to test OpenX serving architecture changes.
-This adapter now mirrors openxBidAdapter and this adapter will be removed in a future release. Please use openxBidAdapter.
-Please note you should only include either openxBidAdapter or openxOrtbBidAdapter in your build.
-
-# Bid Parameters
-## Banner
-
-| Name | Scope | Type | Description | Example
-| ---- | ----- | ---- | ----------- | -------
-| `delDomain` or `platform` | required | String | OpenX delivery domain or platform id provided by your OpenX representative.  | "PUBLISHER-d.openx.net" or "555not5a-real-plat-form-id0123456789"
-| `unit` | required | String | OpenX ad unit ID provided by your OpenX representative. | "1611023122"
-| `customParams` | optional | Object | User-defined targeting key-value pairs. customParams applies to a specific unit. | `{key1: "v1", key2: ["v2","v3"]}`
-| `customFloor` | optional | Number | Minimum price in USD. customFloor applies to a specific unit. For example, use the following value to set a $1.50 floor: 1.50 <br/><br/> **WARNING:**<br/> Misuse of this parameter can impact revenue | 1.50
-| `doNotTrack` | optional | Boolean | Prevents advertiser from using data for this user. <br/><br/> **WARNING:**<br/> Request-level setting.  May impact revenue. | true
-| `coppa` | optional | Boolean | Enables Child's Online Privacy Protection Act (COPPA) regulations. Use of `pbjs.setConfig({coppa: true});` is now preferred. | true
-
-## Video
-
-| Name | Scope | Type | Description | Example
-| ---- | ----- | ---- | ----------- | -------
-| `unit` | required | String | OpenX ad unit ID provided by your OpenX representative. | "1611023122"
-| `delDomain` | required | String |  OpenX delivery domain provided by your OpenX representative.  | "PUBLISHER-d.openx.net"
-| `video` | optional | OpenRTB video subtypes | Use of adUnit.mediaTypes.video is now preferred. | `{ video: {mimes: ['video/mp4']}`
-
-
-# Example
-```javascript
-var adUnits = [
-  {
-    code: 'test-div',
-    sizes: [[728, 90]],  // a display size
-    mediaTypes: {'banner': {}},
-    bids: [
-      {
-        bidder: 'openx',
-        params: {
-          unit: '539439964',
-          delDomain: 'se-demo-d.openx.net',
-          customParams: {
-            key1: 'v1',
-            key2: ['v2', 'v3']
-          },
-        }
-      }, {
-         bidder: 'openx',
-         params: {
-           unit: '539439964',
-           platform: 'a3aece0c-9e80-4316-8deb-faf804779bd1',
-           customParams: {
-             key1: 'v1',
-             key2: ['v2', 'v3']
-           },
-         }
-       }
-    ]
-  },
-  {
-    code: 'video1',
-    mediaTypes: {
-      video: {
-        playerSize: [640, 480],
-        context: 'instream',
-        mimes: ['video/x-ms-wmv, video/mp4']
-      }
-    },
-    bids: [{
-      bidder: 'openx',
-      params: {
-        unit: '1611023124',
-        delDomain: 'PUBLISHER-d.openx.net',
-        video: {
-          mimes: ['video/x-ms-wmv, video/mp4'] // mediaTypes.video preferred
-        }
-      }
-    }]p
-  }
-];
-```
-
-# Configuration
-Add the following code to enable user syncing. By default, Prebid.js version 0.34.0+ turns off user syncing through iframes.
-OpenX strongly recommends enabling user syncing through iframes. This functionality improves DSP user match rates and increases the
-OpenX bid rate and bid price. Be sure to call `pbjs.setConfig()` only once.
-
-```javascript
-pbjs.setConfig({
-   userSync: {
-      iframeEnabled: true
-   }
-});
-```
-
-# Additional Details
-[Banner Ads](https://docs.openx.com/publishers/prebid-adapter-web/)
-
-[Video Ads](https://docs.openx.com/publishers/prebid-adapter-video/)
-