JavaScript API
      Back to home
      1. Help Center
      2. HB Manager
      3. JavaScript API

      relevantDigital.Auction.registerImpressionByAdId()

      This function is used to manually register an impression by the Ad id.

      Under some circumstances, in particular when using the IMA SDK for instream video - it's not possible for Relevant's JavaScript to pick up impressions. Instead, this function can be used to register impressions for headerbid analytics.

      For a complete example on how to use this function, please read the article about HBA instream reporting with Google IMA SDK.

      Parameters

      relevantDigital.Auction.registerImpressionByAdId(id)

      • id - The ad id of the creative. For instream video this is the id of the <Ad> VAST element.

      Return value

      true is returned if the the impression is registered. This means there was one bid response with a matching ad id for which an impression had not previously been registered.

      Example

      See the article on HBA instream reporting with Google IMA SDK.