Page Comparison

...

Event name

Description

AdLoaded

onLoad

Indicates the first time an ad sources triggered the AdLoaded event

AdReady

Fires on every ad AdLoaded event of any ad

AdEvent

onEvent

Granular vast and request bid events per ad source

request
bid
error (no bid)
all other vast events such as pause, resume, etc…

vpaid progress events:

initAd
initAdError
initAdTimeout
AdLoaded
startAd
startAdTimeout
startAdError

AdImpression

onPlay

Called when there is a video impression.
The AdImpression event pass a parameter with extra data that is used for 3rd party reporting:

Code Block

{
  "asid": "Ad source id",
  "clickThrough": "Ad click url if available",
  "videoUrl": "Url of media file if available",
  "mt": "Media type, vast or vpaid",
  "tagInfo" : {
    "url": "Actual ad source meta data, template of url",
    "bidCpm": Actual bid cpm (prebid, rtb) or floor if vast/platform link,
    "pubCpm": Publisher CPM after rev share,
    "floorCpm": floor price used
    "bidCode": "Bidder code from prebid",
    "vast": Array of vast chain,
    "bidder": bidder name,
    "type": Internal type of ad source
    "provider": Internal platform type
    "ismp": 1 if from marketplace
    "bidData": 
    Extra demand/prebid/vast properties if available such as prebid meta
    Note that bidData params will not alwyas be available as it depends on vast/prebid response
      {
        "adSystem": Ad System from vast 
        "advertiserDomains": List of advertiser domains
        "auctionId": Prebid auction id
        "cpm": Prebid CPM
        "dealId": Deal id
        "meta": Prebid meta data as is if available in bid response
        "vast": Vast object (Internal use)
        "vastAdId": Ad id from vast
        "vastAdvertiserId": Advertiser id from vast
        "vastAdvertiserName": Advertiser name from vast
        "vastCreativeAdId": Vast creative ad id
        "vastCreativeId": Vast creative id
        "vastUniversalAdIds": Vast universal ad ids
        "vastUrl": Vast url 
      }
  }
}

AdVideoFirstQuartile

onPlay25

Called when the ad reached 25% of the ad video

AdVideoMidpoint

onPlay50

Called when the ad reached 50% of the ad video

AdVideoThirdQuartile

onPlay75

Called when the ad reached 75% of the ad video

AdVideoComplete

onPlay100

Called when the ad completed

AdClickThru

onClick

Called when the ad is clicked on

AdPaused

onPause

Called when the ad is paused

AdPlaying

onResume

Called when the ad starts playing or resumed

AdError

onError

Called by the player every time it finish running 1 + vastRetry waterfall runs without impression

Called also whenever the player decides that it should stop running, for example when maxImp or maxRun is reached, in this case the event will pass a parameter: {errorlimit: true} to indicate the player is stopping calls for ads

AdStopped

onStopped

Called when the player is stopping

AdSkipped

onSkip

Called when an ad is skipped

AdClosed

onClose

Called when the player is closing

AdVolumeChange

onUnmute

onMute

Called when the ad volume is changed

ContentImpression

onContentPlay

Called whenever a content video is starting to play

ContentComplete

onContentPlay100

Called whenever the content video is ending

ContentPaused

onContentPaused

Called when the content video is paused

ContentPlaying

onContentPlaying

Called when the content video resume playing

ContentClick

onContentClick

Called when the content video is clicked

Inventory

onInventory

Called when the player is initialized

InventoryRequest

onInventoryRequest

Called every time the player starts a waterfall run

AdViewableImpression

Called on viewable impression event - when ad is viewable for at least 2 consecutive sconds

...

Code Block

language	js

player.on("AdError", function(res){
  if(res && res.errorlimit) {
    //Player stopped 
    console.log(res.reason)
  }
});

...

The player support advanced templates such as In Article, Floating, Sticky and many customizations.

Aniview provides a tool for managing templates configuration. this section describes the configuration flags available for templates configuration

In order to activate the template, its is required to wrap the player element in additional elements and call the startTemplate API passing the element of the parent of the player position element

Template Position Wrapper

The player position (<div id="aniplayer_aniviewJS562811134">) is wrapped with an aniBox div and another wrapper

