Interface AdsRequestInterface

  • This documentation provides details on properties and methods for configuring ad requests, including specifying ad responses, ad tag URLs, content details, and ad slot dimensions.

  • The adsResponse property allows for the use of a VAST 2.0 document as the ad response, while adTagUrl specifies the URL from the ad server, which is a required parameter.

  • Properties such as contentDuration, contentKeywords, and contentTitle provide details about the content being shown, which are utilized in AdX ad targeting.

  • The dimensions for linear and non-linear ads can be set with linearAdSlotHeight, linearAdSlotWidth, nonLinearAdSlotHeight, and nonLinearAdSlotWidth, which are required for their respective ad types.

  • Methods like setAdWillAutoPlay, setAdWillPlayMuted, and setContinuousPlayback allow for notifying the SDK about the player's behavior, including autoplay, muted playback, and continuous video playback.
Properties
adsResponse
Specifies a VAST 2.0 document to be used as the ads response instead of making a request through an ad tag url.
adTagUrl
Specifies the ad tag url that is requested from the ad server.
contentDuration
Specifies the duration of the content in seconds to be shown.
contentKeywords
Specifies the keywords used to describe the content to be shown.
contentTitle
Specifies the title of the content to be shown.
forceNonLinearFullSlot
Forces non-linear AdSense ads to render as linear fullslot.
linearAdSlotHeight
Specifies the height of the rectangular area within which a linear ad is displayed.
linearAdSlotWidth
Specifies the width of the rectangular area within which a linear ad is displayed.
liveStreamPrefetchSeconds
Specifies the maximum amount of time to wait in seconds, after calling requestAds, before requesting the ad tag URL.
nonLinearAdSlotHeight
Specifies the height of the rectangular area within which a non linear ad is displayed.
nonLinearAdSlotWidth
Specifies the width of the rectangular area within which a non linear ad is displayed.
omidAccessModeRules
Settings object for mapping verification vendors to OMID Access Modes.
pageUrl
Specifies the full url of the page that will be included in the Google ad request for targeting purposes.
vastLoadTimeout
Override for default VAST load timeout in milliseconds for a single wrapper.
Methods
setAdWillAutoPlay
Notifies the SDK whether the player intends to start the content and ad in response to a user action or whether it will be automatically played.
setAdWillPlayMuted
Notifies the SDK whether the player intends to start ad while muted.
setContinuousPlayback
Notifies the SDK whether the player intends to continuously play the content videos one after another similar to TV broadcast.

Properties

adsResponse

adsResponse: string | Document
Specifies a VAST 2.0 document to be used as the ads response instead of making a request through an ad tag url. This can be useful for debugging and other situations where a VAST response is already available.

This parameter is optional.

adTagUrl

adTagUrl: string
Specifies the ad tag url that is requested from the ad server. For details on constructing the ad tag url, see Create a main ad video tag manually.

This parameter is required.

contentDuration

contentDuration: number
Specifies the duration of the content in seconds to be shown. It is used in 2 cases: 1) AdX ad targeting and 2) deciding when to preload VMAP postroll.

This parameter is optional.

contentKeywords

contentKeywords: string[]
Specifies the keywords used to describe the content to be shown. Used in AdX requests.

This parameter is optional.

contentTitle

contentTitle: string
Specifies the title of the content to be shown. Used in AdX requests.

This parameter is optional.

forceNonLinearFullSlot

forceNonLinearFullSlot: boolean
Forces non-linear AdSense ads to render as linear fullslot. If set, the content video will be paused and the non-linear text or image ad will be rendered as fullslot. The content video will resume once the ad has been skipped or closed.

linearAdSlotHeight

linearAdSlotHeight: number
Specifies the height of the rectangular area within which a linear ad is displayed. This value is used as one of the criteria for ads selection. This value does not need to match actual ad's height.

This parameter is required for linear ads.

linearAdSlotWidth

linearAdSlotWidth: number
Specifies the width of the rectangular area within which a linear ad is displayed. This value is used as one of the criteria for ads selection. This value does not need to match actual ad's width.

This parameter is required for linear ads.

liveStreamPrefetchSeconds

liveStreamPrefetchSeconds: number
Specifies the maximum amount of time to wait in seconds, after calling requestAds, before requesting the ad tag URL. This can be used to stagger requests during a live-stream event, in order to mitigate spikes in the number of requests.

nonLinearAdSlotHeight

nonLinearAdSlotHeight: number
Specifies the height of the rectangular area within which a non linear ad is displayed. This value is used as one of the criteria for ads selection. This value does not need to match actual ad's height.

This parameter is required for non-linear ads.

nonLinearAdSlotWidth

nonLinearAdSlotWidth: number
Specifies the width of the rectangular area within which a non linear ad is displayed. This value is used as one of the criteria for ads selection. This value does not need to match actual ad's width.

This parameter is required for non-linear ads.

omidAccessModeRules

omidAccessModeRules: {
  [key: string]: string;
}
Settings object for mapping verification vendors to OMID Access Modes. The keys must be values in google.ima.OmidVerificationVendor, and the values must be values in google.ima.OmidAccessMode.

Verification script URLs are internally matched against vendor provided regular expressions to resolve to an OmidVerificationVendor key. IMA then looks up the access mode for the given vendor using this object.

For script URLs that don't resolve to a known vendor, or if the resolved OmidVerificationVendor is not provided in this object, IMA will use the access mode provided for OmidVerificationVendor.OTHER. If OmidVerificationVendor.OTHER is not provided, then the LIMITED access mode will be used.

pageUrl

pageUrl: string
Specifies the full url of the page that will be included in the Google ad request for targeting purposes. The url needs to be a valid url. If specified, this value will be used for the [PAGEURL] VAST macro.

This parameter is optional.

vastLoadTimeout

vastLoadTimeout: number
Override for default VAST load timeout in milliseconds for a single wrapper. The default timeout is 5000ms.

This parameter is optional.

Methods

setAdWillAutoPlay

setAdWillAutoPlay(autoPlay: boolean): void
Notifies the SDK whether the player intends to start the content and ad in response to a user action or whether it will be automatically played. Changing this setting will have no impact on ad playback.
Parameters
autoPlay: boolean Whether the content and the ad will be autoplayed or whether it will be started by a user action.

setAdWillPlayMuted

setAdWillPlayMuted(muted: boolean): void
Notifies the SDK whether the player intends to start ad while muted. Changing this setting will have no impact on ad playback, but will send the appropriate signal in the ad request to allow buyers to bid on muted inventory.
Parameters
muted: boolean Whether the ad will be played while muted.

setContinuousPlayback

setContinuousPlayback(continuousPlayback: boolean): void
Notifies the SDK whether the player intends to continuously play the content videos one after another similar to TV broadcast. Changing this setting will have no impact on the ad playback, but will send the appropriate signal in this ad request to allow buyers to bid on the type of ad inventory.
Parameters
continuousPlayback: boolean Whether the content video is played one after another continuously.