Following table lists all the options available while invoking the video ad.
|
Fields |
Description |
|
|
zoneId |
Zone Id. Go to games section in the AppLixir application to get your Id. Use 2050 for testing. |
|
|
accountId |
Account ID shown on the Games panel in the AppLixir application. |
|
|
gameId |
Use Game ID on the Games panel in the AppLixir application. |
|
|
userId |
userId must contain a valid UUID for the current user. UUID4 format is recommended. |
|
|
custom |
Custom data to be sent to the game server regarding the reward. This data can either be a UUID v4 or can be sent in JSON format. |
|
|
fallback |
This field indicates if a fallback should be used when the reward video is not available. It can take the following values: 0 – Do not use fallback ad 1 – Use fallback banner ad If the fallback field is not included in the options, by default it is set to 0 indicating no fallback ad to be displayed. |
|
|
adStatusCb |
The status callback event handler |
|
|
vpos |
This field can take the following values: Top: the player to be displayed at the top of the screen Bottom: the player to be displayed at the bottom of the screen Middle: the player to be displayed at the middle of the screen |
|
|
vposM |
This setting can be used to specify a separate video player position on Mobile devices.It can take the following values: Top: the video player to be displayed at the top of the device screen. Bottom: the video player to be displayed at the bottom of the device screen. Middle: the video player to be displayed at the middle of the device screen. |
|
|
vtos |
Vertical offset with respect to the center of the screen at which the video player should be displayed. For example, +1 offset will move up the player 1% of the screen size. Positive numbers indicate an upwards movement of the player whereas negative numbers indicate a downwards movement of the player. |
|
|
htos |
Horizontal offset with respect to the center of the screen at which the video player should be displayed. For example, +1 offset will move the player 1% towards the right. Positive numbers indicate a right movement of the player whereas negative numbers indicate a movement of the player towards the left. |
|
|
vSize |
Sets the screen size. This field can take the following values. 1. 640x480 - 640px horizontally and 480px vertically 2. 640x360 - 640px horizontally and 360px vertically 3. 800x600 - 800px horizontally and 600px vertically 4. 1024x768 - 1024px horizontally and 768px vertically 5. max - uses all the available space in the parent This field is only applicable for the desktop. For better Fill Rates, we suggest you choose option 4 (1024x768) media player size. |
|
| vSizeM | It is recommended to use "max" to make ads easier to see on small displays | |
|
btnDelay |
Time(in seconds) after which a close button should appear on the ad, using which the ad can be closed. The min value it can take is 11 and the max value can be 31. |
|
|
maxAdt |
Time (in seconds) that an ad must be watched before ad-watched will be sent instead of ad-interrupted when the ad is closed. Values between 31 and 120 may be used. |
|
|
verbosity |
This controls the amount of detail that is logged to DevTools Console Log. It can take values between 0 and 5, where 0 indicates no verbosity and values from 1 to 5 provide increasing levels of log data. This is especially useful for debugging purposes. It is not recommended to use this in a production environment (remove the field or set it to 0) due to performance and security reasons. |
|
|
endMsg |
This option controls the "Thank You" message after an ad has been shown. A value of 1 will show the Thank You message and a value of 0 will not. |
|