THEOplayer > SpotXAdDescription

SpotXAdDescription interface

Inherits from AdDescription . See parent page for inherited properties and methods.

Describes a SpotX ad break request.

Signature:

export interface SpotXAdDescription extends AdDescription 

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'
    }
}

Properties

Property	Type	Description
app (optional)	SpotxData	Application specific SpotX data.
cacheBuster (optional)	boolean	Whether the ad break request should contain a cache buster.
contentPageUrl (optional)	string	The URL of the content page.
custom (optional)	SpotxData	Custom SpotX data.
device (optional)	SpotxData	Device specific SpotX data.
id	number | string	The identifier of the ad break requested from SpotX.
ipAddress (optional)	string	The IP address of the viewer.
maximumAdDuration (optional)	number | string	The maximum duration of the ad, in seconds.
queryParameters (optional)	SpotxQueryParameter	A record of query string parameters added to the SpotX ad break request. Each entry contains the parameter name with associated value.
sources (optional)	string	A source URL which contains the location of ad resources to be scheduled.
user (optional)	SpotxData	User specific SpotX data.

Property Details

app

Warning: This API is deprecated.

Superseded by queryParameters.app.

Application specific SpotX data.

Signature:

app?: SpotxData;

cacheBuster

Whether the ad break request should contain a cache buster.

Signature:

cacheBuster?: boolean;

Remarks

- A cache buster adds a query parameter 'cb' with a random value to circumvent browser caching mechanisms.

contentPageUrl

The URL of the content page.

Signature:

contentPageUrl?: string;

custom

Warning: This API is deprecated.

Superseded by queryParameters.custom.

Custom SpotX data.

Signature:

custom?: SpotxData;

device

Warning: This API is deprecated.

Superseded by queryParameters.device.

Device specific SpotX data.

Signature:

device?: SpotxData;

id

The identifier of the ad break requested from SpotX.

Signature:

id: number | string;

ipAddress

The IP address of the viewer.

Signature:

ipAddress?: string;

maximumAdDuration

The maximum duration of the ad, in seconds.

Signature:

maximumAdDuration?: number | string;

queryParameters

A record of query string parameters added to the SpotX ad break request. Each entry contains the parameter name with associated value.

Signature:

queryParameters?: SpotxQueryParameter;

Remarks

- Available since v2.38.0.

sources

A source URL which contains the location of ad resources to be scheduled.

Signature:

sources?: string;

Remarks

- This will override the generated URL.

user

Warning: This API is deprecated.

Superseded by queryParameters.user.

User specific SpotX data.

Signature:

user?: SpotxData;