prebid.js 6.6.0 → 6.10.0

package/modules/hadronRtdProvider.md

@@ -0,0 +1,126 @@
+## Audigent Hadron Real-time Data Submodule
+
+Audigent is a next-generation, 1st party data management platform and the
+world’s first "data agency", powering the programmatic landscape and DTC
+eCommerce with actionable 1st party audience and contextual data from the
+world’s most influential retailers, lifestyle publishers, content creators,
+athletes and artists.
+
+The Hadron real-time data module in Prebid has been built so that publishers
+can maximize the power of their first-party audiences and contextual data.
+This module provides both an integrated cookieless Hadron identity with real-time
+contextual and audience segmentation solution that seamlessly and easily
+integrates into your existing Prebid deployment.
+
+Users, devices, content, cohorts and other features are identified and utilized
+to augment every bid request with targeted, 1st party data-derived segments
+before being submitted to supply-side platforms. Enriching the bid request with
+robust 1st party audience and contextual data, Audigent's Hadron RTD module
+optimizes targeting, increases the number of bids, increases bid value,
+and drives additional incremental revenue for publishers.
+
+### Publisher Usage
+
+Compile the Hadron RTD module into your Prebid build:
+
+`gulp build --modules=userId,unifiedIdSystem,rtdModule,hadronRtdProvider,appnexusBidAdapter`
+
+Add the Hadron RTD provider to your Prebid config. In this example we will configure
+publisher 1234 to retrieve segments from Audigent. See the
+"Parameter Descriptions" below for more detailed information of the
+configuration parameters. Please work with your Audigent Prebid support team
+(prebid@audigent.com) on which version of Prebid.js supports different bidder
+and segment configurations.
+
+```
+pbjs.setConfig(
+    ...
+    realTimeData: {
+        auctionDelay: 5000,
+        dataProviders: [
+            {
+                name: "hadron",
+                waitForIt: true,
+                params: {
+                    segmentCache: false,
+                    requestParams: {
+                        publisherId: 1234
+                    }
+                }
+            }
+        ]
+    }
+    ...
+}
+```
+
+### Parameter Descriptions for the Hadron Configuration Section
+
+| Name  |Type | Description   | Notes  |
+| :------------ | :------------ | :------------ |:------------ |
+| name | String | Real time data module name | Always 'hadron' |
+| waitForIt | Boolean | Required to ensure that the auction is delayed until prefetch is complete | Optional. Defaults to false |
+| params | Object | | |
+| params.handleRtd | Function | A passable RTD handler that allows custom adunit and ortb2 logic to be configured. The function signature is (bidConfig, rtd, rtdConfig, pbConfig) => {}. | Optional |
+| params.segmentCache | Boolean | This parameter tells the Hadron RTD module to attempt reading segments from a local storage cache instead of always requesting them from the Audigent server. | Optional. Defaults to false. |
+| params.requestParams | Object | Publisher partner specific configuration options, such as optional publisher id and other segment query related metadata to be submitted to Audigent's backend with each request.  Contact prebid@audigent.com for more information. | Optional |
+| params.hadronIdUrl | String | Parameter to specify alternate hadronid endpoint url. | Optional |
+
+### Publisher Customized RTD Handling
+As indicated above, it is possible to provide your own bid augmentation
+functions rather than simply merging supplied data.  This is useful if you
+want to perform custom bid augmentation and logic with Hadron real-time data
+prior to the bid request being sent. Simply add your custom logic to the
+optional handleRtd parameter and provide your custom RTD handling logic there.
+
+Please see the following example, which provides a function to modify bids for
+a bid adapter called adBuzz and perform custom logic on bidder parameters.
+
+```
+pbjs.setConfig(
+    ...
+    realTimeData: {
+        auctionDelay: auctionDelay,
+        dataProviders: [
+            {
+                name: "hadron",
+                waitForIt: true,
+                params: {
+                    handleRtd: function(bidConfig, rtd, rtdConfig, pbConfig) {
+                        var adUnits = bidConfig.adUnits;
+                        for (var i = 0; i < adUnits.length; i++) {
+                            var adUnit = adUnits[i];
+                            for (var j = 0; j < adUnit.bids.length; j++) {
+                                var bid = adUnit.bids[j];
+                                if (bid.bidder == 'adBuzz' && rtd['adBuzz'][0].value != 'excludeSeg') {
+                                    bid.params.adBuzzCustomSegments.push(rtd['adBuzz'][0].id);
+                                }
+                            }
+                        }
+                    },
+                    segmentCache: false,
+                    requestParams: {
+                        publisherId: 1234
+                    }
+                }
+            }
+        ]
+    }
+    ...
+}
+```
+
+The handleRtd function can also be used to configure custom ortb2 data
+processing. Please see the examples available in the hadronRtdProvider_spec.js
+tests and work with your Audigent Prebid integration team (prebid@audigent.com)
+on how to best configure your own Hadron RTD & Open RTB data handlers.
+
+### Testing
+
+To view an example of available segments returned by Audigent's backends:
+
+`gulp serve --modules=userId,unifiedIdSystem,rtdModule,hadronRtdProvider,appnexusBidAdapter`
+
+and then point your browser at:
+
+`http://localhost:9999/integrationExamples/gpt/hadronRtdProvider_example.html`

