Parameters
These parameters are passed in the SDK page address during WebView integration. In the browser, the same settings are set via fields of the settings object, see Browser integration.
| Parameter | Type | Required | Description |
|---|---|---|---|
url | string | yes | Link to the VAST tag |
os | string | no | Platform, when the path has none |
lang | string | no | UI language |
controls | JSON array | no | Controls |
autoplay | boolean | no | Start playback without calling playAd() |
ad_media_file_width | number | no | Desired video width |
ad_media_max_duration_sec | number | no | Maximum ad duration |
debug | string | no | Debug output to the console |
Parameters not listed in the table are appended to the VAST link unchanged.
url
Link to the VAST tag. Encode it with encodeURIComponent.
If the link contains , the SDK substitutes its own version for it.
If the parameter is missing, the SDK sends AdError with code 1.
os
The path sets the platform: /android/, /androidtv/ or /ios/ — see page address. The os parameter is only for older integrations that open the page without a platform in the path.
When both the path and os name a platform, the path wins. With neither, the platform is detected from userAgent; if that fails, android is used.
web is not supported in a WebView: the SDK sends AdError with code web_ui_in_native_build. For the browser, use the browser package.
lang
The SDK's UI language. Default is en.
| Code | Language | Code | Language |
|---|---|---|---|
ar | Arabic | pt | Portuguese |
en | English | ru | Russian |
es | Spanish | sw | Swahili |
fr | French | tr | Turkish |
hi | Hindi | uz | Uzbek |
ky | Kyrgyz |
controls
A JSON array of controls, for example ["ad-skip-btn","ad-more-menu"]. The value "all" enables every control. See the list under Controls.
autoplay
Playback starts immediately after loading, without a call to playAd().
true, 1, yes and a bare parameter (&autoplay) turn autoplay on; false, 0, no turn it off. Any other value is ignored and autoplay stays off.
ad_media_file_width
Desired video width in physical pixels (not CSS pixels). The SDK picks the VAST video file with the closest width, and the larger one when two are equally close.
Must be a positive integer. If the value is missing or invalid, quality is selected automatically based on player size and connection speed.
ad_media_max_duration_sec
Maximum ad duration in seconds. Must be a positive integer, otherwise the parameter is ignored.
debug
debug=true enables the SDK's debug output in the WebView console.
Example
https://cdn.adsdk.ru/android/v3/?url=https%3A%2F%2Fexample.com%2Fvast.xml&lang=ru&controls=%5B%22ad-skip-btn%22%2C%22ad-more-menu%22%5D&ad_media_file_width=1080