vastSelectors

Published as part of module:@mailonline/video-ad-sdk

Source:

Methods

(static) getAdErrorURI(ad) → (nullable) {string}

Gets the Error URI of the passed ad.

Parameters:
Name Type Description
ad ParsedAd

VAST ad object.
Source:

(static) getAds(parsedVAST) → (nullable) {Array}

Selects the ads of the passed VAST.

Parameters:
Name Type Description
parsedVAST ParsedVast

Parsed VAST xml.
Source:

(static) getClickThrough(ad) → (nullable) {VAST-macro}

Gets the click through VAST-macro.

Parameters:
Name Type Description
ad ParsedAd

VAST ad object.
Source:

(static) getClickTracking(ad) → (nullable) {Array.<VAST-macro>}

Gets the click through VAST-macro.

Parameters:
Name Type Description
ad ParsedAd

VAST ad object.
Source:

(static) getCreativeData(xml) → {Object}

Gets the creative data.

Parameters:
Name Type Description
xml string

VAST XML text.
Source:

(static) getCustomClick(ad) → (nullable) {Array.<VAST-macro>}

Gets the custom click VAST-macro.

Parameters:
Name Type Description
ad ParsedAd

VAST ad object.
Source:

(static) getFirstAd(parsedVAST) → (nullable) {ParsedAd}

Selects the first ad of the passed VAST. If the passed VAST response contains an ad pod it will return the first ad in the ad pod sequence.

Parameters:
Name Type Description
parsedVAST ParsedVAST

Parsed VAST xml.
Source:

(static) getIcons(ad) → (nullable) {Array.<VastIcon>}

Gets the Vast Icon definitions from the Vast Ad.

Parameters:
Name Type Description
ad ParsedAd

VAST ad object.
Source:

(static) getImpressionUri(ad) → (nullable) {string}

Gets the Impression URI of the passed ad.

Parameters:
Name Type Description
ad ParsedAd

VAST ad object.
Source:

(static) getInteractiveCreativeFiles(ad) → (nullable) {Array.<InteractiveFile>}

Gets the ad's InteractiveFiles. That were added with the InteractiveCreativeFile tag.

Parameters:
Name Type Description
ad ParsedAd

VAST ad object.
Source:

(static) getInteractiveFiles(ad) → (nullable) {Array.<InteractiveFile>}

Gets all the ad's InteractiveFiles.

Parameters:
Name Type Description
ad ParsedAd

VAST ad object.
Source:

(static) getLinearTrackingEvents(ad, eventNameopt) → (nullable) {Array.<VastTrackingEvent>}

Gets the Linear tracking events from the Vast Ad

Parameters:
Name Type Attributes Description
ad ParsedAd

VAST ad object.
eventName string <optional>

If provided it will filter-out the array events against it.
Source:

(static) getMediaFiles(ad) → (nullable) {Array.<MediaFile>}

Gets the ad's MediaFiles.

Parameters:
Name Type Description
ad ParsedAd

VAST ad object.
Source:

(static) getNonLinearTrackingEvents(ad, eventNameopt) → (nullable) {Array.<VastTrackingEvent>}

Gets the Non Linear tracking events from the Vast Ad

Parameters:
Name Type Attributes Description
ad ParsedAd

VAST ad object.
eventName string <optional>

If provided it will filter-out the array events against it.
Source:

(static) getPodAdSequence(ad) → (nullable) {number}

Gets the sequence of the pod ad.

Parameters:
Name Type Description
ad ParsedAd

Parsed ad definition object.
Source:

(static) getSkipOffset(ad) → (nullable) {ParsedOffset}

Gets the skipoffset.

Parameters:
Name Type Description
ad Object

VAST ad object.
Source:

(static) getVASTAdTagURI(ad) → (nullable) {string}

Returns the VASTAdTagURI from the wrapper ad.

Parameters:
Name Type Description
ad ParsedAd

VAST ad object.
Source:

(static) getVastErrorURI(parsedVAST) → (nullable) {VAST-macro}

Gets the Error URI of the passed parsed VAST xml.

Parameters:
Name Type Description
parsedVAST ParsedVast

Parsed VAST xml.
Source:

(static) getWrapperOptions(ad) → {WrapperOptions}

Returns the options from the wrapper ad.

Parameters:
Name Type Description
ad Object

VAST ad object.
Source:

(static) hasAdPod(parsedVAST) → (nullable) {boolean}

Checks if the passed array of ads have an ad pod.

Parameters:
Name Type Description
parsedVAST ParsedVAST

Parsed VAST xml.
Source:

(static) isAdPod(VastChain) → {boolean}

Returns true if the passed VastChain has an ad pod or false otherwise.

Parameters:
Name Type Description
VastChain Array

Array of VAST responses. See load or requestAd for more info.
Source:

(static) isInline(ad) → {boolean}

Checks if the passed ad is an Inline.

Parameters:
Name Type Description
ad ParsedAd

VAST ad object.
Source:

(static) isPodAd(ad) → (nullable) {boolean}

Checks if the passed ad definition is a pod ad.

Parameters:
Name Type Description
ad ParsedAd

Parsed ad definition object.
Source:

(static) isWrapper(ad) → {boolean}

Checks if the passed ad is a Wrapper.

Parameters:
Name Type Description
ad ParsedAd

VAST ad object.
Source: