-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Tagoras Bid Adapter : Initial release (#10826)
* MinuteMediaPlus Bid Adapter: pass gpp consent to userSync server. * tagorasBidAdapter submission * update maintainer * Remove unneeded GVLID. * Adjust syncs condition logic in tagorasBidAdapter.
- Loading branch information
Showing
3 changed files
with
1,028 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,342 @@ | ||
import {_each, deepAccess, parseSizesInput, parseUrl, uniques, isFn} from '../src/utils.js'; | ||
import {registerBidder} from '../src/adapters/bidderFactory.js'; | ||
import {BANNER, VIDEO} from '../src/mediaTypes.js'; | ||
import {getStorageManager} from '../src/storageManager.js'; | ||
import {config} from '../src/config.js'; | ||
|
||
const DEFAULT_SUB_DOMAIN = 'exchange'; | ||
const BIDDER_CODE = 'tagoras'; | ||
const BIDDER_VERSION = '1.0.0'; | ||
const CURRENCY = 'USD'; | ||
const TTL_SECONDS = 60 * 5; | ||
const UNIQUE_DEAL_ID_EXPIRY = 1000 * 60 * 15; | ||
const storage = getStorageManager({bidderCode: BIDDER_CODE}); | ||
|
||
function getTopWindowQueryParams() { | ||
try { | ||
const parsedUrl = parseUrl(window.top.document.URL, {decodeSearchAsString: true}); | ||
return parsedUrl.search; | ||
} catch (e) { | ||
return ''; | ||
} | ||
} | ||
|
||
export function createDomain(subDomain = DEFAULT_SUB_DOMAIN) { | ||
return `https://${subDomain}.tagoras.io`; | ||
} | ||
|
||
export function extractCID(params) { | ||
return params.cId || params.CID || params.cID || params.CId || params.cid || params.ciD || params.Cid || params.CiD; | ||
} | ||
|
||
export function extractPID(params) { | ||
return params.pId || params.PID || params.pID || params.PId || params.pid || params.piD || params.Pid || params.PiD; | ||
} | ||
|
||
export function extractSubDomain(params) { | ||
return params.subDomain || params.SubDomain || params.Subdomain || params.subdomain || params.SUBDOMAIN || params.subDOMAIN; | ||
} | ||
|
||
function isBidRequestValid(bid) { | ||
const params = bid.params || {}; | ||
return !!(extractCID(params) && extractPID(params)); | ||
} | ||
|
||
function buildRequest(bid, topWindowUrl, sizes, bidderRequest, bidderTimeout) { | ||
const { | ||
params, | ||
bidId, | ||
userId, | ||
adUnitCode, | ||
schain, | ||
mediaTypes, | ||
ortb2Imp, | ||
bidderRequestId, | ||
bidRequestsCount, | ||
bidderRequestsCount, | ||
bidderWinsCount | ||
} = bid; | ||
let {bidFloor, ext} = params; | ||
const hashUrl = hashCode(topWindowUrl); | ||
const uniqueDealId = getUniqueDealId(hashUrl); | ||
const cId = extractCID(params); | ||
const pId = extractPID(params); | ||
const subDomain = extractSubDomain(params); | ||
|
||
const gpid = deepAccess(bid, 'ortb2Imp.ext.gpid', deepAccess(bid, 'ortb2Imp.ext.data.pbadslot', '')); | ||
|
||
if (isFn(bid.getFloor)) { | ||
const floorInfo = bid.getFloor({ | ||
currency: 'USD', | ||
mediaType: '*', | ||
size: '*' | ||
}); | ||
|
||
if (floorInfo.currency === 'USD') { | ||
bidFloor = floorInfo.floor; | ||
} | ||
} | ||
|
||
let data = { | ||
url: encodeURIComponent(topWindowUrl), | ||
uqs: getTopWindowQueryParams(), | ||
cb: Date.now(), | ||
bidFloor: bidFloor, | ||
bidId: bidId, | ||
referrer: bidderRequest.refererInfo.ref, | ||
adUnitCode: adUnitCode, | ||
publisherId: pId, | ||
sizes: sizes, | ||
uniqueDealId: uniqueDealId, | ||
bidderVersion: BIDDER_VERSION, | ||
prebidVersion: '$prebid.version$', | ||
res: `${screen.width}x${screen.height}`, | ||
schain: schain, | ||
mediaTypes: mediaTypes, | ||
gpid: gpid, | ||
transactionId: ortb2Imp?.ext?.tid, | ||
bidderRequestId: bidderRequestId, | ||
bidRequestsCount: bidRequestsCount, | ||
bidderRequestsCount: bidderRequestsCount, | ||
bidderWinsCount: bidderWinsCount, | ||
bidderTimeout: bidderTimeout | ||
}; | ||
|
||
appendUserIdsToRequestPayload(data, userId); | ||
|
||
const sua = deepAccess(bidderRequest, 'ortb2.device.sua'); | ||
|
||
if (sua) { | ||
data.sua = sua; | ||
} | ||
|
||
if (bidderRequest.gdprConsent) { | ||
if (bidderRequest.gdprConsent.consentString) { | ||
data.gdprConsent = bidderRequest.gdprConsent.consentString; | ||
} | ||
if (bidderRequest.gdprConsent.gdprApplies !== undefined) { | ||
data.gdpr = bidderRequest.gdprConsent.gdprApplies ? 1 : 0; | ||
} | ||
} | ||
if (bidderRequest.uspConsent) { | ||
data.usPrivacy = bidderRequest.uspConsent; | ||
} | ||
|
||
if (bidderRequest.gppConsent) { | ||
data.gppString = bidderRequest.gppConsent.gppString; | ||
data.gppSid = bidderRequest.gppConsent.applicableSections; | ||
} else if (bidderRequest.ortb2?.regs?.gpp) { | ||
data.gppString = bidderRequest.ortb2.regs.gpp; | ||
data.gppSid = bidderRequest.ortb2.regs.gpp_sid; | ||
} | ||
|
||
const dto = { | ||
method: 'POST', | ||
url: `${createDomain(subDomain)}/prebid/multi/${cId}`, | ||
data: data | ||
}; | ||
|
||
_each(ext, (value, key) => { | ||
dto.data['ext.' + key] = value; | ||
}); | ||
|
||
return dto; | ||
} | ||
|
||
function appendUserIdsToRequestPayload(payloadRef, userIds) { | ||
let key; | ||
_each(userIds, (userId, idSystemProviderName) => { | ||
key = `uid.${idSystemProviderName}`; | ||
|
||
switch (idSystemProviderName) { | ||
case 'digitrustid': | ||
payloadRef[key] = deepAccess(userId, 'data.id'); | ||
break; | ||
case 'lipb': | ||
payloadRef[key] = userId.lipbid; | ||
break; | ||
case 'parrableId': | ||
payloadRef[key] = userId.eid; | ||
break; | ||
case 'id5id': | ||
payloadRef[key] = userId.uid; | ||
break; | ||
default: | ||
payloadRef[key] = userId; | ||
} | ||
}); | ||
} | ||
|
||
function buildRequests(validBidRequests, bidderRequest) { | ||
const topWindowUrl = bidderRequest.refererInfo.page || bidderRequest.refererInfo.topmostLocation; | ||
const bidderTimeout = config.getConfig('bidderTimeout'); | ||
const requests = []; | ||
validBidRequests.forEach(validBidRequest => { | ||
const sizes = parseSizesInput(validBidRequest.sizes); | ||
const request = buildRequest(validBidRequest, topWindowUrl, sizes, bidderRequest, bidderTimeout); | ||
requests.push(request); | ||
}); | ||
return requests; | ||
} | ||
|
||
function interpretResponse(serverResponse, request) { | ||
if (!serverResponse || !serverResponse.body) { | ||
return []; | ||
} | ||
const {bidId} = request.data; | ||
const {results} = serverResponse.body; | ||
|
||
let output = []; | ||
|
||
try { | ||
results.forEach(result => { | ||
const { | ||
creativeId, | ||
ad, | ||
price, | ||
exp, | ||
width, | ||
height, | ||
currency, | ||
metaData, | ||
advertiserDomains, | ||
mediaType = BANNER | ||
} = result; | ||
if (!ad || !price) { | ||
return; | ||
} | ||
|
||
const response = { | ||
requestId: bidId, | ||
cpm: price, | ||
width: width, | ||
height: height, | ||
creativeId: creativeId, | ||
currency: currency || CURRENCY, | ||
netRevenue: true, | ||
ttl: exp || TTL_SECONDS, | ||
}; | ||
|
||
if (metaData) { | ||
Object.assign(response, { | ||
meta: metaData | ||
}) | ||
} else { | ||
Object.assign(response, { | ||
meta: { | ||
advertiserDomains: advertiserDomains || [] | ||
} | ||
}) | ||
} | ||
|
||
if (mediaType === BANNER) { | ||
Object.assign(response, { | ||
ad: ad, | ||
}); | ||
} else { | ||
Object.assign(response, { | ||
vastXml: ad, | ||
mediaType: VIDEO | ||
}); | ||
} | ||
output.push(response); | ||
}); | ||
return output; | ||
} catch (e) { | ||
return []; | ||
} | ||
} | ||
|
||
function getUserSyncs(syncOptions, responses, gdprConsent = {}, uspConsent = '', gppConsent = {}) { | ||
let syncs = []; | ||
const {iframeEnabled, pixelEnabled} = syncOptions; | ||
const {gdprApplies, consentString = ''} = gdprConsent; | ||
const {gppString, applicableSections} = gppConsent; | ||
|
||
const cidArr = responses.filter(resp => deepAccess(resp, 'body.cid')).map(resp => resp.body.cid).filter(uniques); | ||
let params = `?cid=${encodeURIComponent(cidArr.join(','))}&gdpr=${gdprApplies ? 1 : 0}&gdpr_consent=${encodeURIComponent(consentString || '')}&us_privacy=${encodeURIComponent(uspConsent || '')}` | ||
|
||
if (gppString && applicableSections?.length) { | ||
params += '&gpp=' + encodeURIComponent(gppString); | ||
params += '&gpp_sid=' + encodeURIComponent(applicableSections.join(',')); | ||
} | ||
|
||
if (iframeEnabled) { | ||
syncs.push({ | ||
type: 'iframe', | ||
url: `https://sync.tagoras.io/api/sync/iframe/${params}` | ||
}); | ||
} else if (pixelEnabled) { | ||
syncs.push({ | ||
type: 'image', | ||
url: `https://sync.tagoras.io/api/sync/image/${params}` | ||
}); | ||
} | ||
return syncs; | ||
} | ||
|
||
export function hashCode(s, prefix = '_') { | ||
const l = s.length; | ||
let h = 0 | ||
let i = 0; | ||
if (l > 0) { | ||
while (i < l) { | ||
h = (h << 5) - h + s.charCodeAt(i++) | 0; | ||
} | ||
} | ||
return prefix + h; | ||
} | ||
|
||
export function getUniqueDealId(key, expiry = UNIQUE_DEAL_ID_EXPIRY) { | ||
const storageKey = `u_${key}`; | ||
const now = Date.now(); | ||
const data = getStorageItem(storageKey); | ||
let uniqueId; | ||
|
||
if (!data || !data.value || now - data.created > expiry) { | ||
uniqueId = `${key}_${now.toString()}`; | ||
setStorageItem(storageKey, uniqueId); | ||
} else { | ||
uniqueId = data.value; | ||
} | ||
|
||
return uniqueId; | ||
} | ||
|
||
export function getStorageItem(key) { | ||
try { | ||
return tryParseJSON(storage.getDataFromLocalStorage(key)); | ||
} catch (e) { | ||
} | ||
|
||
return null; | ||
} | ||
|
||
export function setStorageItem(key, value, timestamp) { | ||
try { | ||
const created = timestamp || Date.now(); | ||
const data = JSON.stringify({value, created}); | ||
storage.setDataInLocalStorage(key, data); | ||
} catch (e) { | ||
} | ||
} | ||
|
||
export function tryParseJSON(value) { | ||
try { | ||
return JSON.parse(value); | ||
} catch (e) { | ||
return value; | ||
} | ||
} | ||
|
||
export const spec = { | ||
code: BIDDER_CODE, | ||
version: BIDDER_VERSION, | ||
supportedMediaTypes: [BANNER, VIDEO], | ||
isBidRequestValid, | ||
buildRequests, | ||
interpretResponse, | ||
getUserSyncs | ||
}; | ||
|
||
registerBidder(spec); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Overview | ||
|
||
**Module Name:** Tagoras Bidder Adapter | ||
|
||
**Module Type:** Bidder Adapter | ||
|
||
**Maintainer:** prebid@tagoras.io | ||
|
||
# Description | ||
|
||
Module that connects to Tagoras's demand sources. | ||
|
||
# Test Parameters | ||
```js | ||
var adUnits = [ | ||
{ | ||
code: 'test-ad', | ||
sizes: [[300, 250]], | ||
bids: [ | ||
{ | ||
bidder: 'tagoras', | ||
params: { | ||
cId: '562524b21b1c1f08117fc7f9', | ||
pId: '59ac17c192832d0011283fe3', | ||
bidFloor: 0.0001, | ||
ext: { | ||
param1: 'loremipsum', | ||
param2: 'dolorsitamet' | ||
} | ||
} | ||
} | ||
] | ||
} | ||
]; | ||
``` |
Oops, something went wrong.