mk9-prebid/modules/ajaBidAdapter.js

Header Bidding Management Library

import { Renderer } from '../src/Renderer.js';
import * as utils from '../src/utils.js';
import { registerBidder } from '../src/adapters/bidderFactory.js';
import { VIDEO, BANNER, NATIVE } from '../src/mediaTypes.js';

const BIDDER_CODE = 'aja';
const URL = 'https://ad.as.amanad.adtdp.com/v2/prebid';
const SDK_TYPE = 5;
const AD_TYPE = {
  BANNER: 1,
  NATIVE: 2,
  VIDEO: 3,
};

export const spec = {
  code: BIDDER_CODE,
  supportedMediaTypes: [VIDEO, BANNER, NATIVE],

  /**
   * Determines whether or not the given bid has all the params needed to make a valid request.
   *
   * @param {BidRequest} bidRequest
   * @returns {boolean}
   */
  isBidRequestValid: function(bidRequest) {
    return !!(bidRequest.params.asi);
  },

  /**
   * Build the request to the Server which requests Bids for the given array of Requests.
   * Each BidRequest in the argument array is guaranteed to have passed the isBidRequestValid() test.
   *
   * @param {BidRequest[]} validBidRequests
   * @param {*} bidderRequest
   * @returns {ServerRequest|ServerRequest[]}
   */
  buildRequests: function(validBidRequests, bidderRequest) {
    const bidRequests = [];
    const pageUrl = (bidderRequest && bidderRequest.refererInfo && bidderRequest.refererInfo.referer) || undefined;

    for (let i = 0, len = validBidRequests.length; i < len; i++) {
      const bidRequest = validBidRequests[i];
      let queryString = '';

      const asi = utils.getBidIdParameter('asi', bidRequest.params);
      queryString = utils.tryAppendQueryString(queryString, 'asi', asi);
      queryString = utils.tryAppendQueryString(queryString, 'skt', SDK_TYPE);
      queryString = utils.tryAppendQueryString(queryString, 'tid', bidRequest.transactionId)
      queryString = utils.tryAppendQueryString(queryString, 'prebid_id', bidRequest.bidId);
      queryString = utils.tryAppendQueryString(queryString, 'prebid_ver', '$prebid.version$');

      if (pageUrl) {
        queryString = utils.tryAppendQueryString(queryString, 'page_url', pageUrl);
      }

      const eids = bidRequest.userIdAsEids;
      if (eids && eids.length) {
        queryString = utils.tryAppendQueryString(queryString, 'eids', JSON.stringify({
          'eids': eids,
        }))
      }

      bidRequests.push({
        method: 'GET',
        url: URL,
        data: queryString
      });
    }

    return bidRequests;
  },

  interpretResponse: function(bidderResponse) {
    const bidderResponseBody = bidderResponse.body;

    if (!bidderResponseBody.is_ad_return) {
      return [];
    }

    const ad = bidderResponseBody.ad;

    const bid = {
      requestId: ad.prebid_id,
      cpm: ad.price,
      creativeId: ad.creative_id,
      dealId: ad.deal_id,
      currency: ad.currency || 'USD',
      netRevenue: true,
      ttl: 300, // 5 minutes
      meta: {
        advertiserDomains: []
      },
    }

    if (AD_TYPE.VIDEO === ad.ad_type) {
      const videoAd = bidderResponseBody.ad.video;
      Object.assign(bid, {
        vastXml: videoAd.vtag,
        width: videoAd.w,
        height: videoAd.h,
        renderer: newRenderer(bidderResponseBody),
        adResponse: bidderResponseBody,
        mediaType: VIDEO
      });

      Array.prototype.push.apply(bid.meta.advertiserDomains, videoAd.adomain)
    } else if (AD_TYPE.BANNER === ad.ad_type) {
      const bannerAd = bidderResponseBody.ad.banner;
      Object.assign(bid, {
        width: bannerAd.w,
        height: bannerAd.h,
        ad: bannerAd.tag,
        mediaType: BANNER
      });
      try {
        bannerAd.imps.forEach(impTracker => {
          const tracker = utils.createTrackPixelHtml(impTracker);
          bid.ad += tracker;
        });
      } catch (error) {
        utils.logError('Error appending tracking pixel', error);
      }

      Array.prototype.push.apply(bid.meta.advertiserDomains, bannerAd.adomain)
    } else if (AD_TYPE.NATIVE === ad.ad_type) {
      const nativeAds = ad.native.template_and_ads.ads;
      if (nativeAds.length === 0) {
        return [];
      }

      const nativeAd = nativeAds[0];
      const assets = nativeAd.assets;

      Object.assign(bid, {
        mediaType: NATIVE
      });

      bid.native = {
        title: assets.title,
        body: assets.description,
        cta: assets.cta_text,
        sponsoredBy: assets.sponsor,
        clickUrl: assets.lp_link,
        impressionTrackers: nativeAd.imps,
        privacyLink: assets.adchoice_url
      };

      if (assets.img_main !== undefined) {
        bid.native.image = {
          url: assets.img_main,
          width: parseInt(assets.img_main_width, 10),
          height: parseInt(assets.img_main_height, 10)
        };
      }

      if (assets.img_icon !== undefined) {
        bid.native.icon = {
          url: assets.img_icon,
          width: parseInt(assets.img_icon_width, 10),
          height: parseInt(assets.img_icon_height, 10)
        };
      }

      Array.prototype.push.apply(bid.meta.advertiserDomains, nativeAd.adomain)
    }

    return [bid];
  },

  getUserSyncs: function(syncOptions, serverResponses) {
    const syncs = [];
    if (!serverResponses.length) {
      return syncs;
    }

    const bidderResponseBody = serverResponses[0].body;

    if (syncOptions.pixelEnabled && bidderResponseBody.syncs) {
      bidderResponseBody.syncs.forEach(sync => {
        syncs.push({
          type: 'image',
          url: sync
        });
      });
    }

    if (syncOptions.iframeEnabled && bidderResponseBody.sync_htmls) {
      bidderResponseBody.sync_htmls.forEach(sync => {
        syncs.push({
          type: 'iframe',
          url: sync
        });
      });
    }

    return syncs;
  },
}

function newRenderer(bidderResponse) {
  const renderer = Renderer.install({
    id: bidderResponse.ad.prebid_id,
    url: bidderResponse.ad.video.purl,
    loaded: false,
  });

  try {
    renderer.setRender(outstreamRender);
  } catch (err) {
    utils.logWarn('Prebid Error calling setRender on newRenderer', err);
  }

  return renderer;
}

function outstreamRender(bid) {
  bid.renderer.push(() => {
    window['aja_vast_player'].init({
      vast_tag: bid.adResponse.ad.video.vtag,
      ad_unit_code: bid.adUnitCode, // target div id to render video
      width: bid.width,
      height: bid.height,
      progress: bid.adResponse.ad.video.progress,
      loop: bid.adResponse.ad.video.loop,
      inread: bid.adResponse.ad.video.inread
    });
  });
}

registerBidder(spec);