...
Name | Mandatory | Default Value | Values | Description |
publisherId | Yes | String | Aniview publisher id | |
channelId | Yes | String | Aniview channel id from the same account of the publisher id used | |
position | Yes | String | the div id where the player should be created | |
width | yes | Number | The player width in pixels If width = 100 and height = 0, width is auto detected based on containing element | |
height | yes | Number | The player height in pixels If width = 100 and height = 0, height is auto detected based on containing element and is calculated as width / 1.777 | |
creativeDimensions | No | [{ w: Number, h: Number }] | Specific dimensions for the creatives to be rendered to this placement. | |
refresh | No | Object | refresh Refresh policy config | |
strategy | No | Intervalinterval | String | AutoStartinterval, Interval, Nonenone |
interval | No | 30 000 | Number | 30 000 / 60 000 / 90 000 miliseconds |
noNewInventory | No | false | Don’t send inventory reporting | |
maxRun | No | 9999 | Number | Maximum number of waterfall runs in the player session |
maxImp | No | 9999 | Number | Maximum number of impressions per player session |
errorLimit | No | 5 | Number | Maximum number of (1 + vastRetry) runs of the waterfall that do not generate impression. This means (1 + vastRetry) * (1 + errorLimit) - max number of consecutive waterfall runs that do not generate impression If there is an impression the counter reset to 0 |
ref1 | No | String | Macro list ref1: “AV_MACRO1=value1&AV_MACRO2=value2“ Values should be URL encoded | |
clickThrough | No | Object | Show or not the skip button | |
url | No | String | Clickthrough url when clicking on the ad |
...
Stop the placement, including ad flow.
requestBids()
Allows manually request bids if the refresh strategy is “none”.
renderAd()
Allows manually render the next winning bid’s HTML if the refresh strategy is “none”.
showAd()
Shows the ad inside the placement.
...
The player is created inside the position div with a unique id
...
In order to start running a template with the below configuration options, it is required to call startTemplate passing the element of the parent of the position passed in position. In this case it will be the aniBox element
| Code Block |
|---|
player.startTemplate(document.getElementById(placementConfig.position).parentNode) |
Templates Configuration
The templates configuration ads additional configurations to placementConfigThose configurations are used only if startTemplate is called .
Name | Mandatory | Default Value | Values | Description |
|---|---|---|---|---|
reqOnView | true | Boolean | If set to true, the player will run the waterfall and call ad sources only when in view. When out of view, when its time to call the ad sources, the player will verify that its in view and if not it will wait till the player is in view | |
startOnView | true | Boolean | If set to true, the player will start only when in view. This means that inventory will be sent only when in view and the player loads | |
vitab | false | Boolean | If set to true, tab viewability is taken into account when checking viewability |