Migrating TrustX adapter to 1.0 #1709
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 |
|---|---|---|
| @@ -1,165 +1,147 @@ | ||
| import * as utils from 'src/utils'; | ||
| import {registerBidder} from 'src/adapters/bidderFactory'; | ||
| const BIDDER_CODE = 'trustx'; | ||
| const ENDPOINT_URL = '//sofia.trustx.org/hb'; | ||
| const TIME_TO_LIVE = 360; | ||
| const ADAPTER_SYNC_URL = '//sofia.trustx.org/push_sync'; | ||
| const LOG_ERROR_MESS = { | ||
| noAuid: 'Bid from response has no auid parameter - ', | ||
| noAdm: 'Bid from response has no adm parameter - ', | ||
| noBid: 'Array of bid objects is empty', | ||
| noPlacementCode: 'Can\'t find in requested bids the bid with auid - ', | ||
| emptyUids: 'Uids should be not empty', | ||
| emptySeatbid: 'Seatbid array from response has empty item', | ||
| emptyResponse: 'Response is empty', | ||
| hasEmptySeatbidArray: 'Response has empty seatbid array', | ||
| hasNoArrayOfBids: 'Seatbid from response has no array of bid objects - ' | ||
| }; | ||
| const bidsRequestMap = {}; | ||
| export const spec = { | ||
| code: BIDDER_CODE, | ||
| /** | ||
| * 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) { | ||
| return !!(bid.params.uid && bid.adUnitCode); | ||
|
There was a problem hiding this comment.
|
||
| }, | ||
| /** | ||
| * Make a server request from the list of BidRequests. | ||
| * | ||
| * @param {BidRequest[]} validBidRequests - an array of bids | ||
| * @return ServerRequest Info describing the request to the server. | ||
| */ | ||
| buildRequests: function(validBidRequests) { | ||
| const auids = []; | ||
| const bidsMap = {}; | ||
| const bids = validBidRequests || []; | ||
| const bidderRequestId = bids[0] && bids[0].bidderRequestId; | ||
|
|
||
| bids.forEach(bid => { | ||
| if (!bidsMap[bid.params.uid]) { | ||
| bidsMap[bid.params.uid] = [bid]; | ||
| auids.push(bid.params.uid); | ||
| } else { | ||
| bidsMap[bid.params.uid].push(bid); | ||
| } | ||
| }); | ||
|
|
||
| bidsRequestMap[bidderRequestId] = bidsMap; | ||
|
|
||
| const payload = { | ||
| u: utils.getTopWindowUrl(), | ||
| pt: window.globalPrebidTrustxPriceType === 'gross' ? 'gross' : 'net', | ||
|
There was a problem hiding this comment. you can pass |
||
| auids: auids.join(','), | ||
| reqid: bidderRequestId, | ||
| }; | ||
|
|
||
| // const payloadString = JSON.stringify(payload); | ||
|
There was a problem hiding this comment. remove unwanted code. |
||
| return { | ||
| method: 'GET', | ||
| url: ENDPOINT_URL, | ||
| data: payload, | ||
| }; | ||
| }, | ||
| /** | ||
| * Unpack the response from the server into a list of bids. | ||
| * | ||
| * @param {*} serverResponse A successful response from the server. | ||
| * @param {*} bidRequest | ||
| * @return {Bid[]} An array of bids which were nested inside the server. | ||
| */ | ||
| interpretResponse: function(serverResponse, bidRequest) { | ||
| const bidResponses = []; | ||
| const bidsMap = bidsRequestMap[bidRequest.data.reqid]; | ||
|
|
||
| let errorMessage; | ||
|
|
||
| if (!serverResponse) errorMessage = LOG_ERROR_MESS.emptyResponse; | ||
| else if (serverResponse.seatbid && !serverResponse.seatbid.length) { | ||
| errorMessage = LOG_ERROR_MESS.hasEmptySeatbidArray; | ||
| } | ||
|
|
||
| if (!errorMessage && serverResponse.seatbid) { | ||
| serverResponse.seatbid.forEach(respItem => { | ||
| _addBidResponse(_getBidFromResponse(respItem), bidsMap, bidResponses); | ||
| }); | ||
| } | ||
| if (errorMessage) utils.logError(errorMessage); | ||
| return bidResponses; | ||
| }, | ||
| getUserSyncs: function(syncOptions) { | ||
| if (syncOptions.pixelEnabled) { | ||
| return [{ | ||
| type: 'image', | ||
| url: ADAPTER_SYNC_URL | ||
| }]; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| function _getBidFromResponse(respItem) { | ||
| if (!respItem) { | ||
| utils.logError(LOG_ERROR_MESS.emptySeatbid); | ||
| } else if (!respItem.bid) { | ||
| utils.logError(LOG_ERROR_MESS.hasNoArrayOfBids + JSON.stringify(respItem)); | ||
| } else if (!respItem.bid[0]) { | ||
| utils.logError(LOG_ERROR_MESS.noBid); | ||
| } | ||
| return respItem && respItem.bid && respItem.bid[0]; | ||
| } | ||
|
|
||
| function _addBidResponse(serverBid, bidsMap, bidResponses) { | ||
| if (!serverBid) return; | ||
| let errorMessage; | ||
| if (!serverBid.auid) errorMessage = LOG_ERROR_MESS.noAuid + JSON.stringify(serverBid); | ||
| if (!serverBid.adm) errorMessage = LOG_ERROR_MESS.noAdm + JSON.stringify(serverBid); | ||
| else { | ||
| const awaitingBids = bidsMap[serverBid.auid]; | ||
| if (awaitingBids) { | ||
| awaitingBids.forEach(bid => { | ||
| const bidResponse = { | ||
| requestId: bid.bidId, // bid.bidderRequestId, | ||
| bidderCode: spec.code, | ||
| cpm: serverBid.price, | ||
| width: serverBid.w, | ||
| height: serverBid.h, | ||
| creativeId: serverBid.auid, // bid.bidId, | ||
| currency: 'USD', | ||
| netRevenue: window.globalPrebidTrustxPriceType !== 'gross', | ||
| ttl: TIME_TO_LIVE, | ||
| ad: serverBid.adm, | ||
| dealId: serverBid.dealid | ||
| }; | ||
| bidResponses.push(bidResponse); | ||
| }); | ||
| } else { | ||
| errorMessage = LOG_ERROR_MESS.noPlacementCode + serverBid.auid; | ||
| } | ||
| } | ||
| if (errorMessage) { | ||
| utils.logError(errorMessage); | ||
| } | ||
| } | ||
|
|
||
| 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,39 @@ | ||
| # Overview | ||
|
|
||
| Module Name: TrustX Bidder Adapter | ||
| Module Type: Bidder Adapter | ||
| Maintainer: paul@trustx.org | ||
|
|
||
| # Description | ||
|
|
||
| Module that connects to TrustX demand source to fetch bids. | ||
|
|
||
| # Test Parameters | ||
| ``` | ||
| window.globalPrebidTrustxPriceType = 'gross'; // by default is 'net' | ||
|
There was a problem hiding this comment. After update you don't need this in markdown. Update params as required. There was a problem hiding this comment. Are you sure you're calling the right prebid location on the page example you've provided? On the page it is "../../build/dev/prebid.js". So I can't see any calls to TX bidder going at all. |
||
| var adUnits = [ | ||
| { | ||
| code: 'test-div', | ||
| sizes: [[300, 250]], | ||
| bids: [ | ||
| { | ||
| bidder: "trustx", | ||
| params: { | ||
| uid: '44' | ||
| } | ||
| } | ||
| ] | ||
| },{ | ||
| code: 'test-div', | ||
| sizes: [[728, 90]], | ||
| bids: [ | ||
| { | ||
| bidder: "trustx", | ||
| params: { | ||
| uid: 45 | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| ]; | ||
| ``` | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No global variables. You can create the same in
spec.buildRequestsscope and add it to request object.spec.interpretResponsehas request object as second argument.For reference, check rubiconBidAdapter