Skip to content

update AdGeneration adapter #3228

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Nov 7, 2018
Merged

update AdGeneration adapter #3228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ab93aaa
update AdGeneration adapter
banakemi Oct 5, 2018
9a77457
fix test spec
banakemi Oct 25, 2018
0bd5f0f
update AdGeneration adapter
banakemi Oct 26, 2018
5c68c7c
update AdGeneration adapter
banakemi Nov 5, 2018
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
44 changes: 38 additions & 6 deletions modules/adgenerationBidAdapter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import * as utils from 'src/utils';
// import {config} from 'src/config';
import {registerBidder} from 'src/adapters/bidderFactory';
import {BANNER, NATIVE} from 'src/mediaTypes';
import { config } from 'src/config';
const ADG_BIDDER_CODE = 'adgeneration';

export const spec = {
Expand All @@ -23,7 +23,8 @@ export const spec = {
* @param {validBidRequests[]} - an array of bids
* @return ServerRequest Info describing the request to the server.
*/
buildRequests: function (validBidRequests) {
buildRequests: function (validBidRequests, bidderRequest) {
const ADGENE_PREBID_VERSION = '1.0.1';
let serverRequests = [];
for (let i = 0, len = validBidRequests.length; i < len; i++) {
const validReq = validBidRequests[i];
Expand All @@ -38,12 +39,16 @@ export const spec = {
data = utils.tryAppendQueryString(data, 'hb', 'true');
data = utils.tryAppendQueryString(data, 't', 'json3');
data = utils.tryAppendQueryString(data, 'transactionid', validReq.transactionId);

data = utils.tryAppendQueryString(data, 'sizes', getSizes(validReq));
data = utils.tryAppendQueryString(data, 'currency', getCurrencyType());
data = utils.tryAppendQueryString(data, 'pbver', '$prebid.version$');
data = utils.tryAppendQueryString(data, 'sdkname', 'prebidjs');
data = utils.tryAppendQueryString(data, 'adapterver', ADGENE_PREBID_VERSION);
// native以外にvideo等の対応が入った場合は要修正
if (!validReq.mediaTypes || !validReq.mediaTypes.native) {
data = utils.tryAppendQueryString(data, 'imark', '1');
}

data = utils.tryAppendQueryString(data, 'tp', bidderRequest.refererInfo.referer);
// remove the trailing "&"
if (data.lastIndexOf('&') === data.length - 1) {
data = data.substring(0, data.length - 1);
Expand Down Expand Up @@ -82,10 +87,9 @@ export const spec = {
height: body.h ? body.h : 1,
creativeId: body.creativeid || '',
dealId: body.dealid || '',
currency: 'JPY',
currency: getCurrencyType(),
netRevenue: true,
ttl: body.ttl || 10,
referrer: utils.getTopWindowUrl(),
};
if (bidRequest.mediaTypes && bidRequest.mediaTypes.native) {
bidResponse.native = createNativeAd(body);
Expand Down Expand Up @@ -198,4 +202,32 @@ function removeWrapper(ad) {
return ad.substr(bodyIndex, lastBodyIndex).replace('<body>', '').replace('</body>', '');
}

/**
* request
* @param validReq request
* @returns {?string} 300x250,320x50...
*/
function getSizes(validReq) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This function assumes valid formatting of the sizes input and will crash on invalid size formatting. Since there are try/catch blocks around the adapter, this isn't necessarily something that needs to get fixed, just pointing it out.

const sizes = validReq.sizes;
if (!sizes || sizes.length < 1) return null;
let sizesStr = '';
for (const i in sizes) {
const size = sizes[i];
if (size.length !== 2) return null;
sizesStr += `${size[0]}x${size[1]},`;
}
if (sizesStr || sizesStr.lastIndexOf(',') === sizesStr.length - 1) {
sizesStr = sizesStr.substring(0, sizesStr.length - 1);
}
return sizesStr;
}

/**
* @return {?string} USD or JPY
*/
function getCurrencyType() {
if (config.getConfig('currency.adServerCurrency') && config.getConfig('currency.adServerCurrency').toUpperCase() === 'USD') return 'USD';
return 'JPY';
}

registerBidder(spec);
55 changes: 37 additions & 18 deletions test/spec/modules/adgenerationBidAdapter_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import {expect} from 'chai';
import * as utils from 'src/utils';
import {spec} from 'modules/adgenerationBidAdapter';
import {newBidder} from 'src/adapters/bidderFactory';
import {NATIVE} from 'src/mediaTypes';
import {config} from 'src/config';

describe('AdgenerationAdapter', function () {
const adapter = newBidder(spec);
Expand All @@ -15,7 +15,7 @@ describe('AdgenerationAdapter', function () {
});

describe('isBidRequestValid', function () {
let bid = {
const bid = {
'bidder': 'adg',
'params': {
id: '58278', // banner
Expand All @@ -39,11 +39,10 @@ describe('AdgenerationAdapter', function () {
bidder: 'adg',
params: {
id: '58278',
width: '300',
height: '250'
currency: 'JPY',
},
adUnitCode: 'adunit-code',
sizes: [[300, 250]],
sizes: [[300, 250], [320, 100]],
bidId: '2f6ac468a9c15e',
bidderRequestId: '14a9f773e30243',
auctionId: '4aae9f05-18c6-4fcd-80cf-282708cd584a',
Expand All @@ -53,8 +52,7 @@ describe('AdgenerationAdapter', function () {
bidder: 'adg',
params: {
id: '58278',
width: '300',
height: '250'
currency: 'JPY',
},
mediaTypes: {
native: {
Expand Down Expand Up @@ -87,34 +85,59 @@ describe('AdgenerationAdapter', function () {
transactionTd: 'f76f6dfd-d64f-4645-a29f-682bac7f431a'
}
];
const bidderRequest = {
refererInfo: {
referer: 'http://example.com'
}
};
const data = {
banner: 'posall=SSPLOC&id=58278&sdktype=0&hb=true&t=json3&imark=1',
native: 'posall=SSPLOC&id=58278&sdktype=0&hb=true&t=json3'
banner: `posall=SSPLOC&id=58278&sdktype=0&hb=true&t=json3&sizes=300x250%2C320x100&currency=JPY&pbver=%24prebid.version%24&sdkname=prebidjs&adapterver=1.0.1&imark=1&tp=http%3A%2F%2Fexample.com`,
bannerUSD: `posall=SSPLOC&id=58278&sdktype=0&hb=true&t=json3&sizes=300x250%2C320x100&currency=USD&pbver=%24prebid.version%24&sdkname=prebidjs&adapterver=1.0.1&imark=1&tp=http%3A%2F%2Fexample.com`,
native: 'posall=SSPLOC&id=58278&sdktype=0&hb=true&t=json3&sizes=1x1&currency=JPY&pbver=%24prebid.version%24&sdkname=prebidjs&adapterver=1.0.1&tp=http%3A%2F%2Fexample.com'
};
it('sends bid request to ENDPOINT via GET', function () {
const request = spec.buildRequests(bidRequests)[0];
const request = spec.buildRequests(bidRequests, bidderRequest)[0];
expect(request.url).to.equal(ENDPOINT[1]);
expect(request.method).to.equal('GET');
});

it('sends bid request to debug ENDPOINT via GET', function () {
bidRequests[0].params.debug = true;
const request = spec.buildRequests(bidRequests)[0];
const request = spec.buildRequests(bidRequests, bidderRequest)[0];
expect(request.url).to.equal(ENDPOINT[0]);
expect(request.method).to.equal('GET');
});

it('should attache params to the banner request', function () {
const request = spec.buildRequests(bidRequests)[0];
const request = spec.buildRequests(bidRequests, bidderRequest)[0];
expect(request.data).to.equal(data.banner);
});

it('should attache params to the native request', function () {
const request = spec.buildRequests(bidRequests)[1];
const request = spec.buildRequests(bidRequests, bidderRequest)[1];
expect(request.data).to.equal(data.native);
});
it('allows setConfig to set bidder currency for JPY', function () {
config.setConfig({
currency: {
adServerCurrency: 'JPY'
}
});
const request = spec.buildRequests(bidRequests, bidderRequest)[0];
expect(request.data).to.equal(data.banner);
config.resetConfig();
});
it('allows setConfig to set bidder currency for USD', function () {
config.setConfig({
currency: {
adServerCurrency: 'USD'
}
});
const request = spec.buildRequests(bidRequests, bidderRequest)[0];
expect(request.data).to.equal(data.bannerUSD);
config.resetConfig();
});
});

describe('interpretResponse', function () {
const bidRequests = {
banner: {
Expand Down Expand Up @@ -298,7 +321,6 @@ describe('AdgenerationAdapter', function () {
currency: 'JPY',
netRevenue: true,
ttl: 1000,
referrer: utils.getTopWindowUrl(),
ad: '<div id="medibasspContainer">↵ <iframe src="https://s3-ap-northeast-1.amazonaws.com/sdk-temp/adg-sample-ad/300x250.html?prc=-WjRm3cb&rd=https%3A%2F%2Ftg.socdm.com%2Frd%2Fv1%2Fz%2FhKFj2gDZY2hzbT0yMDAsN2NhNTY1NjQvNTgyNzgvU1NQTE9DLzUxMjYwMS83MjExNS43Njg1NS41MTI2MDEvMTA5MzkyNi82NDkxOS81ODI3ODpTU1BMT0M6Ki9jdD0xNTE1MDM4NTQ3NjQyO3NyPWh0dHBzO2RzcGlkPTMwMTtwcj16ZmkzaWYxV3h5VDJrVk90OXpmMWIzMHE7cHJiPXlRO3Bybz15UTtwcm9jPUpQWTtjcmQyeT0xMTM7Y3J5MmQ9MC4wMDg4NDk1NTc1MjIxMjM4OTAyO2lkeD0wO6VzZXFpZNoAJDgyZDcxYzA3LTg5ZjItM2E1ZC1kYmVmLTFjNjhiMDZkOTBmZKdzZXF0aW1lrTE1MTUwMzg1NDc2NDKkeHVpZLhXamg1c2NDbzRWSUFBR1hRelRrQUFBQUE%2Fp%2Fseqid%3D82d71c07-89f2-3a5d-dbef-1c68b06d90fd%3B%2Fg%2FU%3A%3Furl%3D" style="border: 0px;" width="300" height="250" frameborder="0" scrolling="no"></iframe>↵ </div>',
},
native: {
Expand All @@ -311,7 +333,6 @@ describe('AdgenerationAdapter', function () {
currency: 'JPY',
netRevenue: true,
ttl: 1000,
referrer: utils.getTopWindowUrl(),
ad: '↵ <div id="medibasspContainer">↵ <iframe src="https://s3-ap-northeast-1.amazonaws.com/sdk-temp/adg-sample-ad/300x250.html?prc=-WjRm3cb&rd=https%3A%2F%2Ftg.socdm.com%2Frd%2Fv1%2Fz%2FhKFj2gDZY2hzbT0yMDAsN2NhNTY1NjQvNTgyNzgvU1NQTE9DLzUxMjYwMS83MjExNS43Njg1NS41MTI2MDEvMTA5MzkyNi82NDkxOS81ODI3ODpTU1BMT0M6Ki9jdD0xNTE1MDM4NTQ3NjQyO3NyPWh0dHBzO2RzcGlkPTMwMTtwcj16ZmkzaWYxV3h5VDJrVk90OXpmMWIzMHE7cHJiPXlRO3Bybz15UTtwcm9jPUpQWTtjcmQyeT0xMTM7Y3J5MmQ9MC4wMDg4NDk1NTc1MjIxMjM4OTAyO2lkeD0wO6VzZXFpZNoAJDgyZDcxYzA3LTg5ZjItM2E1ZC1kYmVmLTFjNjhiMDZkOTBmZKdzZXF0aW1lrTE1MTUwMzg1NDc2NDKkeHVpZLhXamg1c2NDbzRWSUFBR1hRelRrQUFBQUE%2Fp%2Fseqid%3D82d71c07-89f2-3a5d-dbef-1c68b06d90fd%3B%2Fg%2FU%3A%3Furl%3D" style="border: 0px;" width="300" height="250" frameborder="0" scrolling="no"></iframe>↵ </div>↵ <img src="https://tg.socdm.com/bc/v3?b=Y2hzbT0zNTQsMjZhOGQ2NTRpZD01ODI3OSZwb3M9U1NQTE9DJmFkPTUxMjYwMy83MjExNi43Njg1Ni41MTI2MDMvMTA5MzkyNy82NDkyMC81ODI3OTpTU1BMT0M6Ki9pZHg9MDtkc3BpZD0zMDE7cHI9emZpM2lmMVd4eVQya1ZPdDl6ZjFiMzBxO3ByYj15UTtwcm89eVE7cHJvYz1KUFk7Y3JkMnk9MTEyLjA1O2NyeTJkPTAuMDA4OTI0NTg3MjM3ODQwMjUwNDtwcnY9aWp6QVZtWW9wbmJUV1B0cWhtZEN1ZWRXNDd0MjU1MEtmYjFWYmI3SzthY2Q9JTdCJTIybWFyZ2luX2lkJTIyJTNBNSU3RDthc2Q9JTdCJTIybWFyZ2luX2lkJTIyJTNBNTIlMkMlMjJtYXJnaW4lMjIlM0FmYWxzZSU3RDsmZXg9MTUxNDE4NzQ4NiZjdD0xNTE0MTg3NDg2Mzc4JnNyPWh0dHA-&amp;xuid=Wjh5scCo4VIAAGXQzTkAAAAA&amp;ctsv=a-ad84&amp;seqid=ca7d6a2d-7cf1-6c6a-f4bd-a19b168ba94b&amp;seqtime=1514187486378&amp;t=.gif" width="1" height="1" style="display:none;border:none;padding:0;margin:0;width:1px;height:1px"/>',
native: {
title: 'Title',
Expand Down Expand Up @@ -351,7 +372,6 @@ describe('AdgenerationAdapter', function () {
expect(result.currency).to.equal(bidResponses.banner.currency);
expect(result.netRevenue).to.equal(bidResponses.banner.netRevenue);
expect(result.ttl).to.equal(bidResponses.banner.ttl);
expect(result.referrer).to.equal(bidResponses.banner.referrer);
expect(result.ad).to.equal(bidResponses.banner.ad);
});

Expand All @@ -365,7 +385,6 @@ describe('AdgenerationAdapter', function () {
expect(result.currency).to.equal(bidResponses.native.currency);
expect(result.netRevenue).to.equal(bidResponses.native.netRevenue);
expect(result.ttl).to.equal(bidResponses.native.ttl);
expect(result.referrer).to.equal(bidResponses.native.referrer);
expect(result.native.title).to.equal(bidResponses.native.native.title);
expect(result.native.image.url).to.equal(bidResponses.native.native.image.url);
expect(result.native.image.height).to.equal(bidResponses.native.native.image.height);
Expand Down