Set up the configuration script manually

You can generate a script to be installed on your resource in the Adfox interface using the HB configurator or you can create one manually.

window.YaHeaderBiddingSettings = {
  biddersMap: adfoxBiddersMap,
  adUnits: adUnits,
  timeout: userTimeout,
  trustedOwners: [123456,111111]
}

Specify the parameters:

In the YaHeaderBiddingSettings method, the onBidsReceived callback function is available. It's called when the bidder survey ends and bids are received.

As an argument, the bids received after the last bidder request are passed in the following format: an array with the Bid object.

A new request to the bidders and its completion triggers this callback function again.

Example of adding the onBidsReceived function

window.YaHeaderBiddingSettings = {
  biddersMap: adfoxBiddersMap,
  adUnits: adUnits,
  timeout: userTimeout,
  callbacks: {
    onBidsReceived: (bids) => {
      console.log('---> PUBLIC CALLBACK onBidsReceived: ', bids);
    }
  }
};

On websites with infinite scroll, new content and new placements load without reloading the page. If you use Header Bidding on pages of this kind of a website, there's no auction for new placements. This is because the bids were made at the initial page response and were already used for ad selection.

To describe a new set of bidders for new placements that are added as new responses, use the window.Ya.headerBidding.pushAdUnits(AdUnit[]) method. Instead of AdUnit[], you need to specify an array of objects with information about which bidders can be asked to bid for newly added placements.

1. Before calling the method for a new placement, add initialization of new queues. To do this, replace the context.js loader code in the head element:

   Old code	New code
   <script> window.yaContextCb = window.yaContextCb || [] </script> <script src="https://yandex.com/ads/system/context.js" async> </script>	<script> window.Ya || (window.Ya = {}); window.yaContextCb = window.yaContextCb || []; window.Ya.adfoxCode || (window.Ya.adfoxCode = {}); window.Ya.adfoxCode.hbCallbacks || (window.Ya.adfoxCode.hbCallbacks = []); </script> <script src="https://yandex.com/ads/system/context.js" async> </script> Copied to clipboard

   Old code	New code
   <script> window.yaContextCb = window.yaContextCb || [] </script> <script src="https://yandex.com/ads/system/context.js" async> </script>	<script> window.Ya || (window.Ya = {}); window.yaContextCb = window.yaContextCb || []; window.Ya.adfoxCode || (window.Ya.adfoxCode = {}); window.Ya.adfoxCode.hbCallbacks || (window.Ya.adfoxCode.hbCallbacks = []); </script> <script src="https://yandex.com/ads/system/context.js" async> </script> Copied to clipboard

2. Add the pushAdUnits method to the unit code. Please note the following:

   • For a new banner placement, the pushAdUnits method must be called before adfoxCode.create.
   • In the object description, the elements' containerId must differ from those previously saved in the configuration script, but you don't need to change the configuration script itself in the page head.

Example of final code for the placement

<div id="adfox_15218"></div>
<script>window.Ya.adfoxCode.hbCallbacks.push(function() {
    window.Ya.headerBidding.pushAdUnits([
        {
          code: 'adfox_15218',
          sizes: [[728, 90]],
          bids: [
            { bidder: 'adriver', params: { placementId: 'adfox_test' } }
          ]
        }
    ]);
    window.yaContextCb.push(function() {
        window.Ya.adfoxCode.create(
            {
               ownerId: 168627,
               containerId: 'adfox_15218',
               params: { p1: 'bzzvh', p2: 'fvxb' }
          }
        );
    });
});
</script>

To add native Criteo ads:

1. In the adUnits array, find the code value.
2. Add a nativeCallback parameter containing the function(json) function to the bids object, where json is the object received in the Criteo response.

If the function call is used in function(json), it must be declared in the global viewable area.

Example of a configuration script with native ads

window.YaHeaderBiddingSettings = {
  biddersMap: { 'criteo': '781965' },
  adUnits: [{
    code: 'adfox_151663576557768486',
    bids: [{
      bidder: 'criteo',
      params: {
        placementId: 1168582,
        nativeCallback: function(json) {
          renderCriteo(json);
          console.log('Hello world');
        }
      }
    }]                
  }],
  timeout: 500
};

If a monetizer account that uses Adfox HB has custom targeting set up, you need to add the puidN parameters and targeting values to the ad tag, where N is the characteristic number from 1 to 63. The puid parameters are added to the params object in name: value format, where:

• name is the parameter name (puidN).
• value is the parameter value.

Example of a configuration script with a monetizer that uses Adfox HB and the added puid parameters

window.YaHeaderBiddingSettings = {
  biddersMap: { 'adfox_example': '957356' },
  adUnits: [{
    code: 'adfox_154875622348837699',
    bids: [{
      bidder: 'adfox_example',
      params: {
        pp: 'g',
        ps: 'cqmv',
        p2: 'fqnq',
        puid1: 'woman',
        puid2: '16:17:18:19',
        puid3: 'green'
      }
    }]
  }],
  timeout: 500
};

From the page where you placed the ad tag, you can call cookie-sync pixels at the time of the request. The pixel link is provided by the monetizer.

To call a cookie-sync pixel:

1. Declare a variable and add the pixel link to it. If you have multiple links, add them to the pixels array as a comma-separated string.

   var syncPixels = [{
       bidder: 'sape',
       pixels: ['https://ssp-rtb.sape.ru/rmatch/.....']
     }]

2. Add a call for the pixels to the YaHeaderBiddingSettings section:

   syncPixels: syncPixels

Example of a configuration script with a cookie-sync pixel for the Sape monetizer

<script>
  var adfoxBiddersMap = {
    'sape': '1648783'
  };

  var adUnits = [
    {
      code: 'adfox_container_id',
      bids: [
        {
          bidder: 'sape',
          params: {
            placementId: '634996'
          }
        }
      ]
    }
  ];

  var userTimeout = 500;

  var syncPixels = [
    {
      bidder: 'sape',
      pixels: [
        'https://ssp-rtb.sape.ru/rmatch/1',
        'https://ssp-rtb.sape.ru/rmatch/2'
      ]
    }
  ];

  window.YaHeaderBiddingSettings = {
    biddersMap: adfoxBiddersMap,
    adUnits: adUnits,
    timeout: userTimeout,
    syncPixels: syncPixels
  };
</script>