Nativo Bid Adapter: add new bid adapter (#6542)

* Initial nativoBidAdapter document creation (js, md and spec)

* Fulling working prebid using nativoBidAdapter. Support for GDPR and CCPA in user syncs.

* Added defult size settings based on the largest ad unit. Added response body validation. Added consent to request url qs params.

* Changed bidder endpoint url

* Changed double quotes to single quotes.

* Reverted package-json.lock to remove modifications from PR

* Added optional bidder param 'url' so the ad server can force- match an existing placement

* Lint fix. Added space after if.

modules/nativoBidAdapter.js

@@ -0,0 +1,307 @@
+import * as utils from '../src/utils.js'
+import { registerBidder } from '../src/adapters/bidderFactory.js'
+import { BANNER } from '../src/mediaTypes.js'
+// import { config } from 'src/config'
+
+const BIDDER_CODE = 'nativo'
+const BIDDER_ENDPOINT = 'https://exchange.postrelease.com/prebid'
+
+const TIME_TO_LIVE = 360
+
+const SUPPORTED_AD_TYPES = [BANNER]
+
+const bidRequestMap = {}
+
+// Prebid adapter referrence doc: https://docs.prebid.org/dev-docs/bidder-adaptor.html
+
+export const spec = {
+  code: BIDDER_CODE,
+  aliases: ['ntv'], // short code
+  supportedMediaTypes: SUPPORTED_AD_TYPES,
+
+  /**
+   * Determines whether or not the given bid request is valid.
+   *
+   * @param {BidRequest} bid The bid params to validate.
+   * @return boolean True if this is a valid bid, and false otherwise.
+   */
+  isBidRequestValid: function (bid) {
+    return bid.params && !!bid.params.placementId
+  },
+
+  /**
+   * Called when the page asks Prebid.js for bids
+   * Make a server request from the list of BidRequests
+   *
+   * @param {Array} validBidRequests - An array of bidRequest objects, one for each AdUnit that your module is involved in. This array has been processed for special features like sizeConfig, so it’s the list that you should be looping through
+   * @param {Object} bidderRequest - The master bidRequest object. This object is useful because it carries a couple of bid parameters that are global to all the bids.
+   * @return ServerRequest Info describing the request to the server.
+   */
+  buildRequests: function (validBidRequests, bidderRequest) {
+    const placementIds = []
+    const placmentBidIdMap = {}
+    let placementId, pageUrl
+    validBidRequests.forEach((request) => {
+      pageUrl = pageUrl || request.params.url // Use the first url value found
+      placementId = request.params.placementId
+      placementIds.push(placementId)
+      placmentBidIdMap[placementId] = {
+        bidId: request.bidId,
+        size: getLargestSize(request.sizes),
+      }
+    })
+    bidRequestMap[bidderRequest.bidderRequestId] = placmentBidIdMap
+
+    if (!pageUrl) pageUrl = bidderRequest.refererInfo.referer
+
+    let params = [
+      { key: 'ntv_ptd', value: placementIds.toString() },
+      { key: 'ntv_pb_rid', value: bidderRequest.bidderRequestId },
+      {
+        key: 'ntv_url',
+        value: encodeURIComponent(pageUrl),
+      },
+    ]
+
+    if (bidderRequest.gdprConsent) {
+      // Put on the beginning of the qs param array
+      params.unshift({
+        key: 'ntv_gdpr_consent',
+        value: bidderRequest.gdprConsent.consentString,
+      })
+    }
+
+    if (bidderRequest.uspConsent) {
+      // Put on the beginning of the qs param array
+      params.unshift({ key: 'us_privacy', value: bidderRequest.uspConsent })
+    }
+
+    let serverRequest = {
+      method: 'GET',
+      url: BIDDER_ENDPOINT + arrayToQS(params),
+    }
+
+    return serverRequest
+  },
+
+  /**
+   * Will be called when the browser has received the response from your server.
+   * The function will parse the response and create a bidResponse object containing one or more bids.
+   * The adapter should indicate no valid bids by returning an empty array.
+   *
+   * @param {Object} response - Data returned from the bidding server request endpoint
+   * @param {Object} request - The request object used to call the server request endpoint
+   * @return {Array} An array of bids which were nested inside the server.
+   */
+  interpretResponse: function (response, request) {
+    // If the bid response was empty, return []
+    if (!response || !response.body || utils.isEmpty(response.body)) return []
+
+    try {
+      const body =
+        typeof response.body === 'string'
+          ? JSON.parse(response.body)
+          : response.body
+
+      const bidResponses = []
+      const seatbids = body.seatbid
+
+      // Step through and grab pertinent data
+      let bidResponse, adUnit
+      seatbids.forEach((seatbid) => {
+        seatbid.bid.forEach((bid) => {
+          adUnit = this.getRequestId(body.id, bid.impid)
+          bidResponse = {
+            requestId: adUnit.bidId,
+            cpm: bid.price,
+            currency: body.cur,
+            width: bid.w || adUnit.size[0],
+            height: bid.h || adUnit.size[1],
+            creativeId: bid.crid,
+            dealId: bid.id,
+            netRevenue: true,
+            ttl: bid.ttl || TIME_TO_LIVE,
+            ad: bid.adm,
+            meta: {
+              advertiserDomains: bid.adomain,
+            },
+          }
+
+          bidResponses.push(bidResponse)
+        })
+      })
+
+      // Don't need the map anymore as it was unique for one request/response
+      delete bidRequestMap[body.id]
+
+      return bidResponses
+    } catch (error) {
+      // If there is an error, return []
+      return []
+    }
+  },
+
+  /**
+   * All user ID sync activity should be done using the getUserSyncs callback of the BaseAdapter model.
+   * Given an array of all the responses from the server, getUserSyncs is used to determine which user syncs should occur.
+   * The order of syncs in the serverResponses array matters. The most important ones should come first, since publishers may limit how many are dropped on their page.
+   * @param {Object} syncOptions - Which user syncs are allowed?
+   * @param {Array} serverResponses - Array of server's responses
+   * @param {Object} gdprConsent - GDPR consent data
+   * @param {Object} uspConsent - USP consent data
+   * @return {Array} The user syncs which should be dropped.
+   */
+  getUserSyncs: function (
+    syncOptions,
+    serverResponses,
+    gdprConsent,
+    uspConsent
+  ) {
+    // Generate consent qs string
+    let params = ''
+    // GDPR
+    if (gdprConsent) {
+      params = appendQSParamString(
+        params,
+        'gdpr',
+        gdprConsent.gdprApplies ? 1 : 0
+      )
+      params = appendQSParamString(
+        params,
+        'gdpr_consent',
+        encodeURIComponent(gdprConsent.consentString || '')
+      )
+    }
+    // CCPA
+    if (uspConsent) {
+      params = appendQSParamString(
+        params,
+        'us_privacy',
+        encodeURIComponent(uspConsent.uspConsent)
+      )
+    }
+
+    // Get sync urls from the respnse and inject cinbsent params
+    const types = {
+      iframe: syncOptions.iframeEnabled,
+      image: syncOptions.pixelEnabled,
+    }
+    const syncs = []
+
+    let body
+    serverResponses.forEach((response) => {
+      // If the bid response was empty, return []
+      if (!response || !response.body || utils.isEmpty(response.body)) {
+        return syncs
+      }
+
+      body =
+        typeof response.body === 'string'
+          ? JSON.parse(response.body)
+          : response.body
+
+      // Make sure we have valid content
+      if (!body || !body.seatbid || body.seatbid.length === 0) return
+
+      body.seatbid.forEach((seatbid) => {
+        // Grab the syncs for each seatbid
+        seatbid.syncUrls.forEach((sync) => {
+          if (types[sync.type]) {
+            if (sync.url.trim() !== '') {
+              syncs.push({
+                type: sync.type,
+                url: sync.url.replace('{GDPR_params}', params),
+              })
+            }
+          }
+        })
+      })
+    })
+
+    return syncs
+  },
+
+  /**
+   * Will be called when an adpater timed out for an auction.
+   * Adapter can fire a ajax or pixel call to register a timeout at thier end.
+   * @param {Object} timeoutData - Timeout specific data
+   */
+  onTimeout: function (timeoutData) {},
+
+  /**
+   * Will be called when a bid from the adapter won the auction.
+   * @param {Object} bid - The bid that won the auction
+   */
+  onBidWon: function (bid) {},
+
+  /**
+   * Will be called when the adserver targeting has been set for a bid from the adapter.
+   * @param {Object} bidder - The bid of which the targeting has been set
+   */
+  onSetTargeting: function (bid) {},
+
+  /**
+   * Maps Prebid's bidId to Nativo's placementId values per unique bidderRequestId
+   * @param {String} bidderRequestId - The unique ID value associated with the bidderRequest
+   * @param {String} placementId - The placement ID value from Nativo
+   * @returns {String} - The bidId value associated with the corresponding placementId
+   */
+  getRequestId: function (bidderRequestId, placementId) {
+    return (
+      bidRequestMap[bidderRequestId] &&
+      bidRequestMap[bidderRequestId][placementId]
+    )
+  },
+}
+registerBidder(spec)
+
+// Utils
+/**
+ * Append QS param to existing string
+ * @param {String} str - String to append to
+ * @param {String} key - Key to append
+ * @param {String} value - Value to append
+ * @returns
+ */
+function appendQSParamString(str, key, value) {
+  return str + `${str.length ? '&' : ''}${key}=${value}`
+}
+
+/**
+ * Convert an object to query string parameters
+ * @param {Object} obj - Object to convert
+ * @returns
+ */
+function arrayToQS(arr) {
+  return (
+    '?' +
+    arr.reduce((value, obj) => {
+      return appendQSParamString(value, obj.key, obj.value)
+    }, '')
+  )
+}
+
+/**
+ * Get the largest size array
+ * @param {Array} sizes - Array of size arrays
+ * @returns Size array with the largest area
+ */
+function getLargestSize(sizes, method = area) {
+  if (!sizes || sizes.length === 0) return []
+  if (sizes.length === 1) return sizes[0]
+
+  return sizes.reduce((prev, current) => {
+    if (method(current) > method(prev)) {
+      return current
+    } else {
+      return prev
+    }
+  })
+}
+
+/**
+ * Calculate the area
+ * @param {Array} size - [width, height]
+ * @returns The calculated area
+ */
+const area = (size) => size[0] * size[1]

modules/nativoBidAdapter.md

@@ -0,0 +1,40 @@
+# Overview
+
+```
+Module Name: Nativo Bid Adapter
+Module Type: Bidder Adapter
+Maintainer: prebiddev@nativo.com
+```
+
+# Description
+
+Module that connects to Nativo's demand sources
+
+# Dev
+
+gulp serve --modules=nativoBidAdapter
+
+# Test Parameters
+
+```
+var adUnits = [
+        {
+            code: 'div-gpt-ad-1460505748561-0',
+            mediaTypes: {
+                banner: {
+                    sizes: [[300, 250], [300,600]],
+                }
+            },
+            // Replace this object to test a new Adapter!
+            bids: [{
+                bidder: 'nativo',
+                params: {
+                    placementId: 1125609,
+                    url: 'https://test-sites.internal.nativo.net/testing/prebid_adpater.html'
+                }
+            }]
+
+        }
+    ];
+
+```