Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Admedia adapter #3481

Merged
merged 3 commits into from
Feb 11, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions modules/admediaBidAdapter.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
import * as utils from '../src/utils';
import {registerBidder} from '../src/adapters/bidderFactory';

const BIDDER_CODE = 'admedia';
const ENDPOINT_URL = '//prebid.admedia.com/bidder/';

export const spec = {
code: BIDDER_CODE,

isBidRequestValid: function (bid) {
return bid.params && !!bid.params.aid;
},

buildRequests: function (validBidRequests, bidderRequest) {
let payload = {};

if (bidderRequest && bidderRequest.refererInfo) {
payload.referer = encodeURIComponent(bidderRequest.refererInfo.referer);
}

payload.tags = [];

utils._each(validBidRequests, function (bid) {
const tag = {
id: bid.bidId,
sizes: bid.sizes,
aid: bid.params.aid
};
payload.tags.push(tag);
});

const payloadString = JSON.stringify(payload);
return {
method: 'POST',
url: ENDPOINT_URL,
data: payloadString,
};
},

interpretResponse: function (serverResponse, bidRequest) {
const bidResponses = [];

if (!serverResponse.body.tags) {
return bidResponses;
}

utils._each(serverResponse.body.tags, function (response) {
if (!response.error && response.cpm > 0) {
const bidResponse = {
requestId: response.id,
cpm: response.cpm,
width: response.width,
height: response.height,
creativeId: response.id,
dealId: response.id,
currency: 'USD',
netRevenue: true,
ttl: 120,
// referrer: REFERER,
ad: response.ad
};

bidResponses.push(bidResponse);
}
});

return bidResponses;
}
};

registerBidder(spec);
42 changes: 42 additions & 0 deletions modules/admediaBidAdapter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Overview

```
Module Name: Admedia Bidder Adapter
Module Type: Bidder Adapter
Maintainer: developers@admedia.com
```

# Description

Admedia Bidder Adapter for Prebid.js.
Only Banner format is supported.

# Test Parameters
```
var adUnits = [
{
code: 'test-div-0',
sizes: [[300, 250]], // a display size
bids: [
{
bidder: 'admedia',
params: {
aid: 86858
}
}
]
},
{
code: 'test-div-1',
sizes: [[300, 50]], // a mobile size
bids: [
{
bidder: 'admedia',
params: {
aid: 86858
}
}
]
}
];
```
138 changes: 138 additions & 0 deletions test/spec/modules/admediaBidAdapter_spec.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
import { expect } from 'chai';
import { spec } from 'modules/admediaBidAdapter';

describe('admediaAdapterTests', function () {
describe('bidRequestValidity', function () {
it('bidRequest with aid', function () {
expect(spec.isBidRequestValid({
bidder: 'admedia',
params: {
aid: 86858,
}
})).to.equal(true);
});

it('bidRequest without aid', function () {
expect(spec.isBidRequestValid({
bidder: 'a4g',
params: {
key: 86858
}
})).to.equal(false);
});
});

describe('bidRequest', function () {
const validBidRequests = [{
'adUnitCode': 'div-gpt-ad-1460505748561-0',
'auctionId': 'e3010a3c-5b95-4475-9ba2-1b004c737c30',
'bidId': '2758de47c84ab58',
'bidRequestsCount': 1,
'bidder': 'admedia',
'bidderRequestId': '1033407c6af0c7',
'params': {
'aid': 86858,
},
'sizes': [[300, 250], [300, 600]],
'transactionId': '5851b2cf-ee2d-4022-abd2-d581ef01604e'
}, {
'adUnitCode': 'div-gpt-ad-1460505748561-1',
'auctionId': 'e3010a3c-5b95-4475-9ba2-1b004c737c30',
'bidId': '3d2aaa400371fa',
'bidRequestsCount': 1,
'bidder': 'admedia',
'bidderRequestId': '1033407c6af0c7',
'params': {
'aid': 84977,
},
'sizes': [[728, 90]],
'transactionId': 'f8b5247e-7715-4e60-9d51-33153e78c190'
}];

const bidderRequest = {
'auctionId': 'e3010a3c-5b95-4475-9ba2-1b004c737c30',
'bidderCode': 'admedia',
'bidderRequestId': '1033407c6af0c7',
'refererInfo': {
'numIframes': 0,
'reachedTop': true,
'referer': 'http://test.com/index.html?pbjs_debug=true'
}

};

const request = spec.buildRequests(validBidRequests, bidderRequest);

it('bidRequest method', function () {
expect(request.method).to.equal('POST');
});

it('bidRequest url', function () {
expect(request.url).to.equal('//prebid.admedia.com/bidder/');
});

it('bidRequest data', function () {
const data = JSON.parse(request.data);
expect(decodeURIComponent(data.referer)).to.be.eql(bidderRequest.refererInfo.referer);
expect(data.tags).to.be.an('array');
expect(data.tags[0].aid).to.be.eql(validBidRequests[0].params.aid);
expect(data.tags[0].id).to.be.eql(validBidRequests[0].bidId);
expect(data.tags[0].sizes).to.be.eql(validBidRequests[0].sizes);
expect(data.tags[1].aid).to.be.eql(validBidRequests[1].params.aid);
expect(data.tags[1].id).to.be.eql(validBidRequests[1].bidId);
expect(data.tags[1].sizes).to.be.eql(validBidRequests[1].sizes);
});
});

describe('interpretResponse', function () {
const serverResponse = {
body: {
tags: [
{
ad: '<img src="https://dummyimage.com/300x600/000150/fff.jpg&text=Admedia">',
cpm: 0.9,
height: 250,
id: '5582180864bc41',
width: 300,
},
{
error: 'Error message',
id: '6dc6ee4e157749'
},
{
ad: '',
cpm: 0,
height: 728,
id: '5762180864bc41',
width: 90,
}
]
},
headers: {}
};

const bidRequest = {};

const result = spec.interpretResponse(serverResponse, bidRequest);

it('Should return an empty array if empty or no tags in response', function () {
expect(spec.interpretResponse({body: ''}, {}).length).to.equal(0);
});

it('Should have only one bid', function () {
expect(result.length).to.equal(1);
});

it('Should have required keys', function () {
expect(result[0].requestId).to.be.eql(serverResponse.body.tags[0].id);
expect(result[0].cpm).to.be.eql(serverResponse.body.tags[0].cpm);
expect(result[0].width).to.be.eql(serverResponse.body.tags[0].width);
expect(result[0].height).to.be.eql(serverResponse.body.tags[0].height);
expect(result[0].creativeId).to.be.eql(serverResponse.body.tags[0].id);
expect(result[0].dealId).to.be.eql(serverResponse.body.tags[0].id);
expect(result[0].netRevenue).to.be.eql(true);
expect(result[0].ttl).to.be.eql(120);
expect(result[0].ad).to.be.eql(serverResponse.body.tags[0].ad);
})
});
});