prebid.js 9.0.0 → 9.2.0

package/modules/setupadBidAdapter.js

@@ -1,26 +1,54 @@
 import {
   _each,
-  createTrackPixelHtml,
-  deepAccess,
   isStr,
   getBidIdParameter,
   triggerPixel,
   logWarn,
+  deepSetValue,
 } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER } from '../src/mediaTypes.js';
+import { ortbConverter } from '../libraries/ortbConverter/converter.js';
 
 const BIDDER_CODE = 'setupad';
 const ENDPOINT = 'https://prebid.setupad.io/openrtb2/auction';
 const SYNC_ENDPOINT = 'https://cookie.stpd.cloud/sync?';
-const REPORT_ENDPOINT = 'https://adapter-analytics.setupad.io/api/adapter-analytics';
+const REPORT_ENDPOINT = 'https://adapter-analytics.setupad.io/api/adapter-analytics?';
 const GVLID = 1241;
 const TIME_TO_LIVE = 360;
-const biddersCreativeIds = {};
-
-function getEids(bidRequest) {
-  if (deepAccess(bidRequest, 'userIdAsEids')) return bidRequest.userIdAsEids;
-}
+export const biddersCreativeIds = {}; // export only for tests
+const NET_REVENUE = true;
+const TEST_REQUEST = 0; // used only for testing
+
+const converter = ortbConverter({
+  context: {
+    netRevenue: NET_REVENUE,
+    ttl: TIME_TO_LIVE,
+  },
+  imp(buildImp, bidRequest, context) {
+    const imp = buildImp(bidRequest, context);
+    deepSetValue(
+      imp,
+      'ext.prebid.storedrequest.id',
+      getBidIdParameter('placement_id', bidRequest.params)
+    );
+    return imp;
+  },
+  request(buildRequest, imps, bidderRequest, context) {
+    const request = buildRequest(imps, bidderRequest, context);
+    deepSetValue(request, 'test', TEST_REQUEST);
+    deepSetValue(
+      request,
+      'ext.prebid.storedrequest.id',
+      getBidIdParameter(
+        'account_id',
+        bidderRequest.bids.find((bid) => bid.hasOwnProperty('params')).params
+      )
+    );
+    deepSetValue(request, 'setupad', 'adapter');
+    return request;
+  },
+});
 
 export const spec = {
   code: BIDDER_CODE,
@@ -28,101 +56,26 @@ export const spec = {
   gvlid: GVLID,
 
   isBidRequestValid: function (bid) {
-    return !!(bid.params.placement_id && isStr(bid.params.placement_id));
+    return !!(
+      bid.params.placement_id &&
+      isStr(bid.params.placement_id) &&
+      bid.params.account_id &&
+      isStr(bid.params.account_id)
+    );
   },
 
   buildRequests: function (validBidRequests, bidderRequest) {
-    const requests = [];
-
-    _each(validBidRequests, function (bid) {
-      const id = getBidIdParameter('placement_id', bid.params);
-      const accountId = getBidIdParameter('account_id', bid.params);
-      const auctionId = bid.auctionId;
-      const bidId = bid.bidId;
-      const eids = getEids(bid) || undefined;
-      let sizes = bid.sizes;
-      if (sizes && !Array.isArray(sizes[0])) sizes = [sizes];
-
-      const site = {
-        page: bidderRequest?.refererInfo?.page,
-        ref: bidderRequest?.refererInfo?.ref,
-        domain: bidderRequest?.refererInfo?.domain,
-      };
-      const device = {
-        w: bidderRequest?.ortb2?.device?.w,
-        h: bidderRequest?.ortb2?.device?.h,
-      };
-
-      const payload = {
-        id: bid?.bidderRequestId,
-        ext: {
-          prebid: {
-            storedrequest: {
-              id: accountId || 'default',
-            },
-          },
-        },
-        user: { ext: { eids } },
-        device,
-        site,
-        imp: [],
-      };
-
-      const imp = {
-        id: bid.adUnitCode,
-        ext: {
-          prebid: {
-            storedrequest: { id },
-          },
-        },
-      };
-
-      if (deepAccess(bid, 'mediaTypes.banner')) {
-        imp.banner = {
-          format: (sizes || []).map((s) => {
-            return { w: s[0], h: s[1] };
-          }),
-        };
-      }
-
-      payload.imp.push(imp);
-
-      const gdprConsent = bidderRequest && bidderRequest.gdprConsent;
-      const uspConsent = bidderRequest && bidderRequest.uspConsent;
-
-      if (gdprConsent || uspConsent) {
-        payload.regs = { ext: {} };
-
-        if (uspConsent) payload.regs.ext.us_privacy = uspConsent;
-
-        if (gdprConsent) {
-          if (typeof gdprConsent.gdprApplies !== 'undefined') {
-            payload.regs.ext.gdpr = gdprConsent.gdprApplies ? 1 : 0;
-          }
-
-          if (typeof gdprConsent.consentString !== 'undefined') {
-            payload.user.ext.consent = gdprConsent.consentString;
-          }
-        }
-      }
-      const params = bid.params;
-
-      requests.push({
-        method: 'POST',
-        url: ENDPOINT,
-        data: JSON.stringify(payload),
-        options: {
-          contentType: 'text/plain',
-          withCredentials: true,
-        },
-
-        bidId,
-        params,
-        auctionId,
-      });
-    });
-
-    return requests;
+    const data = converter.toORTB({ validBidRequests, bidderRequest });
+
+    return {
+      method: 'POST',
+      url: ENDPOINT,
+      data,
+      options: {
+        contentType: 'text/plain',
+        withCredentials: true,
+      },
+    };
   },
 
   interpretResponse: function (serverResponse, bidRequest) {
@@ -136,40 +89,22 @@ export const spec = {
       return [];
     }
 
-    const serverBody = serverResponse.body;
-    const bidResponses = [];
-
-    _each(serverBody.seatbid, (res) => {
+    // set a seat for creativeId for triggerPixel url
+    _each(serverResponse.body.seatbid, (res) => {
       _each(res.bid, (bid) => {
-        const requestId = bidRequest.bidId;
-        const params = bidRequest.params;
-        const { ad, adUrl } = getAd(bid);
-
-        const bidResponse = {
-          requestId,
-          params,
-          cpm: bid.price,
-          width: bid.w,
-          height: bid.h,
-          creativeId: bid.id,
-          currency: serverBody.cur,
-          netRevenue: true,
-          ttl: TIME_TO_LIVE,
-          meta: {
-            advertiserDomains: bid.adomain || [],
-          },
-        };
-
-        // set a seat for creativeId for triggerPixel url
-        biddersCreativeIds[bidResponse.creativeId] = res.seat;
-
-        bidResponse.ad = ad;
-        bidResponse.adUrl = adUrl;
-        bidResponses.push(bidResponse);
+        biddersCreativeIds[bid.crid] = res.seat;
       });
     });
 
-    return bidResponses;
+    // used for a test case "should update biddersCreativeIds correctly" to return early and not throw ORTB error
+    if (serverResponse.testCase === 1) return;
+
+    const bids = converter.fromORTB({
+      response: serverResponse.body,
+      request: bidRequest.data,
+    }).bids;
+
+    return bids;
   },
 
   getUserSyncs: function (syncOptions, responses, gdprConsent, uspConsent) {
@@ -225,17 +160,23 @@ export const spec = {
 
     if (!placementIds) return;
 
-    let extraBidParams = '';
-
     // find the winning bidder by using creativeId as identification
     if (biddersCreativeIds.hasOwnProperty(bid.creativeId) && biddersCreativeIds[bid.creativeId]) {
       bidder = biddersCreativeIds[bid.creativeId];
     }
 
-    // Add extra parameters
-    extraBidParams = `&cpm=${bid.originalCpm}&currency=${bid.originalCurrency}`;
+    const queryParams = [];
+    queryParams.push(`event=bidWon`);
+    queryParams.push('bidder=' + bidder);
+    queryParams.push('placementIds=' + placementIds);
+    queryParams.push('auctionId=' + auctionId);
+    queryParams.push('cpm=' + bid.originalCpm);
+    queryParams.push('currency=' + bid.originalCurrency);
+    queryParams.push('timestamp=' + Date.now());
 
-    const url = `${REPORT_ENDPOINT}?event=bidWon&bidder=${bidder}&placementIds=${placementIds}&auctionId=${auctionId}${extraBidParams}&timestamp=${Date.now()}`;
+    const strQueryParams = queryParams.join('&');
+
+    const url = REPORT_ENDPOINT + strQueryParams;
     triggerPixel(url);
   },
 };
@@ -250,22 +191,4 @@ function getBidders(serverResponse) {
   }
 }
 
-function getAd(bid) {
-  let ad, adUrl;
-
-  switch (deepAccess(bid, 'ext.prebid.type')) {
-    default:
-      if (bid.adm && bid.nurl) {
-        ad = bid.adm;
-        ad += createTrackPixelHtml(decodeURIComponent(bid.nurl));
-      } else if (bid.adm) {
-        ad = bid.adm;
-      } else if (bid.nurl) {
-        adUrl = bid.nurl;
-      }
-  }
-
-  return { ad, adUrl };
-}
-
 registerBidder(spec);

package/modules/setupadBidAdapter.md

@@ -26,7 +26,7 @@ const adUnits = [
         bidder: 'setupad',
         params: {
           placement_id: '123', //required
-          account_id: '123', //optional
+          account_id: '123', //required
         },
       },
     ],

package/modules/smaatoBidAdapter.js

@@ -212,15 +212,19 @@ const converter = ortbConverter({
       return bidderRequest.gdprConsent && bidderRequest.gdprConsent.gdprApplies;
     }
 
+    function setPublisherId(node) {
+      deepSetValue(node, 'publisher.id', bidRequest.params.publisherId);
+    }
+
     const request = buildRequest(imps, bidderRequest, context);
     const bidRequest = context.bidRequests[0];
-    let siteContent;
+    let content;
     const mediaType = context.mediaType;
     if (mediaType === VIDEO) {
       const videoParams = bidRequest.mediaTypes[VIDEO];
       if (videoParams.context === ADPOD) {
         request.imp = createAdPodImp(request.imp[0], videoParams);
-        siteContent = addOptionalAdpodParameters(videoParams);
+        content = addOptionalAdpodParameters(videoParams);
       }
     }
 
@@ -242,19 +246,26 @@ const converter = ortbConverter({
 
     if (request.site) {
       request.site.id = window.location.hostname
-      if (siteContent) {
-        request.site.content = siteContent;
+      if (content) {
+        request.site.content = content;
+      }
+      setPublisherId(request.site);
+    } else if (request.dooh) {
+      request.dooh.id = window.location.hostname
+      if (content) {
+        request.dooh.content = content;
       }
+      setPublisherId(request.dooh);
     } else {
       request.site = {
         id: window.location.hostname,
         domain: bidderRequest.refererInfo.domain || window.location.hostname,
         page: bidderRequest.refererInfo.page || window.location.href,
         ref: bidderRequest.refererInfo.ref,
-        content: siteContent || null
+        content: content || null
       }
+      setPublisherId(request.site);
     }
-    deepSetValue(request.site, 'publisher.id', bidRequest.params.publisherId);
 
     if (request.regs) {
       if (isGdprApplicable()) {

package/modules/smartytechBidAdapter.js

@@ -127,14 +127,19 @@ export const spec = {
       creativeId: response.creativeId,
       netRevenue: true,
       currency: response.currency,
-      mediaType: BANNER
-    }
+      mediaType: BANNER,
+      meta: {}
+    };
 
     if (response.mediaType === VIDEO) {
       bidObject.vastXml = response.ad;
       bidObject.mediaType = VIDEO;
     }
 
+    if (response.meta) {
+      bidObject.meta = response.meta;
+    }
+
     return bidObject;
   },
 

package/modules/topicsFpdModule.js

@@ -130,7 +130,7 @@ export function processFpd(config, {global}, {data = topicsData} = {}) {
 export function getCachedTopics() {
   let cachedTopicData = [];
   const topics = config.getConfig('userSync.topics');
-  const bidderList = topics.bidders || [];
+  const bidderList = topics?.bidders || [];
   let storedSegments = new Map(safeJSONParse(coreStorage.getDataFromLocalStorage(topicStorageName)));
   storedSegments && storedSegments.forEach((value, cachedBidder) => {
     // Check bidder exist in config for cached bidder data and then only retrieve the cached data

package/modules/uid2IdSystem.js

@@ -1,4 +1,3 @@
-/* eslint-disable no-console */
 /**
  * This module adds uid2 ID support to the User ID module
  * The {@link module:modules/userId} module is required.

package/modules/uid2IdSystem_shared.js

@@ -1,4 +1,3 @@
-/* eslint-disable no-console */
 import { ajax } from '../src/ajax.js';
 import { cyrb53Hash } from '../src/utils.js';
 

package/modules/visiblemeasuresBidAdapter.js

@@ -1,213 +1,19 @@
-import { isFn, deepAccess, logMessage, logError } from '../src/utils.js';
-import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
-
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
-import { config } from '../src/config.js';
+import { isBidRequestValid, buildRequests, interpretResponse, getUserSyncs } from '../libraries/teqblazeUtils/bidderUtils.js';
 
 const BIDDER_CODE = 'visiblemeasures';
 const AD_URL = 'https://us-e.visiblemeasures.com/pbjs';
 const SYNC_URL = 'https://cs.visiblemeasures.com';
 
-function isBidResponseValid(bid) {
-  if (!bid.requestId || !bid.cpm || !bid.creativeId || !bid.ttl || !bid.currency) {
-    return false;
-  }
-
-  switch (bid.mediaType) {
-    case BANNER:
-      return Boolean(bid.width && bid.height && bid.ad);
-    case VIDEO:
-      return Boolean(bid.vastUrl || bid.vastXml);
-    case NATIVE:
-      return Boolean(bid.native && bid.native.impressionTrackers && bid.native.impressionTrackers.length);
-    default:
-      return false;
-  }
-}
-
-function getPlacementReqData(bid) {
-  const { params, bidId, mediaTypes } = bid;
-  const schain = bid.schain || {};
-  const { placementId, endpointId } = params;
-  const bidfloor = getBidFloor(bid);
-
-  const placement = {
-    bidId,
-    schain,
-    bidfloor
-  };
-
-  if (placementId) {
-    placement.placementId = placementId;
-    placement.type = 'publisher';
-  } else if (endpointId) {
-    placement.endpointId = endpointId;
-    placement.type = 'network';
-  }
-
-  if (mediaTypes && mediaTypes[BANNER]) {
-    placement.adFormat = BANNER;
-    placement.sizes = mediaTypes[BANNER].sizes;
-  } else if (mediaTypes && mediaTypes[VIDEO]) {
-    placement.adFormat = VIDEO;
-    placement.playerSize = mediaTypes[VIDEO].playerSize;
-    placement.minduration = mediaTypes[VIDEO].minduration;
-    placement.maxduration = mediaTypes[VIDEO].maxduration;
-    placement.mimes = mediaTypes[VIDEO].mimes;
-    placement.protocols = mediaTypes[VIDEO].protocols;
-    placement.startdelay = mediaTypes[VIDEO].startdelay;
-    placement.placement = mediaTypes[VIDEO].placement;
-    placement.plcmt = mediaTypes[VIDEO].plcmt;
-    placement.skip = mediaTypes[VIDEO].skip;
-    placement.skipafter = mediaTypes[VIDEO].skipafter;
-    placement.minbitrate = mediaTypes[VIDEO].minbitrate;
-    placement.maxbitrate = mediaTypes[VIDEO].maxbitrate;
-    placement.delivery = mediaTypes[VIDEO].delivery;
-    placement.playbackmethod = mediaTypes[VIDEO].playbackmethod;
-    placement.api = mediaTypes[VIDEO].api;
-    placement.linearity = mediaTypes[VIDEO].linearity;
-  } else if (mediaTypes && mediaTypes[NATIVE]) {
-    placement.native = mediaTypes[NATIVE];
-    placement.adFormat = NATIVE;
-  }
-
-  return placement;
-}
-
-function getBidFloor(bid) {
-  if (!isFn(bid.getFloor)) {
-    return deepAccess(bid, 'params.bidfloor', 0);
-  }
-
-  try {
-    const bidFloor = bid.getFloor({
-      currency: 'USD',
-      mediaType: '*',
-      size: '*',
-    });
-    return bidFloor.floor;
-  } catch (err) {
-    logError(err);
-    return 0;
-  }
-}
-
 export const spec = {
   code: BIDDER_CODE,
   supportedMediaTypes: [BANNER, VIDEO, NATIVE],
 
-  isBidRequestValid: (bid = {}) => {
-    const { params, bidId, mediaTypes } = bid;
-    let valid = Boolean(bidId && params && (params.placementId || params.endpointId));
-
-    if (mediaTypes && mediaTypes[BANNER]) {
-      valid = valid && Boolean(mediaTypes[BANNER] && mediaTypes[BANNER].sizes);
-    } else if (mediaTypes && mediaTypes[VIDEO]) {
-      valid = valid && Boolean(mediaTypes[VIDEO] && mediaTypes[VIDEO].playerSize);
-    } else if (mediaTypes && mediaTypes[NATIVE]) {
-      valid = valid && Boolean(mediaTypes[NATIVE]);
-    } else {
-      valid = false;
-    }
-    return valid;
-  },
-
-  buildRequests: (validBidRequests = [], bidderRequest = {}) => {
-    // convert Native ORTB definition to old-style prebid native definition
-    validBidRequests = convertOrtbRequestToProprietaryNative(validBidRequests);
-
-    let deviceWidth = 0;
-    let deviceHeight = 0;
-
-    let winLocation;
-    try {
-      const winTop = window.top;
-      deviceWidth = winTop.screen.width;
-      deviceHeight = winTop.screen.height;
-      winLocation = winTop.location;
-    } catch (e) {
-      logMessage(e);
-      winLocation = window.location;
-    }
-
-    const refferUrl = bidderRequest.refererInfo && bidderRequest.refererInfo.page;
-    let refferLocation;
-    try {
-      refferLocation = refferUrl && new URL(refferUrl);
-    } catch (e) {
-      logMessage(e);
-    }
-    // TODO: does the fallback make sense here?
-    let location = refferLocation || winLocation;
-    const language = (navigator && navigator.language) ? navigator.language.split('-')[0] : '';
-    const host = location.host;
-    const page = location.pathname;
-    const secure = location.protocol === 'https:' ? 1 : 0;
-    const placements = [];
-    const request = {
-      deviceWidth,
-      deviceHeight,
-      language,
-      secure,
-      host,
-      page,
-      placements,
-      coppa: config.getConfig('coppa') === true ? 1 : 0,
-      ccpa: bidderRequest.uspConsent || undefined,
-      gdpr: bidderRequest.gdprConsent || undefined,
-      tmax: bidderRequest.timeout
-    };
-
-    const len = validBidRequests.length;
-    for (let i = 0; i < len; i++) {
-      const bid = validBidRequests[i];
-      placements.push(getPlacementReqData(bid));
-    }
-
-    return {
-      method: 'POST',
-      url: AD_URL,
-      data: request
-    };
-  },
-
-  interpretResponse: (serverResponse) => {
-    let response = [];
-    for (let i = 0; i < serverResponse.body.length; i++) {
-      let resItem = serverResponse.body[i];
-      if (isBidResponseValid(resItem)) {
-        const advertiserDomains = resItem.adomain && resItem.adomain.length ? resItem.adomain : [];
-        resItem.meta = { ...resItem.meta, advertiserDomains };
-
-        response.push(resItem);
-      }
-    }
-    return response;
-  },
-
-  getUserSyncs: (syncOptions, serverResponses, gdprConsent, uspConsent) => {
-    let syncType = syncOptions.iframeEnabled ? 'iframe' : 'image';
-    let syncUrl = SYNC_URL + `/${syncType}?pbjs=1`;
-    if (gdprConsent && gdprConsent.consentString) {
-      if (typeof gdprConsent.gdprApplies === 'boolean') {
-        syncUrl += `&gdpr=${Number(gdprConsent.gdprApplies)}&gdpr_consent=${gdprConsent.consentString}`;
-      } else {
-        syncUrl += `&gdpr=0&gdpr_consent=${gdprConsent.consentString}`;
-      }
-    }
-    if (uspConsent && uspConsent.consentString) {
-      syncUrl += `&ccpa_consent=${uspConsent.consentString}`;
-    }
-
-    const coppa = config.getConfig('coppa') ? 1 : 0;
-    syncUrl += `&coppa=${coppa}`;
-
-    return [{
-      type: syncType,
-      url: syncUrl
-    }];
-  }
+  isBidRequestValid: isBidRequestValid(),
+  buildRequests: buildRequests(AD_URL),
+  interpretResponse,
+  getUserSyncs: getUserSyncs(SYNC_URL)
 };
 
 registerBidder(spec);

package/modules/zeta_global_sspAnalyticsAdapter.js

@@ -41,7 +41,8 @@ function adRenderSucceededHandler(args) {
       size: args.bid?.size,
       adomain: args.bid?.adserverTargeting?.hb_adomain,
       timeToRespond: args.bid?.timeToRespond,
-      cpm: args.bid?.cpm
+      cpm: args.bid?.cpm,
+      adUnitCode: args.bid?.adUnitCode
     },
     device: {
       ua: navigator.userAgent
@@ -63,7 +64,8 @@ function auctionEndHandler(args) {
         bidder: b?.bidder,
         mediaType: b?.mediaTypes?.video ? 'VIDEO' : (b?.mediaTypes?.banner ? 'BANNER' : undefined),
         size: b?.sizes?.filter(s => s && s.length === 2).filter(s => Number.isInteger(s[0]) && Number.isInteger(s[1])).map(s => s[0] + 'x' + s[1]).find(s => s),
-        device: b?.ortb2?.device
+        device: b?.ortb2?.device,
+        adUnitCode: b?.adUnitCode
       }))
     })),
     bidsReceived: args.bidsReceived?.map(br => ({
@@ -75,7 +77,8 @@ function auctionEndHandler(args) {
       size: br?.size,
       adomain: br?.adserverTargeting?.hb_adomain,
       timeToRespond: br?.timeToRespond,
-      cpm: br?.cpm
+      cpm: br?.cpm,
+      adUnitCode: br?.adUnitCode
     }))
   }
   sendEvent(EVENTS.AUCTION_END, event);
@@ -93,7 +96,8 @@ function bidTimeoutHandler(args) {
       mediaType: t?.mediaTypes?.video ? 'VIDEO' : (t?.mediaTypes?.banner ? 'BANNER' : undefined),
       size: t?.sizes?.filter(s => s && s.length === 2).filter(s => Number.isInteger(s[0]) && Number.isInteger(s[1])).map(s => s[0] + 'x' + s[1]).find(s => s),
       timeout: t?.timeout,
-      device: t?.ortb2?.device
+      device: t?.ortb2?.device,
+      adUnitCode: t?.adUnitCode
     }))
   }
   sendEvent(EVENTS.BID_TIMEOUT, event);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prebid.js",
-  "version": "9.0.0",
+  "version": "9.2.0",
   "description": "Header Bidding Management Library",
   "main": "src/prebid.public.js",
   "exports": {