Interface: SetupConfig

interface SetupConfig {    integrationId: string;    height?: string;    onComplete?: (arg?: unknown) => void;    onLoad?: (integration: IntegrationElement) => void;    onPassback?: (payload: { reason: string }) => void;    onReady?: (arg?: unknown) => void;    placement?: string;    playlistId?: string;    schain?: string;    width?: string;}

Properties

integrationId

integrationId: string

The identifier for this integration. This value is used to determine the configuration and behavior of the integration.

height?

optional height: string

Enforce a height for the integration. You can pass in a number (interpreted as pixels) or a CSS value (e.g. 100px, 100%).

onComplete()?

optional onComplete: (arg?) => void

Callback that is called when the first content ended.

Parameters

arg?

unknown

Returns

void

onLoad()?

optional onLoad: (integration) => void

Callback that is called when the integration was loaded.

Parameters

integration

IntegrationElement

Returns

void

onPassback()?

optional onPassback: (payload) => void

Callback that is called when the integration is passed back (e.g. no ad available).

Parameters

payload

reason

string

Returns

void

onReady()?

optional onReady: (arg?) => void

Callback that is called when the integration is ready (e.g. ad is available).

Parameters

arg?

unknown

Returns

void

placement?

optional placement: string

An optional placement to detail the integration for analytics.

playlistId?

optional playlistId: string

An optional playlist identifier.

Default Value

auto automatically assigns a playlist

schain?

optional schain: string

Supply chain (schain) information as IAB serialized string (e.g. "1.0,1!exchange.com,123,1"). Integrator nodes are prepended to the backend-provided schain nodes.

width?

optional width: string

Enforce a width for the integration. You can pass in a number (interpreted as pixels) or a CSS value (e.g. 100px, 100%).