Anyclip Bid Adapter : refactor bid adapter (#12030)

* update anyclip adapter * remove coppa * fix jsdoc warnings * create bidderUtils * delete duplicate code * refactor --------- Co-authored-by: Chucky-choo <dedafu47@gmail.com>
prebid · Aug 12, 2024 · 50d30c4 · 50d30c4
1 parent 54efa3c
commit 50d30c4
Show file tree

Hide file tree

Showing 11 changed files with 687 additions and 1,196 deletions.
diff --git a/libraries/xeUtils/bidderUtils.js b/libraries/xeUtils/bidderUtils.js
@@ -0,0 +1,158 @@
+import {deepAccess, getBidIdParameter, isFn, logError, isArray, parseSizesInput} from '../../src/utils.js';
+import {getAdUnitSizes} from '../sizeUtils/sizeUtils.js';
+import {findIndex} from '../../src/polyfill.js';
+
+export function getBidFloor(bid, currency = 'USD') {
+  if (!isFn(bid.getFloor)) {
+    return null;
+  }
+
+  let floor = bid.getFloor({
+    currency,
+    mediaType: '*',
+    size: '*'
+  });
+
+  if (typeof floor === 'object' && !isNaN(floor.floor) && floor.currency === currency) {
+    return floor.floor;
+  }
+
+  return null;
+}
+
+export function isBidRequestValid(bid) {
+  if (bid && typeof bid.params !== 'object') {
+    logError('Params is not defined or is incorrect in the bidder settings');
+    return false;
+  }
+
+  if (!getBidIdParameter('env', bid.params) || !getBidIdParameter('pid', bid.params)) {
+    logError('Env or pid is not present in bidder params');
+    return false;
+  }
+
+  if (deepAccess(bid, 'mediaTypes.video') && !isArray(deepAccess(bid, 'mediaTypes.video.playerSize'))) {
+    logError('mediaTypes.video.playerSize is required for video');
+    return false;
+  }
+
+  return true;
+}
+
+export function buildRequests(validBidRequests, bidderRequest, endpoint) {
+  const {refererInfo = {}, gdprConsent = {}, uspConsent} = bidderRequest;
+  const requests = validBidRequests.map(req => {
+    const request = {};
+    request.bidId = req.bidId;
+    request.banner = deepAccess(req, 'mediaTypes.banner');
+    request.auctionId = req.ortb2?.source?.tid;
+    request.transactionId = req.ortb2Imp?.ext?.tid;
+    request.sizes = parseSizesInput(getAdUnitSizes(req));
+    request.schain = req.schain;
+    request.location = {
+      page: refererInfo.page,
+      location: refererInfo.location,
+      domain: refererInfo.domain,
+      whost: window.location.host,
+      ref: refererInfo.ref,
+      isAmp: refererInfo.isAmp
+    };
+    request.device = {
+      ua: navigator.userAgent,
+      lang: navigator.language
+    };
+    request.env = {
+      env: req.params.env,
+      pid: req.params.pid
+    };
+    request.ortb2 = req.ortb2;
+    request.ortb2Imp = req.ortb2Imp;
+    request.tz = new Date().getTimezoneOffset();
+    request.ext = req.params.ext;
+    request.bc = req.bidRequestsCount;
+    request.floor = getBidFloor(req);
+
+    if (req.userIdAsEids && req.userIdAsEids.length !== 0) {
+      request.userEids = req.userIdAsEids;
+    } else {
+      request.userEids = [];
+    }
+    if (gdprConsent.gdprApplies) {
+      request.gdprApplies = Number(gdprConsent.gdprApplies);
+      request.consentString = gdprConsent.consentString;
+    } else {
+      request.gdprApplies = 0;
+      request.consentString = '';
+    }
+    if (uspConsent) {
+      request.usPrivacy = uspConsent;
+    } else {
+      request.usPrivacy = '';
+    }
+    const video = deepAccess(req, 'mediaTypes.video');
+    if (video) {
+      request.sizes = parseSizesInput(deepAccess(req, 'mediaTypes.video.playerSize'));
+      request.video = video;
+    }
+
+    return request;
+  });
+
+  return {
+    method: 'POST',
+    url: endpoint + '/bid',
+    data: JSON.stringify(requests),
+    withCredentials: true,
+    bidderRequest,
+    options: {
+      contentType: 'application/json',
+    }
+  };
+}
+
+export function interpretResponse(serverResponse, {bidderRequest}) {
+  const response = [];
+  if (!isArray(deepAccess(serverResponse, 'body.data'))) {
+    return response;
+  }
+
+  serverResponse.body.data.forEach(serverBid => {
+    const bidIndex = findIndex(bidderRequest.bids, (bidRequest) => {
+      return bidRequest.bidId === serverBid.requestId;
+    });
+
+    if (bidIndex !== -1) {
+      const bid = {
+        requestId: serverBid.requestId,
+        dealId: bidderRequest.dealId || null,
+        ...serverBid
+      };
+      response.push(bid);
+    }
+  });
+
+  return response;
+}
+
+export function getUserSyncs(syncOptions, serverResponses, gdprConsent = {}, uspConsent = '') {
+  const syncs = [];
+  const pixels = deepAccess(serverResponses, '0.body.data.0.ext.pixels');
+
+  if ((syncOptions.iframeEnabled || syncOptions.pixelEnabled) && isArray(pixels) && pixels.length !== 0) {
+    const gdprFlag = `&gdpr=${gdprConsent.gdprApplies ? 1 : 0}`;
+    const gdprString = `&gdpr_consent=${encodeURIComponent((gdprConsent.consentString || ''))}`;
+    const usPrivacy = `us_privacy=${encodeURIComponent(uspConsent)}`;
+
+    pixels.forEach(pixel => {
+      const [type, url] = pixel;
+      const sync = {type, url: `${url}&${usPrivacy}${gdprFlag}${gdprString}`};
+      if (type === 'iframe' && syncOptions.iframeEnabled) {
+        syncs.push(sync)
+      } else if (type === 'image' && syncOptions.pixelEnabled) {
+        syncs.push(sync)
+      }
+    });
+  }
+
+  return syncs;
+}