forked from prebid/Prebid.js
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add teads bidder adapter (prebid#3135)
* Add teads bidder adapter * Remove bidder code & tests arrow functions
- Loading branch information
Valentin
authored and
AdSpacesDevelopers
committed
Jan 30, 2019
1 parent
2f37a28
commit 5927fb7
Showing
3 changed files
with
429 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,134 @@ | ||
import {registerBidder} from 'src/adapters/bidderFactory'; | ||
const utils = require('src/utils'); | ||
const BIDDER_CODE = 'teads'; | ||
const ENDPOINT_URL = '//a.teads.tv/hb/bid-request'; | ||
const gdprStatus = { | ||
GDPR_APPLIES_PUBLISHER: 12, | ||
GDPR_APPLIES_GLOBAL: 11, | ||
GDPR_DOESNT_APPLY: 0, | ||
CMP_NOT_FOUND_OR_ERROR: 22 | ||
} | ||
|
||
export const spec = { | ||
code: BIDDER_CODE, | ||
supportedMediaTypes: ['video', 'banner'], | ||
/** | ||
* Determines whether or not the given bid request is valid. | ||
* | ||
* @param {BidRequest} bid The bid params to validate. | ||
* @return boolean True if this is a valid bid, and false otherwise. | ||
*/ | ||
isBidRequestValid: function(bid) { | ||
let isValid = false; | ||
if (typeof bid.params !== 'undefined') { | ||
let isValidPlacementId = _validateId(utils.getValue(bid.params, 'placementId')); | ||
let isValidPageId = _validateId(utils.getValue(bid.params, 'pageId')); | ||
isValid = isValidPlacementId && isValidPageId; | ||
} | ||
|
||
if (!isValid) { | ||
utils.logError('Teads placementId and pageId parameters are required. Bid aborted.'); | ||
} | ||
return isValid; | ||
}, | ||
/** | ||
* Make a server request from the list of BidRequests. | ||
* | ||
* @param {validBidRequests[]} an array of bids | ||
* @return ServerRequest Info describing the request to the server. | ||
*/ | ||
buildRequests: function(validBidRequests, bidderRequest) { | ||
const bids = validBidRequests.map(buildRequestObject); | ||
const payload = { | ||
referrer: utils.getTopWindowUrl(), | ||
data: bids, | ||
deviceWidth: screen.width | ||
}; | ||
|
||
let gdpr = bidderRequest.gdprConsent; | ||
if (bidderRequest && gdpr) { | ||
let isCmp = (typeof gdpr.gdprApplies === 'boolean') | ||
let isConsentString = (typeof gdpr.consentString === 'string') | ||
let status = isCmp ? findGdprStatus(gdpr.gdprApplies, gdpr.vendorData) : gdprStatus.CMP_NOT_FOUND_OR_ERROR | ||
payload.gdpr_iab = { | ||
consent: isConsentString ? gdpr.consentString : '', | ||
status: status | ||
}; | ||
} | ||
|
||
const payloadString = JSON.stringify(payload); | ||
return { | ||
method: 'POST', | ||
url: ENDPOINT_URL, | ||
data: payloadString, | ||
}; | ||
}, | ||
/** | ||
* Unpack the response from the server into a list of bids. | ||
* | ||
* @param {*} serverResponse A successful response from the server. | ||
* @return {Bid[]} An array of bids which were nested inside the server. | ||
*/ | ||
interpretResponse: function(serverResponse, bidderRequest) { | ||
const bidResponses = []; | ||
serverResponse = serverResponse.body; | ||
|
||
if (serverResponse.responses) { | ||
serverResponse.responses.forEach(function (bid) { | ||
const bidResponse = { | ||
cpm: bid.cpm, | ||
width: bid.width, | ||
height: bid.height, | ||
currency: bid.currency, | ||
netRevenue: true, | ||
ttl: bid.ttl, | ||
ad: bid.ad, | ||
requestId: bid.bidId, | ||
creativeId: bid.creativeId | ||
}; | ||
bidResponses.push(bidResponse); | ||
}); | ||
} | ||
return bidResponses; | ||
}, | ||
|
||
getUserSyncs: function(syncOptions, responses, gdprApplies) { | ||
if (syncOptions.iframeEnabled) { | ||
return [{ | ||
type: 'iframe', | ||
url: '//sync.teads.tv/iframe' | ||
}]; | ||
} | ||
} | ||
}; | ||
|
||
function findGdprStatus(gdprApplies, gdprData) { | ||
let status = gdprStatus.GDPR_APPLIES_PUBLISHER; | ||
|
||
if (gdprApplies) { | ||
if (gdprData.hasGlobalScope || gdprData.hasGlobalConsent) status = gdprStatus.GDPR_APPLIES_GLOBAL | ||
} else status = gdprStatus.GDPR_DOESNT_APPLY | ||
return status; | ||
} | ||
|
||
function buildRequestObject(bid) { | ||
const reqObj = {}; | ||
let placementId = utils.getValue(bid.params, 'placementId'); | ||
let pageId = utils.getValue(bid.params, 'pageId'); | ||
|
||
reqObj.sizes = utils.parseSizesInput(bid.sizes); | ||
reqObj.bidId = utils.getBidIdParameter('bidId', bid); | ||
reqObj.bidderRequestId = utils.getBidIdParameter('bidderRequestId', bid); | ||
reqObj.placementId = parseInt(placementId, 10); | ||
reqObj.pageId = parseInt(pageId, 10); | ||
reqObj.adUnitCode = utils.getBidIdParameter('adUnitCode', bid); | ||
reqObj.auctionId = utils.getBidIdParameter('auctionId', bid); | ||
reqObj.transactionId = utils.getBidIdParameter('transactionId', bid); | ||
return reqObj; | ||
} | ||
|
||
function _validateId(id) { | ||
return (parseInt(id) > 0); | ||
} | ||
|
||
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,48 @@ | ||
# Overview | ||
|
||
**Module Name**: Teads Bidder Adapter | ||
**Module Type**: Bidder Adapter | ||
**Maintainer**: innov-ssp@teads.tv | ||
|
||
# Description | ||
|
||
Use `teads` as bidder. | ||
|
||
`placementId` & `pageId` are required and must be integers. | ||
|
||
## AdUnits configuration example | ||
``` | ||
var adUnits = [{ | ||
code: 'your-slot_1-div', //use exactly the same code as your slot div id. | ||
sizes: [[300, 250]], | ||
bids: [{ | ||
bidder: 'teads', | ||
params: { | ||
placementId: 12345, | ||
pageId: 1234 | ||
} | ||
}] | ||
},{ | ||
code: 'your-slot_2-div', //use exactly the same code as your slot div id. | ||
sizes: [[600, 800]], | ||
bids: [{ | ||
bidder: 'teads', | ||
params: { | ||
placementId: 12345, | ||
pageId: 1234 | ||
} | ||
}] | ||
}]; | ||
``` | ||
|
||
## UserSync example | ||
|
||
``` | ||
pbjs.setConfig({ | ||
userSync: { | ||
iframeEnabled: true, | ||
syncEnabled: true, | ||
syncDelay: 1 | ||
} | ||
}); | ||
``` |
Oops, something went wrong.