Interface AdData

The ad data object where essential information regarding an ad is stored.

interface AdData {
    adId?: string;
    adParameters?: string;
    adSystem?: string;
    adTitle?: string;
    adVerifications?: {
        executableResource?: {
            apiFramework?: string;
            language?: string;
            type?: string;
            uri?: string;
        }[];
        javaScriptResource?: {
            apiFramework?: string;
            browserOptional?: string;
            uri?: string;
        }[];
        trackingEvents?: {
            event: string;
            uri: string;
        }[];
        vendor?: string;
        verificationParameters?: string;
    }[];
    availAdCount: number;
    availAdIndex: number;
    availDuration: number;
    availStart: number;
    companionAds?: {
        adParameters?: string;
        altText?: string;
        attributes?: {
            adSlotId?: string;
            apiFramework?: string;
            assetHeight?: string;
            assetWidth?: string;
            expandedHeight?: string;
            expandedWidth?: string;
            height?: string;
            id?: string;
            pxratio?: string;
            renderingMode?: string;
            width?: string;
        };
        companionClickThrough?: string;
        companionClickTracking?: string;
        htmlResource?: string;
        iFrameResource?: string;
        sequence?: string;
        staticResource?: string;
        trackingEvents?: {
            beaconUrls: string[];
            eventType: string;
        }[];
    }[];
    creativeId?: string;
    creativeSequence?: string;
    duration: number;
    extensions?: {
        content: string;
        type: string;
    }[];
    icons?: {
        height?: string;
        iconClicks?: {
            iconClickFallbackImages?: {
                altText?: string;
                height?: string;
                staticResource?: string;
                width?: string;
            }[];
            iconClickThrough?: string;
        };
        program?: string;
        staticResource?: string;
        width?: string;
        xPosition?: string;
        yPosition?: string;
    }[];
    inAvailStartOffset: number;
    playCount: number;
    skipOffset: number;
    start: number;
    startDate: number;
    trackingEvents?: {
        beaconUrls: string[];
        durationInSeconds?: number;
        eventId?: string;
        eventProgramDateTime?: string;
        eventType: string;
        startTimeInSeconds?: number;
    }[];
    vastAdId?: string;
    videoClickThrough?: string;
}

Properties

adId? adParameters? adSystem? adTitle? adVerifications? availAdCount availAdIndex availDuration availStart companionAds? creativeId? creativeSequence? duration extensions? icons? inAvailStartOffset playCount skipOffset start startDate trackingEvents? vastAdId? videoClickThrough?

Properties

Optional adId

adId?: string

Optional adParameters

adParameters?: string

Optional adSystem

adSystem?: string

Optional adTitle

adTitle?: string

Optional adVerifications

adVerifications?: {
    executableResource?: {
        apiFramework?: string;
        language?: string;
        type?: string;
        uri?: string;
    }[];
    javaScriptResource?: {
        apiFramework?: string;
        browserOptional?: string;
        uri?: string;
    }[];
    trackingEvents?: {
        event: string;
        uri: string;
    }[];
    vendor?: string;
    verificationParameters?: string;
}[]

Type declaration

  • Optional executableResource?: {
        apiFramework?: string;
        language?: string;
        type?: string;
        uri?: string;
    }[]
  • Optional javaScriptResource?: {
        apiFramework?: string;
        browserOptional?: string;
        uri?: string;
    }[]
  • Optional trackingEvents?: {
        event: string;
        uri: string;
    }[]
  • Optional vendor?: string
  • Optional verificationParameters?: string

availAdCount

availAdCount: number

The total number of ads within the corresponding ad avail.

availAdIndex

availAdIndex: number

The 0-based index of the ad within the corresponding ad avail.

availDuration

availDuration: number

The total duration (in seconds) of the corresponding ad avail, or null if unknown.

availStart

availStart: number

The time position (in seconds relative to the beginning of the playback session) of the corresponding ad avail, or null if unknown.

Optional companionAds

companionAds?: {
    adParameters?: string;
    altText?: string;
    attributes?: {
        adSlotId?: string;
        apiFramework?: string;
        assetHeight?: string;
        assetWidth?: string;
        expandedHeight?: string;
        expandedWidth?: string;
        height?: string;
        id?: string;
        pxratio?: string;
        renderingMode?: string;
        width?: string;
    };
    companionClickThrough?: string;
    companionClickTracking?: string;
    htmlResource?: string;
    iFrameResource?: string;
    sequence?: string;
    staticResource?: string;
    trackingEvents?: {
        beaconUrls: string[];
        eventType: string;
    }[];
}[]

Type declaration

  • Optional adParameters?: string
  • Optional altText?: string
  • Optional attributes?: {
        adSlotId?: string;
        apiFramework?: string;
        assetHeight?: string;
        assetWidth?: string;
        expandedHeight?: string;
        expandedWidth?: string;
        height?: string;
        id?: string;
        pxratio?: string;
        renderingMode?: string;
        width?: string;
    }
    • Optional adSlotId?: string
    • Optional apiFramework?: string
    • Optional assetHeight?: string
    • Optional assetWidth?: string
    • Optional expandedHeight?: string
    • Optional expandedWidth?: string
    • Optional height?: string
    • Optional id?: string
    • Optional pxratio?: string
    • Optional renderingMode?: string
    • Optional width?: string
  • Optional companionClickThrough?: string
  • Optional companionClickTracking?: string
  • Optional htmlResource?: string
  • Optional iFrameResource?: string
  • Optional sequence?: string
  • Optional staticResource?: string
  • Optional trackingEvents?: {
        beaconUrls: string[];
        eventType: string;
    }[]

Optional creativeId

creativeId?: string

Optional creativeSequence

creativeSequence?: string

duration

duration: number

The ad's playback duration in seconds.

Optional extensions

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

Type declaration

  • content: string
  • type: string

Optional icons

icons?: {
    height?: string;
    iconClicks?: {
        iconClickFallbackImages?: {
            altText?: string;
            height?: string;
            staticResource?: string;
            width?: string;
        }[];
        iconClickThrough?: string;
    };
    program?: string;
    staticResource?: string;
    width?: string;
    xPosition?: string;
    yPosition?: string;
}[]

Type declaration

  • Optional height?: string
  • Optional iconClicks?: {
        iconClickFallbackImages?: {
            altText?: string;
            height?: string;
            staticResource?: string;
            width?: string;
        }[];
        iconClickThrough?: string;
    }
    • Optional iconClickFallbackImages?: {
          altText?: string;
          height?: string;
          staticResource?: string;
          width?: string;
      }[]
    • Optional iconClickThrough?: string
  • Optional program?: string
  • Optional staticResource?: string
  • Optional width?: string
  • Optional xPosition?: string
  • Optional yPosition?: string

inAvailStartOffset

inAvailStartOffset: number

The ad's start time offset (in seconds) relative to the beginning of the corresponding ad avail, or null if unknown.

playCount

playCount: number

The number of times the ad was at least partially played.

skipOffset

skipOffset: number

The number of seconds of playback before ad-skip is allowed , or -1 if non-skippable.

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

Optional vastAdId

vastAdId?: string

Optional videoClickThrough

videoClickThrough?: string

The URL to the advertiser's site that's opened when a viewer clicks the ad.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc