Interface: IntegrationProperties

Properties that can be set on the integration element.

Properties

adPlayer?

optional adPlayer: string

crossorigin?

optional crossorigin: "" | "none" | "anonymous" | "use-credentials"

The crossorigin attribute  is used to define the CORS (Cross-Origin Resource Sharing) policy for the video element. Defaults to anonymous. If set to none (non-standard value) it won’t require CORS headers for the loaded media files, though text-tracks from foreign origins then cannot be loaded.

env?

optional env: "local" | "stage"

extraContext?

optional extraContext: ExtraContext

An optional context object that can be used to pass additional application, device and user information to the integration.

hidden?

optional hidden: boolean

Hides the integration element when set to true.

index?

optional index: number

Determines the index of the media item within the playlist that should be or is currently selected.

integrationId?

optional integrationId: string

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

placement?

optional placement: string

Allows the publisher to provide an optional placement attribute, which supplies additional contextual information for enhanced analytics tracking. This can be a simple string or a stringified JSON object. If it is a stringified JSON object, its contents are forwarded as placementDetail. If the object contains a property key name, its value will be tracked for the placement attribute.

playlistId?

optional playlistId: string

Defines the playlist / content identifier that should be loaded and managed by the integration. It can be a single content id, a playlist id or auto. It must be empty when the content is provided via the media-item web components inside the integration.

topLevelIframe?

optional topLevelIframe: boolean

An optional flag that can mark the integration as if it is running in a top-level window context. Useful when the embedded iframe represents an article, which contains this integration.

variant?

optional variant: string