package/modules/haloIdSystem.md

@@ -1,35 +1,4 @@
-## Audigent Halo User ID Submodule
-
-Audigent Halo ID Module. For assistance setting up your module please contact us at [prebid@audigent.com](prebid@audigent.com).
-
-### Prebid Params
-
-Individual params may be set for the Audigent Halo ID Submodule. At least one identifier must be set in the params.
-
-```
-pbjs.setConfig({
-    usersync: {
-        userIds: [{
-            name: 'haloId',
-            storage: {
-                name: 'haloId',
-                type: 'html5'
-            }
-        }]
-    }
-});
-```
-## Parameter Descriptions for the `usersync` Configuration Section
-The below parameters apply only to the HaloID User ID Module integration.
-
-| Param under usersync.userIds[] | Scope | Type | Description | Example |
-| --- | --- | --- | --- | --- |
-| name | Required | String | ID value for the HaloID module - `"haloId"` | `"haloId"` |
-| storage | Required | Object | The publisher must specify the local storage in which to store the results of the call to get the user ID. This can be either cookie or HTML5 storage. | |
-| storage.type | Required | String | This is where the results of the user ID will be stored. The recommended method is `localStorage` by specifying `html5`. | `"html5"` |
-| storage.name | Required | String | The name of the cookie or html5 local storage where the user ID will be stored. | `"haloid"` |
-| storage.expires | Optional | Integer | How long (in days) the user ID information will be stored. | `365` |
-| value | Optional | Object | Used only if the page has a separate mechanism for storing the Halo ID. The value is an object containing the values to be sent to the adapters. In this scenario, no URL is called and nothing is added to local storage | `{"haloId": "eb33b0cb-8d35-4722-b9c0-1a31d4064888"}` |
-| params | Optional | Object | Used to store params for the id system |
-| params.url | Optional | String | Set an alternate GET url for HaloId with this parameter |
-| params.urlArg | Optional | Object | Optional url parameter for params.url |
+## Audigent Halo has been rebranded as Hadron
+## Use the Hadron Id Submodule
+## The Halo modules will be removed from Prebid 7
+## Contact prebid@audigent.com for more info.

package/modules/haloRtdProvider.md

