> Documentation-Index > Setup Guide

smartClientCore

Global Config

• blockInsecureURL
• maxWrapperDepth
• skipOffset
• timeouts
  • adRequest
  • adRequestChain
  • adSlotRequest
  • contentRequest
  • nonlinearMaxDuration
  • videoRequest
  • vpaidReadiness
  • vpaidRequest
• trackImpressionOnStart
• trackSkippedQuartiles
• viewability
  • area
  • time
• urlhandler

blockInsecureURL : Boolean

By default insecure URL requests (tags, tracker, media files) will not be executed within secure environment. Default is true.

maxWrapperDepth : Number

When serving an ad involves a chain of wrappers, an infinite loop is possible where a chain of Wrappers never results in a final inline VAST response. In general, wrappers should be limited to ten before resulting in an inline response. If the add-on detects more than ten wrappers, the add-on rejects any subsequent responses in the chain and returns VAST error 302. Default limit is 10 wrappers.

skipOffset : Number

Time value in seconds that identifies when skip controls are made available to the end user by default. Advertisers may define a skipoffset value in its VAST tag that has higher priority than the publisher setting.

timeouts : Timeouts

adRequest : Number

The number of seconds a single ad request can take to load before being terminated.
Default is 1 seconds.

adRequestChain : Number

The total number of seconds a single ad request chain (VAST Wrappers and final VAST Inline tag) can take to load before being terminated.
Default is 2 seconds.

adSlotRequest : Number

The total number of seconds an ad-slot request (from calling initAdSlot until the Promise resolves or rejects) can take before being terminated.
Default is 4 seconds.

contentRequest : Number

The total number of seconds the video player can take to answer the releaseContent request to the player facade (see FacadeBase.releaseContent()). If the Promise is neither resolved nor rejected within the specified time, the AdSlot becomes terminated. The add-on responds by sending a general error with code 11 (ERROR_CODE.SESSION.NOT_RESTORABLE) and message SessionError: Reset content timed out. Player did not respond.
Default is 3 seconds.

nonlinearMaxDuration : Number

The maximum time in seconds a NonLinear ad is displayed (from triggering the impression) before being terminated. Note: The timer becomes paused for the time a creative has entered the linear state.
Default is 10 seconds.

videoRequest : Number

Representing the number of seconds a video creative can take to load before being terminated.
Default is 3 seconds.

vpaidReadiness : Number

Representing the number of seconds a VPAID creative can take to initialize and respond (from calling VPAID.initAd() until the creative triggers the AdLoaded event) before being terminated.
Default is 3 seconds.

vpaidRequest : Number

Representing the number of seconds a VPAID creative (JavaScript resource) can take to load before being terminated.
Default is 1 seconds.

trackImpressionOnStart : Boolean

Defines whether the trackers impression and creativeView are requested at the time a video ad is loaded or when the video player actually starts playing (start, 0%). The difference is most noticeable with video players or browsers that prevent autoplay without user interaction. The impression and creative view trackers are requested immediately, while the start tracker is requested after a delay, depending on when playback starts. Defaulting to false if omitted.

trackSkippedQuartiles : Boolean

Defines whether to track all VAST progress trackers (start, firstQuartile, midpoint, thirdQuartile and complete), regardless of whether some of them were somehow skipped or to just request VAST progress trackers that were actually triggered by a matching playhead update. Possible "skip" use cases are the user seeks over one or multiple progress points, or the timeupdate interval from the video player is too long. Defaulting to false if omitted.

viewability : AdViewabilityConfig

The Media Ratings Council (MRC) has published the following as recommendations for video viewability. How a video ad is counted when 50% of the ad's pixels are visible for at least two seconds. Publishers should disclose their process for tracking viewable video impressions.

area : number

The percentage of how many pixels of an ad must be in the visible area for the visibility time measurement to begin. Default is 50 percent of pixels.

time : number

The number of seconds a single ad must be visible before a viewable tracker can be triggered.
Default is 2 seconds.

urlhandler : URLHandler

Allows switching to a different implementation for fetching ad tags and trackers valid options are:

• URLHandler.DEFAULT
• URLHandler.NATIVE