Back to Publisher API Reference

pbjs.aliasBidder(adapterName, aliasedName, options)

To define an alias for a bidder adapter, call this method at runtime:

pbjs.aliasBidder('appnexus', 'newAlias', optionsObject );

Defining an alias can help avoid user confusion since it’s possible to send parameters to the same adapter but in different contexts (e.g, The publisher uses "appnexus" for demand and also uses "newAlias" which is an SSP partner that uses the "appnexus" adapter to serve their own unique demand).

If you define an alias and are using pbjs.sendAllBids, you must also set up additional line items in the ad server with keyword targeting that matches the name of the alias. For example:

  • hb_pb_newalias
  • hb_adid_newalias
  • hb_size_newalias
  • hb_deal_newalias

The options object supports these parameters:

Option Parameter Type Description
gvlid integer IAB Global Vendor List ID for this alias for use with the GDPR Enforcement module.

Creating an alias for a Prebid Server adapter is done differently. See ‘extPrebid’ config in the s2sConfig object.

For example:

pbjs.aliasBidder('bidderA', 'aliasOfBidderA', {gvlid: 9999});

Back to Publisher API Reference