prebid.js 7.33.0 → 7.35.0

package/modules/seedingAllianceBidAdapter.js

@@ -2,120 +2,111 @@
 'use strict';
 
 import { registerBidder } from '../src/adapters/bidderFactory.js';
-import { NATIVE } from '../src/mediaTypes.js';
-import { _map, deepSetValue, isEmpty, deepAccess } from '../src/utils.js';
+import { NATIVE, BANNER } from '../src/mediaTypes.js';
+import { _map, isArray, isEmpty, deepSetValue, replaceAuctionPrice } from '../src/utils.js';
 import { config } from '../src/config.js';
 import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
 
-const BIDDER_CODE = 'seedingAlliance';
 const GVL_ID = 371;
+const BIDDER_CODE = 'seedingAlliance';
 const DEFAULT_CUR = 'EUR';
 const ENDPOINT_URL = 'https://b.nativendo.de/cds/rtb/bid?format=openrtb2.5&ssp=pb';
 
-const NATIVE_ASSET_IDS = {0: 'title', 1: 'body', 2: 'sponsoredBy', 3: 'image', 4: 'cta', 5: 'icon'};
+const NATIVE_ASSET_IDS = { 0: 'title', 1: 'body', 2: 'sponsoredBy', 3: 'image', 4: 'cta', 5: 'icon' };
 
 const NATIVE_PARAMS = {
-  title: {
-    id: 0,
-    name: 'title'
-  },
-
-  body: {
-    id: 1,
-    name: 'data',
-    type: 2
-  },
-
-  sponsoredBy: {
-    id: 2,
-    name: 'data',
-    type: 1
-  },
-
-  image: {
-    id: 3,
-    type: 3,
-    name: 'img'
-  },
-
-  cta: {
-    id: 4,
-    type: 12,
-    name: 'data'
-  },
-
-  icon: {
-    id: 5,
-    type: 1,
-    name: 'img'
-  }
+  title: { id: 0, name: 'title' },
+  body: { id: 1, name: 'data', type: 2 },
+  sponsoredBy: { id: 2, name: 'data', type: 1 },
+  image: { id: 3, type: 3, name: 'img' },
+  cta: { id: 4, type: 12, name: 'data' },
+  icon: { id: 5, type: 1, name: 'img' }
 };
 
 export const spec = {
   code: BIDDER_CODE,
-
   gvlid: GVL_ID,
+  supportedMediaTypes: [NATIVE, BANNER],
 
-  supportedMediaTypes: [NATIVE],
-
-  isBidRequestValid: function(bid) {
+  isBidRequestValid: function (bid) {
     return !!bid.params.adUnitId;
   },
 
-  buildRequests: (validBidRequests, bidderRequest) => {
+  buildRequests: (validBidRequests = [], bidderRequest) => {
     // convert Native ORTB definition to old-style prebid native definition
     validBidRequests = convertOrtbRequestToProprietaryNative(validBidRequests);
 
-    const pt = setOnAny(validBidRequests, 'params.pt') || setOnAny(validBidRequests, 'params.priceType') || 'net';
-    const tid = bidderRequest.auctionId;
-    const cur = [config.getConfig('currency.adServerCurrency') || DEFAULT_CUR];
     let url = bidderRequest.refererInfo.page;
 
-    const imp = validBidRequests.map((bid, id) => {
-      const assets = _map(bid.nativeParams, (bidParams, key) => {
-        const props = NATIVE_PARAMS[key];
-
-        const asset = {
-          required: bidParams.required & 1
-        };
+    const imps = validBidRequests.map((bidRequest, id) => {
+      const imp = {
+        id: String(id + 1),
+        tagid: bidRequest.params.adUnitId
+      };
 
-        if (props) {
-          asset.id = props.id;
+      /**
+       * Native Ad
+       */
+      if (bidRequest.nativeParams) {
+        const assets = _map(bidRequest.nativeParams, (nativeAsset, key) => {
+          const props = NATIVE_PARAMS[key];
+
+          if (props) {
+            let wmin, hmin, w, h;
+            let aRatios = nativeAsset.aspect_ratios;
+
+            if (aRatios && aRatios[0]) {
+              aRatios = aRatios[0];
+              wmin = aRatios.min_width || 0;
+              hmin = aRatios.ratio_height * wmin / aRatios.ratio_width | 0;
+            }
 
-          let w, h;
+            if (nativeAsset.sizes) {
+              const sizes = flatten(nativeAsset.sizes);
+              w = parseInt(sizes[0], 10);
+              h = parseInt(sizes[1], 10);
+            }
 
-          if (bidParams.sizes) {
-            w = bidParams.sizes[0];
-            h = bidParams.sizes[1];
+            const asset = {
+              id: props.id,
+              required: nativeAsset.required & 1
+            };
+
+            asset[props.name] = {
+              len: nativeAsset.len,
+              type: props.type,
+              wmin,
+              hmin,
+              w,
+              h
+            };
+
+            return asset;
+          } else {
+            // TODO Filter impressions with required assets we don't support
           }
+        }).filter(Boolean);
 
-          asset[props.name] = {
-            len: bidParams.len,
-            type: props.type,
-            w,
-            h
-          };
+        imp.native = {
+          request: {
+            assets
+          }
+        };
+      } else {
+        let sizes = transformSizes(bidRequest.sizes);
 
-          return asset;
+        imp.banner = {
+          format: sizes,
+          w: sizes[0] ? sizes[0].w : 0,
+          h: sizes[0] ? sizes[0].h : 0
         }
-      })
-        .filter(Boolean);
+      }
 
-      if (bid.params.url) {
-        url = bid.params.url;
+      if (bidRequest.params.url) {
+        url = bidRequest.params.url;
       }
 
-      return {
-        id: String(id + 1),
-        tagid: bid.params.adUnitId,
-        tid: tid,
-        pt: pt,
-        native: {
-          request: {
-            assets
-          }
-        }
-      };
+      return imp;
     });
 
     const request = {
@@ -123,12 +114,9 @@ export const spec = {
       site: {
         page: url
       },
-      device: {
-        ua: navigator.userAgent
-      },
-      cur,
-      imp,
-      user: {},
+      cur: [config.getConfig('currency.adServerCurrency') || DEFAULT_CUR],
+      imp: imps,
+      tmax: bidderRequest.timeout,
       regs: {
         ext: {
           gdpr: 0,
@@ -137,23 +125,22 @@ export const spec = {
       }
     };
 
-    if (bidderRequest && bidderRequest.gdprConsent) {
+    if (bidderRequest.gdprConsent) {
+      request.user = {};
+
       deepSetValue(request, 'user.ext.consent', bidderRequest.gdprConsent.consentString);
       deepSetValue(request, 'regs.ext.gdpr', (typeof bidderRequest.gdprConsent.gdprApplies === 'boolean' && bidderRequest.gdprConsent.gdprApplies) ? 1 : 0);
     }
 
     return {
       method: 'POST',
-      url: ENDPOINT_URL,
+      url: config.getConfig('seedingAlliance.endpoint') || ENDPOINT_URL,
       data: JSON.stringify(request),
-      options: {
-        contentType: 'application/json'
-      },
-      bids: validBidRequests
+      bidRequests: validBidRequests
     };
   },
 
-  interpretResponse: function(serverResponse, { bids }) {
+  interpretResponse: function (serverResponse, { bidRequests }) {
     if (isEmpty(serverResponse.body)) {
       return [];
     }
@@ -165,35 +152,72 @@ export const spec = {
       return result;
     }, []) : [];
 
-    return bids
-      .map((bid, id) => {
+    return bidRequests
+      .map((bidRequest, id) => {
         const bidResponse = bidResponses[id];
 
+        const type = bidRequest.nativeParams ? NATIVE : BANNER;
+
         if (bidResponse) {
-          return {
-            requestId: bid.bidId,
+          const bidObject = {
+            requestId: bidRequest.bidId, // TODO get this value from response?
             cpm: bidResponse.price,
             creativeId: bidResponse.crid,
-            ttl: 1000,
-            netRevenue: (!bid.netRevenue || bid.netRevenue === 'net'),
+            ttl: 600,
+            netRevenue: true,
             currency: cur,
-            mediaType: NATIVE,
+            mediaType: type,
             bidderCode: BIDDER_CODE,
-            native: parseNative(bidResponse),
             meta: {
               advertiserDomains: bidResponse.adomain && bidResponse.adomain.length > 0 ? bidResponse.adomain : []
             }
           };
+
+          if (type === NATIVE) {
+            bidObject.native = parseNative(bidResponse);
+            bidObject.mediaType = NATIVE;
+          }
+
+          if (type === BANNER) {
+            bidObject.ad = replaceAuctionPrice(bidResponse.adm, bidResponse.price);
+            bidObject.width = bidResponse.w;
+            bidObject.height = bidResponse.h;
+            bidObject.mediaType = BANNER;
+          }
+
+          return bidObject;
         }
       })
       .filter(Boolean);
   }
 };
 
-registerBidder(spec);
+function transformSizes(requestSizes) {
+  if (!isArray(requestSizes)) {
+    return [];
+  }
+
+  if (requestSizes.length === 2 && !isArray(requestSizes[0])) {
+    return [{
+      w: parseInt(requestSizes[0], 10),
+      h: parseInt(requestSizes[1], 10)
+    }];
+  } else if (isArray(requestSizes[0])) {
+    return requestSizes.map(item => ({
+      w: parseInt(item[0], 10),
+      h: parseInt(item[1], 10)
+    }));
+  }
+
+  return [];
+}
+
+function flatten(arr) {
+  return [].concat(...arr);
+}
 
 function parseNative(bid) {
-  const {assets, link, imptrackers} = bid.adm.native;
+  const { assets, link, imptrackers } = bid.adm.native;
 
   let clickUrl = link.url.replace(/\$\{AUCTION_PRICE\}/g, bid.price);
 
@@ -228,15 +252,4 @@ function parseNative(bid) {
   return result;
 }
 
-function setOnAny(collection, key) {
-  for (let i = 0, result; i < collection.length; i++) {
-    result = deepAccess(collection[i], key);
-    if (result) {
-      return result;
-    }
-  }
-}
-
-function flatten(arr) {
-  return [].concat(...arr);
-}
+registerBidder(spec);

package/modules/smartadserverBidAdapter.js

@@ -13,6 +13,7 @@ export const spec = {
   gvlid: GVL_ID,
   aliases: ['smart'], // short code
   supportedMediaTypes: [BANNER, VIDEO],
+
   /**
    * Determines whether or not the given bid request is valid.
    *
@@ -131,7 +132,6 @@ export const spec = {
    */
   buildRequests: function (validBidRequests, bidderRequest) {
     // use bidderRequest.bids[] to get bidder-dependent request info
-
     const adServerCurrency = config.getConfig('currency.adServerCurrency');
     const sellerDefinedAudience = deepAccess(bidderRequest, 'ortb2.user.data', config.getAnyConfig('ortb2.user.data'));
     const sellerDefinedContext = deepAccess(bidderRequest, 'ortb2.site.content.data', config.getAnyConfig('ortb2.site.content.data'));
@@ -144,7 +144,6 @@ export const spec = {
         pageid: bid.params.pageId,
         formatid: bid.params.formatId,
         currencyCode: adServerCurrency,
-        bidfloor: bid.params.bidfloor || spec.getBidFloor(bid, adServerCurrency),
         targeting: bid.params.target && bid.params.target !== '' ? bid.params.target : undefined,
         buid: bid.params.buId && bid.params.buId !== '' ? bid.params.buId : undefined,
         appname: bid.params.appName && bid.params.appName !== '' ? bid.params.appName : undefined,
@@ -161,10 +160,21 @@ export const spec = {
         sdc: sellerDefinedContext
       };
 
-      if (bidderRequest && bidderRequest.gdprConsent) {
-        payload.addtl_consent = bidderRequest.gdprConsent.addtlConsent;
-        payload.gdpr_consent = bidderRequest.gdprConsent.consentString;
-        payload.gdpr = bidderRequest.gdprConsent.gdprApplies; // we're handling the undefined case server side
+      if (bidderRequest) {
+        if (bidderRequest.gdprConsent) {
+          payload.addtl_consent = bidderRequest.gdprConsent.addtlConsent;
+          payload.gdpr_consent = bidderRequest.gdprConsent.consentString;
+          payload.gdpr = bidderRequest.gdprConsent.gdprApplies; // we're handling the undefined case server side
+        }
+
+        if (bidderRequest.gppConsent) {
+          payload.gpp = bidderRequest.gppConsent.gppString;
+          payload.gpp_sid = bidderRequest.gppConsent.applicableSections;
+        }
+
+        if (bidderRequest.uspConsent) {
+          payload.us_privacy = bidderRequest.uspConsent;
+        }
       }
 
       if (bid && bid.userId) {
@@ -175,24 +185,28 @@ export const spec = {
         payload.us_privacy = bidderRequest.uspConsent;
       }
 
-      const videoMediaType = deepAccess(bid, 'mediaTypes.video');
       const bannerMediaType = deepAccess(bid, 'mediaTypes.banner');
-      const isAdUnitContainingVideo = videoMediaType && (videoMediaType.context === 'instream' || videoMediaType.context === 'outstream');
-      if (!isAdUnitContainingVideo && bannerMediaType) {
-        payload.sizes = spec.adaptBannerSizes(bannerMediaType.sizes);
-        bidRequests.push(spec.createServerRequest(payload, bid.params.domain));
-      } else if (isAdUnitContainingVideo && !bannerMediaType) {
-        spec.fillPayloadForVideoBidRequest(payload, videoMediaType, bid.params.video);
-        bidRequests.push(spec.createServerRequest(payload, bid.params.domain));
-      } else if (isAdUnitContainingVideo && bannerMediaType) {
-        // If there are video and banner media types in the ad unit, we clone the payload
-        // to create a specific one for video.
-        let videoPayload = deepClone(payload);
+      const videoMediaType = deepAccess(bid, 'mediaTypes.video');
+      const isSupportedVideoContext = videoMediaType && (videoMediaType.context === 'instream' || videoMediaType.context === 'outstream');
+
+      if (bannerMediaType || isSupportedVideoContext) {
+        let type;
+        if (bannerMediaType) {
+          type = BANNER;
+          payload.sizes = spec.adaptBannerSizes(bannerMediaType.sizes);
 
-        spec.fillPayloadForVideoBidRequest(videoPayload, videoMediaType, bid.params.video);
-        bidRequests.push(spec.createServerRequest(videoPayload, bid.params.domain));
+          if (isSupportedVideoContext) {
+            let videoPayload = deepClone(payload);
+            spec.fillPayloadForVideoBidRequest(videoPayload, videoMediaType, bid.params.video);
+            videoPayload.bidfloor = bid.params.bidfloor || spec.getBidFloor(bid, adServerCurrency, VIDEO);
+            bidRequests.push(spec.createServerRequest(videoPayload, bid.params.domain));
+          }
+        } else {
+          type = VIDEO;
+          spec.fillPayloadForVideoBidRequest(payload, videoMediaType, bid.params.video);
+        }
 
-        payload.sizes = spec.adaptBannerSizes(bannerMediaType.sizes);
+        payload.bidfloor = bid.params.bidfloor || spec.getBidFloor(bid, adServerCurrency, type);
         bidRequests.push(spec.createServerRequest(payload, bid.params.domain));
       } else {
         bidRequests.push({});
@@ -253,24 +267,21 @@ export const spec = {
    *
    * @param {object} bid Bid request object
    * @param {string} currency Ad server currency
+   * @param {string} mediaType Bid media type
    * @return {number} Floor price
    */
-  getBidFloor: function (bid, currency) {
+  getBidFloor: function (bid, currency, mediaType) {
     if (!isFn(bid.getFloor)) {
       return DEFAULT_FLOOR;
     }
 
     const floor = bid.getFloor({
       currency: currency || 'USD',
-      mediaType: '*',
+      mediaType,
       size: '*'
     });
 
-    if (isPlainObject(floor) && !isNaN(floor.floor)) {
-      return floor.floor;
-    }
-
-    return DEFAULT_FLOOR;
+    return isPlainObject(floor) && !isNaN(floor.floor) ? floor.floor : DEFAULT_FLOOR;
   },
 
   /**

package/modules/smartyadsBidAdapter.md

@@ -10,6 +10,15 @@ Maintainer: supply@smartyads.com
 
 Module that connects to SmartyAds' demand sources
 
+# Parameters
+
+| Name          | Scope    | Description               | Example              |
+| :------------ | :------- | :------------------------ | :------------------- |
+| `sourceid`  | required (for prebid.js)     | placement ID | "0" |
+| `host`      | required (for prebid-server) | const value, set to "prebid" | "prebid" |
+| `accountid` | required (for prebid-server) | partner ID | "1901" |
+| `traffic`   | optional (for prebid.js)     | Configures the mediaType that should be used. Values can be banner, native or video | "banner" |
+
 # Test Parameters
 ```
     var adUnits = [

package/modules/smartytechBidAdapter.js

@@ -1,29 +1,77 @@
+import {buildUrl, deepAccess} from '../src/utils.js'
+import { BANNER, VIDEO } from '../src/mediaTypes.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
-import {buildUrl} from '../src/utils.js'
 
 const BIDDER_CODE = 'smartytech';
 export const ENDPOINT_PROTOCOL = 'https';
 export const ENDPOINT_DOMAIN = 'server.smartytech.io';
-export const ENDPOINT_PATH = '/hb/bidder';
+export const ENDPOINT_PATH = '/hb/v2/bidder';
 
 export const spec = {
+  supportedMediaTypes: [ BANNER, VIDEO ],
   code: BIDDER_CODE,
 
   isBidRequestValid: function (bidRequest) {
-    return !!parseInt(bidRequest.params.endpointId);
+    return (
+      !!parseInt(bidRequest.params.endpointId) &&
+      spec._validateBanner(bidRequest) &&
+      spec._validateVideo(bidRequest)
+    );
+  },
+
+  _validateBanner: function(bidRequest) {
+    const bannerAdUnit = deepAccess(bidRequest, 'mediaTypes.banner');
+
+    if (bannerAdUnit === undefined) {
+      return true;
+    }
+
+    if (!Array.isArray(bannerAdUnit.sizes)) {
+      return false;
+    }
+
+    return true;
+  },
+
+  _validateVideo: function(bidRequest) {
+    const videoAdUnit = deepAccess(bidRequest, 'mediaTypes.video');
+
+    if (videoAdUnit === undefined) {
+      return true;
+    }
+
+    if (!Array.isArray(videoAdUnit.playerSize)) {
+      return false;
+    }
+
+    if (!videoAdUnit.context) {
+      return false;
+    }
+
+    return true;
   },
 
   buildRequests: function (validBidRequests, bidderRequest) {
     const referer = bidderRequest?.refererInfo?.page || window.location.href;
 
     const bidRequests = validBidRequests.map((validBidRequest) => {
-      return {
+      let video = deepAccess(validBidRequest, 'mediaTypes.video', false);
+      let banner = deepAccess(validBidRequest, 'mediaTypes.banner', false);
+
+      let oneRequest = {
         endpointId: validBidRequest.params.endpointId,
         adUnitCode: validBidRequest.adUnitCode,
-        sizes: validBidRequest.sizes,
-        bidId: validBidRequest.bidId,
-        referer: referer
+        referer: referer,
+        bidId: validBidRequest.bidId
       };
+
+      if (video) {
+        oneRequest.video = video;
+      } else if (banner) {
+        oneRequest.banner = banner;
+      }
+
+      return oneRequest
     });
 
     let adPartnerRequestUrl = buildUrl({
@@ -55,12 +103,14 @@ export const spec = {
         bid: validBids.find(b => b.adUnitCode === key),
         response: responseBody[key]
       }
-    }).map(item => spec.adResponse(item.bid.bidId, item.response));
+    }).map(item => spec._adResponse(item.bid, item.response));
   },
 
-  adResponse: function (requestId, response) {
+  _adResponse: function (request, response) {
     const bidObject = {
-      requestId,
+      requestId: request.bidId,
+      adUnitCode: request.adUnitCode,
+      bidderCode: BIDDER_CODE,
       ad: response.ad,
       cpm: response.cpm,
       width: response.width,
@@ -69,7 +119,14 @@ export const spec = {
       creativeId: response.creativeId,
       netRevenue: true,
       currency: response.currency,
+      mediaType: BANNER
     }
+
+    if (response.mediaType === VIDEO) {
+      bidObject.vastXml = response.ad;
+      bidObject.mediaType = VIDEO;
+    }
+
     return bidObject;
   },
 

package/modules/smartytechBidAdapter.md

@@ -1,44 +1,55 @@
 # Overview
 
-Module Name: SmartyTech Bidder Adapter
-
-Module Type: Bidder Adapter
-
+```
+Module Name:  SmartyTech Bid Adapter
+Module Type:  Bidder Adapter
 Maintainer: info@adpartner.pro
+```
 
 # Description
 
-You can use this adapter to get a bid from smartytech.io.
+Connects to SmartyTech's exchange for bids.
 
-About us : https://smartytech.io
+SmartyTech bid adapter supports Banner and Video
 
-# Test Parameters
+# Sample Ad Unit: For Publishers
+## Sample Banner Ad Unit
+```
+var adUnits = [{
+    code: '/123123123/prebidjs-banner',
+    mediaTypes: {
+        banner: {
+            sizes: [
+                [300, 301],
+                [300, 250]
+            ]
+        }
+    },
+    bids: [{
+        bidder: 'smartytech',
+        params: {
+            endpointId: 12
+        }
+    }]
+}];
+```
 
-```javascript
-    var adUnits = [
-    {
-        code: 'div-smartytech-example',
-        sizes: [[300, 250]],
-        bids: [
-            {
-                bidder: "smartytech",
-                params: {
-                    endpointId: 14
-                }
-            }
-        ]
+## Sample Video Ad Unit
+```
+var videoAdUnit = {
+    code: '/123123123/video-vast-banner',
+    mediaTypes: {
+        video: {
+            context: 'instream',
+            playerSize: [640, 480],
+            mimes: ['video/mp4'],
+        }
     },
-    {
-        code: 'div-smartytech-example-2',
-        sizes: [[300, 250]],
-        bids: [
-            {
-                bidder: "smartytech",
-                params: {
-                    endpointId: 14
-                }
-            }
-        ]
-    }
-];
+    bids: [{
+        bidder: 'smartytech',
+        params: {
+            endpointId: 12
+        }
+    }]
+};
 ```