/** * Describes a single ad identifier used to uniquely identify an ad */ export interface SgaiAdTrackerIdentifiers { /** * A scheme URI that identifies the definition authority for the related identification value */ scheme: string; /** * An identifier value that can be interpreted using the semantics of the named scheme. */ value: string; } /** * Describes a single tracking event for an ad used within ad lifecycle */ export interface SgaiAdTrackingEventData { /** * The event trigger type */ type: AdTrackingEventTrigger; /** * Array of tracking URLs for the event */ urls?: string[]; /** * Offset in seconds relative to reference object (DATE-RANGE/ASSET-LIST) when the event should be triggered */ offset?: number; /** * Start time in seconds */ start?: number; /** * Duration in seconds */ duration?: number; } /** * Describes a resource and parameters that can be utilized to initialize and operate * an ad verification provider Software Development Kit (SDK) */ export interface SgaiAdTrackingVerificationData { /** * Identifies the vendor context that the resource and parameters can be interpreted in */ vendor: string; /** * The parameters that can be used to initialize the vendor verification system */ parameters?: string; /** * URI representing a resource that is part of the vendor verification system */ resource?: string; } /** * Enum representing different types of SGAI ads */ export declare enum SgaiAdType { /** * A basic duration based media asset */ LINEAR = "linear" } /** * Tracking data parsed on DATE-RANGE or inner ads in ASSET-LIST level */ export interface SgaiAdTrackingPayload { /** * The type of the ad */ type: SgaiAdType; /** * The start time of the ad within the primary content timeline or related to start of asset-list */ start: number; /** * The duration of the ad in seconds */ duration: number; /** * Array of ad identifiers to uniquely identify the ad */ identifiers: SgaiAdTrackerIdentifiers[]; /** * Array of tracking events that provide tracking urls for various points in ad lifecycle */ tracking?: SgaiAdTrackingEventData[]; /** * Array of verification data to provide ad verification provider resources */ verification?: SgaiAdTrackingVerificationData[]; /** * Optional click through url for the ad */ clickThrough?: string; } /** * Top level tracking data parsed on ASSET-LIST level */ export interface SgaiAdTrackerData { /** * Total duration of all ads in the asset list in seconds */ duration: number; /** * The start time of the ad list within the primary content timeline */ start?: number; /** * Top level tracking events for the ad list, applicable to all ads in the list */ tracking?: SgaiAdTrackingEventData[]; /** * Array of ad tracking payloads for each ad in the asset list */ payload?: SgaiAdTrackingPayload[]; } export interface AdTrackingEvent { /** * The tracking URL to fire when this event is triggered */ urls: string[]; /** * The offset(absolute time in seconds) when the progress event should be fired */ offset?: number; } export declare enum AdTrackingEventTrigger { /** * When the impression of ad creative occurs */ IMPRESSION = "impression", /** * When a user action has caused the ad to be paused */ PAUSE = "pause", /** * When a user action has caused the ad to be muted */ MUTE = "mute", /** * When a user action has caused the ad to be unmuted */ UNMUTE = "unmute", /** * When a user action has caused the ad to be resumed from paused state */ RESUME = "resume", /** * When the ad has been loaded */ LOADED = "loaded", /** * When the ad is started */ START = "start", /** * When the ad has been playing for a duration equal to the signaled offset */ PROGRESS = "progress", /** * When 25% of the ad has been played */ FIRST_QUARTILE = "firstQuartile", /** * When 50% of the ad has been played */ MIDPOINT = "midpoint", /** * When 75% of the ad has been played */ THIRD_QUARTILE = "thirdQuartile", /** * When the ad has been completed */ COMPLETE = "complete", /** * When an error has occurred during ad playback */ ERROR = "error", /** * When the ad has been clicked */ CLICKED = "clickTracking", /** * When the ad has been skipped */ SKIP = "skip", /** * When the ad is viewable according to the viewability definition * (e.g. 50% of the ad is visible for at least 2 seconds) */ VIEWABLE = "viewable", /** * When the ad is not viewable according to the viewability definition */ NOT_VIEWABLE = "notViewable", /** * When the viewability of the ad cannot be determined due to technical limitations */ VIEW_UNDETERMINED = "viewUndetermined" }