forked from prebid/Prebid.js
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
604 additions
and
131 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
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,110 @@ | ||
| import { logError } from '../src/utils.js'; | ||
| import { ajax } from '../src/ajax.js'; | ||
| import { submodule } from '../src/hook.js'; | ||
|
|
||
| const MODULE_NAME = 'greenbidsRtdProvider'; | ||
| const MODULE_VERSION = '1.0.0'; | ||
| const ENDPOINT = 'https://europe-west1-greenbids-357713.cloudfunctions.net/partner-selection'; | ||
|
|
||
| const auctionInfo = {}; | ||
| const rtdOptions = {}; | ||
|
|
||
| function init(moduleConfig) { | ||
| let params = moduleConfig?.params; | ||
| if (!params?.pbuid) { | ||
| logError('Greenbids pbuid is not set!'); | ||
| return false; | ||
| } else { | ||
| rtdOptions.pbuid = params?.pbuid; | ||
| rtdOptions.targetTPR = params?.targetTPR || 0.99; | ||
| rtdOptions.timeout = params?.timeout || 200; | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| function onAuctionInitEvent(auctionDetails) { | ||
| auctionInfo.auctionId = auctionDetails.auctionId; | ||
| } | ||
|
|
||
| function getBidRequestData(reqBidsConfigObj, callback, config, userConsent) { | ||
| let promise = createPromise(reqBidsConfigObj); | ||
| promise.then(callback); | ||
| } | ||
|
|
||
| function createPromise(reqBidsConfigObj) { | ||
| return new Promise((resolve) => { | ||
| const timeoutId = setTimeout(() => { | ||
| resolve(reqBidsConfigObj); | ||
| }, rtdOptions.timeout); | ||
| ajax( | ||
| ENDPOINT, | ||
| { | ||
| success: (response) => { | ||
| processSuccessResponse(response, timeoutId, reqBidsConfigObj); | ||
| resolve(reqBidsConfigObj); | ||
| }, | ||
| error: () => { | ||
| clearTimeout(timeoutId); | ||
| resolve(reqBidsConfigObj); | ||
| }, | ||
| }, | ||
| createPayload(reqBidsConfigObj), | ||
| { contentType: 'application/json' } | ||
| ); | ||
| }); | ||
| } | ||
|
|
||
| function processSuccessResponse(response, timeoutId, reqBidsConfigObj) { | ||
| clearTimeout(timeoutId); | ||
| const responseAdUnits = JSON.parse(response); | ||
|
|
||
| updateAdUnitsBasedOnResponse(reqBidsConfigObj.adUnits, responseAdUnits); | ||
| } | ||
|
|
||
| function updateAdUnitsBasedOnResponse(adUnits, responseAdUnits) { | ||
| adUnits.forEach((adUnit) => { | ||
| const matchingAdUnit = findMatchingAdUnit(responseAdUnits, adUnit.code); | ||
| if (matchingAdUnit) { | ||
| removeFalseBidders(adUnit, matchingAdUnit); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| function findMatchingAdUnit(responseAdUnits, adUnitCode) { | ||
| return responseAdUnits.find((responseAdUnit) => responseAdUnit.code === adUnitCode); | ||
| } | ||
|
|
||
| function removeFalseBidders(adUnit, matchingAdUnit) { | ||
| const falseBidders = getFalseBidders(matchingAdUnit.bidders); | ||
| adUnit.bids = adUnit.bids.filter((bidRequest) => !falseBidders.includes(bidRequest.bidder)); | ||
| } | ||
|
|
||
| function getFalseBidders(bidders) { | ||
| return Object.entries(bidders) | ||
| .filter(([bidder, shouldKeep]) => !shouldKeep) | ||
| .map(([bidder]) => bidder); | ||
| } | ||
|
|
||
| function createPayload(reqBidsConfigObj) { | ||
| return JSON.stringify({ | ||
| auctionId: auctionInfo.auctionId, | ||
| version: MODULE_VERSION, | ||
| referrer: window.location.href, | ||
| prebid: '$prebid.version$', | ||
| rtdOptions: rtdOptions, | ||
| adUnits: reqBidsConfigObj.adUnits, | ||
| }); | ||
| } | ||
|
|
||
| export const greenbidsSubmodule = { | ||
| name: MODULE_NAME, | ||
| init: init, | ||
| onAuctionInitEvent: onAuctionInitEvent, | ||
| getBidRequestData: getBidRequestData, | ||
| updateAdUnitsBasedOnResponse: updateAdUnitsBasedOnResponse, | ||
| findMatchingAdUnit: findMatchingAdUnit, | ||
| removeFalseBidders: removeFalseBidders, | ||
| getFalseBidders: getFalseBidders, | ||
| }; | ||
|
|
||
| submodule('realTimeData', greenbidsSubmodule); |
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,65 @@ | ||
| # Overview | ||
|
|
||
| ``` | ||
| Module Name: Greenbids RTD Provider | ||
| Module Type: RTD Provider | ||
| Maintainer: [email protected] | ||
| ``` | ||
|
|
||
| # Description | ||
|
|
||
| The Greenbids RTD adapter allows to dynamically filter calls to SSP to reduce outgoing call to the programmatics chain, reducing ad serving carbon impact | ||
|
|
||
| ## Configuration | ||
|
|
||
| This module is configured as part of the `realTimeData.dataProviders` object. | ||
|
|
||
| {: .table .table-bordered .table-striped } | ||
| | Name | Scope | Description | Example | Type | | ||
| |------------|----------|----------------------------------------|---------------|----------| | ||
| | `name ` | required | Real time data module name | `'greenbidsRtdProvider'` | `string` | | ||
| | `waitForIt ` | required (mandatory true value) | Tells prebid auction to wait for the result of this module | `'true'` | `boolean` | | ||
| | `params` | required | | | `Object` | | ||
| | `params.pbuid` | required | The client site id provided by Greenbids. | `'TEST_FROM_GREENBIDS'` | `string` | | ||
| | `params.targetTPR` | optional (default 0.95) | Target True positive rate for the throttling model | `0.99` | `[0-1]` | | ||
| | `params.timeout` | optional (default 200) | Maximum amount of milliseconds allowed for module to finish working (has to be <= to the realTimeData.auctionDelay property) | `200` | `number` | | ||
|
|
||
| #### Example | ||
|
|
||
| ```javascript | ||
| const greenbidsDataProvider = { | ||
| name: 'greenbidsRtdProvider', | ||
| waitForIt: true, | ||
| params: { | ||
| pbuid: 'TEST_FROM_GREENBIDS', | ||
| timeout: 200 | ||
| } | ||
| }; | ||
|
|
||
| pbjs.setConfig({ | ||
| realTimeData: { | ||
| auctionDelay: 200, | ||
| dataProviders: [greenbidsDataProvider] | ||
| } | ||
| }); | ||
| ``` | ||
|
|
||
| ## Integration | ||
| To install the module, follow these instructions: | ||
|
|
||
| #### Step 1: Contact Greenbids to get a pbuid and account | ||
|
|
||
| #### Step 2: Integrate the Greenbids Analytics Adapter | ||
|
|
||
| Greenbids RTD module works hand in hand with Greenbids Analytics module | ||
| See prebid Analytics modules -> Greenbids Analytics module | ||
|
|
||
| #### Step 3: Prepare the base Prebid file | ||
|
|
||
| - Option 1: Use Prebid [Download](/download.html) page to build the prebid package. Ensure that you do check *Greenbids RTD Provider* module | ||
|
|
||
| - Option 2: From the command line, run `gulp build --modules=greenbidsRtdProvider,...` | ||
|
|
||
| #### Step 4: Set configuration | ||
|
|
||
| Enable Greenbids Real Time Module using `pbjs.setConfig`. Example is provided in Configuration section. |
Oops, something went wrong.