Interface Ad

See: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/js/google.ima.Ad

interface Ad {
    getAdId(): string;
    getAdPodInfo(): AdPodInfo;
    getAdSystem(): string;
    getAdvertiserName(): string;
    getApiFramework(): null | string;
    getCompanionAds(width, height, settings?): CompanionAd[];
    getContentType(): string;
    getCreativeAdId(): string;
    getCreativeId(): string;
    getDealId(): string;
    getDescription(): string;
    getDuration(): number;
    getHeight(): number;
    getMediaUrl(): null | string;
    getMinSuggestedDuration(): number;
    getSkipTimeOffset(): number;
    getSurveyUrl(): null | string;
    getTitle(): string;
    getTraffickingParameters(): Record<string, string>;
    getTraffickingParametersString(): string;
    getUiElements(): string[];
    getUniversalAdIdRegistry(): string;
    getUniversalAdIdValue(): string;
    getUniversalAdIds(): UniversalAdIdInfo[];
    getVastMediaBitrate(): number;
    getVastMediaHeight(): number;
    getVastMediaWidth(): number;
    getWidth(): number;
    getWrapperAdIds(): string[];
    getWrapperAdSystems(): string[];
    getWrapperCreativeIds(): string[];
    isLinear(): boolean;
}

Methods

getAdId getAdPodInfo getAdSystem getAdvertiserName getApiFramework getCompanionAds getContentType getCreativeAdId getCreativeId getDealId getDescription getDuration getHeight getMediaUrl getMinSuggestedDuration getSkipTimeOffset getSurveyUrl getTitle getTraffickingParameters getTraffickingParametersString getUiElements getUniversalAdIdRegistry getUniversalAdIdValue getUniversalAdIds getVastMediaBitrate getVastMediaHeight getVastMediaWidth getWidth getWrapperAdIds getWrapperAdSystems getWrapperCreativeIds isLinear

Methods

getAdId

  • getAdId(): string

  • Returns string

getAdPodInfo

getAdSystem

  • getAdSystem(): string

  • Returns string

getAdvertiserName

  • getAdvertiserName(): string

  • Returns string

getApiFramework

  • getApiFramework(): null | string

  • Returns null | string

getCompanionAds

getContentType

  • getContentType(): string

  • Returns string

getCreativeAdId

  • getCreativeAdId(): string

  • Returns string

getCreativeId

  • getCreativeId(): string

  • Returns string

getDealId

  • getDealId(): string

  • Returns string

getDescription

  • getDescription(): string

  • Returns string

getDuration

  • getDuration(): number

  • Returns number

getHeight

  • getHeight(): number

  • Returns number

getMediaUrl

  • getMediaUrl(): null | string

  • Returns null | string

getMinSuggestedDuration

  • getMinSuggestedDuration(): number

  • Returns number

getSkipTimeOffset

  • getSkipTimeOffset(): number

  • Returns number

getSurveyUrl

  • getSurveyUrl(): null | string

  • Returns null | string

getTitle

  • getTitle(): string

  • Returns string

getTraffickingParameters

  • getTraffickingParameters(): Record<string, string>

  • Returns Record<string, string>

getTraffickingParametersString

  • getTraffickingParametersString(): string

  • Returns string

getUiElements

  • getUiElements(): string[]

  • Returns string[]

getUniversalAdIdRegistry

  • getUniversalAdIdRegistry(): string

  • Returns string

getUniversalAdIdValue

  • getUniversalAdIdValue(): string

  • Returns string

getUniversalAdIds

getVastMediaBitrate

  • getVastMediaBitrate(): number

  • Returns number

getVastMediaHeight

  • getVastMediaHeight(): number

  • Returns number

getVastMediaWidth

  • getVastMediaWidth(): number

  • Returns number

getWidth

  • getWidth(): number

  • Returns number

getWrapperAdIds

  • getWrapperAdIds(): string[]

  • Returns string[]

getWrapperAdSystems

  • getWrapperAdSystems(): string[]

  • Returns string[]

getWrapperCreativeIds

  • getWrapperCreativeIds(): string[]

  • Returns string[]

isLinear

  • isLinear(): boolean

  • Returns boolean

Settings

Member Visibility

Theme

On This Page

getAdIdgetAdPodInfogetAdSystemgetAdvertiserNamegetApiFrameworkgetCompanionAdsgetContentTypegetCreativeAdIdgetCreativeIdgetDealIdgetDescriptiongetDurationgetHeightgetMediaUrlgetMinSuggestedDurationgetSkipTimeOffsetgetSurveyUrlgetTitlegetTraffickingParametersgetTraffickingParametersStringgetUiElementsgetUniversalAdIdRegistrygetUniversalAdIdValuegetUniversalAdIdsgetVastMediaBitrategetVastMediaHeightgetVastMediaWidthgetWidthgetWrapperAdIdsgetWrapperAdSystemsgetWrapperCreativeIdsisLinear