prebid.js 6.3.0 → 6.7.0

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/limelightDigitalBidAdapter.js

@@ -159,7 +159,8 @@ function buildPlacement(bidRequest) {
         }
       }),
       type: bidRequest.params.adUnitType.toUpperCase(),
-      publisherId: bidRequest.params.publisherId
+      publisherId: bidRequest.params.publisherId,
+      userIdAsEids: bidRequest.userIdAsEids
     }
   }
 }

package/modules/livewrappedAnalyticsAdapter.js

@@ -114,6 +114,7 @@ let livewrappedAnalyticsAdapter = Object.assign(adapter({EMPTYURL, ANALYTICSTYPE
         let wonBid = cache.auctions[args.auctionId].bids[args.requestId];
         wonBid.won = true;
         wonBid.floorData = args.floorData;
+        wonBid.rUp = args.rUp;
         if (wonBid.sendStatus != 0) {
           livewrappedAnalyticsAdapter.sendEvents();
         }
@@ -288,7 +289,8 @@ function getWins(gdpr, auctionIds) {
           auctionId: auctionIdPos,
           auc: bid.auc,
           buc: bid.buc,
-          lw: bid.lw
+          lw: bid.lw,
+          rUp: bid.rUp
         });
       }
     });

package/modules/livewrappedBidAdapter.js

