Core SDK API Documentation

Class: StaticResource

StaticResource

new StaticResource()

A static resource, such as an image or Flash banner, used by videoplaza.adresponse.Companion.

Members

<static> ApiFramework :string

Indicates the API framework required to display a given StaticResource.

Type:
  • string
Properties:
Name Type Default Description
VPAID string VPAID

The resource is a VPAID ad.
CLICK_TAG string clickTAG

The resource is a clickTAG ad.

adParameters :string

Any information that is to be sent into the ad unit if it is of an executable type.

Type:
  • string

adParametersXmlEncoded :boolean

Indicates whether or not the adParameters field contains XML-encoded data.

Type:
  • boolean

apiFramework :videoplaza.adresponse.StaticResource.ApiFramework

Indicates the framework needed, if any, to display an executable asset.

Type:

assetHeight :number

Height of the static asset in pixels.

Type:
  • number

assetWidth :number

Width of the static asset in pixels.

Type:
  • number

clickThroughUrl :string

A URL of a page which should be opened when the user clicks a companion displaying the static resource.

Type:
  • string

expandedHeight :number

Height of the parent companion's display area when expanded, in pixels.

Type:
  • number

expandedWidth :number

Width of the parent companion's display area when expanded, in pixels.

Type:
  • number

mimeType :string

Asset MIME type. Equal to creativeType in the VAST 3.0 spec.
Possible values are: image/gif, image/jpeg, image/png, application/x-javascript, application/x-shockwave-flash

Type:
  • string

url :string

The URL of the asset to display.

Type:
  • string