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.

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

Adkernel adapter ref and meta keywords forwarding #3184

Merged
merged 1 commit into from
Oct 19, 2018
Merged

Adkernel adapter ref and meta keywords forwarding #3184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
40 changes: 26 additions & 14 deletions modules/adkernelBidAdapter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { BANNER, VIDEO } from 'src/mediaTypes';
import {registerBidder} from 'src/adapters/bidderFactory';
import find from 'core-js/library/fn/array/find';
import includes from 'core-js/library/fn/array/includes';
import {parse as parseUrl} from 'src/url'

const VIDEO_TARGETING = ['mimes', 'minduration', 'maxduration', 'protocols',
'startdelay', 'linearity', 'boxingallowed', 'playbackmethod', 'delivery',
Expand All @@ -22,13 +23,13 @@ export const spec = {
'zoneId' in bidRequest.params && !isNaN(Number(bidRequest.params.zoneId));
},
buildRequests: function(bidRequests, bidderRequest) {
let impDispatch = dispatchImps(bidRequests);
let impDispatch = dispatchImps(bidRequests, bidderRequest.refererInfo);
const gdprConsent = bidderRequest.gdprConsent;
const auctionId = bidderRequest.auctionId;
const requests = [];
Object.keys(impDispatch).forEach(host => {
Object.keys(impDispatch[host]).forEach(zoneId => {
const request = buildRtbRequest(impDispatch[host][zoneId], auctionId, gdprConsent);
const request = buildRtbRequest(impDispatch[host][zoneId], auctionId, gdprConsent, bidderRequest.refererInfo);
requests.push({
method: 'GET',
url: `${window.location.protocol}//${host}/rtbg`,
Expand Down Expand Up @@ -96,8 +97,9 @@ registerBidder(spec);
/**
* Dispatch impressions by ad network host and zone
*/
function dispatchImps(bidRequests) {
return bidRequests.map(buildImp)
function dispatchImps(bidRequests, refererInfo) {
let secure = (refererInfo && refererInfo.referer.indexOf('https:') === 0);
return bidRequests.map(bidRequest => buildImp(bidRequest, secure))
.reduce((acc, curr, index) => {
let bidRequest = bidRequests[index];
let zoneId = bidRequest.params.zoneId;
Expand All @@ -112,7 +114,7 @@ function dispatchImps(bidRequests) {
/**
* Builds parameters object for single impression
*/
function buildImp(bidRequest) {
function buildImp(bidRequest, secure) {
const imp = {
'id': bidRequest.bidId,
'tagid': bidRequest.adUnitCode
Expand All @@ -137,7 +139,7 @@ function buildImp(bidRequest) {
.forEach(param => imp.video[param] = bidRequest.params.video[param]);
}
}
if (utils.getTopWindowLocation().protocol === 'https:') {
if (secure) {
imp.secure = 1;
}
return imp;
Expand All @@ -149,7 +151,7 @@ function buildImp(bidRequest) {
* @return Array[Array[Number]]
*/
function canonicalizeSizesArray(sizes) {
if (sizes.length == 2 && !utils.isArray(sizes[0])) {
if (sizes.length === 2 && !utils.isArray(sizes[0])) {
return [sizes];
}
return sizes;
Expand All @@ -160,12 +162,14 @@ function canonicalizeSizesArray(sizes) {
* @param imps collection of impressions
* @param auctionId
* @param gdprConsent
* @param refInfo
* @return Object complete rtb request
*/
function buildRtbRequest(imps, auctionId, gdprConsent) {
function buildRtbRequest(imps, auctionId, gdprConsent, refInfo) {
let req = {
'id': auctionId,
'imp': imps,
'site': createSite(),
'site': createSite(refInfo),
'at': 1,
'device': {
'ip': 'caller',
Expand Down Expand Up @@ -197,12 +201,20 @@ function getLanguage() {
/**
* Creates site description object
*/
function createSite() {
var location = utils.getTopWindowLocation();
return {
'domain': location.hostname,
'page': location.href.split('?')[0]
function createSite(refInfo) {
let url = parseUrl(refInfo.referer);
let result = {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please use http://prebid.org/dev-docs/bidder-adaptor.html#referrers instead of utils.getTopWindowLocation(); . We will deprecation this function and utils.getTopWindowReferrer() soon

Copy link
Contributor Author

@ckbo3hrk ckbo3hrk Oct 18, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

@jaiminpanchal27 Done

'domain': url.hostname,
'page': url.protocol + '://' + url.hostname + url.pathname
};
if (self === top && document.referrer) {
result.ref = document.referrer;
}
let keywords = document.getElementsByTagName('meta')['keywords'];
if (keywords && keywords.content) {
result.keywords = keywords.content;
}
return result;
}

/**
Expand Down
20 changes: 9 additions & 11 deletions test/spec/modules/adkernelBidAdapter_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import {expect} from 'chai';
import {spec} from 'modules/adkernelBidAdapter';
import * as utils from 'src/utils';
import {parse as parseUrl} from 'src/url';

describe('Adkernel adapter', function () {
const bid1_zone1 = {
Expand Down Expand Up @@ -113,15 +112,13 @@ describe('Adkernel adapter', function () {
}
};

function buildRequest(bidRequests, bidderRequest = {}, url = 'https://example.com/index.html', dnt = true) {
let wmock = sinon.stub(utils, 'getTopWindowLocation').callsFake(() => {
let loc = parseUrl(url);
loc.protocol += ':';
return loc;
});
function buildBidderRequest(url = 'https://example.com/index.html', params = {}) {
return Object.assign({}, params, {refererInfo: {referer: url, reachedTop: true}})
}
const DEFAULT_BIDDER_REQUEST = buildBidderRequest();
function buildRequest(bidRequests, bidderRequest = DEFAULT_BIDDER_REQUEST, dnt = true) {
let dntmock = sinon.stub(utils, 'getDNT').callsFake(() => dnt);
let pbRequests = spec.buildRequests(bidRequests, bidderRequest);
wmock.restore();
dntmock.restore();
let rtbRequests = pbRequests.map(r => JSON.parse(r.data.r));
return [pbRequests, rtbRequests];
Expand Down Expand Up @@ -195,7 +192,8 @@ describe('Adkernel adapter', function () {

it('should contain gdpr-related information if consent is configured', function () {
let [_, bidRequests] = buildRequest([bid1_zone1],
{gdprConsent: {gdprApplies: true, consentString: 'test-consent-string', vendorData: {}}});
buildBidderRequest('http://example.com/index.html',
{gdprConsent: {gdprApplies: true, consentString: 'test-consent-string', vendorData: {}}}));
let bidRequest = bidRequests[0];
expect(bidRequest).to.have.property('regs');
expect(bidRequest.regs.ext).to.be.eql({'gdpr': 1});
Expand All @@ -204,15 +202,15 @@ describe('Adkernel adapter', function () {
});

it('should\'t contain consent string if gdpr isn\'t applied', function () {
let [_, bidRequests] = buildRequest([bid1_zone1], {gdprConsent: {gdprApplies: false}});
let [_, bidRequests] = buildRequest([bid1_zone1], buildBidderRequest('https://example.com/index.html', {gdprConsent: {gdprApplies: false}}));
let bidRequest = bidRequests[0];
expect(bidRequest).to.have.property('regs');
expect(bidRequest.regs.ext).to.be.eql({'gdpr': 0});
expect(bidRequest).to.not.have.property('user');
});

it('should\'t pass dnt if state is unknown', function () {
let [_, bidRequests] = buildRequest([bid1_zone1], {}, 'https://example.com/index.html', false);
let [_, bidRequests] = buildRequest([bid1_zone1], DEFAULT_BIDDER_REQUEST, false);
expect(bidRequests[0].device).to.not.have.property('dnt');
});
});
Expand Down