Interface NonLinearAdsData

The ad data object where essential information regarding a nonlinear ad is stored.

interface NonLinearAdsData {
    duration: number;
    extensions?: {
        content: string;
        type: string;
    }[];
    nonLinearAdList: {
        adId?: string;
        adParameters?: string;
        adSystem?: string;
        adTitle?: string;
        apiFramework?: string;
        clickThrough?: string;
        clickTracking?: string;
        clickTrackingId?: string;
        creativeAdId?: string;
        creativeId?: string;
        creativeSequence?: string;
        durationInSeconds: number;
        expandedHeight?: string;
        expandedWidth?: string;
        height?: string;
        htmlResource?: string;
        iFrameResource?: string;
        maintainAspectRatio?: boolean;
        minSuggestedDuration?: string;
        scalable?: boolean;
        staticResource?: string;
        staticResourceCreativeType?: string;
        width?: string;
    }[];
    nonlinearAvail: boolean;
    start: number;
    startDate: number;
    trackingEvents?: {
        beaconUrls: string[];
        durationInSeconds?: number;
        eventId?: string;
        eventProgramDateTime?: string;
        eventType: string;
        startTimeInSeconds?: number;
    }[];
}

Properties

duration extensions? nonLinearAdList nonlinearAvail start startDate trackingEvents?

Properties

duration

duration: number

The ad's duration in seconds.

Optional extensions

extensions?: {
    content: string;
    type: string;
}[]

Type declaration

  • content: string
  • type: string

nonLinearAdList

nonLinearAdList: {
    adId?: string;
    adParameters?: string;
    adSystem?: string;
    adTitle?: string;
    apiFramework?: string;
    clickThrough?: string;
    clickTracking?: string;
    clickTrackingId?: string;
    creativeAdId?: string;
    creativeId?: string;
    creativeSequence?: string;
    durationInSeconds: number;
    expandedHeight?: string;
    expandedWidth?: string;
    height?: string;
    htmlResource?: string;
    iFrameResource?: string;
    maintainAspectRatio?: boolean;
    minSuggestedDuration?: string;
    scalable?: boolean;
    staticResource?: string;
    staticResourceCreativeType?: string;
    width?: string;
}[]

TODO

Type declaration

  • Optional adId?: string
  • Optional adParameters?: string
  • Optional adSystem?: string
  • Optional adTitle?: string
  • Optional apiFramework?: string
  • Optional clickThrough?: string
  • Optional clickTracking?: string
  • Optional clickTrackingId?: string
  • Optional creativeAdId?: string
  • Optional creativeId?: string
  • Optional creativeSequence?: string
  • durationInSeconds: number
  • Optional expandedHeight?: string
  • Optional expandedWidth?: string
  • Optional height?: string
  • Optional htmlResource?: string
  • Optional iFrameResource?: string
  • Optional maintainAspectRatio?: boolean
  • Optional minSuggestedDuration?: string
  • Optional scalable?: boolean
  • Optional staticResource?: string
  • Optional staticResourceCreativeType?: string
  • Optional width?: string

nonlinearAvail

nonlinearAvail: boolean

Whether the nonlinear ad is from a nonlinear avail.

start

start: number

The ad's time position (in seconds) relative to the beginning of the playback session.

startDate

startDate: number

The ad's time position (in seconds) as wall clock time since the epoch, or 0 if unavailable.

Optional trackingEvents

trackingEvents?: {
    beaconUrls: string[];
    durationInSeconds?: number;
    eventId?: string;
    eventProgramDateTime?: string;
    eventType: string;
    startTimeInSeconds?: number;
}[]

Type declaration

  • beaconUrls: string[]
  • Optional durationInSeconds?: number
  • Optional eventId?: string
  • Optional eventProgramDateTime?: string
  • eventType: string
  • Optional startTimeInSeconds?: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc