Skip to content

Start.io Bid Adapter: Implement support for coppa, usp, floors and ortb_blocking features #13433

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+147 −16
Open

Start.io Bid Adapter: Implement support for coppa, usp, floors and ortb_blocking features #13433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8969bee
Implement additional features support for Start.io adapter
prebid-startio Jun 25, 2025
bfff77a
Get coppa from bidderRequest.ortb2.regs.coppa instead of config
prebid-startio Jun 27, 2025
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
56 changes: 52 additions & 4 deletions modules/startioBidAdapter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { registerBidder } from '../src/adapters/bidderFactory.js';
import { BANNER, VIDEO, NATIVE } from '../src/mediaTypes.js';
import { logError } from '../src/utils.js';
import { logError, isFn, isPlainObject } from '../src/utils.js';
import { ortbConverter } from '../libraries/ortbConverter/converter.js'
import { ortb25Translator } from '../libraries/ortb2.5Translator/translator.js';

Expand All @@ -18,11 +18,18 @@ const converter = ortbConverter({
imp.banner.h ??= imp.banner.format[0]?.h;
}

const floor = getBidFloor(bidRequest);
if (floor) {
imp.bidfloor = floor;
imp.bidfloorcur = 'USD';
}

return imp;
},
request(buildRequest, imps, bidderRequest, context) {
const request = buildRequest(imps, bidderRequest, context);
const publisherId = bidderRequest?.bids?.[0]?.params?.publisherId;
const bidParams = context?.bidParams;
const publisherId = bidParams?.publisherId;
if (request?.site) {
request.site.publisher = request.site.publisher || {};
request.site.publisher.id = publisherId;
Expand All @@ -33,6 +40,25 @@ const converter = ortbConverter({
request.ext = request.ext || {};
request.ext.prebid = request.ext.prebid || {};

const ortb = bidderRequest.ortb2;
request.regs ??= {};
request.regs.coppa = ortb?.regs?.coppa;

if (bidderRequest.uspConsent) {
request.regs.ext ??= {};
request.regs.ext.us_privacy = bidderRequest.uspConsent;
}

request.bcat = ortb?.bcat || bidParams?.bcat;
request.badv = ortb?.badv || bidParams?.badv;
request.bapp = ortb?.bapp || bidParams?.bapp;

spec.supportedMediaTypes.forEach(mediaType => {
if (request.imp[0].hasOwnProperty(mediaType)) {
request.imp[0][mediaType].battr ??= ortb?.[mediaType]?.battr || bidParams?.battr;
}
})

return request;
},
bidResponse(buildBidResponse, bid, context) {
Expand All @@ -56,16 +82,38 @@ const converter = ortbConverter({
translator: ortb25Translator()
});

function getBidFloor(bid) {
if (isFn(bid.getFloor)) {
const floor = bid.getFloor({
currency: 'USD',
mediaType: '*',
size: '*'
});
if (isPlainObject(floor) && !isNaN(floor.floor) && floor.currency === 'USD') {
return floor.floor;
}
}
return bid.params?.floor;
}

function isValidBidFloorCurrency(bid) {
return !bid.ortb2Imp?.bidfloorcur || bid.ortb2Imp.bidfloorcur === 'USD';
}

export const spec = {
code: BIDDER_CODE,
supportedMediaTypes: [VIDEO, BANNER, NATIVE],
gvlid: GVLID,
isBidRequestValid: (bid) => !!bid,
isBidRequestValid: (bid) => !!bid && isValidBidFloorCurrency(bid),

buildRequests: (bidRequests, bidderRequest) => {
return bidRequests.map((bidRequest) => {
const mediaType = Object.keys(bidRequest.mediaTypes || {})[0] || BANNER;
const data = converter.toORTB({ bidRequests: [bidRequest], bidderRequest, context: { mediaType } });
const data = converter.toORTB({
bidRequests: [bidRequest],
bidderRequest,
context: {mediaType, bidParams: bidRequest.params}
});

return {
method: METHOD,
Expand Down
107 changes: 95 additions & 12 deletions test/spec/modules/startioBidAdapter_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { expect } from 'chai';
import { spec } from 'modules/startioBidAdapter.js';
import { BANNER, VIDEO, NATIVE } from 'src/mediaTypes.js';
import {deepClone} from '../../../src/utils';

const DEFAULT_REQUEST_DATA = {
adUnitCode: 'test-div',
Expand Down Expand Up @@ -62,6 +63,10 @@ const VALID_MEDIA_TYPES_REQUESTS = {
}]
}

const DEFAULT_BIDDER_REQUEST = {
refererInfo: { referer: 'https://example.com' },
};

const VALID_BIDDER_REQUEST = {
auctionId: '19c97f22-5bd1-4b16-a128-80f75fb0a8a0',
bidderCode: 'startio',
Expand Down Expand Up @@ -180,16 +185,30 @@ describe('Prebid Adapter: Startio', function () {
};
expect(spec.isBidRequestValid(bidRequest)).to.eql(true);
});
it('should verify bidFloorCur for bid request', function () {
const bidRequestUSD = {
bidder: 'startio',
ortb2Imp: {
bidfloorcur: 'USD'
}
};
expect(spec.isBidRequestValid(bidRequestUSD)).to.eql(true);

const bidRequestEUR = {
bidder: 'startio',
ortb2Imp: {
bidfloorcur: 'EUR'
}
};
expect(spec.isBidRequestValid(bidRequestEUR)).to.eql(false);
});
});

describe('buildRequests', function () {
it('should build request for banner media type', function () {
const bidRequest = VALID_MEDIA_TYPES_REQUESTS[BANNER][0];
const bidderRequest = {
refererInfo: { referer: 'https://example.com' },
};

const requests = spec.buildRequests([bidRequest], bidderRequest);
const requests = spec.buildRequests([bidRequest], DEFAULT_BIDDER_REQUEST);

expect(requests).to.have.lengthOf(1);
const request = requests[0];
Expand All @@ -198,14 +217,81 @@ describe('Prebid Adapter: Startio', function () {
expect(request.data.imp[0].banner.w).to.equal(300);
expect(request.data.imp[0].banner.h).to.equal(250);
});

it('should provide bidfloor when either bid param or getFloor function exists', function () {
let bidRequest = deepClone(DEFAULT_REQUEST_DATA);

// with no param or getFloor bidfloor is not specified
let request = spec.buildRequests([bidRequest], DEFAULT_BIDDER_REQUEST)[0].data;
expect(request.imp[0].bidfloor).to.not.exist;
expect(request.imp[0].bidfloorcur).to.not.exist;

// with param and no getFloor bidfloor uses value from param
bidRequest.params.floor = 1.3;
request = spec.buildRequests([bidRequest], DEFAULT_BIDDER_REQUEST)[0].data;
expect(request.imp[0].bidfloor).to.equal(1.3);
expect(request.imp[0].bidfloorcur).to.equal('USD');

// with param and getFloor bidfloor uses value form getFloor
bidRequest.getFloor = () => { return { currency: 'USD', floor: 2.4 }; };
request = spec.buildRequests([bidRequest], DEFAULT_BIDDER_REQUEST)[0].data;
expect(request.imp[0].bidfloor).to.equal(2.4);
expect(request.imp[0].bidfloorcur).to.equal('USD');
});

it('should provide us_privacy', function () {
let bidderRequest = deepClone(DEFAULT_BIDDER_REQUEST);

bidderRequest.uspConsent = '1YYN';
const request = spec.buildRequests([DEFAULT_REQUEST_DATA], bidderRequest)[0].data;

expect(request.regs.ext.us_privacy).to.equal('1YYN');
});

it('should provide coppa', () => {
let bidderRequest = deepClone(DEFAULT_BIDDER_REQUEST);
bidderRequest.ortb2 = {regs: {coppa: 0}};
let request = spec.buildRequests([DEFAULT_REQUEST_DATA], bidderRequest)[0].data;
expect(request.regs.coppa).to.equal(0);

bidderRequest.ortb2 = {regs: {coppa: 1}};
request = spec.buildRequests([DEFAULT_REQUEST_DATA], bidderRequest)[0].data;
expect(request.regs.coppa).to.equal(1);
});

it('should provide blocked parameters', function () {
let bidRequest = deepClone(DEFAULT_REQUEST_DATA);
let bidderRequest = deepClone(DEFAULT_BIDDER_REQUEST);

bidRequest.params.bcat = ['IAB25', 'IAB7-39'];
bidRequest.params.bapp = ['com.bad.app1'];
bidRequest.params.badv = ['competitor1.com', 'badsite1.net'];
bidRequest.params.battr = [1, 2];

let request = spec.buildRequests([bidRequest], bidderRequest)[0].data;
expect(request.bcat).to.deep.equal(['IAB25', 'IAB7-39']);
expect(request.bapp).to.deep.equal(['com.bad.app1']);
expect(request.badv).to.deep.equal(['competitor1.com', 'badsite1.net']);
expect(request.imp[0].banner.battr).to.deep.equal([1, 2]);

bidderRequest.ortb2 = {
bcat: ['IAB1', 'IAB2'],
bapp: ['com.bad.app2'],
badv: ['competitor2.com', 'badsite2.net'],
banner: { battr: [3, 4] }
};
request = spec.buildRequests([bidRequest], bidderRequest)[0].data;
expect(request.bcat).to.deep.equal(['IAB1', 'IAB2']);
expect(request.bapp).to.deep.equal(['com.bad.app2']);
expect(request.badv).to.deep.equal(['competitor2.com', 'badsite2.net']);
expect(request.imp[0].banner.battr).to.deep.equal([3, 4]);
});

if (FEATURES.VIDEO) {
it('should build request for video media type', function () {
const bidRequest = VALID_MEDIA_TYPES_REQUESTS[VIDEO][0];
const bidderRequest = {
refererInfo: { referer: 'https://example.com' },
};

const requests = spec.buildRequests([bidRequest], bidderRequest);
const requests = spec.buildRequests([bidRequest], DEFAULT_BIDDER_REQUEST);

expect(requests).to.have.lengthOf(1);
const request = requests[0];
Expand All @@ -219,11 +305,8 @@ describe('Prebid Adapter: Startio', function () {
if (FEATURES.NATIVE) {
it('should build request for native media type', function () {
const bidRequest = VALID_MEDIA_TYPES_REQUESTS[NATIVE][0];
const bidderRequest = {
refererInfo: { referer: 'https://example.com' },
};

const requests = spec.buildRequests([bidRequest], bidderRequest);
const requests = spec.buildRequests([bidRequest], DEFAULT_BIDDER_REQUEST);

expect(requests).to.have.lengthOf(1);
const request = requests[0];
Expand Down