Integrate option to pass clickThrough urls to renderAd method (prebid…

…#5796)

* adding options to renderAd method

* adding replaceClickThrough method to utils

* implemented replaceClickThrough method in render ad to enable ssps adding url param clickthrough for publisher side counting

* update to cover some validation and unit tests as requested by harpere

* adding unit test for clickthrough implementation;

src/prebid.js

@@ -342,7 +342,7 @@ function emitAdRenderFail({ reason, message, bid, id }) {
  * @param {string} id bid id to locate the ad
  * @alias module:pbjs.renderAd
  */
-$$PREBID_GLOBAL$$.renderAd = function (doc, id) {
+$$PREBID_GLOBAL$$.renderAd = function (doc, id, options) {
  utils.logInfo('Invoking $$PREBID_GLOBAL$$.renderAd', arguments);
  utils.logMessage('Calling renderAd with adId :' + id);
 
@@ -354,6 +354,14 @@ $$PREBID_GLOBAL$$.renderAd = function (doc, id) {
  // replace macros according to openRTB with price paid = bid.cpm
  bid.ad = utils.replaceAuctionPrice(bid.ad, bid.cpm);
  bid.adUrl = utils.replaceAuctionPrice(bid.adUrl, bid.cpm);
+
+ // replacing clickthrough if submitted
+ if (options && options.clickThrough) {
+ const { clickThrough } = options;
+ bid.ad = utils.replaceClickThrough(bid.ad, clickThrough);
+ bid.adUrl = utils.replaceClickThrough(bid.adUrl, clickThrough);
+ }
+
  // save winning bids
  auctionManager.addWinningBid(bid);
 

src/utils.js

@@ -718,6 +718,11 @@ export function replaceAuctionPrice(str, cpm) {
  return str.replace(/\$\{AUCTION_PRICE\}/g, cpm);
 }
 
+export function replaceClickThrough(str, clicktag) {
+ if (!str || !clicktag || typeof clicktag !== 'string') return;
+ return str.replace(/\${CLICKTHROUGH}/g, clicktag);
+}
+
 export function timestamp() {
  return new Date().getTime();
 }

test/spec/unit/pbjs_api_spec.js

@@ -1197,6 +1197,14 @@ describe('Unit: Prebid Module', function () {
  assert.deepEqual($$PREBID_GLOBAL$$.getAllWinningBids()[0], adResponse);
  });
 
+ it('should replace ${CLICKTHROUGH} macro in winning bids response', function () {
+ pushBidResponseToAuction({
+ ad: "<script type='text/javascript' src='http://server.example.com/ad/ad.js?clickthrough=${CLICKTHROUGH}'></script>"
+ });
+ $$PREBID_GLOBAL$$.renderAd(doc, bidId, {clickThrough: 'https://someadserverclickurl.com'});
+ expect(adResponse).to.have.property('ad').and.to.match(/https:\/\/someadserverclickurl\.com/i);
+ });
+
  it('fires billing url if present on s2s bid', function () {
  const burl = 'http://www.example.com/burl';
  pushBidResponseToAuction({