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

Jump to bottom

Kargo Bid Adapter : add support for client hints #9184

Merged
merged 4 commits into from
Nov 4, 2022
Merged

Kargo Bid Adapter : add support for client hints #9184

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
5093cfd
pageURL pull from topmostLocation
jsadwith Oct 25, 2022
0bdf068
Merge branch 'prebid:master' into master
jsadwith Nov 1, 2022
1bec84d
Kargo: Support for client hints (#9)
jsadwith Nov 1, 2022
9e83a91
Adding tests for sua
jsadwith Nov 2, 2022
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
22 changes: 14 additions & 8 deletions modules/kargoBidAdapter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { _each, buildUrl, triggerPixel } from '../src/utils.js';
import { _each, buildUrl, deepAccess, pick, triggerPixel } from '../src/utils.js';
import { config } from '../src/config.js';
import { registerBidder } from '../src/adapters/bidderFactory.js';
import { getStorageManager } from '../src/storageManager.js';
Expand Down Expand Up @@ -37,10 +37,9 @@ export const spec = {
bidSizes[bid.bidId] = bid.sizes;
});

let tdid;
if (validBidRequests.length > 0 && validBidRequests[0].userId && validBidRequests[0].userId.tdid) {
tdid = validBidRequests[0].userId.tdid;
}
const firstBidRequest = validBidRequests[0];

const tdid = deepAccess(firstBidRequest, 'userId.tdid')

const transformedParams = Object.assign({}, {
sessionId: spec._getSessionId(),
Expand All @@ -62,10 +61,17 @@ export const spec = {
prebidRawBidRequests: validBidRequests
}, spec._getAllMetadata(bidderRequest, tdid));

// User Agent Client Hints / SUA
const uaClientHints = deepAccess(firstBidRequest, 'ortb2.device.sua');
if (uaClientHints) {
transformedParams.device.sua = pick(uaClientHints, ['browsers', 'platform', 'mobile', 'model']);
}

// Pull Social Canvas segments and embed URL
if (validBidRequests.length > 0 && validBidRequests[0].params.socialCanvas) {
transformedParams.socialCanvasSegments = validBidRequests[0].params.socialCanvas.segments;
transformedParams.socialEmbedURL = validBidRequests[0].params.socialCanvas.embedURL;
const socialCanvas = deepAccess(firstBidRequest, 'params.socialCanvas');
if (socialCanvas) {
transformedParams.socialCanvasSegments = socialCanvas.segments;
transformedParams.socialEmbedURL = socialCanvas.embedURL;
}

const encodedParams = encodeURIComponent(JSON.stringify(transformedParams));
Expand Down
80 changes: 76 additions & 4 deletions test/spec/modules/kargoBidAdapter_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,33 @@ describe('kargo adapter tests', function () {
userId: {
tdid: 'fake-tdid'
},
sizes: [[320, 50], [300, 250], [300, 600]]
sizes: [[320, 50], [300, 250], [300, 600]],
ortb2: {
device: {
sua: {
platform: {
brand: 'macOS',
version: [ '12', '6', '0' ]
},
browsers: [
{
brand: 'Chromium',
version: [ '106', '0', '5249', '119' ]
},
{
brand: 'Google Chrome',
version: [ '106', '0', '5249', '119' ]
},
{
brand: 'Not;A=Brand',
version: [ '99', '0', '0', '0' ]
}
],
mobile: 0,
model: ''
}
}
}
},
{
params: {
Expand Down Expand Up @@ -259,6 +285,28 @@ describe('kargo adapter tests', function () {
device: {
width: screen.width,
height: screen.height,
sua: {
platform: {
brand: 'macOS',
version: [ '12', '6', '0' ]
},
browsers: [
{
brand: 'Chromium',
version: [ '106', '0', '5249', '119' ]
},
{
brand: 'Google Chrome',
version: [ '106', '0', '5249', '119' ]
},
{
brand: 'Not;A=Brand',
version: [ '99', '0', '0', '0' ]
}
],
mobile: 0,
model: '',
},
},
userIDs: {
kargoID: '5f108831-302d-11e7-bf6b-4595acd3bf6c',
Expand All @@ -280,13 +328,39 @@ describe('kargo adapter tests', function () {
prebidRawBidRequests: [
{
bidId: 1,
ortb2: {
device: {
sua: {
platform: {
brand: 'macOS',
version: [ '12', '6', '0' ]
},
browsers: [
{
brand: 'Chromium',
version: [ '106', '0', '5249', '119' ]
},
{
brand: 'Google Chrome',
version: [ '106', '0', '5249', '119' ]
},
{
brand: 'Not;A=Brand',
version: [ '99', '0', '0', '0' ]
}
],
mobile: 0,
model: ''
}
}
},
params: {
placementId: 'foo'
},
userId: {
tdid: 'fake-tdid'
},
sizes: [[320, 50], [300, 250], [300, 600]]
sizes: [[320, 50], [300, 250], [300, 600]],
},
{
bidId: 2,
Expand Down Expand Up @@ -330,7 +404,6 @@ describe('kargo adapter tests', function () {
var payload = {
timeout: 200,
uspConsent: '1---',
foo: 'bar',
refererInfo: {
page: 'https://www.prebid.org',
},
Expand All @@ -349,7 +422,6 @@ describe('kargo adapter tests', function () {
expect(request.method).to.equal('GET');
expect(request.currency).to.equal('USD');
expect(request.timeout).to.equal(200);
expect(request.foo).to.equal('bar');
expect(krakenParams).to.deep.equal(expected);
// Make sure session ID stays the same across requests simulating multiple auctions on one page load
for (let i in sessionIds) {
Expand Down