@@ -1,4 +1,4 @@
-import { isSafariBrowser, deepAccess, getWindowTop } from '../src/utils.js';
+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';
@@ -60,11 +60,17 @@ export const spec = {
     const bundle = find(bidRequests, hasBundleParam);
     const tid = find(bidRequests, hasTidParam);
     const schain = bidRequests[0].schain;
+    let ortb2 = config.getConfig('ortb2');
+    const eids = handleEids(bidRequests);
     bidUrl = bidUrl ? bidUrl.params.bidUrl : URL;
     url = url ? url.params.url : (getAppDomain() || getTopWindowLocation(bidderRequest));
     test = test ? test.params.test : undefined;
     var adRequests = bidRequests.map(bidToAdRequest);
 
+    if (eids) {
+      ortb2 = mergeDeep(ortb2 || {}, eids);
+    }
+
     const payload = {
       auctionId: auctionId ? auctionId.auctionId : undefined,
       publisherId: publisherId ? publisherId.params.publisherId : undefined,
@@ -86,7 +92,7 @@ export const spec = {
       cookieSupport: !isSafariBrowser() && storage.cookiesAreEnabled(),
       rcv: getAdblockerRecovered(),
       adRequests: [...adRequests],
-      rtbData: handleEids(bidRequests),
+      rtbData: ortb2,
       schain: schain
     };
 

package/modules/loglyliftBidAdapter.js

@@ -0,0 +1,79 @@
+import { config } from '../src/config.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { NATIVE } from '../src/mediaTypes.js';
+
+const BIDDER_CODE = 'loglylift';
+const ENDPOINT_URL = 'https://bid.logly.co.jp/prebid/client/v1';
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [NATIVE],
+
+  isBidRequestValid: function (bid) {
+    return !!(bid.params && bid.params.adspotId);
+  },
+
+  buildRequests: function (bidRequests, bidderRequest) {
+    const requests = [];
+    for (let i = 0, len = bidRequests.length; i < len; i++) {
+      const request = {
+        method: 'POST',
+        url: ENDPOINT_URL + '?adspot_id=' + bidRequests[i].params.adspotId,
+        data: JSON.stringify(newBidRequest(bidRequests[i], bidderRequest)),
+        options: {},
+        bidderRequest
+      };
+      requests.push(request);
+    }
+    return requests;
+  },
+
+  interpretResponse: function (serverResponse, { bidderRequest }) {
+    serverResponse = serverResponse.body;
+    const bidResponses = [];
+    if (!serverResponse || serverResponse.error) {
+      return bidResponses;
+    }
+    serverResponse.bids.forEach(function (bid) {
+      bidResponses.push(bid);
+    })
+    return bidResponses;
+  },
+
+  getUserSyncs: function (syncOptions, serverResponses) {
+    const syncs = [];
+
+    if (syncOptions.iframeEnabled && serverResponses.length > 0) {
+      syncs.push({
+        type: 'iframe',
+        url: 'https://sync.logly.co.jp/sync/sync.html'
+      });
+    }
+    return syncs;
+  }
+
+};
+
+function newBidRequest(bid, bidderRequest) {
+  const currencyObj = config.getConfig('currency');
+  const currency = (currencyObj && currencyObj.adServerCurrency) || 'USD';
+
+  return {
+    auctionId: bid.auctionId,
+    bidderRequestId: bid.bidderRequestId,
+    transactionId: bid.transactionId,
+    adUnitCode: bid.adUnitCode,
+    bidId: bid.bidId,
+    mediaTypes: bid.mediaTypes,
+    params: bid.params,
+    prebidJsVersion: '$prebid.version$',
+    url: window.location.href,
+    domain: config.getConfig('publisherDomain'),
+    referer: bidderRequest.refererInfo.referer,
+    auctionStartTime: bidderRequest.auctionStart,
+    currency: currency,
+    timeout: config.getConfig('bidderTimeout')
+  };
+}
+
+registerBidder(spec);

package/modules/loglyliftBidAdapter.md

@@ -0,0 +1,55 @@
+# Overview
+```
+Module Name: LOGLY lift for Publisher
+Module Type: Bidder Adapter
+Maintainer: dev@logly.co.jp
+```
+
+# Description
+Module that connects to Logly's demand sources.
+Currently module supports only native mediaType.
+
+# Test Parameters
+```
+var adUnits = [
+  // Native adUnit
+  {
+    code: 'test-native-code',
+    sizes: [[1, 1]],
+    mediaTypes: {
+      native: {
+        title: {
+          required: true
+        },
+        image: {
+          required: true
+        },
+        sponsoredBy: {
+          required: true
+        }
+      }
+    },
+    bids: [{
+      bidder: 'loglylift',
+      params: {
+        adspotId: 4302078
+      }
+    }]
+  }
+];
+```
+
+# UserSync example
+
+```
+pbjs.setConfig({
+  userSync: {
+    filterSettings: {
+      iframe: {
+        bidders: '*', // '*' represents all bidders
+        filter: 'include'
+      }
+    }
+  }
+});
+```

package/modules/nextMillenniumBidAdapter.js

@@ -25,12 +25,14 @@ export const spec = {
       window.nmmRefreshCounts[bid.adUnitCode] = window.nmmRefreshCounts[bid.adUnitCode] || 0;
       const postBody = {
         'id': bid.auctionId,
-        'refresh_count': window.nmmRefreshCounts[bid.adUnitCode]++,
         'ext': {
           'prebid': {
             'storedrequest': {
               'id': getBidIdParameter('placement_id', bid.params)
             }
+          },
+          'nextMillennium': {
+            'refresh_count': window.nmmRefreshCounts[bid.adUnitCode]++,
           }
         }
       }
@@ -44,12 +46,14 @@ export const spec = {
         if (uspConsent) {
           postBody.regs.ext.us_privacy = uspConsent;
         }
-        if (typeof gdprConsent.gdprApplies !== 'undefined') {
-          postBody.regs.ext.gdpr = gdprConsent.gdprApplies ? 1 : 0;
-        }
-        if (typeof gdprConsent.consentString !== 'undefined') {
-          postBody.user = {
-            ext: { consent: gdprConsent.consentString }
+        if (gdprConsent) {
+          if (typeof gdprConsent.gdprApplies !== 'undefined') {
+            postBody.regs.ext.gdpr = gdprConsent.gdprApplies ? 1 : 0;
+          }
+          if (typeof gdprConsent.consentString !== 'undefined') {
+            postBody.user = {
+              ext: { consent: gdprConsent.consentString }
+            }
           }
         }
       }

package/modules/oguryBidAdapter.js

@@ -10,6 +10,7 @@ const DEFAULT_TIMEOUT = 1000;
 const BID_HOST = 'https://mweb-hb.presage.io/api/header-bidding-request';
 const TIMEOUT_MONITORING_HOST = 'https://ms-ads-monitoring-events.presage.io';
 const MS_COOKIE_SYNC_DOMAIN = 'https://ms-cookie-sync.presage.io';
+const ADAPTER_VERSION = '1.2.7';
 
 function isBidRequestValid(bid) {
   const adUnitSizes = getAdUnitSizes(bid);
@@ -55,7 +56,11 @@ function buildRequests(validBidRequests, bidderRequest) {
         consent: ''
       }
     },
-    imp: []
+    imp: [],
+    ext: {
+      adapterversion: ADAPTER_VERSION,
+      prebidversion: '$prebid.version$'
+    }
   };
 
   if (bidderRequest.hasOwnProperty('gdprConsent') &&
@@ -123,7 +128,9 @@ function interpretResponse(openRtbBidResponse) {
         meta: {
           advertiserDomains: bid.adomain
         },
-        nurl: bid.nurl
+        nurl: bid.nurl,
+        adapterVersion: ADAPTER_VERSION,
+        prebidVersion: '$prebid.version$'
       };
 
       bidResponse.ad = bid.adm;

package/modules/onetagBidAdapter.js

@@ -347,11 +347,13 @@ function getSizes(sizes) {
 function getUserSyncs(syncOptions, serverResponses, gdprConsent, uspConsent) {
   let syncs = [];
   let params = '';
-  if (gdprConsent && typeof gdprConsent.consentString === 'string') {
-    params += '&gdpr_consent=' + gdprConsent.consentString;
+  if (gdprConsent) {
     if (typeof gdprConsent.gdprApplies === 'boolean') {
       params += '&gdpr=' + (gdprConsent.gdprApplies ? 1 : 0);
     }
+    if (typeof gdprConsent.consentString === 'string') {
+      params += '&gdpr_consent=' + gdprConsent.consentString;
+    }
   }
   if (uspConsent && typeof uspConsent === 'string') {
     params += '&us_privacy=' + uspConsent;

package/modules/optimeraRtdProvider.js

@@ -173,7 +173,9 @@ export function setScoresURL() {
 }
 
 /**
- * Set the scores for the divice if given.
+ * Set the scores for the device if given.
+ * Add any any insights to the winddow.optimeraInsights object.
+ *
  * @param {*} result
  * @returns {string} JSON string of Optimera Scores.
  */
@@ -184,6 +186,11 @@ export function setScores(result) {
     if (device !== 'default' && scores.device[device]) {
       scores = scores.device[device];
     }
+    logInfo(scores);
+    if (scores.insights) {
+      window.optimeraInsights = window.optimeraInsights || {};
+      window.optimeraInsights.data = scores.insights;
+    }
   } catch (e) {
     logError('Optimera score file could not be parsed.');
   }