prebid.js 8.40.0 → 8.41.0

package/modules/pstudioBidAdapter.md

@@ -0,0 +1,148 @@
+# Overview
+
+```
+Module Name: PStudio Bid Adapter
+Module Type: Bidder Adapter
+Maintainer: pstudio@telkomsel.com 
+```
+
+# Description
+
+Currently module supports banner as well as instream video mediaTypes.
+
+
+# Test parameters
+
+Those parameters should be used to get test responses from the adapter.
+
+```js
+var adUnits = [
+  // Banner ad unit
+  {
+    code: 'test-div-1',
+    mediaTypes: {
+      banner: {
+        sizes: [[300, 250]],
+      },
+    },
+    bids: [
+      {
+        bidder: 'pstudio',
+        params: {
+          // id of test publisher
+          pubid: '22430f9d-9610-432c-aabe-6134256f11af',
+          floorPrice: 1.25,
+        },
+      },
+    ],
+  },
+  // Instream video ad unit
+  {
+    code: 'test-div-2',
+    mediaTypes: {
+      video: {
+        context: 'instream',
+        playerSize: [640, 480],
+        mimes: ['video/mp4'],
+        protocols: [3],
+      },
+    },
+    bids: [
+      {
+        bidder: 'pstudio',
+        params: {
+          // id of test publisher
+          pubid: '22430f9d-9610-432c-aabe-6134256f11af',
+          floorPrice: 1.25,
+        },
+      },
+    ],
+  },
+];
+```
+
+# Sample Banner Ad Unit
+
+```js
+var adUnits = [
+  {
+    code: 'test-div-1',
+    mediaTypes: {
+      banner: {
+        sizes: [[300, 250]],
+        pos: 0,
+        name: 'test-name',
+      },
+    },
+    bids: [
+      {
+        bidder: 'pstudio',
+        params: {
+          pubid: '22430f9d-9610-432c-aabe-6134256f11af', // required
+          floorPrice: 1.15, // required
+          bcat: ['IAB1-1', 'IAB1-3'], // optional
+          badv: ['nike.com'], // optional
+          bapp: ['com.foo.mygame'], // optional
+        },
+      },
+    ],
+  },
+];
+```
+
+# Sample Video Ad Unit
+
+```js
+var videoAdUnits = [
+  {
+    code: 'test-instream-video',
+    mediaTypes: {
+      video: {
+        context: 'instream', // required (only instream accepted)
+        playerSize: [640, 480], // required (alternatively it could be pair of `w` and `h` parameters)
+        mimes: ['video/mp4'], // required (only choices `video/mp4`, `application/javascript`, `video/webm` and `video/ogg` supported)
+        protocols: [2, 3], // 1 required (only choices 2 and 3 supported)
+        minduration: 5, // optional
+        maxduration: 30, // optional
+        startdelay: 5, // optional
+        placement: 1, // optional (only 1 accepted, as it is instream placement)
+        skip: 1, // optional
+        skipafter: 1, // optional
+        minbitrate: 10, // optional
+        maxbitrate: 10, // optional
+        delivery: 1, // optional
+        playbackmethod: [1, 3], // optional
+        api: [2], // optional (only choice 2 supported)
+        linearity: 1, // optional
+      },
+    },
+    bids: [
+      {
+        bidder: 'pstudio',
+        params: {
+          pubid: '22430f9d-9610-432c-aabe-6134256f11af',
+          floorPrice: 1.25,
+          badv: ['adidas.com'],
+        },
+      },
+    ],
+  },
+];
+```
+
+# Configuration for video
+
+### Prebid cache
+
+For video ads, Prebid cache must be enabled, as the demand partner does not support caching of video content.
+
+```js
+pbjs.setConfig({
+  cache: {
+    url: 'https://prebid.adnxs.com/pbc/v1/cache',
+  },
+});
+```
+
+Please provide Prebid Cache of your choice. This example uses AppNexus cache, but if you use other cache, change it according to your needs.
+

package/modules/publirBidAdapter.js

