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

feat(openxBidAdapter): PBID-125: Adding all other user id adapters: #11

Merged
merged 1 commit into from
Mar 19, 2020
Merged

feat(openxBidAdapter): PBID-125: Adding all other user id adapters: #11

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
35 changes: 26 additions & 9 deletions modules/openxBidAdapter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,19 @@ import {parse} from '../src/url.js';
const SUPPORTED_AD_TYPES = [BANNER, VIDEO];
const BIDDER_CODE = 'openx';
const BIDDER_CONFIG = 'hb_pb';
const BIDDER_VERSION = '3.0.1';

const USER_ID_CODE_TO_QUERY_ARG = {
idl_env: 'lre', // liveramp
pubcid: 'pubcid', // publisher common id
tdid: 'ttduuid', // the trade desk
criteoId: 'criteoid' // criteo id
const BIDDER_VERSION = '3.0.2';

export const USER_ID_CODE_TO_QUERY_ARG = {
britepoolid: 'britepoolid', // BritePool ID
criteoId: 'criteoid', // CriteoID
digitrustid: 'digitrustid', // DigiTrust
id5id: 'id5id', // ID5 ID
idl_env: 'lre', // LiveRamp IdentityLink
lipb: 'lipbid', // LiveIntent ID
netId: 'netid', // netID
parrableid: 'parrableid', // Parrable ID
pubcid: 'pubcid', // PubCommon ID
tdid: 'ttduuid', // The Trade Desk Unified ID
};

export const spec = {
Expand Down Expand Up @@ -259,9 +265,20 @@ function buildCommonQueryParamsFromBids(bids, bidderRequest) {
}

function appendUserIdsToQueryParams(queryParams, userIds) {
utils._each(userIds, (userIdValue, userIdProviderKey) => {
utils._each(userIds, (userIdObjectOrValue, userIdProviderKey) => {
const key = USER_ID_CODE_TO_QUERY_ARG[userIdProviderKey];

if (USER_ID_CODE_TO_QUERY_ARG.hasOwnProperty(userIdProviderKey)) {
queryParams[USER_ID_CODE_TO_QUERY_ARG[userIdProviderKey]] = userIdValue;
switch (userIdProviderKey) {
case 'digitrustid':
queryParams[key] = utils.deepAccess(userIdObjectOrValue, 'data.id');
break;
case 'lipb':
queryParams[key] = userIdObjectOrValue.lipbid;
break;
default:
queryParams[key] = userIdObjectOrValue;
}
}
});

Expand Down
201 changes: 58 additions & 143 deletions test/spec/modules/openxBidAdapter_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import {expect} from 'chai';
import {spec, resetBoPixel} from 'modules/openxBidAdapter.js';
import {spec, USER_ID_CODE_TO_QUERY_ARG} from 'modules/openxBidAdapter.js';
import {newBidder} from 'src/adapters/bidderFactory.js';
import {userSync} from 'src/userSync.js';
import {config} from 'src/config.js';
Expand Down Expand Up @@ -1026,151 +1026,66 @@ describe('OpenxAdapter', function () {
});

describe('when there are userid providers', function () {
describe('with publisher common id', function () {
it('should not send a pubcid query param when there is no crumbs.pubcid and no userId.pubcid defined in the bid requests', function () {
const request = spec.buildRequests(bidRequestsWithMediaTypes, mockBidderRequest);
expect(request[0].data).to.not.have.any.keys('pubcid');
});

it('should send a pubcid query param when crumbs.pubcid is defined in the bid requests', function () {
const bidRequestsWithPubcid = [{
bidder: 'openx',
params: {
unit: '11',
delDomain: 'test-del-domain'
},
crumbs: {
pubcid: 'c4a4c843-2368-4b5e-b3b1-6ee4702b9ad6'
},
adUnitCode: 'adunit-code',
mediaTypes: {
banner: {
sizes: [[300, 250], [300, 600]]
}
},
bidId: 'test-bid-id-1',
bidderRequestId: 'test-bid-request-1',
auctionId: 'test-auction-1'
}];
const request = spec.buildRequests(bidRequestsWithPubcid, mockBidderRequest);
expect(request[0].data.pubcid).to.equal('c4a4c843-2368-4b5e-b3b1-6ee4702b9ad6');
});

it('should send a pubcid query param when userId.pubcid is defined in the bid requests', function () {
const bidRequestsWithPubcid = [{
bidder: 'openx',
params: {
unit: '11',
delDomain: 'test-del-domain'
},
userId: {
pubcid: 'c1a4c843-2368-4b5e-b3b1-6ee4702b9ad6'
},
adUnitCode: 'adunit-code',
mediaTypes: {
banner: {
sizes: [[300, 250], [300, 600]]
}
},
bidId: 'test-bid-id-1',
bidderRequestId: 'test-bid-request-1',
auctionId: 'test-auction-1'
}];
const request = spec.buildRequests(bidRequestsWithPubcid, mockBidderRequest);
expect(request[0].data.pubcid).to.equal('c1a4c843-2368-4b5e-b3b1-6ee4702b9ad6');
});
});

describe('with the trade desk unified id', function () {
it('should not send a tdid query param when there is no userId.tdid defined in the bid requests', function () {
const request = spec.buildRequests(bidRequestsWithMediaTypes, mockBidderRequest);
expect(request[0].data).to.not.have.any.keys('ttduuid');
});

it('should send a tdid query param when userId.tdid is defined in the bid requests', function () {
const bidRequestsWithTdid = [{
bidder: 'openx',
params: {
unit: '11',
delDomain: 'test-del-domain'
},
userId: {
tdid: '00000000-aaaa-1111-bbbb-222222222222'
},
adUnitCode: 'adunit-code',
mediaTypes: {
banner: {
sizes: [[300, 250], [300, 600]]
}
},
bidId: 'test-bid-id-1',
bidderRequestId: 'test-bid-request-1',
auctionId: 'test-auction-1'
}];
const request = spec.buildRequests(bidRequestsWithTdid, mockBidderRequest);
expect(request[0].data.ttduuid).to.equal('00000000-aaaa-1111-bbbb-222222222222');
});
});

describe('with the liveRamp identity link envelope', function () {
it('should not send a tdid query param when there is no userId.lre defined in the bid requests', function () {
const request = spec.buildRequests(bidRequestsWithMediaTypes, mockBidderRequest);
expect(request[0].data).to.not.have.any.keys('lre');
});
const EXAMPLE_DATA_BY_ATTR = {
britepoolid: '1111-britepoolid',
criteoId: '1111-criteoId',
digitrustid: {data: {id: 'DTID', keyv: 4, privacy: {optout: false}, producer: 'ABC', version: 2}},
id5id: '1111-id5id',
idl_env: '1111-idl_env',
lipb: {lipbid: '1111-lipb'},
netId: 'fH5A3n2O8_CZZyPoJVD-eabc6ECb7jhxCicsds7qSg',
parrableid: 'eidVersion.encryptionKeyReference.encryptedValue',
pubcid: '1111-pubcid',
tdid: '1111-tdid',
};

it('should send a lre query param when userId.lre is defined in the bid requests', function () {
const bidRequestsWithLiveRampEnvelope = [{
bidder: 'openx',
params: {
unit: '11',
delDomain: 'test-del-domain'
},
userId: {
idl_env: '00000000-aaaa-1111-bbbb-222222222222'
},
adUnitCode: 'adunit-code',
mediaTypes: {
banner: {
sizes: [[300, 250], [300, 600]]
}
},
bidId: 'test-bid-id-1',
bidderRequestId: 'test-bid-request-1',
auctionId: 'test-auction-1'
}];
const request = spec.buildRequests(bidRequestsWithLiveRampEnvelope, mockBidderRequest);
expect(request[0].data.lre).to.equal('00000000-aaaa-1111-bbbb-222222222222');
});
});
// generates the same set of tests for each id provider
utils._each(USER_ID_CODE_TO_QUERY_ARG, (userIdQueryArg, userIdProviderKey) => {
describe(`with userId attribute: ${userIdProviderKey}`, function () {
it(`should not send a ${userIdQueryArg} query param when there is no userId.${userIdProviderKey} defined in the bid requests`, function () {
const request = spec.buildRequests(bidRequestsWithMediaTypes, mockBidderRequest);
expect(request[0].data).to.not.have.any.keys(userIdQueryArg);
});

describe('with the criteo id for exchanges', function () {
it('should not send a criteoid query param when there is no userId.criteoId defined in the bid requests', function () {
const request = spec.buildRequests(bidRequestsWithMediaTypes, mockBidderRequest);
expect(request[0].data).to.not.have.any.keys('criteoid');
});
it(`should send a ${userIdQueryArg} query param when userId.${userIdProviderKey} is defined in the bid requests`, function () {
const bidRequestsWithUserId = [{
bidder: 'openx',
params: {
unit: '11',
delDomain: 'test-del-domain'
},
userId: {
},
adUnitCode: 'adunit-code',
mediaTypes: {
banner: {
sizes: [[300, 250], [300, 600]]
}
},
bidId: 'test-bid-id-1',
bidderRequestId: 'test-bid-request-1',
auctionId: 'test-auction-1'
}];
// enrich bid request with userId key/value
bidRequestsWithUserId[0].userId[userIdProviderKey] = EXAMPLE_DATA_BY_ATTR[userIdProviderKey];

const request = spec.buildRequests(bidRequestsWithUserId, mockBidderRequest);

let userIdValue;
// handle cases where userId key refers to an object
switch (userIdProviderKey) {
case 'digitrustid':
userIdValue = EXAMPLE_DATA_BY_ATTR.digitrustid.data.id;
break;
case 'lipb':
userIdValue = EXAMPLE_DATA_BY_ATTR.lipb.lipbid;
break;
default:
userIdValue = EXAMPLE_DATA_BY_ATTR[userIdProviderKey];
}

it('should send a criteoid query param when userId.criteoId is defined in the bid requests', function () {
const bidRequestsWithCriteo = [{
bidder: 'openx',
params: {
unit: '11',
delDomain: 'test-del-domain'
},
userId: {
criteoId: '00000000-aaaa-1111-bbbb-222222222222'
},
adUnitCode: 'adunit-code',
mediaTypes: {
banner: {
sizes: [[300, 250], [300, 600]]
}
},
bidId: 'test-bid-id-1',
bidderRequestId: 'test-bid-request-1',
auctionId: 'test-auction-1'
}];
const request = spec.buildRequests(bidRequestsWithCriteo, mockBidderRequest);
expect(request[0].data.criteoid).to.equal('00000000-aaaa-1111-bbbb-222222222222');
expect(request[0].data[USER_ID_CODE_TO_QUERY_ARG[userIdProviderKey]]).to.equal(userIdValue);
});
});
});
});
Expand Down