Package com.jwplayer.pub.api.media.ads

Class AdCompanion

java.lang.Object

com.jwplayer.pub.api.media.ads.AdCompanion

public class AdCompanion
extends Object

An Ad Companion.

Constructor Summary

Constructors

Constructor	Description
AdCompanion(String click, int height, int width, String resource, AdCompanionType type, List<String> creativeViews)

Method Summary

Modifier and Type	Method	Description
String	getClick()	URL to link to when clicking the companion.
List<String>	getCreativeViews()	A List of included creativeview event tracking pixels
int	getHeight()	The height of the companion in pixels.
String	getResource()	The URL to the static/iframe resource, or the raw HTML content.
AdCompanionType	getType()	The type of the creative: static, iframe, or HTML.
int	getWidth()	The width of the companion in pixels.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AdCompanion

public AdCompanion(String click,
 int height,
 int width,
 String resource,
 AdCompanionType type,
 List<String> creativeViews)

Method Details

getClick

public String getClick()

URL to link to when clicking the companion. Only available if the type is static.

Returns:

link URL.

getHeight

public int getHeight()

The height of the companion in pixels.

Returns:

height.

getWidth

public int getWidth()

The width of the companion in pixels.

Returns:

width.

getResource

public String getResource()

The URL to the static/iframe resource, or the raw HTML content.

Returns:

static webpage or iframe URL.

getType

public AdCompanionType getType()

The type of the creative: static, iframe, or HTML.

Returns:

'static', 'iframe', or 'HTML'.

getCreativeViews

public List<String> getCreativeViews()

A List of included creativeview event tracking pixels