modules/gamoshiBidAdapter.js
import {
deepAccess,
deepSetValue,
getDNT,
inIframe,
isArray,
isFn,
isNumber,
isPlainObject,
isStr,
logError,
logWarn
} from '../src/utils.js';
import {registerBidder} from '../src/adapters/bidderFactory.js';
import {Renderer} from '../src/Renderer.js';
import {BANNER, VIDEO} from '../src/mediaTypes.js';
import {includes} from '../src/polyfill.js';
const ENDPOINTS = {
'gamoshi': 'https://rtb.gamoshi.io'
};
const DEFAULT_TTL = 360;
export const helper = {
getTopFrame: function () {
try {
return window.top === window ? 1 : 0;
} catch (e) {
}
return 0;
},
startsWith: function (str, search) {
return str.substr(0, search.length) === search;
},
getMediaType: function (bid) {
if (bid.ext) {
if (bid.ext.media_type) {
return bid.ext.media_type.toLowerCase();
} else if (bid.ext.vast_url) {
return VIDEO;
} else {
return BANNER;
}
}
return BANNER;
},
getBidFloor(bid) {
if (!isFn(bid.getFloor)) {
return bid.params.bidfloor ? bid.params.bidfloor : null;
}
let bidFloor = bid.getFloor({
mediaType: '*',
size: '*',
currency: 'USD'
});
if (isPlainObject(bidFloor) && !isNaN(bidFloor.floor) && bidFloor.currency === 'USD') {
return bidFloor.floor;
}
return null;
}
};
export const spec = {
code: 'gamoshi',
aliases: ['gambid', '9MediaOnline'],
supportedMediaTypes: ['banner', 'video'],
isBidRequestValid: function (bid) {
return !!bid.params.supplyPartnerId && isStr(bid.params.supplyPartnerId) &&
(!bid.params['rtbEndpoint'] || isStr(bid.params['rtbEndpoint'])) &&
(!bid.params.bidfloor || isNumber(bid.params.bidfloor)) &&
(!bid.params['adpos'] || isNumber(bid.params['adpos'])) &&
(!bid.params['protocols'] || Array.isArray(bid.params['protocols'])) &&
(!bid.params.instl || bid.params.instl === 0 || bid.params.instl === 1);
},
buildRequests: function (validBidRequests, bidderRequest) {
return validBidRequests.map(bidRequest => {
const {adUnitCode, mediaTypes, params, sizes, bidId} = bidRequest;
const baseEndpoint = params['rtbEndpoint'] || ENDPOINTS['gamoshi'];
const rtbEndpoint = `${baseEndpoint}/r/${params.supplyPartnerId}/bidr?rformat=open_rtb&reqformat=rtb_json&bidder=prebid` + (params.query ? '&' + params.query : '');
const rtbBidRequest = {
id: bidderRequest.bidderRequestId,
site: {
domain: bidderRequest.refererInfo.domain,
page: bidderRequest.refererInfo.page,
ref: bidderRequest.refererInfo.ref
},
device: {
ua: navigator.userAgent,
dnt: getDNT() ? 1 : 0,
h: screen.height,
w: screen.width,
language: navigator.language
},
imp: [],
ext: {},
user: {ext: {}},
source: {ext: {}},
regs: {ext: {}}
};
const gdprConsent = getGdprConsent(bidderRequest);
rtbBidRequest.ext.gdpr_consent = gdprConsent;
deepSetValue(rtbBidRequest, 'regs.ext.gdpr', gdprConsent.consent_required === true ? 1 : 0);
deepSetValue(rtbBidRequest, 'user.ext.consent', gdprConsent.consent_string);
if (validBidRequests[0].schain) {
deepSetValue(rtbBidRequest, 'source.ext.schain', validBidRequests[0].schain);
}
if (bidderRequest && bidderRequest.uspConsent) {
deepSetValue(rtbBidRequest, 'regs.ext.us_privacy', bidderRequest.uspConsent);
}
const imp = {
id: bidId,
instl: deepAccess(bidderRequest.ortb2Imp, 'instl') === 1 || params.instl === 1 ? 1 : 0,
tagid: adUnitCode,
bidfloor: helper.getBidFloor(bidRequest) || 0,
bidfloorcur: 'USD',
secure: 1
};
const hasFavoredMediaType =
params.favoredMediaType && includes(this.supportedMediaTypes, params.favoredMediaType);
if (!mediaTypes || mediaTypes.banner) {
if (!hasFavoredMediaType || params.favoredMediaType === BANNER) {
const bannerImp = Object.assign({}, imp, {
banner: {
w: sizes.length ? sizes[0][0] : 300,
h: sizes.length ? sizes[0][1] : 250,
pos: deepAccess(bidderRequest, 'mediaTypes.banner.pos') || params.pos || 0,
topframe: inIframe() ? 0 : 1
}
});
rtbBidRequest.imp.push(bannerImp);
}
}
if (mediaTypes && mediaTypes.video) {
if (!hasFavoredMediaType || params.favoredMediaType === VIDEO) {
const playerSize = mediaTypes.video.playerSize || sizes;
const videoImp = Object.assign({}, imp, {
video: {
protocols: bidRequest.mediaTypes.video.protocols || params.protocols || [1, 2, 3, 4, 5, 6],
pos: deepAccess(bidRequest, 'mediaTypes.video.pos') || params.pos || 0,
ext: {
context: mediaTypes.video.context
},
mimes: bidRequest.mediaTypes.video.mimes,
maxduration: bidRequest.mediaTypes.video.maxduration,
api: bidRequest.mediaTypes.video.api,
skip: bidRequest.mediaTypes.video.skip || bidRequest.params.video.skip,
placement: bidRequest.mediaTypes.video.placement || bidRequest.params.video.placement,
minduration: bidRequest.mediaTypes.video.minduration || bidRequest.params.video.minduration,
playbackmethod: bidRequest.mediaTypes.video.playbackmethod || bidRequest.params.video.playbackmethod,
startdelay: bidRequest.mediaTypes.video.startdelay || bidRequest.params.video.startdelay
}
});
if (isArray(playerSize[0])) {
videoImp.video.w = playerSize[0][0];
videoImp.video.h = playerSize[0][1];
} else if (isNumber(playerSize[0])) {
videoImp.video.w = playerSize[0];
videoImp.video.h = playerSize[1];
} else {
videoImp.video.w = 300;
videoImp.video.h = 250;
}
rtbBidRequest.imp.push(videoImp);
}
}
let eids = [];
if (bidRequest && bidRequest.userId) {
addExternalUserId(eids, deepAccess(bidRequest, `userId.id5id.uid`), 'id5-sync.com', 'ID5ID');
addExternalUserId(eids, deepAccess(bidRequest, `userId.tdid`), 'adserver.org', 'TDID');
addExternalUserId(eids, deepAccess(bidRequest, `userId.idl_env`), 'liveramp.com', 'idl');
}
if (eids.length > 0) {
rtbBidRequest.user.ext.eids = eids;
}
if (rtbBidRequest.imp.length === 0) {
return;
}
return {
method: 'POST',
url: rtbEndpoint,
data: rtbBidRequest,
bidRequest
};
});
},
interpretResponse: function (serverResponse, bidRequest) {
const response = serverResponse && serverResponse.body;
if (!response) {
logError('empty response');
return [];
}
const bids = response.seatbid.reduce((acc, seatBid) => acc.concat(seatBid.bid), []);
let outBids = [];
bids.forEach(bid => {
const outBid = {
requestId: bidRequest.bidRequest.bidId,
cpm: bid.price,
width: bid.w,
height: bid.h,
ttl: DEFAULT_TTL,
creativeId: bid.crid || bid.adid,
netRevenue: true,
currency: bid.cur || response.cur,
mediaType: helper.getMediaType(bid),
};
if (bid.adomain && bid.adomain.length) {
outBid.meta = {
advertiserDomains: bid.adomain
}
}
if (deepAccess(bidRequest.bidRequest, 'mediaTypes.' + outBid.mediaType)) {
if (outBid.mediaType === BANNER) {
outBids.push(Object.assign({}, outBid, {ad: bid.adm}));
} else if (outBid.mediaType === VIDEO) {
const context = deepAccess(bidRequest.bidRequest, 'mediaTypes.video.context');
outBids.push(Object.assign({}, outBid, {
vastUrl: bid.ext.vast_url,
vastXml: bid.adm,
renderer: context === 'outstream' ? newRenderer(bidRequest.bidRequest, bid) : undefined
}));
}
}
});
return outBids;
},
getUserSyncs: function (syncOptions, serverResponses, gdprConsent, uspConsent) {
const syncs = [];
let gdprApplies = false;
let consentString = '';
let uspConsentString = '';
if (gdprConsent && (typeof gdprConsent.gdprApplies === 'boolean')) {
gdprApplies = gdprConsent.gdprApplies;
}
let gdpr = gdprApplies ? 1 : 0;
if (gdprApplies && gdprConsent.consentString) {
consentString = encodeURIComponent(gdprConsent.consentString);
}
if (uspConsent) {
uspConsentString = encodeURIComponent(uspConsent);
}
const macroValues = {
gdpr: gdpr,
consent: consentString,
uspConsent: uspConsentString
};
serverResponses.forEach(resp => {
if (resp.body) {
const bidResponse = resp.body;
if (bidResponse.ext && Array.isArray(bidResponse.ext['utrk'])) {
bidResponse.ext['utrk']
.forEach(pixel => {
const url = replaceMacros(pixel.url, macroValues);
syncs.push({type: pixel.type, url});
});
}
if (Array.isArray(bidResponse.seatbid)) {
bidResponse.seatbid.forEach(seatBid => {
if (Array.isArray(seatBid.bid)) {
seatBid.bid.forEach(bid => {
if (bid.ext && Array.isArray(bid.ext['utrk'])) {
bid.ext['utrk']
.forEach(pixel => {
const url = replaceMacros(pixel.url, macroValues);
syncs.push({type: pixel.type, url});
});
}
});
}
});
}
}
});
return syncs;
}
};
function newRenderer(bidRequest, bid, rendererOptions = {}) {
const renderer = Renderer.install({
url: (bidRequest.params && bidRequest.params.rendererUrl) || (bid.ext && bid.ext.renderer_url) || 'https://s.gamoshi.io/video/latest/renderer.js',
config: rendererOptions,
loaded: false,
});
try {
renderer.setRender(renderOutstream);
} catch (err) {
logWarn('Prebid Error calling setRender on renderer', err);
}
return renderer;
}
function renderOutstream(bid) {
bid.renderer.push(() => {
const unitId = bid.adUnitCode + '/' + bid.adId;
window['GamoshiPlayer'].renderAd({
id: unitId,
debug: window.location.href.indexOf('pbjsDebug') >= 0,
placement: document.getElementById(bid.adUnitCode),
width: bid.width,
height: bid.height,
events: {
ALL_ADS_COMPLETED: () => window.setTimeout(() => {
window['GamoshiPlayer'].removeAd(unitId);
}, 300)
},
vastUrl: bid.vastUrl,
vastXml: bid.vastXml
});
});
}
function addExternalUserId(eids, value, source, rtiPartner) {
if (isStr(value)) {
eids.push({
source,
uids: [{
id: value,
ext: {
rtiPartner
}
}]
});
}
}
function replaceMacros(url, macros) {
return url
.replace('[GDPR]', macros.gdpr)
.replace('[CONSENT]', macros.consent)
.replace('[US_PRIVACY]', macros.uspConsent);
}
function getGdprConsent(bidderRequest) {
const gdprConsent = bidderRequest.gdprConsent;
if (gdprConsent && gdprConsent.consentString && gdprConsent.gdprApplies) {
return {
consent_string: gdprConsent.consentString,
consent_required: gdprConsent.gdprApplies
};
}
return {
consent_required: false,
consent_string: '',
};
}
registerBidder(spec);