prebid.js 6.6.0 → 6.7.0

package/integrationExamples/gpt/amp/creative.html

@@ -1,38 +1,16 @@
 <!-- This script tag should be returned by your ad server -->
 
+<script src="https://cdn.jsdelivr.net/npm/prebid-universal-creative@latest/dist/creative.js"></script>
 <script>
-    // This is the `renderAd` function from Prebid.js moved within the creative iframe
-  var renderAd = function (ev) {
-    var key = ev.message ? "message" : "data";
-    var data = {};
-    try {
-      data = JSON.parse(ev[key]);
-    } catch (e) {
-      // Do nothing.  No ad found.
-    }
-    if (data.ad || data.adUrl) {
-      if (data.ad) {
-        document.write(data.ad);
-        document.close();
-      } else if (data.adUrl) {
-        document.write('<IFRAME SRC="' + data.adUrl + '" WIDTH="'+ data.width +'" HEIGHT="'+ data.height +'" FRAMEBORDER="0" SCROLLING="no" MARGINHEIGHT="0" MARGINWIDTH="0" TOPMARGIN="0" LEFTMARGIN="0" ALLOWTRANSPARENCY="true"></IFRAME>');
-        document.close();
-      }
-    }
-  };
+  var ucTagData = {};
+  ucTagData.adServerDomain = "";
+  ucTagData.pubUrl = "%%PATTERN:url%%";
+  ucTagData.targetingMap = "%%PATTERN:TARGETINGMAP%%";
+  ucTagData.hbPb = "%%PATTERN:hb_pb%%";
 
-  var requestAdFromPrebid = function () {
-    var message = JSON.stringify({
-      message: 'Prebid creative requested: %%PATTERN:hb_adid%%',
-      adId: '%%PATTERN:hb_adid%%'
-    });
-    window.parent.postMessage(message, '*');
-  };
-
-  var listenAdFromPrebid = function () {
-    window.addEventListener("message", renderAd, false);
-  };
-
-  listenAdFromPrebid();
-  requestAdFromPrebid();
+  try {
+    ucTag.renderAd(document, ucTagData);
+  } catch (e) {
+    console.log(e);
+  }
 </script>

package/modules/adbookpspBidAdapter.js

@@ -363,7 +363,7 @@ function impBidsToPrebidBids(
 }
 
 const impToPrebidBid =
