Back to Publisher API Reference

pbjs.setBidderConfig(options, mergeFlag)

This function is similar to setConfig, but is designed to support certain bidder-specific scenarios.

Configuration provided through the setConfig function is globally available to all bidder adapters. This makes sense because most of these settings are global in nature. However, there are use cases where different bidders require different data, or where certain parameters apply only to a given bidder. Use setBidderConfig when you need to support these cases.

Note if you would like to add to existing config you can pass true for the optional second mergeFlag argument like setBidderConfig(options, true). If not passed, this argument defaults to false and setBidderConfig replaces all values for specified bidders.

The page usage is:

pbjs.setBidderConfig({
   bidders: ['bidderA'],
   config: {
      customArg: "customVal"
   }
});

or

pbjs.setBidderConfig({
   bidders: ['bidderB'],
   config: {
       ortb2: {
           site: {
               ext: {
                   data: {
                      pageType: "article",
                      category: "tools"
                   }
               }
            },
            user: {
               ext: {
                   data: {
                      registered: true,
                      interests: ["cars"]
                   }
               }
          }
      }
   }
});

How to interpret these examples:

• When ‘bidderA’ calls getConfig('customArg'), it will receive the object that contains ‘customArg’. If any other bidder calls getConfig('customArg'), it will receive nothing.
• When ‘bidderB’ calls getConfig('ortb2'), it will receive this override definition rather than whatever else might have been defined globally. If any other bidder calls getConfig('ortb2'), it will receive the globally defined objects.

This function is also used by the schain feature. Refer to the schain documentation for examples.

Back to Publisher API Reference