Following table lists all the options available while invoking the video ad.
|
Fields |
Description |
Mandatory |
|
zoneId |
Zone Id. Go to games section in the Applixir application to get your Id. Use 2050 for testing. |
Yes |
|
devId |
Account ID shown on the Games panel in the Applixir application. |
No but this field is mandatory when using RMS. |
|
gameId |
Use Game ID on the Games panel in the Applixir application. |
No, but this field is mandatory when using RMS. |
|
userId |
UUID of the logged in user of the game application |
No, but this field is mandatory when the callback mode is MD5 and TID. |
|
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. |
No |
|
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. |
No, default value is 0. |
|
adStatusCb |
The status callback event handler |
No |
|
muted |
This field can take the following values: true: the video plays in muted mode false: the video plays at the current system volume |
No |
|
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 |
No |
|
vposM |
This field is used to define a separate video position for 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. |
No |
|
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. |
No |
|
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. |
No |
|
vSize |
Sets the screen size to either ‘640x480’ (default) or ‘640x360’. This field is only applicable for the desktop. Mobile ads will be square in portrait mode or fullscreen in landscape mode.
|
No |
|
maxAdt |
Time (in seconds) after which the status ‘ad-watched’ should be raised. This field can take any numeric value between 31 and 120. Even if the video is longer, after maxAdt number of seconds, the ad-watched event will be sent. |
No |
|
z2url |
The game server location where the z2 window file is hosted. |
No, only required in case of z2 window. |