prebid.js 7.40.0 → 7.41.0

package/modules/yandexBidAdapter.js

@@ -1,17 +1,50 @@
-import { formatQS, deepAccess, triggerPixel, isArray, isNumber } from '../src/utils.js';
+import { formatQS, deepAccess, triggerPixel, _each, _map } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
-import { BANNER } from '../src/mediaTypes.js'
+import { BANNER, NATIVE } from '../src/mediaTypes.js'
+import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
 
 const BIDDER_CODE = 'yandex';
-const BIDDER_URL = 'https://bs.yandex.ru/metadsp';
+const BIDDER_URL = 'https://bs.yandex.ru/prebid';
 const DEFAULT_TTL = 180;
 const DEFAULT_CURRENCY = 'EUR';
+const SUPPORTED_MEDIA_TYPES = [ BANNER, NATIVE ];
 const SSP_ID = 10500;
 
+const IMAGE_ASSET_TYPES = {
+  ICON: 1,
+  IMAGE: 3,
+};
+const DATA_ASSET_TYPES = {
+  TITLE: 0,
+  SPONSORED: 1,
+  DESC: 2,
+  RATING: 3,
+  LIKES: 4,
+  ADDRESS: 9,
+  DESC2: 10,
+  DISPLAY_URL: 11,
+  CTA_TEXT: 12,
+  E_504: 504,
+};
+export const NATIVE_ASSETS = {
+  title: [1, DATA_ASSET_TYPES.TITLE],
+  body: [2, DATA_ASSET_TYPES.DESC],
+  body2: [3, DATA_ASSET_TYPES.DESC2],
+  sponsoredBy: [4, DATA_ASSET_TYPES.SPONSORED],
+  icon: [5, IMAGE_ASSET_TYPES.ICON],
+  image: [6, IMAGE_ASSET_TYPES.IMAGE],
+  displayUrl: [7, DATA_ASSET_TYPES.DISPLAY_URL],
+  cta: [8, DATA_ASSET_TYPES.CTA_TEXT],
+  rating: [9, DATA_ASSET_TYPES.RATING],
+  likes: [10, DATA_ASSET_TYPES.LIKES],
+}
+const NATIVE_ASSETS_IDS = {};
+_each(NATIVE_ASSETS, (asset, key) => { NATIVE_ASSETS_IDS[asset[0]] = key });
+
 export const spec = {
   code: BIDDER_CODE,
   aliases: ['ya'], // short code
-  supportedMediaTypes: [ BANNER ],
+  supportedMediaTypes: SUPPORTED_MEDIA_TYPES,
 
   isBidRequestValid: function(bid) {
     const { params } = bid;
@@ -22,13 +55,11 @@ export const spec = {
     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]);
+    return true;
   },
 
   buildRequests: function(validBidRequests, bidderRequest) {
-    const gdprApplies = deepAccess(bidderRequest, 'gdprConsent.gdprApplies');
-    const consentString = deepAccess(bidderRequest, 'gdprConsent.consentString');
+    validBidRequests = convertOrtbRequestToProprietaryNative(validBidRequests);
 
     let referrer = '';
     let domain = '';
@@ -48,9 +79,6 @@ export const spec = {
     return validBidRequests.map((bidRequest) => {
       const { params } = bidRequest;
       const { targetRef, withCredentials = true } = params;
-      const sizes = bidRequest.mediaTypes.banner.sizes;
-      const size = sizes[0];
-      const [ w, h ] = size;
 
       const { pageId, impId } = extractPlacementIds(params);
 
@@ -59,28 +87,24 @@ export const spec = {
         'target-ref': targetRef || domain,
         'ssp-id': SSP_ID,
       };
-      if (gdprApplies !== undefined) {
+
+      const gdprApplies = Boolean(deepAccess(bidderRequest, 'gdprConsent.gdprApplies'));
+      if (gdprApplies) {
+        const consentString = deepAccess(bidderRequest, 'gdprConsent.consentString');
         queryParams['gdpr'] = 1;
         queryParams['tcf-consent'] = consentString;
       }
 
       const imp = {
         id: impId,
-        banner: {
-          format: sizes,
-          w,
-          h,
-        }
+        banner: mapBanner(bidRequest),
+        native: mapNative(bidRequest),
       };
 
-      if (bidRequest.getFloor) {
-        const floorInfo = bidRequest.getFloor({
-          currency: DEFAULT_CURRENCY,
-          size
-        });
-
-        imp.bidfloor = floorInfo.floor;
-        imp.bidfloorcur = floorInfo.currency;
+      const bidfloor = getBidfloor(bidRequest);
+      if (bidfloor) {
+        imp.bidfloor = bidfloor.floor;
+        imp.bidfloorcur = bidfloor.currency;
       }
 
       const queryParamsString = formatQS(queryParams);
@@ -91,8 +115,9 @@ export const spec = {
           id: bidRequest.bidId,
           imp: [imp],
           site: {
-            ref_url: referrer,
-            page_url: page,
+            ref: referrer,
+            page,
+            domain,
           },
           tmax: timeout,
         },
@@ -104,58 +129,27 @@ export const spec = {
     });
   },
 
-  interpretResponse: function(serverResponse, {bidRequest}) {
-    let response = serverResponse.body;
-    if (!response.seatbid) {
-      return [];
-    }
-
-    const { cur, seatbid } = serverResponse.body;
-    const rtbBids = seatbid
-      .map(seatbid => seatbid.bid)
-      .reduce((a, b) => a.concat(b), []);
-
-    return rtbBids.map(rtbBid => {
-      let prBid = {
-        requestId: bidRequest.bidId,
-        cpm: rtbBid.price,
-        currency: cur || DEFAULT_CURRENCY,
-        width: rtbBid.w,
-        height: rtbBid.h,
-        creativeId: rtbBid.adid,
-        nurl: rtbBid.nurl,
-
-        netRevenue: true,
-        ttl: DEFAULT_TTL,
-
-        meta: {
-          advertiserDomains: rtbBid.adomain && rtbBid.adomain.length > 0 ? rtbBid.adomain : [],
-        }
-      };
-
-      prBid.ad = rtbBid.adm;
-
-      return prBid;
-    });
-  },
+  interpretResponse: interpretResponse,
 
   onBidWon: function (bid) {
     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)
-    ;
+    let cpm, currency;
+    if (bid.hasOwnProperty('originalCurrency') && bid.hasOwnProperty('originalCpm')) {
+      cpm = bid.originalCpm;
+      currency = bid.originalCurrency;
+    } else {
+      cpm = bid.cpm;
+      currency = bid.currency;
+    }
+    cpm = deepAccess(bid, 'adserverTargeting.hb_pb') || cpm;
 
-    triggerPixel(nurl);
+    const pixel = replaceAuctionPrice(nurl, cpm, currency);
+    triggerPixel(pixel);
   }
 }
 
@@ -193,4 +187,198 @@ function extractPlacementIds(bidRequestParams) {
   return result;
 }
 
+function getBidfloor(bidRequest) {
+  const floors = [];
+
+  if (typeof bidRequest.getFloor === 'function') {
+    SUPPORTED_MEDIA_TYPES.forEach(type => {
+      if (bidRequest.hasOwnProperty(type)) {
+        const floorInfo = bidRequest.getFloor({
+          currency: DEFAULT_CURRENCY,
+          mediaType: type,
+          size: bidRequest.sizes || '*' }
+        )
+        floors.push(floorInfo);
+      }
+    });
+  }
+
+  return floors.sort((a, b) => b.floor - a.floor)[0];
+}
+
+function mapBanner(bidRequest) {
+  if (deepAccess(bidRequest, 'mediaTypes.banner')) {
+    const sizes = bidRequest.sizes || bidRequest.mediaTypes.banner.sizes;
+    const format = sizes.map((size) => ({
+      w: size[0],
+      h: size[1],
+    }));
+    const { w, h } = format[0];
+
+    return {
+      format,
+      w,
+      h,
+    }
+  }
+}
+
+function mapNative(bidRequest) {
+  const adUnitNativeAssets = deepAccess(bidRequest, 'mediaTypes.native');
+  if (adUnitNativeAssets) {
+    const assets = [];
+
+    Object.keys(adUnitNativeAssets).forEach((assetCode) => {
+      if (NATIVE_ASSETS.hasOwnProperty(assetCode)) {
+        const nativeAsset = NATIVE_ASSETS[assetCode];
+        const adUnitAssetParams = adUnitNativeAssets[assetCode];
+        const asset = mapAsset(assetCode, adUnitAssetParams, nativeAsset);
+        assets.push(asset);
+      }
+    });
+
+    return {
+      ver: 1.1,
+      request: JSON.stringify({
+        ver: 1.1,
+        assets
+      }),
+    };
+  }
+}
+
+function mapAsset(assetCode, adUnitAssetParams, nativeAsset) {
+  const [ nativeAssetId, nativeAssetType ] = nativeAsset;
+  const asset = {
+    id: nativeAssetId,
+  };
+
+  if (adUnitAssetParams.required) {
+    asset.required = 1;
+  }
+
+  if (assetCode === 'title') {
+    asset.title = {
+      len: adUnitAssetParams.len || 25,
+    };
+  } else if (assetCode === 'image' || assetCode === 'icon') {
+    asset.img = mapImageAsset(adUnitAssetParams, nativeAssetType);
+  } else {
+    asset.data = {
+      type: nativeAssetType,
+      len: adUnitAssetParams.len,
+    };
+  }
+
+  return asset;
+}
+
+function mapImageAsset(adUnitImageAssetParams, nativeAssetType) {
+  const img = {
+    type: nativeAssetType,
+  };
+
+  if (adUnitImageAssetParams.aspect_ratios) {
+    const ratio = adUnitImageAssetParams.aspect_ratios[0];
+    const minWidth = ratio.min_width || 100;
+
+    img.wmin = minWidth;
+    img.hmin = (minWidth / ratio.ratio_width * ratio.ratio_height);
+  }
+
+  if (adUnitImageAssetParams.sizes) {
+    const size = Array.isArray(adUnitImageAssetParams.sizes[0]) ? adUnitImageAssetParams.sizes[0] : adUnitImageAssetParams.sizes;
+    img.w = size[0];
+    img.h = size[1];
+  }
+
+  return img;
+}
+
+function interpretResponse(serverResponse, { bidRequest }) {
+  let response = serverResponse.body;
+  if (!response.seatbid) {
+    return [];
+  }
+  const { seatbid, cur } = serverResponse.body;
+  const bidsReceived = seatbid
+    .map(seatbid => seatbid.bid)
+    .reduce((a, b) => a.concat(b), []);
+
+  const currency = cur || DEFAULT_CURRENCY;
+
+  return bidsReceived.map(bidReceived => {
+    const price = bidReceived.price;
+    let prBid = {
+      requestId: bidRequest.bidId,
+      cpm: price,
+      currency: currency,
+      width: bidReceived.w,
+      height: bidReceived.h,
+      creativeId: bidReceived.adid,
+      nurl: bidReceived.nurl,
+
+      netRevenue: true,
+      ttl: DEFAULT_TTL,
+
+      meta: {
+        advertiserDomains: bidReceived.adomain && bidReceived.adomain.length > 0 ? bidReceived.adomain : [],
+      }
+    };
+
+    if (bidReceived.adm.indexOf('{') === 0) {
+      prBid.mediaType = NATIVE;
+      prBid.native = interpretNativeAd(bidReceived, price, currency);
+    } else {
+      prBid.mediaType = BANNER;
+      prBid.ad = bidReceived.adm;
+    }
+
+    return prBid;
+  });
+}
+
+function interpretNativeAd(bidReceived, price, currency) {
+  try {
+    const { adm } = bidReceived;
+    const { native } = JSON.parse(adm);
+
+    const result = {
+      clickUrl: native.link.url,
+    };
+
+    native.assets.forEach(asset => {
+      const assetCode = NATIVE_ASSETS_IDS[asset.id];
+      if (!assetCode) {
+        return;
+      }
+      if (assetCode === 'image' || assetCode === 'icon') {
+        result[assetCode] = {
+          url: asset.img.url,
+          width: asset.img.w,
+          height: asset.img.h
+        };
+      } else if (assetCode === 'title') {
+        result[assetCode] = asset.title.text;
+      } else {
+        result[assetCode] = asset.data.value;
+      }
+    });
+
+    result.impressionTrackers = _map(native.imptrackers, (tracker) =>
+      replaceAuctionPrice(tracker, price, currency)
+    );
+
+    return result;
+  } catch (e) {}
+}
+
+function replaceAuctionPrice(url, price, currency) {
+  if (!url) return;
+
+  return url
+    .replace(/\${AUCTION_PRICE}/, price)
+    .replace(/\${AUCTION_CURRENCY}/, currency);
+}
+
 registerBidder(spec);

package/modules/yandexBidAdapter.md

@@ -20,21 +20,58 @@ Yandex Bidder Adapter for Prebid.js.
 
 # Test Parameters
 
-```
-var adUnits = [{
-  code: 'banner-1',
-  mediaTypes: {
-    banner: {
-      sizes: [[240, 400], [300, 600]],
-    }
+```javascript
+var adUnits = [
+  { // banner
+    code: 'banner-1',
+    mediaTypes: {
+      banner: {
+        sizes: [[240, 400], [300, 600]],
+      }
+    },
+    bids: [
+      {
+        bidder: 'yandex',
+        params: {
+          placementId: '346580-1'
+        },
+      }
+    ],
   },
-  bids: [{
-    {
-      bidder: 'yandex',
-      params: {
-        placementId: '346580-1'
+  { // native
+    code: 'banner-2',
+    mediaTypes: {
+      native: {
+        title: {
+          required: true,
+          len: 25
+        },
+        image: {
+          required: true,
+          sizes: [300, 250],
+        },
+        icon: {
+          sizes: [32, 32],
+        },
+        body: {
+          len: 90
+        },
+        body2: {
+          len: 90
+        },
+        sponsoredBy: {
+          len: 25,
+        }
       },
-    }
-  }]
-}];
+    },
+    bids: [
+      {
+        bidder: 'yandex',
+        params: {
+          placementId: '346580-1'
+        },
+      }
+    ],
+  },
+];
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prebid.js",
-  "version": "7.40.0",
+  "version": "7.41.0",
   "description": "Header Bidding Management Library",
   "main": "src/prebid.js",
   "scripts": {

package/src/videoCache.js

@@ -9,8 +9,8 @@
  * This trickery helps integrate with ad servers, which set character limits on request params.
  */
 
-import { ajax } from './ajax.js';
-import { config } from './config.js';
+import {ajaxBuilder} from './ajax.js';
+import {config} from './config.js';
 import {auctionManager} from './auctionManager.js';
 
 /**
@@ -142,11 +142,11 @@ function shimStorageCallback(done) {
  * @param {videoCacheStoreCallback} [done] An optional callback which should be executed after
  * the data has been stored in the cache.
  */
-export function store(bids, done) {
+export function store(bids, done, getAjax = ajaxBuilder) {
   const requestData = {
     puts: bids.map(toStorageRequest)
   };
-
+  const ajax = getAjax(config.getConfig('cache.timeout'));
   ajax(config.getConfig('cache.url'), shimStorageCallback(done), JSON.stringify(requestData), {
     contentType: 'text/plain',
     withCredentials: true