Version: 2.69.0

SpotXAdDescription

THEOplayer > SpotXAdDescription

SpotXAdDescription interface

Describes a SpotX ad break request.

Signature:
export interface SpotXAdDescription extends AdDescription

Properties

PropertyTypeDescription
appSpotxDataApplication specific SpotX data.
cacheBusterbooleanWhether the ad break request should contain a cache buster.
contentPageUrlstringThe URL of the content page.
customSpotxDataCustom SpotX data.
deviceSpotxDataDevice specific SpotX data.
idnumber | stringThe identifier of the ad break requested from SpotX.
ipAddressstringThe IP address of the viewer.
maximumAdDurationnumber | stringThe maximum duration of the ad, in seconds.
queryParametersSpotxQueryParameterA record of query string parameters added to the SpotX ad break request. Each entry contains the parameter name with associated value.
sourcesstringA source URL which contains the location of ad resources to be scheduled.
userSpotxDataUser specific SpotX data.

Remarks


- Available since v2.13.0.

Example

{
integration: 'spotx',
id: 123456,
cacheBuster: true,
app: {
bundle: 'com.exampleapps.example',
name: 'My CTV App'
},
device: {
ifa: '38400000-8cf0-11bd-b23e-10b96e40000d',
ua: 'Mozilla/5.0 (iPhone; CPU iPhone OS 10_3 like Mac OS X) AppleWebKit/602.1.50 (KHTML, like Gecko) CriOS/56.0.2924.75 Mobile/14E5239e Safari/602.1',
geo: {
lat: -24.378528,
lon: -128.325119
},
dnt: 1,
lmt: 1,
},
custom: {
category: ['category1', 'category2'],
somekey: 'somevalue'
}
user: {
yob: 1984,
gender: 'm'
}
}