diff --git a/modules/clicktripzBidAdapter.js b/modules/clicktripzBidAdapter.js new file mode 100644 index 00000000000..2149cbe4527 --- /dev/null +++ b/modules/clicktripzBidAdapter.js @@ -0,0 +1,67 @@ +import {logError, _each} from '../src/utils.js'; +import {registerBidder} from '../src/adapters/bidderFactory.js'; + +const BIDDER_CODE = 'clicktripz'; +const ENDPOINT_URL = 'https://www.clicktripz.com/x/prebid/v1'; + +export const spec = { + code: BIDDER_CODE, + aliases: ['ctz'], // short code + + isBidRequestValid: function (bid) { + if (bid && bid.params && bid.params.placementId && bid.params.siteId) { + return true; + } + + return false; + }, + + buildRequests: function (validBidRequests) { + let bidRequests = []; + + _each(validBidRequests, function (bid) { + bidRequests.push({ + bidId: bid.bidId, + placementId: bid.params.placementId, + siteId: bid.params.siteId, + sizes: bid.sizes.map(function (size) { + return size.join('x') + }) + }); + }); + return { + method: 'POST', + url: ENDPOINT_URL, + data: bidRequests + }; + }, + + interpretResponse: function (serverResponse) { + let bidResponses = []; + + if (serverResponse && serverResponse.body) { + _each(serverResponse.body, function (bid) { + if (bid.errors) { + logError(bid.errors); + return; + } + + const size = bid.size.split('x'); + bidResponses.push({ + requestId: bid.bidId, + cpm: bid.cpm, + width: size[0], + height: size[1], + creativeId: bid.creativeId, + currency: bid.currency, + netRevenue: bid.netRevenue, + ttl: bid.ttl, + adUrl: bid.adUrl + }); + }); + } + return bidResponses; + } +}; + +registerBidder(spec); diff --git a/modules/clicktripzBidAdapter.md b/modules/clicktripzBidAdapter.md new file mode 100644 index 00000000000..1de1e26f37a --- /dev/null +++ b/modules/clicktripzBidAdapter.md @@ -0,0 +1,35 @@ +# Overview + +``` +Module Name: Clicktripz Bidder Adapter +Module Type: Bidder Adapter +Maintainer: integration-support@clicktripz.com +``` + +# Description +Our module makes it easy to integrate Clicktripz demand sources into your website. + +Supported Ad Fortmats: +* Banner + +# Test Parameters +``` + var adUnits = [ + { + code: 'test-div', + mediaTypes: { + banner: { + sizes: [[300, 250], [300,600]], + } + }, + bids: [ + { + bidder: "clicktripz", + params: { + placementId: '4312c63f', + siteId: 'prebid', + } + } + ] + } + ]; diff --git a/test/spec/modules/clicktripzBidAdapter_spec.js b/test/spec/modules/clicktripzBidAdapter_spec.js new file mode 100644 index 00000000000..fed94811c4e --- /dev/null +++ b/test/spec/modules/clicktripzBidAdapter_spec.js @@ -0,0 +1,152 @@ +import {expect} from 'chai'; +import {spec} from 'modules/clicktripzBidAdapter.js'; + +const ENDPOINT_URL = 'https://www.clicktripz.com/x/prebid/v1'; + +describe('clicktripzBidAdapter', function () { + describe('isBidRequestValid', function () { + let bid = { + 'bidder': 'clicktripz', + 'params': { + placementId: 'testPlacementId', + siteId: 'testSiteId' + }, + 'adUnitCode': 'adunit-code', + 'sizes': [ + [300, 250] + ], + 'bidId': '1234asdf1234', + 'bidderRequestId': '1234asdf1234asdf', + 'auctionId': '61466567-d482-4a16-96f0-fe5f25ffbdf120' + }; + + let bid2 = { + 'bidder': 'clicktripz', + 'params': { + placementId: 'testPlacementId' + }, + 'adUnitCode': 'adunit-code', + 'sizes': [ + [300, 250] + ], + 'bidId': '1234asdf1234', + 'bidderRequestId': '1234asdf1234asdf', + 'auctionId': '61466567-d482-4a16-96f0-fe5f25ffbdf120' + }; + + let bid3 = { + 'bidder': 'clicktripz', + 'params': { + siteId: 'testSiteId' + }, + 'adUnitCode': 'adunit-code', + 'sizes': [ + [300, 250] + ], + 'bidId': '1234asdf1234', + 'bidderRequestId': '1234asdf1234asdf', + 'auctionId': '61466567-d482-4a16-96f0-fe5f25ffbdf120' + }; + + it('should return true when required params found', function () { + expect(spec.isBidRequestValid(bid)).to.equal(true); + }); + + it('should return false when required params are NOT found', function () { + expect(spec.isBidRequestValid(bid2)).to.equal(false); + expect(spec.isBidRequestValid(bid3)).to.equal(false); + }); + }); + + describe('buildRequests', function () { + let validBidRequests = [{ + 'bidder': 'clicktripz', + 'params': { + placementId: 'testPlacementId', + siteId: 'testSiteId' + }, + 'sizes': [ + [300, 250], + [300, 300] + ], + 'bidId': '23beaa6af6cdde', + 'bidderRequestId': '19c0c1efdf37e7', + 'auctionId': '61466567-d482-4a16-96f0-fe5f25ffbdf1', + }, { + 'bidder': 'clicktripz', + 'params': { + placementId: 'testPlacementId2', + siteId: 'testSiteId2' + }, + 'sizes': [ + [300, 250] + ], + 'bidId': '25beaa6af6cdde', + 'bidderRequestId': '19c0c1efdf37e7', + 'auctionId': '61466567-d482-4a16-96f0-fe5f25ffbdf1', + }]; + + const request = spec.buildRequests(validBidRequests); + it('sends bid request to our endpoint via POST', function () { + expect(request.method).to.equal('POST'); + }); + it('sends bid request to our endpoint via POST', function () { + expect(request.method).to.equal('POST'); + }); + + it('sends bid request to our endpoint at the correct URL', function () { + expect(request.url).to.equal(ENDPOINT_URL); + }); + it('sends bid request to our endpoint at the correct URL', function () { + expect(request.url).to.equal(ENDPOINT_URL); + }); + + it('transforms sizes into an array of strings. Pairs of concatenated sizes joined with an x', function () { + expect(request.data[0].sizes.toString()).to.equal('300x250,300x300'); + }); + it('transforms sizes into an array of strings. Pairs of concatenated sizes joined with an x', function () { + expect(request.data[1].sizes.toString()).to.equal('300x250'); + }); + + it('includes bidId, siteId, and placementId in payload', function () { + expect(request.data[0].bidId).to.equal('23beaa6af6cdde'); + expect(request.data[0].siteId).to.equal('testSiteId'); + expect(request.data[0].placementId).to.equal('testPlacementId'); + }); + it('includes bidId, siteId, and placementId in payload', function () { + expect(request.data[1].bidId).to.equal('25beaa6af6cdde'); + expect(request.data[1].siteId).to.equal('testSiteId2'); + expect(request.data[1].placementId).to.equal('testPlacementId2'); + }); + }); + + describe('interpretResponse', function () { + let serverResponse = { + body: [{ + 'bidId': 'bid-request-id', + 'ttl': 120, + 'netRevenue': true, + 'size': '300x200', + 'currency': 'USD', + 'adUrl': 'https://www.clicktripz.com/n3/crane/v0/render?t=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXlsb2FkIjoiaHR0cHM6XC9cL3d3dy5jbGlja3RyaXB6LmNvbVwvY2xpY2sucGhwP2NhbXBhaWduSUQ9MTkxNTYmcHJlQ2hlY2tlZD0xJnB1Ymxpc2hlcklEPTM2MCZzZWFyY2hLZXk9N2M5MzQ0NzhlM2M1NTc3Y2EyN2ZmN2Y1NTg5N2NkMzkmc2VhcmNoRGlzcGxheVR5cGU9MSZkaXNwbGF5VHlwZT00JmNyZWF0aXZlVHlwZT1zaW5nbGUmaXNQb3BVbmRlcj0wJnBvc2l0aW9uPTEmdHlwZT0xJmNpdHk9TWFkcmlkJTJDK1NwYWluJmNoZWNrSW5EYXRlPTAzJTJGMDElMkYyMDIwJmNoZWNrT3V0RGF0ZT0wMyUyRjA1JTJGMjAyMCZndWVzdHM9MiZyb29tcz0xIn0.WBDGYr1qfkSvOuK02VpMW3iAua1E02jjDGDViFc2kaE', + 'creativeId': '25ef9876abc5681f153', + 'cpm': 50 + }] + }; + it('should get the correct bid response', function () { + let expectedResponse = [{ + 'requestId': 'bid-request-id', + 'cpm': 50, + 'netRevenue': true, + 'width': '300', + 'height': '200', + 'creativeId': '25ef9876abc5681f153', + 'currency': 'USD', + 'adUrl': 'https://www.clicktripz.com/n3/crane/v0/render?t=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXlsb2FkIjoiaHR0cHM6XC9cL3d3dy5jbGlja3RyaXB6LmNvbVwvY2xpY2sucGhwP2NhbXBhaWduSUQ9MTkxNTYmcHJlQ2hlY2tlZD0xJnB1Ymxpc2hlcklEPTM2MCZzZWFyY2hLZXk9N2M5MzQ0NzhlM2M1NTc3Y2EyN2ZmN2Y1NTg5N2NkMzkmc2VhcmNoRGlzcGxheVR5cGU9MSZkaXNwbGF5VHlwZT00JmNyZWF0aXZlVHlwZT1zaW5nbGUmaXNQb3BVbmRlcj0wJnBvc2l0aW9uPTEmdHlwZT0xJmNpdHk9TWFkcmlkJTJDK1NwYWluJmNoZWNrSW5EYXRlPTAzJTJGMDElMkYyMDIwJmNoZWNrT3V0RGF0ZT0wMyUyRjA1JTJGMjAyMCZndWVzdHM9MiZyb29tcz0xIn0.WBDGYr1qfkSvOuK02VpMW3iAua1E02jjDGDViFc2kaE', + 'ttl': 120 + }]; + let result = spec.interpretResponse(serverResponse); + expect(result).to.deep.equal(expectedResponse); + }); + }); +});