Skip to content

Yaleo Bid Adapter

Yaleo Bid Adapter is a Prebid.js bidder adapter that enables publishers to request display demand from Yaleo in client-side auctions.

Yaleo Bid Adapter (yaleo) was introduced in Prebid.js v10. If your setup is still on Prebid v9, use the CDN-hosted v9-compatible adapter build.

Supported bidder params:

Name Required Type Description
placementId Yes string Yaleo placement identifier
memberId No number Member identifier. Defaults to Audienzz member ID 3927
maxCpm No number Maximum accepted CPM
forceDarkTheme No boolean Forces dark theme for this ad unit. Overrides request-level device.ext.darkmode

Example ad unit config:

const adUnits = [
{
code: 'your-placement',
mediaTypes: {
banner: {
sizes: [[300, 250], [300, 600]],
},
},
bids: [
{
bidder: 'yaleo',
params: {
placementId: '460a301d-a9f7-4104-b55f-2a3d4674a973',
memberId: 12345,
maxCpm: 2.5,
},
},
],
},
];

yaleo-bidder can force dark theme styling on pre-rendered placements in two ways.

Set forceDarkTheme: true in the bidder params:

{
bidder: 'yaleo',
params: {
placementId: '460a301d-a9f7-4104-b55f-2a3d4674a973',
forceDarkTheme: true,
},
}

Set OpenRTB device.ext.darkmode to 1 via Prebid first-party data. This applies to all Yaleo ad units in the request unless an ad unit sets forceDarkTheme:

pbjs.setConfig({
ortb2: {
device: {
ext: {
darkmode: 1,
},
},
},
});
Source Scope Notes
params.forceDarkTheme Single ad unit Highest priority
device.ext.darkmode: 1 Entire bid request Used when forceDarkTheme is unset
Automatic detection After client hydration Publisher-specific detectors; prefers-color-scheme only on known dark-theme sites

To migrate from the legacy custom Yaleo adapter to the Yaleo adapter from Prebid.js repository, replace parameters as follows:

  • yaleoPlacementId -> placementId
  • xandrTagId -> remove. No longer needed as it’s taken from Yaleo placement configuration
  • sizes -> remove; use Supported sizes in Yaleo placement configuration instead
  • memberId -> optional new param. Defaults to Audienzz member ID 3927
  • maxCpm -> unchanged

Before:

{
bidder: 'yaleo',
params: {
yaleoPlacementId: '1711cf50-b98e-4d6a-9d6f-e0136639f9fa',
xandrTagId: 15833008,
sizes: [[300, 200], [300, 300]],
maxCpm: 3.5,
},
}

After:

{
bidder: 'yaleo',
params: {
placementId: '1711cf50-b98e-4d6a-9d6f-e0136639f9fa',
memberId: 12345, // omit if 3927
maxCpm: 3.5, // omit if not needed
},
}