@@ -1,126 +1,3 @@
-## Audigent Halo Real-time Data Submodule
-
-Audigent is a next-generation, 1st party data management platform and the
-world’s first "data agency", powering the programmatic landscape and DTC
-eCommerce with actionable 1st party audience and contextual data from the
-world’s most influential retailers, lifestyle publishers, content creators,
-athletes and artists.
-
-The Halo real-time data module in Prebid has been built so that publishers
-can maximize the power of their first-party audiences and contextual data.
-This module provides both an integrated cookieless Halo identity with real-time
-contextual and audience segmentation solution that seamlessly and easily
-integrates into your existing Prebid deployment.
-
-Users, devices, content, cohorts and other features are identified and utilized
-to augment every bid request with targeted, 1st party data-derived segments
-before being submitted to supply-side platforms. Enriching the bid request with
-robust 1st party audience and contextual data, Audigent's Halo RTD module
-optimizes targeting, increases the number of bids, increases bid value,
-and drives additional incremental revenue for publishers.
-
-### Publisher Usage
-
-Compile the Halo RTD module into your Prebid build:
-
-`gulp build --modules=userId,unifiedIdSystem,rtdModule,haloRtdProvider,appnexusBidAdapter`
-
-Add the Halo RTD provider to your Prebid config. In this example we will configure
-publisher 1234 to retrieve segments from Audigent. See the
-"Parameter Descriptions" below for more detailed information of the
-configuration parameters. Please work with your Audigent Prebid support team
-(prebid@audigent.com) on which version of Prebid.js supports different bidder
-and segment configurations.
-
-```
-pbjs.setConfig(
-    ...
-    realTimeData: {
-        auctionDelay: 5000,
-        dataProviders: [
-            {
-                name: "halo",
-                waitForIt: true,
-                params: {
-                    segmentCache: false,
-                    requestParams: {
-                        publisherId: 1234
-                    }
-                }
-            }
-        ]
-    }
-    ...
-}
-```
-
-### Parameter Descriptions for the Halo Configuration Section
-
-| Name  |Type | Description   | Notes  |
-| :------------ | :------------ | :------------ |:------------ |
-| name | String | Real time data module name | Always 'halo' |
-| waitForIt | Boolean | Required to ensure that the auction is delayed until prefetch is complete | Optional. Defaults to false |
-| params | Object | | |
-| params.handleRtd | Function | A passable RTD handler that allows custom adunit and ortb2 logic to be configured. The function signature is (bidConfig, rtd, rtdConfig, pbConfig) => {}. | Optional |
-| params.segmentCache | Boolean | This parameter tells the Halo RTD module to attempt reading segments from a local storage cache instead of always requesting them from the Audigent server. | Optional. Defaults to false. |
-| params.requestParams | Object | Publisher partner specific configuration options, such as optional publisher id and other segment query related metadata to be submitted to Audigent's backend with each request.  Contact prebid@audigent.com for more information. | Optional |
-| params.haloIdUrl | String | Parameter to specify alternate haloid endpoint url. | Optional |
-
-### Publisher Customized RTD Handling
-As indicated above, it is possible to provide your own bid augmentation
-functions rather than simply merging supplied data.  This is useful if you
-want to perform custom bid augmentation and logic with Halo real-time data
-prior to the bid request being sent. Simply add your custom logic to the
-optional handleRtd parameter and provide your custom RTD handling logic there.
-
-Please see the following example, which provides a function to modify bids for
-a bid adapter called adBuzz and perform custom logic on bidder parameters.
-
-```
-pbjs.setConfig(
-    ...
-    realTimeData: {
-        auctionDelay: auctionDelay,
-        dataProviders: [
-            {
-                name: "halo",
-                waitForIt: true,
-                params: {
-                    handleRtd: function(bidConfig, rtd, rtdConfig, pbConfig) {
-                        var adUnits = bidConfig.adUnits;
-                        for (var i = 0; i < adUnits.length; i++) {
-                            var adUnit = adUnits[i];
-                            for (var j = 0; j < adUnit.bids.length; j++) {
-                                var bid = adUnit.bids[j];
-                                if (bid.bidder == 'adBuzz' && rtd['adBuzz'][0].value != 'excludeSeg') {
-                                    bid.params.adBuzzCustomSegments.push(rtd['adBuzz'][0].id);
-                                }
-                            }
-                        }
-                    },
-                    segmentCache: false,
-                    requestParams: {
-                        publisherId: 1234
-                    }
-                }
-            }
-        ]
-    }
-    ...
-}
-```
-
-The handleRtd function can also be used to configure custom ortb2 data
-processing. Please see the examples available in the haloRtdProvider_spec.js
-tests and work with your Audigent Prebid integration team (prebid@audigent.com)
-on how to best configure your own Halo RTD & Open RTB data handlers.
-
-### Testing
-
-To view an example of available segments returned by Audigent's backends:
-
-`gulp serve --modules=userId,unifiedIdSystem,rtdModule,haloRtdProvider,appnexusBidAdapter`
-
-and then point your browser at:
-
-`http://localhost:9999/integrationExamples/gpt/haloRtdProvider_example.html`
+## Audigent Halo has been rebranded as Hadron
+## Use the Hadron Rtd Submodule
+## The Halo modules will be removed from Prebid 7

