Pulse SDK API Documentation

Interface: OverlayAd

OO.Pulse. OverlayAd

This interface is used to interact with individual overlay video ads received from a OO.Pulse.Session.

You must notify this object of the following events:

Depending on your application some of the other methods may need to be called in response to user interaction.

Methods

adClickThroughTriggered()

Notify the SDK that the overlay ad was clicked.

adClosed()

Notify the SDK that the overlay ad was closed via a close button.

adDisplayed()

Call this method when the ad is displayed.

adFailedWithError(error)

Notify the SDK that there was an error displaying the overlay ad.

Parameters:
Name Type Description
error OO.PulseAdError

The OO.PulseAdError that best describes the problem.

adFinished()

Call this method when the ad is done displaying and was displayed for its intended duration.

getClickthroughURL()

Get the ad's clickthrough URL.

Returns:

the URL to open when the ad is clicked.

Type
string

getCoreAd()

Returns the underlying low-level core Ad object. Advanced use only! In most cases, you do not need this.

Returns:

The underlying core Ad object.

Type
videoplaza.adresponse.Ad

getDuration()

Get the ad's duration

Returns:

The duration (in seconds) of the ad.

Type
number

getHeight()

Get the ad's height

Returns:

The ad's height in pixels

Type
number

getResourceMimeType()

Get the ad resource mime type. Images or swf files can be used as overlay ads.

Returns:

The resource's mime type.

Type
string

getResourceURL()

Get the overlay ad's resource URL.

Returns:

The URL of the resource to display.

Type
string

getWidth()

Get the ad's width

Returns:

The ad's width in pixels.

Type
number