How to Apply or Change COMPANION Settings

What are Companions?

Companions are additional image areas that display static advertisement images the accompany the main ad that is played back in the player. Many ad responses from your Ad Campaigns and/or Custom Ad Engines return also these images in the response that can be loaded into predefined elements in your web page.

By adding a companion to your player, you are setting up the connection between the ad response and your web page to display the relevant companion ad image using the Player. The companion object in the Player will point to a specific <div> element in your web page to target and display the image there.

 

 

Add a Companion

To add a Companion to your Player, perform the following steps:

  1. Access the player wizard by editing an existing player or creating a new one.

    Access_AD_SETTINGS_tab.jpeg

  2. Click on 'ADVANCED' and select the 'AD SETTINGS' tab.

    NUI_Player_Companion_1602_.jpeg

  3. Under the 'AD SETTINGS' tab, go to the 'COMPANIONS' area.

    NUI_Player_Companion_1603_.jpeg

  4. Click on 'Add Companion'. A new companion block is added to your player.

  5. Apply the relevant fields according to the following table:

    Field Name Description
    Element Name Enter the ID name given to the corresponding <DIV> element in the player's designated web page. This field links between the companion banner and the <DIV> element in the player's page.
    Width Enter the width of the companion banner in pixels.
    Height Enter the height of the companion banner in pixels.
    Keep Companion Select this check box to continue displaying the companion after the ad (within the VAST tag) has finished playing.
    Failover Optional: Enter a URL address for an image that will load the image in the companion element when the ad response does not return any companion banners.
    Failover on Start Optional: Selecting this check box will enforce the failover image to be displayed in the companion elements always.


  6. Optional: Repeat steps 4-5 for any additional companion you would like to define for this player.

  7. Click on 'SAVE'. You companions are applied and saved to your player.

 

Have more questions? Submit a request