prebid.js 8.5.0 → 8.7.0

package/modules/optidigitalBidAdapter.js

@@ -7,6 +7,7 @@ const GVL_ID = 915;
 const ENDPOINT_URL = 'https://pbs.optidigital.com/bidder';
 const USER_SYNC_URL_IFRAME = 'https://scripts.opti-digital.com/js/presync.html?endpoint=optidigital';
 let CUR = 'USD';
+let isSynced = false;
 
 export const spec = {
   code: BIDDER_CODE,
@@ -46,8 +47,6 @@ export const spec = {
       referrer: (bidderRequest.refererInfo && bidderRequest.refererInfo.page) ? bidderRequest.refererInfo.page : '',
       hb_version: '$prebid.version$',
       deviceWidth: document.documentElement.clientWidth,
-      // TODO: fix auctionId leak: https://github.com/prebid/Prebid.js/issues/9781
-      auctionId: deepAccess(validBidRequests[0], 'auctionId'),
       bidderRequestId: deepAccess(validBidRequests[0], 'bidderRequestId'),
       publisherId: deepAccess(validBidRequests[0], 'params.publisherId'),
       imp: validBidRequests.map(bidRequest => buildImp(bidRequest, ortb2)),
@@ -56,6 +55,10 @@ export const spec = {
       bapp: deepAccess(validBidRequests[0], 'params.bapp') || []
     }
 
+    if (validBidRequests[0].auctionId) {
+      payload.auctionId = validBidRequests[0].auctionId;
+    }
+
     if (validBidRequests[0].params.pageTemplate && validBidRequests[0].params.pageTemplate !== '') {
       payload.pageTemplate = validBidRequests[0].params.pageTemplate;
     }
@@ -136,21 +139,23 @@ export const spec = {
      */
   getUserSyncs: function(syncOptions, serverResponses, gdprConsent, uspConsent) {
     let syncurl = '';
+    if (!isSynced) {
+      // Attaching GDPR Consent Params in UserSync url
+      if (gdprConsent) {
+        syncurl += '&gdpr=' + (gdprConsent.gdprApplies ? 1 : 0);
+        syncurl += '&gdpr_consent=' + encodeURIComponent(gdprConsent.consentString || '');
+      }
+      if (uspConsent && uspConsent.consentString) {
+        syncurl += `&ccpa_consent=${uspConsent.consentString}`;
+      }
 
-    // Attaching GDPR Consent Params in UserSync url
-    if (gdprConsent) {
-      syncurl += '&gdpr=' + (gdprConsent.gdprApplies ? 1 : 0);
-      syncurl += '&gdpr_consent=' + encodeURIComponent(gdprConsent.consentString || '');
-    }
-    if (uspConsent && uspConsent.consentString) {
-      syncurl += `&ccpa_consent=${uspConsent.consentString}`;
-    }
-
-    if (syncOptions.iframeEnabled) {
-      return [{
-        type: 'iframe',
-        url: USER_SYNC_URL_IFRAME + syncurl
-      }];
+      if (syncOptions.iframeEnabled) {
+        isSynced = true;
+        return [{
+          type: 'iframe',
+          url: USER_SYNC_URL_IFRAME + syncurl
+        }];
+      }
     }
   },
 };
@@ -218,4 +223,8 @@ function _getFloor (bid, sizes, currency) {
   return floor !== null ? floor : bid.params.floor;
 }
 
+export function resetSync() {
+  isSynced = false;
+}
+
 registerBidder(spec);

package/modules/pubCircleBidAdapter.js

@@ -0,0 +1,231 @@
+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';
+
+const BIDDER_CODE = 'pubcircle';
+const AD_URL = 'https://ml.pubcircle.ai/pbjs';
+const SYNC_URL = 'https://cs.pubcircle.ai';
+
+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 } = params;
+  const bidfloor = getBidFloor(bid);
+
+  const placement = {
+    bidId,
+    schain,
+    bidfloor
+  };
+
+  placement.placementId = placementId;
+  placement.type = 'publisher';
+
+  if (bid.userId) {
+    getUserId(placement.eids, bid.userId.uid2 && bid.userId.uid2.id, 'uidapi.com');
+    getUserId(placement.eids, bid.userId.lotamePanoramaId, 'lotame.com');
+    getUserId(placement.eids, bid.userId.idx, 'idx.lat');
+    getUserId(placement.eids, bid.userId.idl_env, 'liveramp.com');
+  }
+
+  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.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;
+  }
+}
+
+function getUserId(eids, id, source, uidExt) {
+  if (id) {
+    var uid = { id };
+    if (uidExt) {
+      uid.ext = uidExt;
+    }
+    eids.push({
+      source,
+      uids: [ uid ]
+    });
+  }
+}
+
+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 && 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
+    }];
+  },
+
+  onBidViewable: function (bid) {
+    // to do : we need to implement js tag to fire pixel with viewability counter
+  }
+};
+
+registerBidder(spec);