package/modules/hybridBidAdapter.js

@@ -3,7 +3,7 @@ import { registerBidder } from '../src/adapters/bidderFactory.js'
 import { auctionManager } from '../src/auctionManager.js'
 import { BANNER, VIDEO } from '../src/mediaTypes.js'
 import {Renderer} from '../src/Renderer.js';
-import find from 'core-js-pure/features/array/find.js';
+import find from 'prebidjs-polyfill/find.js';
 
 const BIDDER_CODE = 'hybrid';
 const DSP_ENDPOINT = 'https://hbe198.hybrid.ai/prebidhb';

package/modules/improvedigitalBidAdapter.js

@@ -4,7 +4,7 @@ import { config } from '../src/config.js';
 import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
 import {Renderer} from '../src/Renderer.js';
 import { createEidsArray } from './userId/eids.js';
-import includes from 'core-js-pure/features/array/includes.js';
+import includes from 'prebidjs-polyfill/includes.js';
 
 const BIDDER_CODE = 'improvedigital';
 const RENDERER_URL = 'https://acdn.adnxs.com/video/outstream/ANOutstreamVideo.js';
@@ -90,6 +90,7 @@ export const spec = {
     // End of adding first party data
 
     requestParameters.schain = bidRequests[0].schain;
+    requestParameters.coppa = config.getConfig('coppa') === true;
 
     if (bidRequests[0].userId) {
       const eids = createEidsArray(bidRequests[0].userId);
@@ -652,6 +653,10 @@ export function ImproveDigitalAdServerJSClient(endPoint) {
       }
     }
 
+    if (requestParameters.coppa) {
+      impressionBidRequestObject.coppa = 1;
+    }
+
     return impressionBidRequestObject;
   };
 

package/modules/insticatorBidAdapter.js

@@ -7,7 +7,7 @@ import {
   logError,
 } from '../src/utils.js';
 import { getStorageManager } from '../src/storageManager.js';
-import find from 'core-js-pure/features/array/find.js';
+import find from 'prebidjs-polyfill/find.js';
 
 const BIDDER_CODE = 'insticator';
 const ENDPOINT = 'https://ex.ingage.tech/v1/openrtb'; // production endpoint

package/modules/interactiveOffersBidAdapter.js

