prebid.js 6.2.0 → 6.6.0

package/modules/cwireBidAdapter.js

@@ -26,6 +26,7 @@ export const RENDERER_URL = 'https://cdn.cwi.re/prebid/renderer/LATEST/renderer.
 export const CW_PAGE_VIEW_ID = generateUUID();
 const LS_CWID_KEY = 'cw_cwid';
 const CW_GROUPS_QUERY = 'cwgroups';
+const CW_CREATIVE_QUERY = 'cwcreative';
 
 const storage = getStorageManager();
 
@@ -161,6 +162,7 @@ export const spec = {
 
     let refgroups = [];
 
+    const cwCreativeId = getQueryVariable(CW_CREATIVE_QUERY);
     const rgQuery = getQueryVariable(CW_GROUPS_QUERY);
     if (rgQuery !== null) {
       refgroups = rgQuery.split(',');
@@ -171,6 +173,7 @@ export const spec = {
     const payload = {
       cwid: localStorageCWID,
       refgroups,
+      cwcreative: cwCreativeId,
       slots: slots,
       httpRef: referer || '',
       pageViewId: CW_PAGE_VIEW_ID,

package/modules/dailyhuntBidAdapter.js

@@ -0,0 +1,435 @@
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import * as mediaTypes from '../src/mediaTypes.js';
+import {deepAccess, _map, isEmpty} from '../src/utils.js';
+import { ajax } from '../src/ajax.js';
+import find from 'core-js-pure/features/array/find.js';
+import { OUTSTREAM, INSTREAM } from '../src/video.js';
+
+const BIDDER_CODE = 'dailyhunt';
+const BIDDER_ALIAS = 'dh';
+const SUPPORTED_MEDIA_TYPES = [mediaTypes.BANNER, mediaTypes.NATIVE, mediaTypes.VIDEO];
+
+const PROD_PREBID_ENDPOINT_URL = 'https://pbs.dailyhunt.in/openrtb2/auction?partner=';
+const PROD_PREBID_TEST_ENDPOINT_URL = 'https://qa-pbs-van.dailyhunt.in/openrtb2/auction?partner=';
+
+const ORTB_NATIVE_TYPE_MAPPING = {
+  img: {
+    '3': 'image',
+    '1': 'icon'
+  },
+  data: {
+    '1': 'sponsoredBy',
+    '2': 'body',
+    '3': 'rating',
+    '4': 'likes',
+    '5': 'downloads',
+    '6': 'price',
+    '7': 'salePrice',
+    '8': 'phone',
+    '9': 'address',
+    '10': 'body2',
+    '11': 'displayUrl',
+    '12': 'cta'
+  }
+}
+
+const ORTB_NATIVE_PARAMS = {
+  title: {
+    id: 0,
+    name: 'title'
+  },
+  icon: {
+    id: 1,
+    type: 1,
+    name: 'img'
+  },
+  image: {
+    id: 2,
+    type: 3,
+    name: 'img'
+  },
+  sponsoredBy: {
+    id: 3,
+    name: 'data',
+    type: 1
+  },
+  body: {
+    id: 4,
+    name: 'data',
+    type: 2
+  },
+  cta: {
+    id: 5,
+    type: 12,
+    name: 'data'
+  },
+  body2: {
+    id: 4,
+    name: 'data',
+    type: 10
+  },
+};
+
+// Encode URI.
+const _encodeURIComponent = function (a) {
+  let b = window.encodeURIComponent(a);
+  b = b.replace(/'/g, '%27');
+  return b;
+}
+
+// Extract key from collections.
+const extractKeyInfo = (collection, key) => {
+  for (let i = 0, result; i < collection.length; i++) {
+    result = deepAccess(collection[i].params, key);
+    if (result) {
+      return result;
+    }
+  }
+  return undefined
+}
+
+// Flattern Array.
+const flatten = (arr) => {
+  return [].concat(...arr);
+}
+
+const createOrtbRequest = (validBidRequests, bidderRequest) => {
+  let device = createOrtbDeviceObj(validBidRequests);
+  let user = createOrtbUserObj(validBidRequests)
+  let site = createOrtbSiteObj(validBidRequests, bidderRequest.refererInfo.referer)
+  return {
+    id: bidderRequest.auctionId,
+    imp: [],
+    site,
+    device,
+    user,
+  };
+}
+
+const createOrtbDeviceObj = (validBidRequests) => {
+  let device = { ...extractKeyInfo(validBidRequests, `device`) };
+  device.ua = navigator.userAgent;
+  return device;
+}
+
+const createOrtbUserObj = (validBidRequests) => ({ ...extractKeyInfo(validBidRequests, `user`) })
+
+const createOrtbSiteObj = (validBidRequests, page) => {
+  let site = { ...extractKeyInfo(validBidRequests, `site`), page };
+  let publisher = createOrtbPublisherObj(validBidRequests);
+  if (!site.publisher) {
+    site.publisher = publisher
+  }
+  return site
+}
+
+const createOrtbPublisherObj = (validBidRequests) => ({ ...extractKeyInfo(validBidRequests, `publisher`) })
+
+// get bidFloor Function for different creatives
+function getBidFloor(bid, creative) {
+  let floorInfo = typeof (bid.getFloor) == 'function' ? bid.getFloor({ currency: 'USD', mediaType: creative, size: '*' }) : {};
+  return Math.floor(floorInfo.floor || (bid.params.bidfloor ? bid.params.bidfloor : 0.0));
+}
+
+const createOrtbImpObj = (bid) => {
+  let params = bid.params
+  let testMode = !!bid.params.test_mode
+
+  // Validate Banner Request.
+  let bannerObj = deepAccess(bid.mediaTypes, `banner`);
+  let nativeObj = deepAccess(bid.mediaTypes, `native`);
+  let videoObj = deepAccess(bid.mediaTypes, `video`);
+
+  let imp = {
+    id: bid.bidId,
+    ext: {
+      dailyhunt: {
+        placement_id: params.placement_id,
+        publisher_id: params.publisher_id,
+        partner: params.partner_name
+      }
+    }
+  };
+
+  // Test Mode Campaign.
+  if (testMode) {
+    imp.ext.test_mode = testMode;
+  }
+
+  if (bannerObj) {
+    imp.banner = {
+      ...createOrtbImpBannerObj(bid, bannerObj)
+    }
+    imp.bidfloor = getBidFloor(bid, 'banner');
+  } else if (nativeObj) {
+    imp.native = {
+      ...createOrtbImpNativeObj(bid, nativeObj)
+    }
+    imp.bidfloor = getBidFloor(bid, 'native');
+  } else if (videoObj) {
+    imp.video = {
+      ...createOrtbImpVideoObj(bid, videoObj)
+    }
+    imp.bidfloor = getBidFloor(bid, 'video');
+  }
+  return imp;
+}
+
+const createOrtbImpBannerObj = (bid, bannerObj) => {
+  let format = [];
+  bannerObj.sizes.forEach(size => format.push({ w: size[0], h: size[1] }))
+
+  return {
+    id: 'banner-' + bid.bidId,
+    format
+  }
+}
+
+const createOrtbImpNativeObj = (bid, nativeObj) => {
+  const assets = _map(bid.nativeParams, (bidParams, key) => {
+    const props = ORTB_NATIVE_PARAMS[key];
+    const asset = {
+      required: bidParams.required & 1,
+    };
+    if (props) {
+      let h = 0;
+      let w = 0;
+
+      asset.id = props.id;
+
+      if (bidParams.sizes) {
+        const sizes = flatten(bidParams.sizes);
+        w = sizes[0];
+        h = sizes[1];
+      }
+
+      asset[props.name] = {
+        len: bidParams.len ? bidParams.len : 20,
+        type: props.type,
+        w,
+        h
+      };
+
+      return asset;
+    }
+  }).filter(Boolean);
+  let request = {
+    assets,
+    ver: '1,0'
+  }
+  return { request: JSON.stringify(request) };
+}
+
+const createOrtbImpVideoObj = (bid, videoObj) => {
+  let obj = {};
+  let params = bid.params
+  if (!isEmpty(bid.params.video)) {
+    obj = {
+      topframe: 1,
+      skip: params.video.skippable || 0,
+      linearity: params.video.linearity || 1,
+      minduration: params.video.minduration || 5,
+      maxduration: params.video.maxduration || 60,
+      mimes: params.video.mimes || ['video/mp4'],
+      protocols: getProtocols(params.video),
+      w: params.video.playerSize[0][0],
+      h: params.video.playerSize[0][1],
+    };
+  } else {
+    obj = {
+      mimes: ['video/mp4'],
+    };
+  }
+  obj.ext = {
+    ...videoObj,
+  }
+  return obj;
+}
+
+export function getProtocols({protocols}) {
+  let defaultValue = [2, 3, 5, 6, 7, 8];
+  let listProtocols = [
+    {key: 'VAST_1_0', value: 1},
+    {key: 'VAST_2_0', value: 2},
+    {key: 'VAST_3_0', value: 3},
+    {key: 'VAST_1_0_WRAPPER', value: 4},
+    {key: 'VAST_2_0_WRAPPER', value: 5},
+    {key: 'VAST_3_0_WRAPPER', value: 6},
+    {key: 'VAST_4_0', value: 7},
+    {key: 'VAST_4_0_WRAPPER', value: 8}
+  ];
+  if (protocols) {
+    return listProtocols.filter(p => {
+      return protocols.indexOf(p.key) !== -1
+    }).map(p => p.value);
+  } else {
+    return defaultValue;
+  }
+}
+
+const createServerRequest = (ortbRequest, validBidRequests, isTestMode = 'false') => ({
+  method: 'POST',
+  url: isTestMode === 'true' ? PROD_PREBID_TEST_ENDPOINT_URL + validBidRequests[0].params.partner_name : PROD_PREBID_ENDPOINT_URL + validBidRequests[0].params.partner_name,
+  data: JSON.stringify(ortbRequest),
+  options: {
+    contentType: 'application/json',
+    withCredentials: true
+  },
+  bids: validBidRequests
+})
+
+const createPrebidBannerBid = (bid, bidResponse) => ({
+  requestId: bid.bidId,
+  cpm: bidResponse.price.toFixed(2),
+  creativeId: bidResponse.crid,
+  width: bidResponse.w,
+  height: bidResponse.h,
+  ttl: 360,
+  netRevenue: bid.netRevenue === 'net',
+  currency: 'USD',
+  ad: bidResponse.adm,
+  mediaType: 'banner',
+  winUrl: bidResponse.nurl,
+  adomain: bidResponse.adomain
+})
+
+const createPrebidNativeBid = (bid, bidResponse) => ({
+  requestId: bid.bidId,
+  cpm: bidResponse.price.toFixed(2),
+  creativeId: bidResponse.crid,
+  currency: 'USD',
+  ttl: 360,
+  netRevenue: bid.netRevenue === 'net',
+  native: parseNative(bidResponse),
+  mediaType: 'native',
+  winUrl: bidResponse.nurl,
+  width: bidResponse.w,
+  height: bidResponse.h,
+  adomain: bidResponse.adomain
+})
+
+const parseNative = (bid) => {
+  let adm = JSON.parse(bid.adm)
+  const { assets, link, imptrackers, jstracker } = adm.native;
+  const result = {
+    clickUrl: _encodeURIComponent(link.url),
+    clickTrackers: link.clicktrackers || [],
+    impressionTrackers: imptrackers || [],
+    javascriptTrackers: jstracker ? [ jstracker ] : []
+  };
+  assets.forEach(asset => {
+    if (!isEmpty(asset.title)) {
+      result.title = asset.title.text
+    } else if (!isEmpty(asset.img)) {
+      result[ORTB_NATIVE_TYPE_MAPPING.img[asset.img.type]] = {
+        url: asset.img.url,
+        height: asset.img.h,
+        width: asset.img.w
+      }
+    } else if (!isEmpty(asset.data)) {
+      result[ORTB_NATIVE_TYPE_MAPPING.data[asset.data.type]] = asset.data.value
+    }
+  });
+
+  return result;
+}
+
+const createPrebidVideoBid = (bid, bidResponse) => {
+  let videoBid = {
+    requestId: bid.bidId,
+    cpm: bidResponse.price.toFixed(2),
+    creativeId: bidResponse.crid,
+    width: bidResponse.w,
+    height: bidResponse.h,
+    ttl: 360,
+    netRevenue: bid.netRevenue === 'net',
+    currency: 'USD',
+    mediaType: 'video',
+    winUrl: bidResponse.nurl,
+    adomain: bidResponse.adomain
+  };
+
+  let videoContext = bid.mediaTypes.video.context;
+  switch (videoContext) {
+    case OUTSTREAM:
+      videoBid.vastXml = bidResponse.adm;
+      break;
+    case INSTREAM:
+      videoBid.videoCacheKey = bidResponse.ext.bidder.cacheKey;
+      videoBid.vastUrl = bidResponse.ext.bidder.vastUrl;
+      break;
+  }
+  return videoBid;
+}
+
+const getQueryVariable = (variable) => {
+  let query = window.location.search.substring(1);
+  let vars = query.split('&');
+  for (var i = 0; i < vars.length; i++) {
+    let pair = vars[i].split('=');
+    if (decodeURIComponent(pair[0]) == variable) {
+      return decodeURIComponent(pair[1]);
+    }
+  }
+  return false;
+}
+
+export const spec = {
+  code: BIDDER_CODE,
+
+  aliases: [BIDDER_ALIAS],
+
+  supportedMediaTypes: SUPPORTED_MEDIA_TYPES,
+
+  isBidRequestValid: bid => !!bid.params.placement_id && !!bid.params.publisher_id && !!bid.params.partner_name,
+
+  buildRequests: function (validBidRequests, bidderRequest) {
+    let serverRequests = [];
+
+    // ORTB Request.
+    let ortbReq = createOrtbRequest(validBidRequests, bidderRequest);
+
+    validBidRequests.forEach((bid) => {
+      let imp = createOrtbImpObj(bid)
+      ortbReq.imp.push(imp);
+    });
+
+    serverRequests.push({ ...createServerRequest(ortbReq, validBidRequests, getQueryVariable('dh_test')) });
+
+    return serverRequests;
+  },
+
+  interpretResponse: function (serverResponse, request) {
+    const { seatbid } = serverResponse.body;
+    let bids = request.bids;
+    let prebidResponse = [];
+
+    let seatBids = seatbid[0].bid;
+
+    seatBids.forEach(ortbResponseBid => {
+      let bidId = ortbResponseBid.impid;
+      let actualBid = find(bids, (bid) => bid.bidId === bidId);
+      let bidMediaType = ortbResponseBid.ext.prebid.type
+      switch (bidMediaType) {
+        case mediaTypes.BANNER:
+          prebidResponse.push(createPrebidBannerBid(actualBid, ortbResponseBid));
+          break;
+        case mediaTypes.NATIVE:
+          prebidResponse.push(createPrebidNativeBid(actualBid, ortbResponseBid));
+          break;
+        case mediaTypes.VIDEO:
+          prebidResponse.push(createPrebidVideoBid(actualBid, ortbResponseBid));
+          break;
+      }
+    })
+    return prebidResponse;
+  },
+
+  onBidWon: function(bid) {
+    ajax(bid.winUrl, null, null, {
+      method: 'GET'
+    })
+  }
+}
+
+registerBidder(spec);

package/modules/dailyhuntBidAdapter.md

@@ -99,3 +99,7 @@ Dailyhunt bid adapter supports Banner, Native and Video.
         }
     ];
 ```
+
+## latest commit has all the required support for latest version of prebid above 6.x
+## Dailyhunt adapter was there till 4.x and then removed in version 5.x of prebid.
+## this doc has been also submitted to https://github.com/prebid/prebid.github.io

package/modules/docereeBidAdapter.js

@@ -14,6 +14,13 @@ export const spec = {
     const { placementId } = bid.params;
     return !!placementId
   },
+  isGdprConsentPresent: (bid) => {
+    const { gdpr, gdprConsent } = bid.params;
+    if (gdpr == '1') {
+      return !!gdprConsent
+    }
+    return true
+  },
   buildRequests: (validBidRequests) => {
     const serverRequests = [];
     const { data } = config.getConfig('doceree.user')
@@ -21,7 +28,7 @@ export const spec = {
     const encodedUserInfo = window.btoa(encodeURIComponent(JSON.stringify(data)))
 
     validBidRequests.forEach(function(validBidRequest) {
-      const { publisherUrl, placementId } = validBidRequest.params;
+      const { publisherUrl, placementId, gdpr, gdprConsent } = validBidRequest.params;
       const url = publisherUrl || page
       let queryString = '';
       queryString = tryAppendQueryString(queryString, 'id', placementId);
@@ -32,6 +39,8 @@ export const spec = {
       queryString = tryAppendQueryString(queryString, 'prebidjs', true);
       queryString = tryAppendQueryString(queryString, 'token', token);
       queryString = tryAppendQueryString(queryString, 'requestId', validBidRequest.bidId);
+      queryString = tryAppendQueryString(queryString, 'gdpr', gdpr);
+      queryString = tryAppendQueryString(queryString, 'gdpr_consent', gdprConsent);
 
       serverRequests.push({
         method: 'GET',

package/modules/docereeBidAdapter.md

@@ -25,6 +25,8 @@ var adUnits = [
                params: {
                     placementId: 'DOC_7jm9j5eqkl0xvc5w', //required
                     publisherUrl: document.URL || window.location.href, //optional
+                    gdpr: '1', //optional
+                    gdprConsent:'CPQfU1jPQfU1jG0AAAENAwCAAAAAAAAAAAAAAAAAAAAA.IGLtV_T9fb2vj-_Z99_tkeYwf95y3p-wzhheMs-8NyZeH_B4Wv2MyvBX4JiQKGRgksjLBAQdtHGlcTQgBwIlViTLMYk2MjzNKJrJEilsbO2dYGD9Pn8HT3ZCY70-vv__7v3ff_3g', //optional
                }
             }
        ]

package/modules/dspxBidAdapter.js

@@ -12,7 +12,7 @@ const GVLID = 602;
 export const spec = {
   code: BIDDER_CODE,
   gvlid: GVLID,
-  aliases: ['dspx'],
+  aliases: [],
   supportedMediaTypes: [BANNER, VIDEO],
   isBidRequestValid: function(bid) {
     return !!(bid.params.placement);

package/modules/engageyaBidAdapter.js

@@ -8,7 +8,7 @@ const BIDDER_CODE = 'engageya';
 const ENDPOINT_URL = 'https://recs.engageya.com/rec-api/getrecs.json';
 const ENDPOINT_METHOD = 'GET';
 const SUPPORTED_SIZES = [
-  [100, 75], [236, 202], [100, 100], [130, 130], [200, 200], [250, 250], [300, 272], [300, 250], [300, 230], [300, 214], [300, 187], [300, 166], [300, 150], [300, 133], [300, 120], [400, 200], [300, 200], [250, 377], [620, 410], [207, 311], [310, 166], [310, 333], [190, 106], [228, 132], [300, 174], [80, 60], [600, 500], [600, 600], [1080, 610], [1080, 610], [624, 350], [650, 1168], [1080, 1920], [300, 374]
+  [100, 75], [236, 202], [100, 100], [130, 130], [200, 200], [250, 250], [300, 272], [300, 250], [300, 230], [300, 214], [300, 187], [300, 166], [300, 150], [300, 133], [300, 120], [400, 200], [300, 200], [250, 377], [620, 410], [207, 311], [310, 166], [310, 333], [190, 106], [228, 132], [300, 174], [80, 60], [600, 500], [600, 600], [1080, 610], [1080, 610], [624, 350], [650, 1168], [1080, 1920], [300, 374], [336, 280]
 ];
 
 function getPageUrl(bidRequest, bidderRequest) {

package/modules/feedadBidAdapter.js

@@ -176,13 +176,13 @@ function isMediaTypesEmpty(mediaTypes) {
  * @return {FeedAdApiBidRequest}
  */
 function createApiBidRParams(request) {
-  return {
+  return Object.assign({}, request.params, {
     ad_type: 0,
     client_token: request.params.clientToken,
     placement_id: request.params.placementId,
     sdk_version: `prebid_${VERSION}`,
     app_hybrid: false,
-  };
+  });
 }
 
 /**

package/modules/feedadBidAdapter.md

@@ -26,6 +26,7 @@ Prebid.JS adapter that connects to the FeedAd demand sources.
                     params: {
                         clientToken: 'your-client-token' // see below for more info
                         placementId: 'your-placement-id' // see below for more info
+                        decoration: 'decoration parameters' // optional, see below for info
                     }
                 }
             ]
@@ -35,7 +36,8 @@ Prebid.JS adapter that connects to the FeedAd demand sources.
 
 # Required Parameters
 
-| Parameter | Description |
-| --------- | ----------- |
+| Parameter     | Description |
+|---------------| ----------- |
 | `clientToken` | Your FeedAd web client token. You can view your client token inside the FeedAd admin panel. |
 | `placementId` | You can choose placement IDs yourself. A placement ID should be named after the ad position inside your product. For example, if you want to display an ad inside a list of news articles, you could name it "ad-news-overview".<br> A placement ID may consist of lowercase `a-z`, `0-9`, `-` and `_`. You do not have to manually create the placement IDs before using them. Just specify them within the code, and they will appear in the FeedAd admin panel after the first request. <br> [Learn more](/concept/feed_ad/index.html) about Placement IDs and how they are grouped to play the same Creative. |
+| `decoration`  | Optional. If you want to apply a [decoration](https://docs.feedad.com/web/feed_ad/#decorations) to the ad.

package/modules/futureads.md

@@ -0,0 +1,48 @@
+# Overview
+Module Name: Future Ads Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: contact@futureads.io
+# Description
+Connects to Future Ads demand source to fetch bids.
+Banner and Video formats are supported.
+Please use ```futureads``` as the bidder code.
+# Test Parameters
+```
+var adUnits = [
+    {
+        code: 'desktop-banner-ad-div',
+        sizes: [[300, 250]], // a display size
+        bids: [
+            {
+                bidder: "futureads",
+                params: {
+                    zone: '2eb6bd58-865c-47ce-af7f-a918108c3fd2'
+                }
+            }
+        ]
+    },{
+        code: 'mobile-banner-ad-div',
+        sizes: [[300, 50]], // a mobile size
+        bids: [
+            {
+                bidder: "futureads",
+                params: {
+                    zone: '62211486-c50b-4356-9f0f-411778d31fcc'
+                }
+            }
+        ]
+    },{
+        code: 'video-ad',
+        sizes: [[300, 50]],
+        mediaType: 'video',
+        bids: [
+            {
+                bidder: "futureads",
+                params: {
+                    zone: 'ebeb1e79-8cb4-4473-b2d0-2e24b7ff47fd'
+                }
+            }
+        ]
+    },
+];
+```