package/modules/pubCircleBidAdapter.md

@@ -0,0 +1,79 @@
+# Overview
+
+```
+Module Name: PubCirlce Bidder Adapter
+Module Type: PubCirlce Bidder Adapter
+Maintainer: system@smartyads.com
+```
+
+# Description
+
+Connects to PubCirlce exchange for bids.
+PubCirlce bid adapter supports Banner, Video (instream and outstream) and Native.
+
+# Test Parameters
+```
+    var adUnits = [
+                // Will return static test banner
+                {
+                    code: 'addunit1',
+                    mediaTypes: {
+                        banner: {
+                            sizes: [ [300, 250], [320, 50] ],
+                        }
+                    },
+                    bids: [
+                        {
+                            bidder: 'pubcircle',
+                            params: {
+                                placementId: 'testBanner',
+                            }
+                        }
+                    ]
+                },
+                {
+                    code: 'addunit2',
+                    mediaTypes: {
+                        video: {
+                            playerSize: [ [640, 480] ],
+                            context: 'instream',
+                            minduration: 5,
+                            maxduration: 60,
+                        }
+                    },
+                    bids: [
+                        {
+                            bidder: 'pubcircle',
+                            params: {
+                                placementId: 'testVideo',
+                            }
+                        }
+                    ]
+                },
+                {
+                    code: 'addunit3',
+                    mediaTypes: {
+                        native: {
+                            title: {
+                                required: true
+                            },
+                            body: {
+                                required: true
+                            },
+                            icon: {
+                                required: true,
+                                size: [64, 64]
+                            }
+                        }
+                    },
+                    bids: [
+                        {
+                            bidder: 'pubcircle',
+                            params: {
+                                placementId: 'testNative',
+                            }
+                        }
+                    ]
+                }
+            ];
+```

package/modules/relevadRtdProvider.js

