VPAID Implementation Guide

Owned by
Itay Nave
Last updated: Feb 12, 2024
2 min read

Background

Aniview™ vast-vpaid tag is a vast tag returning Aniview ad manager VPAID JS media.

Any player that supports Javascript VPAID tags can work with the Aniview VPAID tag.

Example tag url:

http://go.aniview.com/api/adserver/vast/?AV_PUBLISHERID=[PublisherId]&AV_CHANNELID=[ChannelId]&AV_URL=[EncodedPageURL]&cb=[RandomNumber]

Parameters

The following parameters can be passed in the URL.

Special cases

When using a combination of:

  1. Our VPAID

  2. 3rd party player

  3. Sound on

  4. Click to play

Then please add:

&usevslot=1&imaiosskip=false&plcmt=1&soundbutton=true

Otherwise ads might get stack, not work on iOS, etc.
See below for info on each of these.

Macros

All AV_ or custom macros can be passed in the tag URL. Below is a list of required and frequently used macros:

 

Notes

Web

InApp

 

Notes

Web

InApp

AV_PUBLISHERID

Publisher Id

Required

Required

AV_CHANNELID

Channel Id

Required

Required

AV_CONSENT

consent string

Recommended to avoid latency

Recommended to avoid latency

AV_GDPR

0/1

Recommended

Recommended

AV_URL

URL Encoded of current page url

Optional

 

AV_APPNAME

App name as appears in the appstore

 

Recommended

AV_APPPKGNAME

App bundle/package name

 

Required

AV_APPSTOREURL

URL to app page in appstore

 

Recommended

AV_IDFA or AV_AID

IDFA/Advertiser id

 

Required

AV_LATITUDE

Latitude

 

Recommended

AV_LONGITUDE

Longitude

 

Recommended

AV_WIDTH

Player width

Recommended

Recommended

AV_HEIGHT

Player height

Recommended

Recommended

Additional AV_ or custom macros can be passed as well

 

 

 

 

 

 

 

Parameters

It is also possible to pass adConfig parameters in the tag URL. Below is a list of parameters that are frequently used.

Important note: All adConfig parameters must be passed in lowercase.

Parameter

Values

Description

Parameter

Values

Description

skip

false - default

true

Show skip button

skiptimer

Number

Skip timer in seconds. Must be > 0

To enable skip button after 3 sec add

&close=true&closetimer=3

soundbutton

false - default

true

Enable sound button to possible issues with sound in iOS

logo

true - default

false

Show or don't show logo

usevslot

false - default

true - Required for sound on

Set to true if:

this is a preroll/midrol and requires syncing sound on/off with the player

The vpaid is running in a 3rd party iframe using Google IMA

hidecontrols

true - default in vpaid

false

By default, all controls and progress bar are not visible. To enable, add &hidecontrols=false

imaiosskip

true - default
false - Click to play sound on

Must be set to false with usevslot=true and plcmt=1 for click to play sound on

plcmt

1 - instream sound on
2 - Accompanying Content
3 - Interstitial
4 - Outstream

Placement

vastretry

0 - default

Number up to 5

Number of times to retry running the waterfall before sending AdError.
Default is 0 - no retries - one run.
Increasing it may increase fill but will also increase the delay

autosounddetect

false - default
true

Set to true to force the Ad to run with sound on, regardless of the Player running with sound off.
Must be combined with autosoundvolume.

autosoundvolume

Range between 0 to 1

Applies a value that defines the volume the Ad will play at.
E.g - 0.5 will play the Ad at 50% of the max volume.

showbigplay=false&showpreloader=false

 

Hide spinners when the vpaid loads

iiqpartner

 

Intentiq partner id