Code Block

language	html

<div style="width: 100%; margin: 0px auto; max-width: 640px;">
  <div id="aniBox" style="height: 1px;">
    <div id="aniplayer_aniviewJS562811134">
    </div>
  </div>
</div>

The player template generator automatically build this structure

The player is created inside the position div with a unique id

Starting Template

In order to start running a template with the below configuration options, it is required to call startTemplate also provides the reason for stopping in reason field

Possible values are:

Player mode:

errorlimit: Player reached max number of waterfall runs without impression
emptywf: The waterfall is empty
maxrun: The player reached adConfig.maxrun waterfall runs
maximp: The player reached adConfig.maximp impressions

Vpaid mode:

maxpagereq: The vpaid reached the maximum number of ad requests on the page and cannot run again
maxpagerun: The vpaid reached the maximum number of runs on the page

Player Templates

The player support advanced templates such as In Article, Floating, Sticky and many customizations.

Aniview provides a tool for managing templates configuration. this section describes the configuration flags available for templates configuration

In order to activate the template, its is required to wrap the player element in additional elements and call the startTemplate API 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(adConfig.position).parentNode)

Templates Configuration

The templates configuration ads additional configurations to adConfig

Those configurations are used only if startTemplate is called

...

Name

...

Mandatory

...

Default Value

...

Values

...

Description

playOnView

...

false

...

Boolean

...

If set to true, the player will automatically check viewability and will call startAd only when in view.

...

startOnView

...

false

...

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

...

player position element

Template Position Wrapper

The player position (<div id="aniplayer_aniviewJS562811134">) is wrapped with an aniBox div and another wrapper

Code Block

language	html

<div style="width: 100%; margin: 0px auto; max-width: 640px;">
  <div id="aniBox" style="height: 1px;">
    <div id="aniplayer_aniviewJS562811134">
    </div>
  </div>
</div>

The player template generator automatically build this structure

The player is created inside the position div with a unique id

Starting Template

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(adConfig.position).parentNode)

Templates Configuration

The templates configuration ads additional configurations to adConfig

Those configurations are used only if startTemplate is called

Name	Mandatory	Default Value	Values	Description
playOnView		false	Boolean	If set to true, the player will run the waterfall and call ad sources automatically check viewability and will call startAd only when in view. When out of view, when
startOnView		false	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
reqOnView		false	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
vitab		false	Boolean	If set to true, tab viewability is taken into account when checking viewability
pauseOnUnseen		false	Boolean	If set to true, the player will pause when its out of view
pauseOnBlur		false	Boolean	Pause when browser window lose focus
openAnim		false	Boolean	If true, player opens in animation
hideInitPreloader		false	Boolean	Hide player when searching for ads
showPlayer			Boolean	Force showing the player
scriptId	Yes		String	Id of script used to position the player if no pos defined
posId			String	Position id If defined the player will be located on the element with the specified id
posTag			String	Position tag If defined the player will be located on the element with the specified tag name
posClass			String	Position class If defined the player will be located on the first element with the specified class
posSelector			String	Position selector If defined, the player position will use querySelector with the given string
posDfp1x1			Boolean	If defined, it is assumed the player script is served inside a 1x1 hidden iframe generated by DFP The player will position at the place of the iframe in the parent window
adLabel			Object	If defined, it will appear above the player e.g. {"text":"Advertisment"}
pricegranularity			“high” ”medium” ”low” or a number	high (0.01): $0.01 jumps medium (0.1): $0.1 low (1): $1 Or can be a number. for example, 0.2 means 0,0, 0.2, 0.4, etc $0.2 jumps
pricegranularitymax			Number	max $ value. Higher number will translate to this value
pricegranularitydecimals			Number	Number of decimals after the . Undefined is auto - based on granularity
Player types
InArticle/InFeed				The player opens up only when there is an ad impression and takes the place in the page to display the ad. When it finish usually it collapse Use with a combination of playOnView and other flags
Floating			Object	A floating player has a position in the page body and when out of view it floats to a fixed position over the page is its always viewable A floating player can start as InArticle/InFeed and float when the position is out of view
size			Number 0-1	The size of the floating player will be the size of the original player x size
right			Number	Create a margin of the defined number from the right side of the window
bottom			Number	Create a margin of the defined number from the bottom of the window
customCss			String	Used to define custom CSS that will be implemented in <style></style>. Note it is appended to all existing CSS
floatingCss			String	Used to define custom place for the floating player, for example use the below for a bottom-left floating half the size of the original player. Note it overwrites/replaces the floating’s original CSS. For example: `'z-index:10000001;position:fixed; bottom:5px; left:5px; -webkit-transform:scale(0.5); -webkit-transform-origin:bottom left; transform:scale(0.5); transform-origin:bottom left'`
floatOnBottom			Boolean	By default the floating player only appears when scrolling down, If true, will float whenever the player is out of view
closeButton			Boolean	If true, show a close button that will unfloat the player to its original position
Sticky			Object	A sticky player is always sticking i a fixed position on the screen, typically in one of the screen corners
size			Number	The size of the sticky player will be the size of the original placement x size Set to 1 for easy configuration
position			String	Defines the position of the sticky player. Can be one of: Bottom-Right Bottom-Left Top-Right Top-Left
right			Number	Create a margin of the defined number from the right side of the window	left	Number	Create a margin of the defined number from the left side of the window	top	Number	Create a margin of the defined number from the top side of the window	bottom	Number	Create a margin of the defined number from the bottom side of the window

