An NPM package to manage ads logic for Tab for a Cause
npm install tab-ads
Some of the motivation for this module is to handle bidder partners that are not part of the Prebid ecosystem or need to run outside Prebid. (In a way, it's like a mini Prebid in which Prebid is one of the bidder partners.)
fetchAds(config): fetch ads for specified ad units. See config.js for config options.
AdComponent: returns a React AdComponent, which handles ad display.
getAvailableAdUnits: returns an object of available ad units (leaderboard, rectangleAdPrimary, and rectangleAdSecondary). See getAvailableAdUnits.js.
In addition, the module sets window.tabAds with two properties useful for debugging:
- getAllWinningBids: a function that returns information on the winning ad for each ad slot
- adDataStore: storage of each bidder partner's raw and formatted bid responses, as well as Google Ad Manager's slot events
tab-ads:HTML
`We could consider adding a
function to tab-ads, which apps could use to insert scripts into the page.Building Prebid from Source
We build Prebid.js from source and keep the built Prebid code in source control. We do this because:
1. We can build Prebid to include only the required modules. This reduces the JS bundle size.
2. We can patch Prebid to ensure it works as expected in the context of a new tab page. Our users may view the new tab page within an iframe that has a chrome-extension:// or moz-extension:// protocol, and this can break bidders that need to know the correct domain and referrer.To build a new version of Prebid:
yarn run prebid:buildTo modify the Prebid patches:
modify files as needed in
* add tests for the patches in
* run to update the patches file
* run yarn run prebid:build to put those patches into effect in the build Prebid fileVerifying Prebid Bidder Requests
In the new tab page iframe context, we need to ensure that Prebid bidders send the correct page URL and referrer info. We don't have automated tests for this yet. To verify, we need to load the page in a new tab page iframe and inspect each partner's network request.We should check this every time we upgrade Prebid.
Here's what to check for each partner, assuming the iframed page is
https://example.com/newtab/:| Partner | Request URL | What to check |
| ------------- | ------------- | ------------- |
| Magnite |
https://fastlane.rubiconproject.com/a/api/fastlane.json | Query param rf is https://example.com/newtab/ |
| Media.net | https://prebid.media.net/rtb/prebid | Payload site.domain is example.com and site.page is https://example.com/newtab/ |
| OpenX | https://tabforacause-d.openx.net/w/1.0/arj | Query param ju is https://example.com/newtab/ |
| Pulsepoint | https://bid.contextweb.com/header/ortb | Payload site.page and site.ref are both https://example.com/newtab/ |
| Sonobi | apex.go.sonobi.com/trinity.json | Query param ref is https://example.com/newtab/ |
| Unruly | https://targeting.unrulymedia.com/unruly_prebid | Payload refererInfo.referer is https://example.com/newtab/ |GDPR and CCPA: We should manually ensure that data privacy preferences are passed to ad partners. We use
tab-cmp as our consent management platform. See tab-cmp's "Ad Partners" sections of its test checklist for what to verify in ad partner requests.Testing In-Progress Builds in Local Projects
It's often helpful to test development builds of
tab-ads in other local projects.1. Install yalc:
yarn global add yalc
2. In : run yarn run dev:publish
3. In the consuming project: run