@@ -0,0 +1,391 @@
+import {
+  logWarn,
+  logInfo,
+  isArray,
+  isFn,
+  deepAccess,
+  isEmpty,
+  contains,
+  timestamp,
+  triggerPixel,
+  getDNT,
+  getBidIdParameter
+} from '../src/utils.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER, VIDEO } from '../src/mediaTypes.js';
+import { config } from '../src/config.js';
+import { getStorageManager } from '../src/storageManager.js';
+import { ajax } from '../src/ajax.js';
+
+const SUPPORTED_AD_TYPES = [BANNER, VIDEO];
+const BIDDER_CODE = 'publir';
+const ADAPTER_VERSION = '1.0.0';
+const TTL = 360;
+const CURRENCY = 'USD';
+const DEFAULT_SELLER_ENDPOINT = 'https://prebid.publir.com/publirPrebidEndPoint';
+const DEFAULT_IMPS_ENDPOINT = 'https://prebidimpst.publir.com/publirPrebidImpressionTracker';
+const SUPPORTED_SYNC_METHODS = {
+  IFRAME: 'iframe',
+  PIXEL: 'pixel'
+}
+
+export const storage = getStorageManager({ bidderCode: BIDDER_CODE });
+export const spec = {
+  code: BIDDER_CODE,
+  version: ADAPTER_VERSION,
+  aliases: ['plr'],
+  supportedMediaTypes: SUPPORTED_AD_TYPES,
+  isBidRequestValid: function (bidRequest) {
+    if (!bidRequest.params.pubId) {
+      logWarn('pubId is a mandatory param for Publir adapter');
+      return false;
+    }
+
+    return true;
+  },
+  buildRequests: function (validBidRequests, bidderRequest) {
+    const reqObj = {};
+    const generalObject = validBidRequests[0];
+    reqObj.params = generatePubGeneralsParams(generalObject, bidderRequest);
+    reqObj.bids = generatePubBidParams(validBidRequests, bidderRequest);
+    reqObj.bids.timestamp = timestamp();
+    let options = {
+      withCredentials: false
+    };
+
+    return {
+      method: 'POST',
+      url: DEFAULT_SELLER_ENDPOINT,
+      data: reqObj,
+      options
+    }
+  },
+  interpretResponse: function ({ body }) {
+    const bidResponses = [];
+    if (body.bids) {
+      body.bids.forEach(adUnit => {
+        const bidResponse = {
+          requestId: adUnit.requestId,
+          cpm: adUnit.cpm,
+          currency: adUnit.currency || CURRENCY,
+          width: adUnit.width,
+          height: adUnit.height,
+          ttl: adUnit.ttl || TTL,
+          creativeId: adUnit.creativeId,
+          netRevenue: adUnit.netRevenue || true,
+          nurl: adUnit.nurl,
+          mediaType: adUnit.mediaType,
+          meta: {
+            mediaType: adUnit.mediaType
+          },
+        };
+
+        if (adUnit.mediaType === VIDEO) {
+          bidResponse.vastXml = adUnit.vastXml;
+        } else if (adUnit.mediaType === BANNER) {
+          bidResponse.ad = adUnit.ad;
+        }
+
+        if (adUnit.adomain && adUnit.adomain.length) {
+          bidResponse.meta.advertiserDomains = adUnit.adomain;
+        } else {
+          bidResponse.meta.advertiserDomains = [];
+        }
+        if (adUnit?.meta?.ad_key) {
+          bidResponse.meta.ad_key = adUnit.meta.ad_key ?? null;
+        }
+        if (adUnit.campId) {
+          bidResponse.campId = adUnit.campId;
+        }
+        bidResponse.bidder = BIDDER_CODE;
+        bidResponses.push(bidResponse);
+      });
+    } else {
+      return [];
+    }
+    return bidResponses;
+  },
+  getUserSyncs: function (syncOptions, serverResponses) {
+    const syncs = [];
+    for (const response of serverResponses) {
+      if (response.body && response.body.params) {
+        if (syncOptions.iframeEnabled && response.body.params.userSyncURL) {
+          syncs.push({
+            type: 'iframe',
+            url: response.body.params.userSyncURL
+          });
+        }
+        if (syncOptions.pixelEnabled && isArray(response.body.params.userSyncPixels)) {
+          const pixels = response.body.params.userSyncPixels.map(pixel => {
+            return {
+              type: 'image',
+              url: pixel
+            }
+          })
+          syncs.push(...pixels)
+        }
+      }
+    }
+    return syncs;
+  },
+  onBidWon: function (bid) {
+    if (bid == null) {
+      return;
+    }
+    logInfo('onBidWon:', bid);
+    ajax(DEFAULT_IMPS_ENDPOINT, null, JSON.stringify(bid), { method: 'POST', mode: 'no-cors', credentials: 'include', headers: { 'Content-Type': 'application/json' } });
+    if (bid.hasOwnProperty('nurl') && bid.nurl.length > 0) {
+      triggerPixel(bid.nurl);
+    }
+  },
+};
+
+registerBidder(spec);
+
+/**
+ * Get floor price
+ * @param bid {bid}
+ * @returns {Number}
+ */
+function getFloor(bid, mediaType) {
+  if (!isFn(bid.getFloor)) {
+    return 0;
+  }
+  let floorResult = bid.getFloor({
+    currency: CURRENCY,
+    mediaType: mediaType,
+    size: '*'
+  });
+  return floorResult.currency === CURRENCY && floorResult.floor ? floorResult.floor : 0;
+}
+
+/**
+ * Get the the ad sizes array from the bid
+ * @param bid {bid}
+ * @returns {Array}
+ */
+function getSizesArray(bid, mediaType) {
+  let sizesArray = []
+
+  if (deepAccess(bid, `mediaTypes.${mediaType}.sizes`)) {
+    sizesArray = bid.mediaTypes[mediaType].sizes;
+  } else if (Array.isArray(bid.sizes) && bid.sizes.length > 0) {
+    sizesArray = bid.sizes;
+  }
+
+  return sizesArray;
+}
+
+/**
+ * Get schain string value
+ * @param schainObject {Object}
+ * @returns {string}
+ */
+function getSupplyChain(schainObject) {
+  if (isEmpty(schainObject)) {
+    return '';
+  }
+  let scStr = `${schainObject.ver},${schainObject.complete}`;
+  schainObject.nodes.forEach((node) => {
+    scStr += '!';
+    scStr += `${getEncodedValIfNotEmpty(node.asi)},`;
+    scStr += `${getEncodedValIfNotEmpty(node.sid)},`;
+    scStr += `${node.hp ? encodeURIComponent(node.hp) : ''},`;
+    scStr += `${getEncodedValIfNotEmpty(node.rid)},`;
+    scStr += `${getEncodedValIfNotEmpty(node.name)},`;
+    scStr += `${getEncodedValIfNotEmpty(node.domain)}`;
+  });
+  return scStr;
+}
+
+/**
+ * Get encoded node value
+ * @param val {string}
+ * @returns {string}
+ */
+function getEncodedValIfNotEmpty(val) {
+  return !isEmpty(val) ? encodeURIComponent(val) : '';
+}
+
+function getAllowedSyncMethod(filterSettings, bidderCode) {
+  const iframeConfigsToCheck = ['all', 'iframe'];
+  const pixelConfigToCheck = 'image';
+  if (filterSettings && iframeConfigsToCheck.some(config => isSyncMethodAllowed(filterSettings[config], bidderCode))) {
+    return SUPPORTED_SYNC_METHODS.IFRAME;
+  }
+  if (!filterSettings || !filterSettings[pixelConfigToCheck] || isSyncMethodAllowed(filterSettings[pixelConfigToCheck], bidderCode)) {
+    return SUPPORTED_SYNC_METHODS.PIXEL;
+  }
+}
+
+/**
+ * Check if sync rule is supported
+ * @param syncRule {Object}
+ * @param bidderCode {string}
+ * @returns {boolean}
+ */
+function isSyncMethodAllowed(syncRule, bidderCode) {
+  if (!syncRule) {
+    return false;
+  }
+  const isInclude = syncRule.filter === 'include';
+  const bidders = isArray(syncRule.bidders) ? syncRule.bidders : [bidderCode];
+  return isInclude && contains(bidders, bidderCode);
+}
+
+/**
+ * get device type
+ * @param ua {ua}
+ * @returns {string}
+ */
+function getDeviceType(ua) {
+  if (/ipad|android 3.0|xoom|sch-i800|playbook|tablet|kindle/i.test(ua.toLowerCase())) {
+    return '5';
+  }
+  if (/iphone|ipod|android|blackberry|opera|mini|windows\sce|palm|smartphone|iemobile/i.test(ua.toLowerCase())) {
+    return '4';
+  }
+  if (/smart[-_\s]?tv|hbbtv|appletv|googletv|hdmi|netcast|viera|nettv|roku|\bdtv\b|sonydtv|inettvbrowser|\btv\b/i.test(ua.toLowerCase())) {
+    return '3';
+  }
+  return '1';
+}
+
+function generatePubBidParams(validBidRequests, bidderRequest) {
+  const bidsArray = [];
+
+  if (validBidRequests.length) {
+    validBidRequests.forEach(bid => {
+      bidsArray.push(generateBidParameters(bid, bidderRequest));
+    });
+  }
+  return bidsArray;
+}
+
+/**
+ * Generate bid specific parameters
+ * @param {bid} bid
+ * @param {bidderRequest} bidderRequest
+ * @returns {Object} bid specific params object
+ */
+function generateBidParameters(bid, bidderRequest) {
+  const { params } = bid;
+  const mediaType = isBanner(bid) ? BANNER : VIDEO;
+  const sizesArray = getSizesArray(bid, mediaType);
+
+  // fix floor price in case of NAN
+  if (isNaN(params.floorPrice)) {
+    params.floorPrice = 0;
+  }
+
+  const bidObject = {
+    mediaType,
+    adUnitCode: getBidIdParameter('adUnitCode', bid),
+    sizes: sizesArray,
+    floorPrice: Math.max(getFloor(bid, mediaType), params.floorPrice),
+    bidId: getBidIdParameter('bidId', bid),
+    bidderRequestId: getBidIdParameter('bidderRequestId', bid),
+    loop: getBidIdParameter('bidderRequestsCount', bid),
+    transactionId: bid.ortb2Imp?.ext?.tid,
+    coppa: 0
+  };
+
+  const pubId = params.pubId;
+  if (pubId) {
+    bidObject.pubId = pubId;
+  }
+
+  const sua = deepAccess(bid, `ortb2.device.sua`);
+  if (sua) {
+    bidObject.sua = sua;
+  }
+
+  const coppa = deepAccess(bid, `ortb2.regs.coppa`)
+  if (coppa) {
+    bidObject.coppa = 1;
+  }
+
+  return bidObject;
+}
+
+function isBanner(bid) {
+  return bid.mediaTypes && bid.mediaTypes.banner;
+}
+
+function getLocalStorage(cookieObjName) {
+  if (storage.localStorageIsEnabled()) {
+    const lstData = storage.getDataFromLocalStorage(cookieObjName);
+    return lstData;
+  }
+  return '';
+}
+
+/**
+ * Generate params that are common between all bids
+ * @param generalObject
+ * @param {bidderRequest} bidderRequest
+ * @returns {object} the common params object
+ */
+function generatePubGeneralsParams(generalObject, bidderRequest) {
+  const domain = bidderRequest.refererInfo;
+  const { syncEnabled, filterSettings } = config.getConfig('userSync') || {};
+  const { bidderCode } = bidderRequest;
+  const generalBidParams = generalObject.params;
+  const timeout = bidderRequest.timeout;
+  const generalParams = {
+    wrapper_type: 'prebidjs',
+    wrapper_vendor: '$$PREBID_GLOBAL$$',
+    wrapper_version: '$prebid.version$',
+    adapter_version: ADAPTER_VERSION,
+    auction_start: bidderRequest.auctionStart,
+    publisher_id: generalBidParams.pubId,
+    publisher_name: domain,
+    site_domain: domain,
+    dnt: getDNT() ? 1 : 0,
+    device_type: getDeviceType(navigator.userAgent),
+    ua: navigator.userAgent,
+    is_wrapper: !!generalBidParams.isWrapper,
+    session_id: generalBidParams.sessionId || getBidIdParameter('bidderRequestId', generalObject),
+    tmax: timeout,
+    user_cookie: getLocalStorage('_publir_prebid_creative')
+  };
+
+  const userIdsParam = getBidIdParameter('userId', generalObject);
+  if (userIdsParam) {
+    generalParams.userIds = JSON.stringify(userIdsParam);
+  }
+
+  const ortb2Metadata = bidderRequest.ortb2 || {};
+  if (ortb2Metadata.site) {
+    generalParams.site_metadata = JSON.stringify(ortb2Metadata.site);
+  }
+  if (ortb2Metadata.user) {
+    generalParams.user_metadata = JSON.stringify(ortb2Metadata.user);
+  }
+
+  if (syncEnabled) {
+    const allowedSyncMethod = getAllowedSyncMethod(filterSettings, bidderCode);
+    if (allowedSyncMethod) {
+      generalParams.cs_method = allowedSyncMethod;
+    }
+  }
+
+  if (bidderRequest.uspConsent) {
+    generalParams.us_privacy = bidderRequest.uspConsent;
+  }
+
+  if (bidderRequest && bidderRequest.gdprConsent && bidderRequest.gdprConsent.gdprApplies) {
+    generalParams.gdpr = bidderRequest.gdprConsent.gdprApplies;
+    generalParams.gdpr_consent = bidderRequest.gdprConsent.consentString;
+  }
+
+  if (generalObject.schain) {
+    generalParams.schain = getSupplyChain(generalObject.schain);
+  }
+
+  if (bidderRequest && bidderRequest.refererInfo) {
+    generalParams.page_url = deepAccess(bidderRequest, 'refererInfo.page') || deepAccess(window, 'location.href');
+  }
+
+  return generalParams;
+}