@@ -110,6 +110,7 @@ function composeOrtb2Data(rtdData, prefix) {
   !isEmpty(categories.cat) && deepSetValue(addOrtb2, prefix + '.cat', categories.cat);
   !isEmpty(categories.pagecat) && deepSetValue(addOrtb2, prefix + '.pagecat', categories.pagecat);
   !isEmpty(categories.sectioncat) && deepSetValue(addOrtb2, prefix + '.sectioncat', categories.sectioncat);
+  !isEmpty(categories.sectioncat) && deepSetValue(addOrtb2, prefix + '.ext.data.relevad_rtd', categories.sectioncat);
   !isEmpty(categories.cattax) && deepSetValue(addOrtb2, prefix + '.cattax', categories.cattax);
 
   if (!isEmpty(content) && !isEmpty(content.segs) && content.segtax) {
@@ -134,7 +135,8 @@ function setBidderSiteAndContent(bidderOrtbFragment, bidder, rtdData) {
   try {
     let addOrtb2 = composeOrtb2Data(rtdData, 'site');
     !isEmpty(rtdData.segments) && deepSetValue(addOrtb2, 'user.ext.data.relevad_rtd', rtdData.segments);
-    !isEmpty(rtdData.categories?.sectioncat) && deepSetValue(addOrtb2, 'site.ext.data.relevad_rtd', rtdData.categories.sectioncat);
+    !isEmpty(rtdData.segments) && deepSetValue(addOrtb2, 'user.ext.data.segments', rtdData.segments);
+    !isEmpty(rtdData.categories) && deepSetValue(addOrtb2, 'user.ext.data.contextual_categories', rtdData.categories.pagecat);
     if (isEmpty(addOrtb2)) {
       return;
     }
@@ -180,7 +182,7 @@ function getFiltered(data, minscore) {
   const cats = filterByScore(data.cats, minscore);
   const pcats = filterByScore(data.pcats, minscore) || cats;
   const scats = filterByScore(data.scats, minscore) || pcats;
-  const cattax = data.cattax ? data.cattax : CATTAX_IAB;
+  const cattax = (data.cattax || data.cattax === undefined) ? data.cattax : CATTAX_IAB;
   relevadData.categories = {cat: cats, pagecat: pcats, sectioncat: scats, cattax: cattax};
 
   const contsegs = filterByScore(data.contsegs, minscore);
@@ -268,15 +270,12 @@ export function addRtdData(reqBids, data, moduleConfig) {
           }
           if (wb && !isEmpty(relevadList)) {
             setBidderSiteAndContent(reqBids.ortb2Fragments?.bidder, bid.bidder, relevadData);
+            setBidderSiteAndContent(bid, 'ortb2', relevadData);
             deepSetValue(bid, 'params.keywords.relevad_rtd', relevadList);
-            deepSetValue(bid, 'params.target', [].concat(bid.params?.target ? [bid.params.target] : []).concat(relevadList.map(entry => { return 'relevad_rtd=' + entry; })).join(';'));
+            !(bid.params?.target || '').includes('relevad_rtd=') && deepSetValue(bid, 'params.target', [].concat(bid.params?.target ? [bid.params.target] : []).concat(relevadList.map(entry => { return 'relevad_rtd=' + entry; })).join(';'));
             let firstPartyData = {};
             firstPartyData[bid.bidder] = { firstPartyData: { relevad_rtd: relevadList } };
             config.setConfig(firstPartyData);
-            !isEmpty(relevadData.segments) && deepSetValue(bid, 'ortb2.user.ext.data.segments', relevadData.segments);
-            !isEmpty(relevadData.categories) && deepSetValue(bid, 'ortb2.user.ext.data.contextual_categories', relevadData.categories.pagecat);
-            !isEmpty(relevadData.categories) && deepSetValue(bid, 'ortb2.site.ext.data.relevad_rtd', relevadData.categories.pagecat);
-            !isEmpty(relevadData.segments) && deepSetValue(bid, 'ortb2.user.ext.data.relevad_rtd', relevadData.segments);
           }
         }
       } catch (e) {

package/modules/ssmasBidAdapter.js

@@ -6,8 +6,8 @@ import {config} from '../src/config.js';
 
 export const SSMAS_CODE = 'ssmas';
 const SSMAS_SERVER = 'ads.ssmas.com';
-export const SSMAS_ENDPOINT = `http://${SSMAS_SERVER}/ortb`;
-const SYNC_URL = `http://sync.ssmas.com/user_sync`;
+export const SSMAS_ENDPOINT = `https://${SSMAS_SERVER}/ortb`;
+const SYNC_URL = `https://sync.ssmas.com/user_sync`;
 export const SSMAS_REQUEST_METHOD = 'POST';
 const GDPR_VENDOR_ID = 1183;
 

package/modules/tappxBidAdapter.js

@@ -12,7 +12,7 @@ const BIDDER_CODE = 'tappx';
 const GVLID_CODE = 628;
 const TTL = 360;
 const CUR = 'USD';
-const TAPPX_BIDDER_VERSION = '0.1.2';
+const TAPPX_BIDDER_VERSION = '0.1.3';
 const TYPE_CNN = 'prebidjs';
 const LOG_PREFIX = '[TAPPX]: ';
 const VIDEO_SUPPORT = ['instream', 'outstream'];
@@ -146,22 +146,22 @@ function validBasic(bid) {
     return false;
   }
 
-  if (bid.params.tappxkey == null) {
+  if (!bid.params.tappxkey) {
     logWarn(LOG_PREFIX, 'Please review the mandatory Tappxkey parameter.');
     return false;
   }
 
-  if (bid.params.host == null) {
+  if (!bid.params.host) {
     logWarn(LOG_PREFIX, 'Please review the mandatory Host parameter.');
     return false;
   }
 
-  let classicEndpoint = true
+  let classicEndpoint = true;
   if ((new RegExp(`^(vz.*|zz.*)\\.*$`, 'i')).test(bid.params.host)) {
-    classicEndpoint = false
+    classicEndpoint = false;
   }
 
-  if (classicEndpoint && bid.params.endpoint == null) {
+  if (classicEndpoint && !bid.params.endpoint) {
     logWarn(LOG_PREFIX, 'Please review the mandatory endpoint Tappx parameters.');
     return false;
   }
@@ -191,7 +191,7 @@ function validMediaType(bid) {
  */
 function interpretBid(serverBid, request) {
   let bidReturned = {
-    requestId: request.bids.bidId,
+    requestId: request.bids?.bidId,
     cpm: serverBid.price,
     currency: serverBid.cur ? serverBid.cur : CUR,
     width: serverBid.w,
@@ -206,7 +206,7 @@ function interpretBid(serverBid, request) {
   if (typeof serverBid.nurl != 'undefined') { bidReturned.nurl = serverBid.nurl }
   if (typeof serverBid.burl != 'undefined') { bidReturned.burl = serverBid.burl }
 
-  if (typeof request.bids.mediaTypes !== 'undefined' && typeof request.bids.mediaTypes.video !== 'undefined') {
+  if (typeof request.bids?.mediaTypes !== 'undefined' && typeof request.bids?.mediaTypes.video !== 'undefined') {
     bidReturned.vastXml = serverBid.adm;
     bidReturned.vastUrl = serverBid.lurl;
     bidReturned.ad = serverBid.adm;
@@ -214,13 +214,12 @@ function interpretBid(serverBid, request) {
     bidReturned.width = serverBid.w;
     bidReturned.height = serverBid.h;
 
-    if (request.bids.mediaTypes.video.context === 'outstream') {
-      const url = (serverBid.ext.purl) ? serverBid.ext.purl : false;
-      if (typeof url === 'undefined') {
+    if (request.bids?.mediaTypes.video.context === 'outstream') {
+      if (!serverBid.ext.purl) {
         logWarn(LOG_PREFIX, 'Error getting player outstream from tappx');
         return false;
       }
-      bidReturned.renderer = createRenderer(bidReturned, request, url);
+      bidReturned.renderer = createRenderer(bidReturned, request, serverBid.ext.purl);
     }
   } else {
     bidReturned.ad = serverBid.adm;
@@ -228,7 +227,7 @@ function interpretBid(serverBid, request) {
   }
 
   if (typeof bidReturned.adomain !== 'undefined' || bidReturned.adomain !== null) {
-    bidReturned.meta = { advertiserDomains: request.bids.adomain };
+    bidReturned.meta = { advertiserDomains: request.bids?.adomain };
   }
 
   return bidReturned;
@@ -252,6 +251,7 @@ function buildOneRequest(validBidRequests, bidderRequest) {
   const BIDEXTRA = deepAccess(validBidRequests, 'params.ext');
   const bannerMediaType = deepAccess(validBidRequests, 'mediaTypes.banner');
   const videoMediaType = deepAccess(validBidRequests, 'mediaTypes.video');
+  const ORTB2 = deepAccess(validBidRequests, 'ortb2');
 
   // let requests = [];
   let payload = {};
@@ -304,6 +304,8 @@ function buildOneRequest(validBidRequests, bidderRequest) {
   let h;
 
   if (bannerMediaType) {
+    if (!Array.isArray(bannerMediaType.sizes)) { logWarn(LOG_PREFIX, 'Banner sizes array not found.'); }
+
     let banner = {};
     w = bannerMediaType.sizes[0][0];
     h = bannerMediaType.sizes[0][1];
@@ -341,7 +343,9 @@ function buildOneRequest(validBidRequests, bidderRequest) {
     }
 
     if ((video.w === undefined || video.w == null || video.w <= 0) ||
-        (video.h === undefined || video.h == null || video.h <= 0)) {
+      (video.h === undefined || video.h == null || video.h <= 0)) {
+      if (!Array.isArray(videoMediaType.playerSize)) { logWarn(LOG_PREFIX, 'Video playerSize array not found.'); }
+
       w = videoMediaType.playerSize[0][0];
       h = videoMediaType.playerSize[0][1];
       video.w = w;
@@ -410,6 +414,14 @@ function buildOneRequest(validBidRequests, bidderRequest) {
   let geo = {};
   geo.country = deepAccess(validBidRequests, 'params.geo.country');
   // < Device object
+  let configGeo = {};
+  configGeo.country = ORTB2?.device?.geo;
+
+  if (typeof configGeo.country !== 'undefined') {
+    device.geo = configGeo;
+  } else if (typeof geo.country !== 'undefined') {
+    device.geo = geo;
+  };
 
   // > GDPR
   let user = {};
@@ -491,7 +503,7 @@ function getLanguage() {
 
 function getOs() {
   let ua = navigator.userAgent;
-  if (ua.indexOf('Windows') != -1) { return 'Windows'; } else if (ua.indexOf('Mac OS X') != -1) { return 'macOS'; } else if (ua.match(/Android/)) { return 'Android'; } else if (ua.match(/(iPhone|iPod|iPad)/)) { return 'iOS'; } else if (ua.indexOf('Linux') != -1) { return 'Linux'; } else { return 'Unknown'; }
+  if (ua.match(/Android/)) { return 'Android'; } else if (ua.match(/(iPhone|iPod|iPad)/)) { return 'iOS'; } else if (ua.indexOf('Mac OS X') != -1) { return 'macOS'; } else if (ua.indexOf('Windows') != -1) { return 'Windows'; } else if (ua.indexOf('Linux') != -1) { return 'Linux'; } else { return 'Unknown'; }
 }
 
 function getVendor() {

package/modules/tappxBidAdapter.md

@@ -92,3 +92,20 @@ Ads sizes available: [300,250], [320,50], [320,480], [480,320], [728,90], [768,1
         }
     ];
 ```
+### Configuration
+
+Use `setConfig` to configure this submodule ortb2.device.geo, this will allow geolocation
+`Geo` object to bring First Party Information.
+
+```javascript
+var TIMEOUT = 1000;
+pbjs.setConfig({
+    ortb2:{
+        device:{
+            geo:{
+                country:'US'
+            }
+        }
+    }
+});
+```