-  (bidderRequestBody, bidResponseCurrency, referrer, targetingMap) => (bid) => {
+  (bidderRequestBody, bidResponseCurrency, referrer, targetingMap) => (bid, bidIndex) => {
     try {
       const bidRequest = findBidRequest(bidderRequestBody, bid);
 
@@ -377,7 +377,7 @@ const impToPrebidBid =
       let prebidBid = {
         ad: bid.adm,
         adId: bid.adid,
-        adserverTargeting: targetingMap[bid.impid],
+        adserverTargeting: targetingMap[bidIndex],
         adUnitCode: bidRequest.tagid,
         bidderRequestId: bidderRequestBody.id,
         bidId: bid.id,
@@ -408,6 +408,9 @@ const impToPrebidBid =
         };
       }
 
+      if (deepAccess(bid, 'ext.pa_win') === true) {
+        prebidBid.auctionWinner = true;
+      }
       return prebidBid;
     } catch (error) {
       logError(`${BIDDER_CODE}: Error while building bid`, error);
@@ -429,29 +432,43 @@ function buildTargetingMap(bids) {
   const values = impIds.reduce((result, id) => {
     result[id] = {
       lineItemIds: [],
+      orderIds: [],
       dealIds: [],
       adIds: [],
+      adAndOrderIndexes: []
     };
 
     return result;
   }, {});
 
-  bids.forEach((bid) => {
-    values[bid.impid].lineItemIds.push(bid.ext.liid);
-    values[bid.impid].dealIds.push(bid.dealid);
-    values[bid.impid].adIds.push(bid.adid);
+  bids.forEach((bid, bidIndex) => {
+    let impId = bid.impid;
+    values[impId].lineItemIds.push(bid.ext.liid);
+    values[impId].dealIds.push(bid.dealid);
+    values[impId].adIds.push(bid.adid);
+
+    if (deepAccess(bid, 'ext.ordid')) {
+      values[impId].orderIds.push(bid.ext.ordid);
+      bid.ext.ordid.split(TARGETING_VALUE_SEPARATOR).forEach((ordid, ordIndex) => {
+        let adIdIndex = values[impId].adIds.indexOf(bid.adid);
+        values[impId].adAndOrderIndexes.push(adIdIndex + '_' + ordIndex)
+      })
+    }
   });
 
   const targetingMap = {};
 
-  for (const id of impIds) {
-    targetingMap[id] = {
+  bids.forEach((bid, bidIndex) => {
+    let id = bid.impid;
+
+    targetingMap[bidIndex] = {
       hb_liid_adbookpsp: values[id].lineItemIds.join(TARGETING_VALUE_SEPARATOR),
       hb_deal_adbookpsp: values[id].dealIds.join(TARGETING_VALUE_SEPARATOR),
+      hb_ad_ord_adbookpsp: values[id].adAndOrderIndexes.join(TARGETING_VALUE_SEPARATOR),
       hb_adid_c_adbookpsp: values[id].adIds.join(TARGETING_VALUE_SEPARATOR),
+      hb_ordid_adbookpsp: values[id].orderIds.join(TARGETING_VALUE_SEPARATOR),
     };
-  }
-
+  })
   return targetingMap;
 }
 

package/modules/adhashBidAdapter.js

@@ -6,7 +6,7 @@ const VERSION = '1.0';
 
 export const spec = {
   code: 'adhash',
-  url: 'https://bidder.adhash.org/rtb?version=' + VERSION + '&prebid=true',
+  url: 'https://bidder.adhash.com/rtb?version=' + VERSION + '&prebid=true',
   supportedMediaTypes: [ BANNER ],
 
   isBidRequestValid: (bid) => {
@@ -37,7 +37,7 @@ export const spec = {
       var size = validBidRequests[i].sizes[index].join('x');
       bidRequests.push({
         method: 'POST',
-        url: url,
+        url: url + '&publisher=' + validBidRequests[i].params.publisherId,
         bidRequest: validBidRequests[i],
         data: {
           timezone: new Date().getTimezoneOffset() / 60,
@@ -87,7 +87,7 @@ export const spec = {
       cpm: responseBody.creatives[0].costEUR,
       ad:
         `<div id="${oneTimeId}"></div>
-        <script src="https://bidder.adhash.org/static/scripts/creative.min.js"></script>
+        <script src="https://bidder.adhash.com/static/scripts/creative.min.js"></script>
         <script>callAdvertiser(${bidderResponse},['${oneTimeId}'],${requestData},${publisherURL})</script>`,
       width: request.bidRequest.sizes[0][0],
       height: request.bidRequest.sizes[0][1],

package/modules/colossussspBidAdapter.js

@@ -47,7 +47,10 @@ export const spec = {
    * @return boolean True if this is a valid bid, and false otherwise.
    */
   isBidRequestValid: (bid) => {
-    return Boolean(bid.bidId && bid.params && !isNaN(bid.params.placement_id));
+    const validPlacamentId = bid.params && !isNaN(bid.params.placement_id);
+    const validGroupId = bid.params && !isNaN(bid.params.group_id);
+
+    return Boolean(bid.bidId && (validPlacamentId || validGroupId));
   },
 
   /**
@@ -61,13 +64,13 @@ export const spec = {
     const location = winTop.location;
     let placements = [];
     let request = {
-      'deviceWidth': winTop.screen.width,
-      'deviceHeight': winTop.screen.height,
-      'language': (navigator && navigator.language) ? navigator.language : '',
-      'secure': location.protocol === 'https:' ? 1 : 0,
-      'host': location.host,
-      'page': location.pathname,
-      'placements': placements,
+      deviceWidth: winTop.screen.width,
+      deviceHeight: winTop.screen.height,
+      language: (navigator && navigator.language) ? navigator.language : '',
+      secure: location.protocol === 'https:' ? 1 : 0,
+      host: location.host,
+      page: location.pathname,
+      placements: placements,
     };
 
     if (bidderRequest) {
@@ -85,6 +88,7 @@ export const spec = {
       let traff = bid.params.traffic || BANNER
       let placement = {
         placementId: bid.params.placement_id,
+        groupId: bid.params.group_id,
         bidId: bid.bidId,
         sizes: bid.mediaTypes[traff].sizes,
         traffic: traff,

package/modules/colossussspBidAdapter.md

@@ -26,5 +26,19 @@ Module that connects to Colossus SSP demand sources
                 traffic: 'banner'
             }
         }]
-    ];
+    }, {
+        code: 'placementid_1',
+        mediaTypes: {
+            banner: {
+                sizes: [[300, 250], [300,600]]
+            }
+        },
+        bids: [{
+            bidder: 'colossusssp',
+            params: {
+                group_id: 0,
+                traffic: 'banner'
+            }
+        }]
+    }];
 ```

package/modules/compassBidAdapter.js

@@ -97,7 +97,7 @@ export const spec = {
 
   isBidRequestValid: (bid = {}) => {
     const { params, bidId, mediaTypes } = bid;
-    let valid = Boolean(bidId && params && params.placementId);
+    let valid = Boolean(bidId && params && (params.placementId || params.endpointId));
 
     if (mediaTypes && mediaTypes[BANNER]) {
       valid = valid && Boolean(mediaTypes[BANNER] && mediaTypes[BANNER].sizes);

package/modules/consumableBidAdapter.md

@@ -4,7 +4,7 @@ Module Name: Consumable Bid Adapter
 
 Module Type: Consumable Adapter
 
-Maintainer: naffis@consumable.com
+Maintainer: prebid@consumable.com
 
 # Description
 

package/modules/gnetBidAdapter.js

@@ -1,9 +1,9 @@
-import { _each, parseSizesInput, isEmpty } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { _each, isEmpty, parseSizesInput } from '../src/utils.js';
 import { BANNER } from '../src/mediaTypes.js';
 
 const BIDDER_CODE = 'gnet';
-const ENDPOINT = 'https://adserver.gnetproject.com/prebid.php';
+const ENDPOINT = 'https://service.gnetrtb.com/api/adrequest';
 
 export const spec = {
   code: BIDDER_CODE,
@@ -16,7 +16,7 @@ export const spec = {
    * @return boolean True if this is a valid bid, and false otherwise.
    */
   isBidRequestValid: function (bid) {
-    return !!(bid.params.websiteId);
+    return !!(bid.params.websiteId && bid.params.adunitId);
   },
 
   /**

package/modules/gnetBidAdapter.md

@@ -1,14 +1,14 @@
 # Overview
 
 ```
-Module Name: Gnet Bidder Adapter
+Module Name: Gnet RTB Bidder Adapter
 Module Type: Bidder Adapter
-Maintainer: roberto.wu@grumft.com
+Maintainer: bruno.bonanho@grumft.com
 ```
 
 # Description
 
-Connect to Gnet Project exchange for bids.
+Connect to Gnet RTB exchange for bids.
 
 # Test Parameters
 ```
@@ -24,7 +24,7 @@ Connect to Gnet Project exchange for bids.
                 {
                     bidder: 'gnet',
                     params: {
-                        websiteId: '4'
+                        websiteId: '1', adunitId: '1'
                     }
                 }
             ]

package/modules/gumgumBidAdapter.js

@@ -298,10 +298,10 @@ function buildRequests(validBidRequests, bidderRequest) {
     const date = new Date();
     const lt = date.getTime();
     const to = date.getTimezoneOffset();
-    if (to) {
-      lt && (data.lt = lt);
-      data.to = to;
-    }
+
+    // ADTS-174 Removed unnecessary checks to fix failing test
+    data.lt = lt;
+    data.to = to;
 
     // ADTS-169 add adUnitCode to requests
     if (adUnitCode) data.aun = adUnitCode

package/modules/jwplayerRtdProvider.js

@@ -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/pilotxBidAdapter.js

@@ -0,0 +1,147 @@
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+const BIDDER_CODE = 'pilotx';
+const ENDPOINT_URL = '//adn.pilotx.tv/hb'
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: ['banner', 'video'],
+  aliases: ['pilotx'], // short 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) {
+    let sizesCheck = !!bid.sizes
+    let paramSizesCheck = !!bid.params.sizes
+    var sizeConfirmed = false
+    if (sizesCheck) {
+      if (bid.sizes.length < 1) {
+        return false
+      } else {
+        sizeConfirmed = true
+      }
+    }
+    if (paramSizesCheck) {
+      if (bid.params.sizes.length < 1 && !sizeConfirmed) {
+        return false
+      } else {
+        sizeConfirmed = true
+      }
+    }
+    if (!sizeConfirmed) {
+      return false
+    }
+    return !!(bid.params.placementId);
+  },
+  /**
+         * Make a server request from the list of BidRequests.
+         *
+         * @param {validBidRequests[]} - an array of bids
+         * @return ServerRequest Info describing the request to the server.
+         */
+  buildRequests: function (validBidRequests, bidderRequest) {
+    let payloadItems = {};
+    validBidRequests.forEach(bidRequest => {
+      let sizes = [];
+      let placementId = this.setPlacementID(bidRequest.params.placementId)
+      payloadItems[placementId] = {}
+      if (bidRequest.sizes.length > 0) {
+        if (Array.isArray(bidRequest.sizes[0])) {
+          for (let i = 0; i < bidRequest.sizes.length; i++) {
+            sizes[i] = [(bidRequest.sizes[i])[0], (bidRequest.sizes[i])[1]]
+          }
+        } else {
+          sizes[0] = [bidRequest.sizes[0], bidRequest.sizes[1]]
+        }
+        payloadItems[placementId]['sizes'] = sizes
+      }
+      if (bidRequest.mediaTypes != null) {
+        for (let i in bidRequest.mediaTypes) {
+          payloadItems[placementId][i] = {
+            ...bidRequest.mediaTypes[i]
+          }
+        }
+      }
+      let consentTemp = ''
+      let consentRequiredTemp = false
+      if (bidderRequest && bidderRequest.gdprConsent) {
+        consentTemp = 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
+        consentRequiredTemp = (typeof bidderRequest.gdprConsent.gdprApplies === 'boolean') ? bidderRequest.gdprConsent.gdprApplies : true
+      }
+
+      payloadItems[placementId]['gdprConsentString'] = consentTemp
+      payloadItems[placementId]['gdprConsentRequired'] = consentRequiredTemp
+      payloadItems[placementId]['bidId'] = bidRequest.bidId
+    });
+    const payload = payloadItems;
+    const payloadString = JSON.stringify(payload);
+    return {
+      method: 'POST',
+      url: ENDPOINT_URL,
+      data: payloadString,
+    };
+  },
+  /**
+         * Unpack the response from the server into a list of bids.
+         *
+         * @param {ServerResponse} serverResponse A successful response from the server.
+         * @return {Bid[]} An array of bids which were nested inside the server.
+         */
+  interpretResponse: function (serverResponse, bidRequest) {
+    const serverBody = serverResponse.body;
+    const bidResponses = [];
+    if (serverBody.mediaType == 'banner') {
+      const bidResponse = {
+        requestId: serverBody.requestId,
+        cpm: serverBody.cpm,
+        width: serverBody.width,
+        height: serverBody.height,
+        creativeId: serverBody.creativeId,
+        currency: serverBody.currency,
+        netRevenue: false,
+        ttl: serverBody.ttl,
+        ad: serverBody.ad,
+        mediaType: 'banner',
+        meta: {
+          mediaType: 'banner',
+          advertiserDomains: serverBody.advertiserDomains
+        }
+      }
+      bidResponses.push(bidResponse)
+    } else if (serverBody.mediaType == 'video') {
+      const bidResponse = {
+        requestId: serverBody.requestId,
+        cpm: serverBody.cpm,
+        width: serverBody.width,
+        height: serverBody.height,
+        creativeId: serverBody.creativeId,
+        currency: serverBody.currency,
+        netRevenue: false,
+        ttl: serverBody.ttl,
+        vastUrl: serverBody.vastUrl,
+        mediaType: 'video',
+        meta: {
+          mediaType: 'video',
+          advertiserDomains: serverBody.advertiserDomains
+        }
+      }
+      bidResponses.push(bidResponse)
+    }
+
+    return bidResponses;
+  },
+
+  /**
+   * Formats placement ids for adserver ingestion purposes
+   * @param {string[]} The placement ID/s in an array
+   */
+  setPlacementID: function (placementId) {
+    if (Array.isArray(placementId)) {
+      return placementId.join('#')
+    }
+    return placementId
+  },
+}
+registerBidder(spec);

package/modules/pilotxBidAdapter.md

@@ -0,0 +1,50 @@
+# Overview
+
+```
+Module Name:  Pilotx Prebid Adapter
+Module Type:  Bidder Adapter
+Maintainer:   tony@pilotx.tv
+```
+
+# Description
+
+Connects to Pilotx 
+
+Pilotx's bid adapter supports banner and video.
+
+# Test Parameters
+```
+// Banner adUnit
+var adUnits = [{
+    code: 'div-gpt-ad-1460505748561-0',
+    mediaTypes: {
+        banner: {
+            sizes: [[300, 250], [300,600]],
+        }
+    },
+    bids: [{
+        bidder: 'pilotx',
+        params: {
+            placementId: ["1423"]
+        }
+    }]
+
+}];
+
+// Video adUnit
+var videoAdUnit = {
+    code: 'video1',
+    mediaTypes: {
+        video: {
+            context: 'instream',
+            playerSize: [640, 480],
+        }
+    },
+    bids: [{
+        bidder: 'pilotx',
+        params: {
+            placementId: '1422',
+        }
+    }]
+};
+```