@@ -83,7 +83,8 @@ function parseRequestPrebidjsToOpenRTB(prebidRequest) {
   let openRTBRequest = JSON.parse(JSON.stringify(DEFAULT['OpenRTBBidRequest']));
   openRTBRequest.id = prebidRequest.auctionId;
   openRTBRequest.ext = {
-    auctionstart: Date.now()
+    refererInfo: prebidRequest.refererInfo,
+    auctionId: prebidRequest.auctionId
   };
 
   openRTBRequest.site = JSON.parse(JSON.stringify(DEFAULT['OpenRTBBidRequestSite']));
@@ -111,15 +112,17 @@ function parseRequestPrebidjsToOpenRTB(prebidRequest) {
   openRTBRequest.user = JSON.parse(JSON.stringify(DEFAULT['OpenRTBBidRequestUser']));
 
   openRTBRequest.imp = [];
-  prebidRequest.bids.forEach(function(bid, impId) {
-    impId++;
+  prebidRequest.bids.forEach(function(bid) {
     if (!ret.partnerId) {
       ret.partnerId = bid.params.partnerId;
     }
     let imp = JSON.parse(JSON.stringify(DEFAULT['OpenRTBBidRequestImp']));
-    imp.id = impId;
+    imp.id = bid.bidId;
     imp.secure = secure;
-    imp.tagid = bid.bidId;
+    imp.tagid = bid.adUnitCode;
+    imp.ext = {
+      rawdata: bid
+    };
 
     openRTBRequest.site.publisher.id = openRTBRequest.site.publisher.id || 0;
     openRTBRequest.tmax = openRTBRequest.tmax || bid.params.tmax || 0;
@@ -152,7 +155,7 @@ function parseResponseOpenRTBToPrebidjs(openRTBResponse) {
         if (seatbid.bid && seatbid.bid.forEach) {
           seatbid.bid.forEach(function(bid) {
             let prebid = JSON.parse(JSON.stringify(DEFAULT['PrebidBid']));
-            prebid.requestId = bid.ext.tagid;
+            prebid.requestId = bid.impid;
             prebid.ad = bid.adm;
             prebid.creativeId = bid.crid;
             prebid.cpm = bid.price;

package/modules/intersectionRtdProvider.js

@@ -2,7 +2,7 @@ import {submodule} from '../src/hook.js';
 import {isFn, logError} from '../src/utils.js';
 import {config} from '../src/config.js';
 import {getGlobal} from '../src/prebidGlobal.js';
-import includes from 'core-js-pure/features/array/includes.js';
+import includes from 'prebidjs-polyfill/includes.js';
 import '../src/adapterManager.js';
 let observerAvailable = true;
 function getIntersectionData(requestBidsObject, onDone, providerConfig, userConsent) {

package/modules/ixBidAdapter.js

@@ -4,10 +4,10 @@ import { config } from '../src/config.js';
 import CONSTANTS from '../src/constants.json';
 import { getStorageManager, validateStorageEnforcement } from '../src/storageManager.js';
 import events from '../src/events.js';
-import find from 'core-js-pure/features/array/find.js';
+import find from 'prebidjs-polyfill/find.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { INSTREAM, OUTSTREAM } from '../src/video.js';
-import includes from 'core-js-pure/features/array/includes.js';
+import includes from 'prebidjs-polyfill/includes.js';
 import { Renderer } from '../src/Renderer.js';
 
 const BIDDER_CODE = 'ix';

package/modules/jwplayerRtdProvider.js

@@ -13,7 +13,7 @@ import { submodule } from '../src/hook.js';
 import { config } from '../src/config.js';
 import { ajaxBuilder } from '../src/ajax.js';
 import { logError } from '../src/utils.js';
-import find from 'core-js-pure/features/array/find.js';
+import find from 'prebidjs-polyfill/find.js';
 import { getGlobal } from '../src/prebidGlobal.js';
 
 const SUBMODULE_NAME = 'jwplayer';
@@ -155,8 +155,10 @@ export function enrichAdUnits(adUnits) {
       if (!vat) {
         return;
       }
+      const contentId = getContentId(vat.mediaID);
+      const contentData = getContentData(vat.segments);
       const targeting = formatTargetingResponse(vat);
-      addTargetingToBids(adUnit.bids, targeting);
+      enrichBids(adUnit.bids, targeting, contentId, contentData);
     };
     loadVat(jwTargeting, onVatResponse);
   });
@@ -235,6 +237,9 @@ export function getVatFromPlayer(playerID, mediaID) {
   };
 }
 
+/*
+  deprecated
+ */
 export function formatTargetingResponse(vat) {
   const { segments, mediaID } = vat;
   const targeting = {};
@@ -243,23 +248,83 @@ export function formatTargetingResponse(vat) {
   }
 
   if (mediaID) {
-    const id = 'jw_' + mediaID;
     targeting.content = {
-      id
+      id: getContentId(mediaID)
     }
   }
   return targeting;
 }
 
-function addTargetingToBids(bids, targeting) {
-  if (!bids || !targeting) {
+export function getContentId(mediaID) {
+  if (!mediaID) {
+    return;
+  }
+
+  return 'jw_' + mediaID;
+}
+
+export function getContentData(segments) {
+  if (!segments || !segments.length) {
+    return;
+  }
+
+  const formattedSegments = segments.reduce((convertedSegments, rawSegment) => {
+    convertedSegments.push({
+      id: rawSegment,
+      value: rawSegment
+    });
+    return convertedSegments;
+  }, []);
+
+  return {
+    name: 'jwplayer',
+    ext: {
+      segtax: 502
+    },
+    segment: formattedSegments
+  };
+}
+
+export function addOrtbSiteContent(bid, contentId, contentData) {
+  if (!contentId && !contentData) {
     return;
   }
 
-  bids.forEach(bid => addTargetingToBid(bid, targeting));
+  let ortb2 = bid.ortb2 || {};
+  let site = ortb2.site = ortb2.site || {};
+  let content = site.content = site.content || {};
+
+  if (contentId) {
+    content.id = contentId;
+  }
+
+  if (contentData) {
+    const data = content.data = content.data || [];
+    data.push(contentData);
+  }
+
+  bid.ortb2 = ortb2;
 }
 
+function enrichBids(bids, targeting, contentId, contentData) {
+  if (!bids) {
+    return;
+  }
+
+  bids.forEach(bid => {
+    addTargetingToBid(bid, targeting);
+    addOrtbSiteContent(bid, contentId, contentData);
+  });
+}
+
+/*
+  deprecated
+ */
 export function addTargetingToBid(bid, targeting) {
+  if (!targeting) {
+    return;
+  }
+
   const rtd = bid.rtd || {};
   const jwRtd = {};
   jwRtd[SUBMODULE_NAME] = Object.assign({}, rtd[SUBMODULE_NAME], { targeting });

package/modules/jwplayerRtdProvider.md

@@ -81,20 +81,30 @@ realTimeData = {
 # Usage for Bid Adapters:
 
 Implement the `buildRequests` function. When it is called, the `bidRequests` param will be an array of bids.
-Each bid for which targeting information was found will conform to the following object structure:
+Each bid for which targeting information was found will have a ortb2 param conforming to the [oRTB v2 object structure](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf). The `ortb2` object will contain our proprietaty targeting segments in a format compliant with the [IAB's segment taxonomy structure](https://github.com/InteractiveAdvertisingBureau/openrtb/blob/master/extensions/community_extensions/segtax.md).
+
+Example:
 
 ```javascript
 {
     adUnitCode: 'xyz',
     bidId: 'abc',
     ...,
-    rtd: {
-        jwplayer: {
-            targeting: {
-                segments: ['123', '456'],
-                content: {
-                    id: 'jw_abc123'
-                }
+    ortb2: {
+        site: {
+            content: {
+                id: 'jw_abc123',
+                data: [{
+                    name: 'jwplayer',
+                    ext: {
+                        segtax: 502
+                    },
+                    segment: [{ 
+                        id: '123'
+                    }, { 
+                        id: '456'
+                    }]
+                }]
             }
         }   
     }
@@ -102,9 +112,15 @@ Each bid for which targeting information was found will conform to the following
 ```
 
 where:
-- `segments` is an array of jwpseg targeting segments, of type string.
-- `content` is an object containing metadata for the media. It may contain the following information: 
-  - `id` is a unique identifier for the specific media asset.
+- `ortb2` is an object containing first party data
+  - `site` is an object containing page specific information
+    - `content` is an object containing metadata for the media. It may contain the following information: 
+      - `id` is a unique identifier for the specific media asset
+      - `data` is an array containing segment taxonomy objects that have the following parameters:
+        - `name` is the `jwplayer` string indicating the provider name
+        - `ext.segtax` whose `502` value is the unique identifier for JW Player's proprietary taxonomy
+        - `segment` is an array containing the segment taxonomy values as an object where:
+          - `id` is the string representation of the data segment value. 
   
 **Example:**
 

package/modules/kargoBidAdapter.js

@@ -73,8 +73,8 @@ export const spec = {
       let meta;
       if (adUnit.metadata && adUnit.metadata.landingPageDomain) {
         meta = {
-          clickUrl: adUnit.metadata.landingPageDomain,
-          advertiserDomains: [adUnit.metadata.landingPageDomain]
+          clickUrl: adUnit.metadata.landingPageDomain[0],
+          advertiserDomains: adUnit.metadata.landingPageDomain
         };
       }
       bidResponses.push({

package/modules/livewrappedBidAdapter.js

@@ -1,7 +1,7 @@
 import { isSafariBrowser, deepAccess, getWindowTop, mergeDeep } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { config } from '../src/config.js';
-import find from 'core-js-pure/features/array/find.js';
+import find from 'prebidjs-polyfill/find.js';
 import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
 import { getStorageManager } from '../src/storageManager.js';