prebid.js 9.0.0 → 9.2.0

package/modules/loyalBidAdapter.js

@@ -1,191 +1,17 @@
-import { 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 } from '../libraries/teqblazeUtils/bidderUtils.js';
 
 const BIDDER_CODE = 'loyal';
 const AD_URL = 'https://us-east-1.loyal.app/pbjs';
 
-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,
-    eids: []
-  };
-
-  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) {
-  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,
-      tmax: bidderRequest.timeout
-    };
-
-    if (bidderRequest.gdprConsent?.consentString) {
-      request.gdpr = {
-        consentString: bidderRequest.gdprConsent.consentString
-      };
-    }
-
-    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;
-  },
+  isBidRequestValid: isBidRequestValid(),
+  buildRequests: buildRequests(AD_URL),
+  interpretResponse
 };
 
 registerBidder(spec);

package/modules/lunamediahbBidAdapter.js

@@ -1,132 +1,19 @@
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
-import { config } from '../src/config.js';
-import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
+import { isBidRequestValid, buildRequests, interpretResponse, getUserSyncs } from '../libraries/teqblazeUtils/bidderUtils.js';
 
 const BIDDER_CODE = 'lunamediahb';
 const AD_URL = 'https://balancer.lmgssp.com/?c=o&m=multi';
 const SYNC_URL = 'https://cookie.lmgssp.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) || Boolean(bid.vastXml);
-    case NATIVE:
-      return Boolean(bid.native && bid.native.impressionTrackers);
-    default:
-      return false;
-  }
-}
-
 export const spec = {
   code: BIDDER_CODE,
   supportedMediaTypes: [BANNER, VIDEO, NATIVE],
 
-  isBidRequestValid: (bid) => {
-    return Boolean(bid.bidId && bid.params && !isNaN(parseInt(bid.params.placementId)));
-  },
-
-  buildRequests: (validBidRequests = [], bidderRequest) => {
-    // convert Native ORTB definition to old-style prebid native definition
-    validBidRequests = convertOrtbRequestToProprietaryNative(validBidRequests);
-
-    let winTop = window;
-    let location;
-    location = bidderRequest?.refererInfo ?? null;
-
-    const placements = [];
-    const request = {
-      'deviceWidth': winTop.screen.width,
-      'deviceHeight': winTop.screen.height,
-      'language': (navigator && navigator.language) ? navigator.language.split('-')[0] : '',
-      'secure': 1,
-      'host': location?.domain ?? '',
-      'page': location?.page ?? '',
-      'placements': placements
-    };
-
-    if (bidderRequest) {
-      if (bidderRequest.uspConsent) {
-        request.ccpa = bidderRequest.uspConsent;
-      }
-      if (bidderRequest.gdprConsent) {
-        request.gdpr = bidderRequest.gdprConsent
-      }
-    }
-
-    const len = validBidRequests.length;
-    for (let i = 0; i < len; i++) {
-      const bid = validBidRequests[i];
-      const placement = {
-        placementId: bid.params.placementId,
-        bidId: bid.bidId,
-        schain: bid.schain || {},
-      };
-      const mediaType = bid.mediaTypes
-
-      if (mediaType && mediaType[BANNER] && mediaType[BANNER].sizes) {
-        placement.sizes = mediaType[BANNER].sizes;
-        placement.traffic = BANNER;
-      } else if (mediaType && mediaType[VIDEO]) {
-        if (mediaType[VIDEO].playerSize) {
-          placement.wPlayer = mediaType[VIDEO].playerSize[0];
-          placement.hPlayer = mediaType[VIDEO].playerSize[1];
-        }
-        placement.traffic = VIDEO;
-        placement.videoContext = mediaType[VIDEO].context || 'instream'
-      } else if (mediaType && mediaType[NATIVE]) {
-        placement.native = mediaType[NATIVE];
-        placement.traffic = NATIVE;
-      }
-      placements.push(placement);
-    }
-
-    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)) {
-        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(['placementId']),
+  buildRequests: buildRequests(AD_URL),
+  interpretResponse,
+  getUserSyncs: getUserSyncs(SYNC_URL)
 };
 
 registerBidder(spec);

package/modules/mathildeadsBidAdapter.js

@@ -1,212 +1,19 @@
-import { isFn, deepAccess, logMessage } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
-import {config} from '../src/config.js';
-import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
+import { isBidRequestValid, buildRequests, interpretResponse, getUserSyncs } from '../libraries/teqblazeUtils/bidderUtils.js';
 
 const BIDDER_CODE = 'mathildeads';
 const AD_URL = 'https://endpoint2.mathilde-ads.com/pbjs';
 const SYNC_URL = 'https://cs2.mathilde-ads.com';
 
-function isBidResponseValid (bid) {
-  if (!bid.requestId || !bid.cpm || !bid.creativeId ||
-    !bid.ttl || !bid.currency || !bid.meta) {
-    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 } = params;
-  const bidfloor = getBidFloor(bid);
-
-  const placement = {
-    placementId,
-    bidId,
-    schain,
-    bidfloor
-  };
-
-  if (mediaTypes[BANNER]) {
-    placement.adFormat = BANNER;
-    placement.sizes = mediaTypes[BANNER].sizes;
-  }
-
-  if (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.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;
-  }
-
-  if (mediaTypes[NATIVE]) {
-    placement.adFormat = NATIVE;
-    placement.native = mediaTypes[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 (_) {
-    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);
-
-    if (mediaTypes[BANNER]) {
-      valid = valid && Boolean(mediaTypes[BANNER] && mediaTypes[BANNER].sizes);
-    }
-
-    if (mediaTypes[VIDEO]) {
-      valid = valid && Boolean(mediaTypes[VIDEO] && mediaTypes[VIDEO].playerSize);
-    }
-
-    if (mediaTypes[NATIVE]) {
-      valid = valid && Boolean(mediaTypes[NATIVE]);
-    }
-
-    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?.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(['placementId']),
+  buildRequests: buildRequests(AD_URL),
+  interpretResponse,
+  getUserSyncs: getUserSyncs(SYNC_URL)
 };
 
 registerBidder(spec);