prebid.js 7.25.0 → 7.27.0

package/modules/viqeoBidAdapter.js

@@ -0,0 +1,180 @@
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+import {logError, logInfo, _each, mergeDeep, isFn, isNumber, isPlainObject} from '../src/utils.js'
+import {VIDEO} from '../src/mediaTypes.js';
+import {Renderer} from '../src/Renderer.js';
+
+const BIDDER_CODE = 'viqeo';
+const DEFAULT_MIMES = ['application/javascript'];
+const VIQEO_ENDPOINT = 'https://ads.betweendigital.com/openrtb_bid';
+const RENDERER_URL = 'https://cdn.viqeo.tv/js/vq_starter.js';
+const DEFAULT_CURRENCY = 'USD';
+const DEFAULT_SSPID = 44697;
+
+function getBidFloor(bid) {
+  const {floor, currency} = bid.params;
+  const curr = currency || DEFAULT_CURRENCY;
+  if (!isFn(bid.getFloor)) {
+    return {floor: isNumber(floor) ? floor : 0, currency: curr};
+  }
+  const floorInfo = bid.getFloor({currency: curr, mediaType: VIDEO, size: '*'});
+  if (isPlainObject(floorInfo) && isNumber(floorInfo.floor) && floorInfo.currency === curr) {
+    return floorInfo;
+  }
+  return {floor: floor || 0, currency: currency || DEFAULT_CURRENCY};
+}
+
+function getVideoTargetingParams({mediaTypes: {video}}) {
+  const result = {};
+  Object.keys(Object(video))
+    .forEach(key => {
+      if (key === 'playerSize') {
+        result.w = video.playerSize[0][0];
+        result.h = video.playerSize[0][1];
+      } else if (key !== 'context') {
+        result[key] = video[key];
+      }
+    })
+  return result;
+}
+
+/**
+ * @type {BidderSpec}
+ */
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [VIDEO],
+  /**
+   * @param {BidRequest} bidRequest The bid params to validate.
+   * @return boolean True if this is a valid bid, and false otherwise.
+   */
+  isBidRequestValid: ({params}) => {
+    if (!params) {
+      logError('failed validation: params not declared');
+      return false;
+    }
+    if (!params.user && !params.user?.buyeruid) {
+      logError('failed validation: user.buyeruid not declared');
+      return false;
+    }
+    if (!params.playerOptions) {
+      logError('failed validation: playerOptions not declared');
+      return false;
+    }
+    const {profileId, videoId, playerId} = params.playerOptions;
+    if (!profileId) {
+      logError('failed validation: profileId not declared');
+      return false;
+    }
+    if (!videoId && !playerId) {
+      logError('failed validation: videoId or playerId not declared');
+      return false;
+    }
+    return true;
+  },
+  /**
+   * @param validBidRequests {BidRequest[]}
+   * @returns {ServerRequest[]}
+   */
+  buildRequests: (validBidRequests) => {
+    logInfo('validBidRequests', validBidRequests);
+    const bidRequests = [];
+    _each(validBidRequests, (bid, i) => {
+      const {
+        params: {test, sspId, endpointUrl},
+        mediaTypes: {video},
+      } = bid;
+      const ortb2 = bid.ortb2 || {};
+      const user = bid.params.user || {};
+      const device = bid.params.device || {};
+      const site = bid.params.site || {};
+      const w = window;
+      const floorInfo = getBidFloor(bid);
+      const data = {
+        id: bid.bidId,
+        test,
+        imp: [{
+          id: `${i}`,
+          tagid: bid.adUnitCode,
+          video: {
+            ...getVideoTargetingParams(bid),
+            mimes: video.mimes || DEFAULT_MIMES,
+          },
+          bidfloor: floorInfo.floor,
+          bidfloorcur: floorInfo.currency,
+          secure: 1
+        }],
+        site: test === 1 ? {
+          page: 'https://viqeo.tv',
+          domain: 'viqeo.tv'
+        } : mergeDeep({
+          domain: w.location.hostname,
+          page: w.location.href
+        }, ortb2.site, site),
+        device: mergeDeep({
+          w: w.screen.width,
+          h: w.screen.height,
+          ua: w.navigator.userAgent,
+        }, ortb2.device, device),
+        user: mergeDeep({...user}, ortb2.user),
+        app: bid.params.app,
+      };
+      bidRequests.push({
+        url: endpointUrl || `${VIQEO_ENDPOINT}/?sspId=${sspId || DEFAULT_SSPID}`,
+        method: 'POST',
+        data,
+        bids: validBidRequests,
+      });
+    });
+    return bidRequests;
+  },
+  /**
+   * @param {ServerResponse} serverResponse
+   * @param {BidRequest} bidRequests
+   * @return {Bid[]}
+   */
+  interpretResponse: (serverResponse, bidRequests) => {
+    logInfo('serverResponse', serverResponse);
+    const bidResponses = [];
+    if (!serverResponse || !serverResponse.body) {
+      logError('empty response');
+      return [];
+    }
+    try {
+      const {id, seatbid, cur} = serverResponse.body;
+      _each(seatbid, (sb) => {
+        const {bid} = sb;
+        _each(bid, (b) => {
+          const bidRequest = bidRequests.bids.find(({bidId}) => bidId === id);
+          const renderer = Renderer.install({
+            url: bidRequest?.params?.renderUrl || RENDERER_URL,
+          });
+          renderer.setRender((bid) => {
+            if (window.VIQEO) {
+              window.VIQEO.renderPrebid(bid);
+            } else {
+              logError('failed get window.VIQEO');
+            }
+          });
+          bidResponses.push({
+            requestId: id,
+            currency: cur,
+            cpm: b.price,
+            ttl: b.exp,
+            netRevenue: true,
+            creativeId: b.cid,
+            width: b.w || bidRequest?.mediaTypes[VIDEO].playerSize[0][0],
+            height: b.h || bidRequest?.mediaTypes[VIDEO].playerSize[0][1],
+            vastXml: b.adm,
+            vastUrl: b.nurl,
+            mediaType: VIDEO,
+            renderer,
+          })
+        })
+      });
+    } catch (error) {
+      logError(error);
+    }
+    return bidResponses;
+  },
+}
+registerBidder(spec);