...

of the defined number from the right side of the window
left	Number	Create a margin of the defined number from the left side of the window
top	Number	Create a margin of the defined number from the top side of the window
bottom	Number	Create a margin of the defined number from the bottom side of the window

User Id Modules

User id modules are addon modules, most available as part of prebid, that provide addition user id info to bidders. it is possible to setup those providers on the manage.aniview.com settings or in adConfig.

user id modules configuration is under adConfig.uidproviders.idName = { Prebid configuration params }

Aniview is using the default storge configuration for each module

The params can be used as below but can also include additional info such as hashed email if available, please contact the id provider rep for more info

Module

adConfig parameters

ID5

"id5Id": {
"partner": "id provided"
}

pub common

"pubCommonId": {
"enabled": "1"
},

Hardon

"hadronId": {
"partnerId": "id provided"
},

33Across

"33Across": {
"pid": "id provided"
},

Identity link

"identityLink": {
"pid": "id provided"
},

Criteo id

"criteoId": {
"enabled": "1"
},

Unified id

"unifiedId": {
"partner": "id provided"
},

Panorama id

"panoramaId": {
"clientId": "id provided"
},

UID2

Contact tradedesk for info

Requires hashed id

Live Intent

Contact id provider

Requires hashed id

connectId

Contact id provider

Requires hashed id

Intent Iq

Code Block
avintentiq: { partner: id provided, all: true, } ,

Example configuration:

Code Block

uidproviders: {
    "33acrossId": {
      pid: "-----"
    },
    "connectId": {
      pixelId: "-----",
      he: "ed8ddbf5a171981db8ef938596ca297d5e3f84bcc280041c5880dba3baf9c1d4"
    },
    avintentiq: {
      partner: -----,
      all: true,
    } ,
    liveintent: {
      emailHash: "c75def97eed250d1698487fc0a4d8c9675b6d62246cd1dc7a60f71b0c6441b22",
      requestedAttributesOverrides: {
        uid2: true,
        bidswitch: true,
        medianet: true,
        magnite: true,
        pubmatic: true,
        index: true,
        openx: true,
      }
    } 
}

Prebid ortb info

OpenRTB site info can be set in

adConfig.openrtb.site = {

…ortb site info…

}

In any case, the player will automatically pass the page and domain

OpenRTB content info is automatically taken from the content player config.content.contents[] array

OpenRTB content and ext can be set in this object

Some ssps and content providers support IrisTV. For support using Aniview CMS please contact your account rep

Iris data can be set in:

config.content.contents[0].irisId

config.content.contents[0].irisContext

Versions Compared

Old Version 44

New Version Current

Key

Template Position Wrapper

Starting Template

Player Templates

Templates Configuration

Template Position Wrapper

Starting Template

Templates Configuration

User Id Modules

Prebid ortb info

Related articles