package/modules/publirBidAdapter.md

@@ -0,0 +1,47 @@
+# Overview
+
+```
+Module Name:  Publir Bid Adapter
+Module Type:  Bidder Adapter
+Maintainer: info@publir.com
+```
+
+
+# Description
+
+Module that connects to Publir's demand sources.
+
+The Publir adapter requires setup and approval from the Publir. Please reach out to info@publir.com to create an Publir account.
+
+The adapter supports Video(instream).
+
+# Bid Parameters
+## Video
+
+| Name | Scope | Type | Description | Example
+| ---- | ----- | ---- | ----------- | -------
+| `pubId` | required | String |  Publir publisher Id provided by your Publir representative  | "1234567890abcdef12345678"
+
+
+# Test Parameters
+```javascript
+var adUnits = [
+       {
+        code: 'hre_div-hre-vcn-1',
+        sizes: [[1080, 1920]]],
+        mediaTypes: {
+          banner: {
+            sizes: [
+              [1080, 1920],
+            ],
+          },
+        },
+        bids: [{
+          bidder: 'publir',
+          params: {
+            pubId: '1234567890abcdef12345678'
+          }
+        }]
+      }
+   ];
+```

package/modules/pubmaticAnalyticsAdapter.js

@@ -151,6 +151,7 @@ function parseBidResponse(bid) {
     'cpm', () => window.parseFloat(Number(bid.cpm).toFixed(BID_PRECISION)),
     'originalCpm', () => window.parseFloat(Number(bid.originalCpm).toFixed(BID_PRECISION)),
     'originalCurrency',
+    'adserverTargeting',
     'dealChannel',
     'meta',
     'status',
@@ -278,6 +279,7 @@ function gatherPartnerBidsForAdUnitForLogger(adUnit, adUnitId, highestBid) {
       if (isOWPubmaticBid(adapterName) && isS2SBidder(bid.bidder)) {
         return;
       }
+      const pg = window.parseFloat(Number(bid.bidResponse?.adserverTargeting?.hb_pb || bid.bidResponse?.adserverTargeting?.pwtpb).toFixed(BID_PRECISION));
       partnerBids.push({
         'pn': adapterName,
         'bc': bid.bidderCode || bid.bidder,
@@ -303,7 +305,8 @@ function gatherPartnerBidsForAdUnitForLogger(adUnit, adUnitId, highestBid) {
         'ocry': bid.bidResponse ? (bid.bidResponse.originalCurrency || CURRENCY_USD) : CURRENCY_USD,
         'piid': bid.bidResponse ? (bid.bidResponse.partnerImpId || EMPTY_STRING) : EMPTY_STRING,
         'frv': bid.bidResponse ? bid.bidResponse.floorData?.floorRuleValue : undefined,
-        'md': bid.bidResponse ? getMetadata(bid.bidResponse.meta) : undefined
+        'md': bid.bidResponse ? getMetadata(bid.bidResponse.meta) : undefined,
+        'pb': pg || undefined
       });
     });
     return partnerBids;
@@ -457,8 +460,9 @@ function executeBidWonLoggerCall(auctionId, adUnitId) {
   let referrer = config.getConfig('pageUrl') || cache.auctions[auctionId].referer || '';
   let adv = winningBid.bidResponse ? getAdDomain(winningBid.bidResponse) || undefined : undefined;
   let fskp = floorData ? (floorData.floorRequestData ? (floorData.floorRequestData.skipped == false ? 0 : 1) : undefined) : undefined;
-
+  let pg = window.parseFloat(Number(winningBid?.bidResponse?.adserverTargeting?.hb_pb || winningBid?.bidResponse?.adserverTargeting?.pwtpb)) || undefined;
   let pixelURL = END_POINT_WIN_BID_LOGGER;
+
   pixelURL += 'pubid=' + publisherId;
   pixelURL += '&purl=' + enc(config.getConfig('pageUrl') || cache.auctions[auctionId].referer || '');
   pixelURL += '&tst=' + Math.round((new window.Date()).getTime() / 1000);
@@ -475,6 +479,7 @@ function executeBidWonLoggerCall(auctionId, adUnitId) {
   pixelURL += '&kgpv=' + enc(getValueForKgpv(winningBid, adUnitId));
   pixelURL += '&piid=' + enc(winningBid.bidResponse.partnerImpId || EMPTY_STRING);
   pixelURL += '&di=' + enc(winningBid?.bidResponse?.dealId || OPEN_AUCTION_DEAL_ID);
+  pixelURL += '&pb=' + enc(pg);
 
   pixelURL += '&plt=' + enc(getDevicePlatform());
   pixelURL += '&psz=' + enc((winningBid?.bidResponse?.dimensions?.width || '0') + 'x' +