package/modules/viqeoBidAdapter.md

@@ -0,0 +1,56 @@
+# Overview
+
+**Module Name**: Viqeo Bidder Adapter
+**Module Type**: Bidder Adapter
+**Maintainer**: muravjovv1@gmail.com
+
+# Description
+
+Viqeo Bidder Adapter for Prebid.js. About: https://viqeo.tv/
+
+### Bid params
+
+{: .table .table-bordered .table-striped }
+| Name                        | Scope    | Description                                                                                                                | Example                  | Type      |
+|-----------------------------|----------|----------------------------------------------------------------------------------------------------------------------------|--------------------------|-----------|
+| `user`                      | required | The object containing user data (See OpenRTB spec)                                                                         | `user: {}`               | `object`  |
+| `user.buyeruid`             | required | User id                                                                                                                    | `"12345"`                | `string`  |
+| `playerOptions`             | required | The object containing Viqeo player options                                                                                 | `playerOptions: {}`      | `object`  |
+| `playerOptions.profileId`   | required | Viqeo profile id                                                                                                           | `1382`                   | `number`  |
+| `playerOptions.videId`      | optional | Viqeo video id                                                                                                             | `"ed584da454c7205ca7e4"` | `string`  |
+| `playerOptions.playerId`    | optional | Viqeo player id                                                                                                            | `1`                      | `number`  |
+| `device`                    | optional | The object containing device data (See OpenRTB spec)                                                                       | `device: {}`             | `object`  |
+| `site`                      | optional | The object containing site data (See OpenRTB spec)                                                                         | `site: {}`               | `object`  |
+| `app`                       | optional | The object containing app data (See OpenRTB spec)                                                                          | `app: {}`                | `object`  |
+| `floor`                     | optional | Bid floor price                                                                                                            | `0.5`                    | `number`  |
+| `currency`                  | optional | 3-letter ISO 4217 code defining the currency of the bid.                                                                   | `EUR`                    | `string`  |
+| `test`                      | optional | Flag which will induce a sample bid response when true; only set to true for testing purposes (1 = true, 0 = false)        | `1`                      | `integer` |
+| `sspId`                     | optional | For debug, request id                                                                                                      | `1`                      | `number`  |
+| `renderUrl`                 | optional | For debug, script player url                                                                                               | `"https://viqeo.tv"`     | `string`  |
+| `endpointUrl`               | optional | For debug, api endpoint                                                                                                    | `"https://viqeo.tv"`     | `string`  |
+
+# Test Parameters
+```
+    var adUnits = [{
+      code: 'your-slot', // use exactly the same code as your slot div id.
+      mediaTypes: {
+          video: {
+            context: 'outstream',
+            playerSize: [640, 480]  
+          }
+      },
+      bids: [{
+        bidder: 'viqeo',
+        params: { 
+            user: {
+                buyeruid: '1',
+            },
+            playerOptions: {
+                videoId: 'ed584da454c7205ca7e4',
+                profileId: 1382,
+            },
+            test: 1,
+        }
+      }]
+    }];
+```

