Yaleo Bid Adapter
yaleoBidAdapter connects Prebid.js to the Yaleo bidder service.
Demo Page
Section titled “Demo Page”js/apps/yaleo-bidder/demo is a static page that runs a single Prebid.js auction against the deployed bidder and renders the winning bid. Use it to check a placement without any local setup.
| Environment | Demo URL | Prebid.js bundle | Bidder endpoint |
|---|---|---|---|
| Production | https://cdn.adnz.co/yaleo-bidder/index.html?yaleoPlacementId=9c752583-d856-4b44-a227-c0ce6c7a8cfa&size=300x250 | pbjs.adnz.co |
https://bidder.yaleo.com/prebid |
| Development | https://dev-cdn.adnz.co/yaleo-bidder/index.html?yaleoPlacementId=9c752583-d856-4b44-a227-c0ce6c7a8cfa&size=300x250 | dev-pbjs.adnz.co |
https://dev-bidder.yaleo.com/prebid |
The environment is picked by hostname: only cdn.adnz.co uses production, every other host uses development. The bundle is loaded as https://<host>/prebid-v11.js?modules=yaleoBidAdapter&globalName=pbjs.
Query Parameters
Section titled “Query Parameters”| Parameter | Format | Default | Description |
|---|---|---|---|
yaleoPlacementId |
UUID | 9c752583-d856-4b44-a227-c0ce6c7a8cfa |
Yaleo placement to request. The default placement bids in both environments. Empty values fall back to the default. |
size |
<width>x<height> |
300x250 |
Banner size of the ad unit, subject to the size rule in Debugging the Adapter. Case-insensitive (300X250 works). Empty or malformed values fall back to the default. |
The page URL (https://example.com/) and memberId (3927) are fixed, and Prebid.js runs with debug: true, so auction logs are in the browser console.
Running the Bidder Service
Section titled “Running the Bidder Service”./bazel run //js/apps/yaleo-bidder/server:bin_localStarts on http://localhost:8080.
Debugging the Adapter
Section titled “Debugging the Adapter”To debug yaleoBidAdapter, run Prebid.js locally and point the adapter at the local bidder service:
-
Clone the Prebid.js repository.
-
In
yaleoBidAdapter.ts, changePREBID_URLtohttp://localhost:8080/prebidto target the local bidder service. -
Start Prebid.js with only the Yaleo adapter:
Terminal window gulp serve --notest --modules=yaleoBidAdapterThis builds a dev bundle containing only
yaleoBidAdapterand starts a server with live reload on port 9999. -
In
integrationExamples/testBidder/testBidderBannerExample.html, configure the bidder asyaleowith the required params:bids: [{bidder: 'yaleo',params: {placementId: 'your-placement-id'}}] -
Open the test page in a browser to exercise bid requests against the adapter: localhost:9999/integrationExamples/testBidder/testBidderBannerExample.html
No-Bid Reasons
Section titled “No-Bid Reasons”ext.yaleo.nobid lists every impression in the request that got no bid. When no impression bids, seatbid is empty, as below. When some do, seatbid holds their bids and the list covers the rest:
{ "id": "auction-1", "seatbid": [], "ext": { "yaleo": { "nobid": [ { "impid": "imp-1", "placementId": "9c752583-d856-4b44-a227-c0ce6c7a8cfa", "reason": "size_mismatch", "message": "Requested sizes 728x90 are not supported by placement \"9c752583-d856-4b44-a227-c0ce6c7a8cfa\". Supported sizes: 300x250; 1x1 always matches." } ] } }}Find it in the network panel, in Prebid Server debug httpcalls, or in Prebid.js as bidderRequest.pbsExt.yaleo on bidderDone. Both Yaleo adapters build requests with Prebid’s pbsExtensions processors, which put the params where the bidder reads them (imp.ext.prebid.bidder.yaleo) and copy the response ext to bidderRequest.pbsExt. The first matching reason wins:
| Reason | Meaning |
|---|---|
invalid_params |
The impression’s params are unusable: placementId missing or not a UUID, or a bad memberId, maxCpm or forceDarkTheme. placementId is omitted when there was no valid one. |
placement_not_found |
Yaleo did not return the placement. |
placement_disabled |
The placement is disabled. |
no_banner_size |
The banner has no width and height. |
size_mismatch |
None of the banner sizes is 1x1 or a supported size of the placement. |
no_items |
The placement returned no items. |
no_ad_units |
The placement returned no ad units, only articles. |
xandr_bid_unusable |
Xandr bid, but the native markup could not be used. |
xandr_no_bid |
Xandr returned no bid for the placement’s ad units. |
above_max_cpm |
The highest CPM is above maxCpm; the message shows both in the currency they were compared in. |
The bidder also logs the list at DEBUG, which production shows only for requests with ext.prebid.debug. The response is the place to read it.