Core SDK API Documentation

Class: Companion

Companion

new Companion()

A companion is used to represent additional banner ads that display along with a main ad.

Members

<static> RequiredRule :string

Used to determine whether all, at least one or none of the Companions with the same
sequence number need to be displayed successfully for their parentAd to not be failed.

Type:
  • string
Properties:
Name Type Default Description
YES string yes

Indicates that the parentAd must be failed if this Companion is not successfully displayed.
AT_LEAST_ONE_FOR_THIS_SEQUENCE string atLeastOne

Indicates that the parentAd must be failed if not at least one of its Companions, sharing the same sequence number as this one, is successfully displayed.
NO string no

Indicates that this Companion is not required to be displayed along with the parentAd.

customId :string

The custom companion ad id set in the Pulse UI.

Type:
  • string

height :number

Height of the companion's display area in pixels.

Type:
  • number

id :string

The companion ad id assigned by Pulse.

Type:
  • string

parentAd :videoplaza.adresponse.Ad

The Ad the Companion is to be shown along with.

Type:

required :videoplaza.adresponse.Companion.RequiredRule

Determines whether this companion is required to be displayed along with its parentAd or not.

Type:
See:

resources :Array

The resources used to display the companion ad. If this array contains multiple resources, the video player
should determine the most appropriate type to display. The resources can be any of the following types:
videoplaza.adresponse.IFrameResource, videoplaza.adresponse.HtmlResource, videoplaza.adresponse.StaticResource.

Type:
  • Array

sequence :number

The order in which the Companion is to be displayed. If Companions have the same sequence number, they should be displayed at the same time.

Type:
  • number

trackingEvents :object

Map of URLs for various tracking events.

Type:
  • object

width :number

Width of the companion's display area in pixels.

Type:
  • number

zone :string

The placement zone ID of the companion set in the Pulse UI.

Type:
  • string