package/modules/yandexBidAdapter.js

@@ -1,5 +1,6 @@
-import { formatQS, deepAccess, triggerPixel } from '../src/utils.js';
+import { formatQS, deepAccess, triggerPixel, isArray, isNumber } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER } from '../src/mediaTypes.js'
 
 const BIDDER_CODE = 'yandex';
 const BIDDER_URL = 'https://bs.yandex.ru/metadsp';
@@ -10,9 +11,19 @@ const SSP_ID = 10500;
 export const spec = {
   code: BIDDER_CODE,
   aliases: ['ya'], // short code
+  supportedMediaTypes: [ BANNER ],
 
   isBidRequestValid: function(bid) {
-    return !!(bid.params && bid.params.pageId && bid.params.impId);
+    const { params } = bid;
+    if (!params) {
+      return false;
+    }
+    const { pageId, impId } = extractPlacementIds(params);
+    if (!(pageId && impId)) {
+      return false;
+    }
+    const sizes = bid.mediaTypes?.banner?.sizes;
+    return isArray(sizes) && isArray(sizes[0]) && isNumber(sizes[0][0]) && isNumber(sizes[0][1]);
   },
 
   buildRequests: function(validBidRequests, bidderRequest) {
@@ -29,9 +40,19 @@ export const spec = {
       page = bidderRequest.refererInfo.page;
     }
 
+    let timeout = null;
+    if (bidderRequest) {
+      timeout = bidderRequest.timeout;
+    }
+
     return validBidRequests.map((bidRequest) => {
       const { params } = bidRequest;
-      const { pageId, impId, targetRef, withCredentials = true } = params;
+      const { targetRef, withCredentials = true } = params;
+      const sizes = bidRequest.mediaTypes.banner.sizes;
+      const size = sizes[0];
+      const [ w, h ] = size;
+
+      const { pageId, impId } = extractPlacementIds(params);
 
       const queryParams = {
         'imp-id': impId,
@@ -43,24 +64,23 @@ export const spec = {
         queryParams['tcf-consent'] = consentString;
       }
 
-      const floorInfo = bidRequest.getFloor ? bidRequest.getFloor({
-        currency: DEFAULT_CURRENCY
-      }) : {};
-      const bidfloor = floorInfo.floor;
-      const bidfloorcur = floorInfo.currency;
-
       const imp = {
         id: impId,
-        bidfloor,
-        bidfloorcur,
-      };
-      const bannerParams = deepAccess(bidRequest, 'mediaTypes.banner');
-      if (bannerParams) {
-        const [ w, h ] = bannerParams.sizes[0];
-        imp.banner = {
+        banner: {
+          format: sizes,
           w,
           h,
-        };
+        }
+      };
+
+      if (bidRequest.getFloor) {
+        const floorInfo = bidRequest.getFloor({
+          currency: DEFAULT_CURRENCY,
+          size
+        });
+
+        imp.bidfloor = floorInfo.floor;
+        imp.bidfloorcur = floorInfo.currency;
       }
 
       const queryParamsString = formatQS(queryParams);
@@ -74,6 +94,7 @@ export const spec = {
             ref_url: referrer,
             page_url: page,
           },
+          tmax: timeout,
         },
         options: {
           withCredentials,
@@ -102,6 +123,7 @@ export const spec = {
         width: rtbBid.w,
         height: rtbBid.h,
         creativeId: rtbBid.adid,
+        nurl: rtbBid.nurl,
 
         netRevenue: true,
         ttl: DEFAULT_TTL,
@@ -118,13 +140,57 @@ export const spec = {
   },
 
   onBidWon: function (bid) {
-    const nurl = bid['nurl'];
-
+    let nurl = bid['nurl'];
     if (!nurl) {
       return;
     }
+
+    const cpm = deepAccess(bid, 'adserverTargeting.hb_pb') || '';
+    const curr = (bid.hasOwnProperty('originalCurrency') && bid.hasOwnProperty('originalCpm'))
+      ? bid.originalCurrency
+      : bid.currency;
+
+    nurl = nurl
+      .replace(/\${AUCTION_PRICE}/, cpm)
+      .replace(/\${AUCTION_CURRENCY}/, curr)
+    ;
+
     triggerPixel(nurl);
   }
 }
 
+function extractPlacementIds(bidRequestParams) {
+  const { placementId } = bidRequestParams;
+  const result = { pageId: null, impId: null };
+
+  let pageId, impId;
+  if (placementId) {
+    /*
+     * Possible formats
+     * R-I-123456-2
+     * R-123456-1
+     * 123456-789
+     */
+    const num = placementId.lastIndexOf('-');
+    if (num === -1) {
+      return result;
+    }
+    const num2 = placementId.lastIndexOf('-', num - 1);
+    pageId = placementId.slice(num2 + 1, num);
+    impId = placementId.slice(num + 1);
+  } else {
+    pageId = bidRequestParams.pageId;
+    impId = bidRequestParams.impId;
+  }
+
+  if (!parseInt(pageId, 10) || !parseInt(impId, 10)) {
+    return result;
+  }
+
+  result.pageId = pageId;
+  result.impId = impId;
+
+  return result;
+}
+
 registerBidder(spec);

package/modules/yandexBidAdapter.md

@@ -12,10 +12,11 @@ Yandex Bidder Adapter for Prebid.js.
 
 # Parameters
 
-| Name          | Scope    | Description             | Example   | Type      |
-|---------------|----------|-------------------------|-----------|-----------|
-| `pageId`      | required | Page ID                 | `123`     | `Integer` |
-| `impId`       | required | Block ID                | `1`       | `Integer` |
+| Name          | Required?                                  | Description | Example | Type      |
+|---------------|--------------------------------------------|-------------|---------|-----------|
+| `placementId` | Yes                                        | Block ID    | `123-1` | `String`  |
+| `pageId`      | No<br>Deprecated. Please use `placementId` | Page ID     | `123`   | `Integer` |
+| `impId`       | No<br>Deprecated. Please use `placementId` | Imp ID      | `1`     | `Integer` |
 
 # Test Parameters
 
@@ -24,15 +25,14 @@ var adUnits = [{
   code: 'banner-1',
   mediaTypes: {
     banner: {
-      sizes: [[240, 400]],
+      sizes: [[240, 400], [300, 600]],
     }
   },
   bids: [{
     {
       bidder: 'yandex',
       params: {
-        pageId: 346580,
-        impId: 143,
+        placementId: '346580-1'
       },
     }
   }]

package/modules/yieldlabBidAdapter.js

@@ -41,6 +41,7 @@ export const spec = {
 
     const adslotIds = []
     const adslotSizes = [];
+    const adslotFloors = [];
     const timestamp = Date.now()
     const query = {
       ts: timestamp,
@@ -77,7 +78,7 @@ export const spec = {
       }
       const floor = getBidFloor(bid, sizes)
       if (floor) {
-        query.floor = floor;
+        adslotFloors.push(bid.params.adslotId + ':' + floor);
       }
     })
 
@@ -99,6 +100,11 @@ export const spec = {
     if (adslotSizes.length > 0) {
       query.sizes = adslotSizes.join(',')
     }
+
+    if (adslotFloors.length > 0) {
+      query.floor = adslotFloors.join(',')
+    }
+
     const queryString = createQueryString(query)
 
     return {
@@ -370,21 +376,32 @@ function getContentObject(bid) {
 }
 
 /**
- * Creates a string for iab_content object
+ * Creates a string for iab_content object by
+ * 1. flatten the iab content object
+ * 2. encoding the values
+ * 3. joining array of defined keys ('keyword', 'cat') into one value seperated with '|'
+ * 4. encoding the whole string
  * @param {Object} iabContent
  * @returns {String}
  */
 function createIabContentString(iabContent) {
   const arrKeys = ['keywords', 'cat']
   const str = []
-  for (const key in iabContent) {
-    if (iabContent.hasOwnProperty(key)) {
-      const value = (arrKeys.indexOf(key) !== -1 && Array.isArray(iabContent[key]))
-        ? iabContent[key].map(node => encodeURIComponent(node)).join('|') : encodeURIComponent(iabContent[key])
-      str.push(''.concat(key, ':', value))
+  const transformObjToParam = (obj = {}, extraKey = '') => {
+    for (const key in obj) {
+      if ((arrKeys.indexOf(key) !== -1 && Array.isArray(obj[key]))) {
+        // Array of defined keyword which have to be joined into one value from "key: [value1, value2, value3]" to "key:value1|value2|value3"
+        str.push(''.concat(key, ':', obj[key].map(node => encodeURIComponent(node)).join('|')))
+      } else if (typeof obj[key] !== 'object') {
+        str.push(''.concat(extraKey + key, ':', encodeURIComponent(obj[key])))
+      } else {
+        // Object has to be further flattened
+        transformObjToParam(obj[key], ''.concat(extraKey, key, '.'));
+      }
     }
-  }
-  return encodeURIComponent(str.join(','))
+    return str.join(',');
+  };
+  return encodeURIComponent(transformObjToParam(iabContent))
 }
 
 /**
@@ -452,7 +469,7 @@ function extractSizes(bid) {
  *
  * @param {Object} bid
  * @param {string[]} sizes
- * @returns The floor CPM of a matched rule based on the rule selection process (mediaType, size and currency),
+ * @returns The floor CPM in cents of a matched rule based on the rule selection process (mediaType, size and currency),
  *          using the getFloor() inputs. Multi sizes and unsupported media types will default to '*'
  */
 function getBidFloor(bid, sizes) {
@@ -464,10 +481,10 @@ function getBidFloor(bid, sizes) {
   const floor = bid.getFloor({
     currency: CURRENCY_CODE,
     mediaType: mediaType !== undefined && spec.supportedMediaTypes.includes(mediaType) ? mediaType : '*',
-    size: sizes.length !== 1 ? '*' : extractSizes(sizes)
+    size: sizes.length !== 1 ? '*' : sizes[0].split(DIMENSION_SIGN)
   });
   if (floor.currency === CURRENCY_CODE) {
-    return floor.floor;
+    return (floor.floor * 100).toFixed(0);
   }
   return undefined;
 }

package/modules/yieldliftBidAdapter.js

@@ -2,9 +2,9 @@ import {deepSetValue, logInfo, deepAccess} from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER} from '../src/mediaTypes.js';
 
-const ENDPOINT_URL = 'https://x.yieldlift.com/auction';
+const ENDPOINT_URL = 'https://x.yieldlift.com/pbjs';
 
-const DEFAULT_BID_TTL = 30;
+const DEFAULT_BID_TTL = 300;
 const DEFAULT_CURRENCY = 'USD';
 const DEFAULT_NET_REVENUE = true;
 
@@ -98,7 +98,7 @@ export const spec = {
           width: bid.w,
           height: bid.h,
           ad: bid.adm,
-          ttl: DEFAULT_BID_TTL,
+          ttl: typeof bid.exp === 'number' ? bid.exp : DEFAULT_BID_TTL,
           creativeId: bid.crid,
           netRevenue: DEFAULT_NET_REVENUE,
           currency: DEFAULT_CURRENCY,