/
Macros

Macros

This article lists the available macros in the system.

If a macro is auto detected, it is resolved automatically.

Values sent from the player override detected values.

If using VAST/VPAID, macros can be passed as is in the VPAID link.

Macros can be used in vast url, templates and 3rd party trackers. format of a macro is [MACRO_NAME] (macro name inside [])

Example: [AV_WIDTH]

Players

When using a player, most macros are passed in ref1

Macros are passed in ref1 like that:

ref1: β€œAV_CUSTOM1=abc&AV_IDFA=1234-5678β€œ

Macro list

Macro Name
Demand

Supply Tag Query Parameter

Support Targeting

Auto
Detected Integration

Detection Method

oRTB

Reportable

Player configuration Parameter

Description

GAM MACRO

Macro Name
Demand

Supply Tag Query Parameter

Support Targeting

Auto
Detected Integration

Detection Method

oRTB

Reportable

Player configuration Parameter

Description

GAM MACRO

[AV_PUBLISHERID]

[AV_PUBLISHER_ID]

AV_PUBLISHERID=

Β 

Β 

Β 

n/a

Yes

Network/Publisher

publisherId or AV_PUBLISHERID in vast

Aniview publisher id

Β 

[AV_CHANNELID]

[AV_CHANNEL_ID]

AV_CHANNELID=

Β 

Β 

Β 

n/a

Yes

Channel Name

channelId or AV_CHANNELID in vast

Aniview channel id

Β 

[AV_WIDTH]

AV_WIDTH=

Yes

Player, VPAID

Β 

imp.video.w

Yes
Player Size

width or AV_WIDTH in vast mode

The player width

Β 

[AV_HEIGHT]

AV_HEIGHT=

Yes

Player, VPAID

Β 

imp.video.h

Yes

Player Size

height or AV_HEIGHT in vast mode

The player height

Β 

[AV_URL]

AV_URL=

Yes (Domain)

Player, VPAID

Β 

site.page

No

ref1

Automatically detected page url where the player is running.

Β 

[AV_DOMAIN]

AV_DOMAIN=

Yes (Domain)

Player, VPAID

Resolved from AV_URL, can be sent as parameter

site.domain
or
app.domain

Yes

Domain

r

Automatically detected root domain name

For example, for https://www.cnn.com/news it is cnn.com

Β 

[AV_HOST]

AV_HOST=

Β 

Player, VPAID

Resolved from AV_URL, can be sent as parameter

site.domain
or
app.domain

Yes

Domain

Β 

The full host name

For example, for https://www.cnn.com/news it is www.cnn.com

Β 

[AV_CATEGORY]

AV_CATEGORY=

Β 

No

Β 

site.cat
or
app.cat

Yes

IAB Category

AV_CATEGORY

Web site IAB category

Β 

[AV_RANDOM]

Β 

Β 

Yes

Β 

n/a

No

Β 

Random number generated on the server. Use AVC_RANDOM for player

Β 

[AV_TIMESTAMP]

Β 

Β 

Yes

Β 

n/a

No

Β 

Unique timestamp generated on the server

Β 

[AV_RTB_DEVICE_TYPE]

AV_RTB_DEVICE_TYPE=

Β 

Yes

Β 

device.devicetype

No

Β 

oRTB Device type

Β 

[AV_USERAGENT]

AV_USERAGENT=

Β 

Yes

UA

device.ua

No

AV_USERAGENT

Browser user agent

Β 

[AV_IP]

AV_IP=

Β 

Yes

Header

device.ip

no

Β 

Device ip address

Β 

[AV_COUNTRY]

AV_COUNTRY=

Yes

Yes

UA

device.geo.country

Yes

Country

Β 

Device country

Β 

[AV_REGION]

AV_REGION=

Yes

Yes

IP

device.geo.region

Yes

Region

Β 

Region code

Β 

[AV_BROWSER]

AV_BROWSER=

Β 

Yes

UA

device.sua.browsers.brand

Yes

Browser Name

Β 

Browser name

Β 

[AV_OS]

AV_OS

Yes

Yes

UA

device.os

Yes

OS

Β 

Device operating system

Β 

[AV_OSVERS]

AV_OSVERS

Β 

Yes

UA

device.osv

Yes

OS Version

Β 

Device operating system version

Β 

[AV_DNT]

Β 

Β 

No

Β 

device.dnt

No

AV_DNT

Do not track flag

Β 

[AV_PLCMT]

Β 

Β 

Partially

When using Aniview Player/SDK it is being detected automatically

imp.video.plcmt

Β 

AV_PLCMT

Video placement according to RTB definition. If known, it is recommended to pass it in ref1/vpaid url

In-Stream: 1

Accompanying Content: 2

Interstitial: 3

No Content/Standalone: 4

Β 

[AV_PLACEMENT]

Β 

Β 

Partially

Β 

imp.video.placement

Yes

Placement Type

AV_PLACEMENT

(IAB DEPRECATED it in OpenRTB 2.6)
Video placement according to RTB definition. If known, it is recommended to pass it in ref1/vpaid url

In-Stream: 1

In-Banner: 2

In-Article: 3

In-Feed: 4

Interstitial/Slider/Floating: 5

Β 

[AV_CARRIER]

AV_CARRIER=

Β 

Yes

Β 

device.carrier

No

Β 

Network carrier name

Β 

[AV_CONNECTIONTYPE]

AV_CONNECTIONTYPE=

Β 

Yes

Β 

device.connectiontype

No

Β 

Device connection type eg wifi, cell, etc…

Β 

[AV_IDFA], [AV_AID]

Β 

Yes

No

Β 

device.ifa

No

AV_IDFA, AV_AID

Device idfa or android id, must be provided in inapp

%%ADVERTISING_IDENTIFIER_PLAIN%%

[AV_IDFAMD5], [AV_AIDMD5]

Β 

Β 

No

Β 

device.didmd5

No

AV_IDFAMD5, AV_AIDMD5

MD5 encoded Idfa. Recommended to pass in inapp

Β 

[AV_IDFASHA1], [AV_AIDSHA1]

Β 

Β 

No

Β 

device.didsha1

No

AV_IDFASHA1, AV_AIDSHA1

Sha1 encoded Idfa, Recommended to pass in inapp

Β 

[AV_IFA_TYPE]

Β 

Β 

Yes

Β 

device.ext.ifa_type

No

AV_IFA_TYPE

aaid: Android TV
rida: Roku
afai: Amazon Fire
idfa: Apple tvOS
msai: Xbox/Microsoft

aaid (Android ID)

idfa (Apple ID)

%%ADVERTISING_IDENTIFIER_TYPE%%

[AV_MODEL]

Β 

Β 

Yes

Β 

device.model

Yes

Device Model

AV_MODEL

Device model

Β 

[AV_MAKE]

Β 

Β 

No

Β 

device.make

Yes

Device Brand

AV_MAKE

Device maker

Β 

[AV_LATITUDE]

Β 

Β 

Yes (IP based)

Β 

device.geo.lat

Yes

Latitude

AV_LATITUDE

Latitude

Β 

[AV_LONGITUDE]

Β 

Β 

Yes (IP based)

Β 

device.geo.lon

Yes

Longitude

AV_LONGITUDE

Longitude

Β 

[AV_APPNAME]

AV_APPNAME=

Β 

Yes

Β 

app.name

Yes

App Name

AV_APPNAME

Inapp app name

Can be autodetected

Β 

[AV_APPPKGNAME]

AV_APPPKGNAME=

yes

No

Β 

Β 

app.bundle

Yes

Domain

AV_APPPKGNAME

App bundle/package name. Must be provided in inapp (e.g. iOS 591560124,Β Android: com.pic.photoeditor)

Β 

[AV_APPSTOREURL]

AV_APPSTOREURL=

Β 

Yes

Β 

app.storeurl

No

AV_APPSTOREURL

App store url

Β 

[AV_APPVERS]

Β 

Β 

No

Β 

app.ver

No

AV_APPVERS

inapp app version

Β 

AV_VIDEOID

deprecated please use AV_CONTENT_ID

Β 

Β 

No

Β 

n/a

Yes

Video ID

Β 

AV_VIDEOID

Content video id

%%VIDEO_ID%%

AV_VIDEOURL

deprecated - please use AV_CONTENT_URL

Β 

Β 

No

Β 

n/a

No

AV_VIDEOURL

Content video url

Β 

AV_DESCRIPTION

Β 

Β 

No

Β 

n/a

No

AV_DESCRIPTION

Content description

Β 

AV_DURATION

deprecated - please use AV_CONTENT_LENGTH

Β 

Β 

Yes - with aniview content player

Β 

n/a

Yes

Duration

AV_DURATION

Content duration

%%VIDEO_DURATION%%

AV_KEYWORDS

Β 

Β 

No

Β 

site.keywords or app.keywords

No

AV_KEYWORDS

Content/Page keywords

Β 

AV_LANGUAGE

Β 

Β 

Yes

Β 

app.content.language or site.content.language

No

AV_LANGUAGE

2 lowercase letter language code

For example, en

Β 

AV_TITLE

deprecated - please use AV_CONTENT_TITLE

Β 

Β 

No

Β 

n/a

No

AV_TITLE

Content title

%%VIDEO_TITLE%%

AV_GPP

Β 

Β 

Yes

Β 

regs.ext.gpp

No

AV_GPP

Sting of IAB Global Privacy Platform

Β 

AV_GPP_SID

Β 

Β 

Yes

Β 

regs.ext.gpp_sid

No

AV_GPP_SID

The actual used section of the GPP string

Β 

AV_SUBID

Β 

Β 

No

Β 

ext.sub

Yes

Sub ID

AV_SUBID

Custom subid

Β 

AV_CDIM1

Β 

Β 

No

Β 

n/a

Yes

AV_CDIM1

Custom dimension that appears in Ad Server Reporting: Metrics and Dimensions under Custom 1

Β 

AV_CDIM2

Β 

Β 

No

Β 

n/a

Yes

AV_CDIM2

Custom dimension that appears in Ad Server Reporting: Metrics and Dimensions under Custom 2

Β 

AV_CDIM3

Β 

Β 

No

Β 

n/a

Yes

AV_CDIM3

Custom dimension that appears in Ad Server Reporting: Metrics and Dimensions under Custom 3

Β 

AV_M10-AV_M20

Β 

Β 

No

Β 

n/a

Yes

Custom Metrics

Β 

Custom metrics that can be used in Core Settings | Report Custom Metrics

Β 

AV_CUSTOM1-AV_CUSTOM16

or

AVC_CUSTOM1-16

Β 

Β 

No

Β 

n/a

Yes

Customs

Β 

Custom dimensions that don’t appear in reporting, but can be passed into Ad Sources at runtime.

They can also be used in Core Settings | Custom Params(it’s just optional - see notes there).

Β 

AV_CUSTOM17-AV_CUSTOM21

Β 

Β 

No

Β 

n/a

Yes

Customs

Β 

Custom parameters that can be used with replacements

Β 

AVC_INVIEW

Β 

Β 

Yes

Β 

n/a

No

Β 

Auto detected - 1 if player is in view, 0 if not

Apply to vast url only

Β 

AVC_INVIEWPERC

Β 

Yes

in player settings

Yes

Β 

n/a

No

Β 

Viewability percentage of the player

Apply to vast url only and requires the use of AVC_INVIEW

Β 

AV_GDPR

Β 

Β 

Yes

Β 

regs.ext.gdpr

No

AV_GDPR

1 if gdpr applies, 0 if not

Β 

AV_CONSENT

Β 

Β 

Yes

Β 

user.ext.consent

Yes

Request No Consent

Bid No Consent

Impression No Consent

AV_CONSENT

Consent string as detected using IAB CMP api if implemented on the publisher page

In Google IMA - [GDPRCONSENT]

In GAM as Vast - ${GDPR_CONSENT_780}
780 = TCF Vendor of Aniview

AV_CCPA

Β 

Β 

Yes

Β 

regs.ext.us_privacy

Yes

Request CCPA

Bid CCPA

Impression CCPA

AV_CCPA

Use privacy
Typically use &us_privacy=[AV_CCPA]

Β 

AV_SCHAIN

Β 

Β 

Β 

Β 

oRTB <(below) 2.5 ext.schain

oRTB =(equal) 2.5 source.ext.schain

oRTB >(above) 2.5 source.schain

No

AV_SCHAIN

AV_SCHAIN can be configured in the platform or passed as schain string format in ref1

The system will set AV_SCHAIN as needed: Object in prebid/rtb or string in vast

If this is not the first chain, it must be passed in ref1/vast call and aniview will add the defined chain to the existing one

Β 

AV_LSELLER_ID

Β 

Β 

Need to Be configured or sent in ref1

Β 

source.ext.schain.nodes.sid

No

AV_LSELLER_ID

Some platforms such as AOL requires passing only the seller id, for example in AOL &scpid=[AV_LSELLER_ID]

Β 

AV_SECURED

Β 

Yes

Yes

Β 

imp.secure

No

Β 

The protocol that the page was load in. http/https

Β 

AV_CPM

Β 

Β 

Yes

Β 

bidprice

Yes

Β 

CPM as configured in the ad source

Β 

AVC_CPM

Β 

Β 

Yes

Used in client side integration with player/sdk

cpm

Yes

Β 

If prebid or rtb, the actual CPM of the impression, otherwise the cpm defined on the ad source

Β 

AV_ECPM

Β 

Β 

Yes

Β 

n/a

Yes

Β 

AdSource configured cpm / 1000

Β 

AV_HASH_CPM

Β 

Β 

Yes

Β 

n/a

No

Β 

The adsource configured CPM in hashed format

Β 

AV_REV_CPM

Β 

Β 

Yes

Β 

n/a

Β 

Β 

The configured AdSource CPM divided by the channel RevShare that is set(if set)

In channel configuration panel:

Β 

AVC_DATE

Β 

Β 

Yes

Β 

n/a

Yes

Date

Β 

Date in the format yyy-mm-dd

Β 

AVC_TIME

Β 

Β 

Yes

Β 

n/a

Yes

Hour

Β 

Time in the format hh-mm-ss

Β 

AV_CHANNEL_NAME

Β 

Β 

Yes

Β 

n/a

Yes

Channel Name

Β 

The channel name

Β 

AV_ADSOURCE_ID

Β 

Β 

Yes

Β 

n/a

Yes

Ad Source ID

Β 

The AdSource ID

Β 

AV_ADSOURCE_NAME

Β 

Β 

Yes

Β 

n/a

Yes

Ad Source Name

Β 

The AdSource Name

Β 

AV_PUB_CON_ID

Β 

Β 

Yes

Β 

n/a

Yes

Publisher Connection ID

Β 

The Publisher/Partner INSTANCE ID where the traffic came from

Β 

AV_CON_ID

Β 

Β 

Yes

Β 

n/a

Yes

Publisher Connection ID

Β 

Publisher/Partner CONNECTION ID

Β 

AV_ADVERTISER_ID

Β 

Β 

Yes, Need to Be configured on the server or sent in ref1

Β 

n/a

Yes

Advertiser ID

,

Advertiser ID

Β 

AV_APPSITE_ID

Β 

Β 

Yes, Need to Be configured on the server or sent in ref1

Β 

site.id or app.id

Yes

App/Site ID

Β 

The channel AppSite ID

Β 

AV_APPSITE_NAME

Β 

Β 

Yes, Need to Be configured on the server or sent in ref1

Β 

site.name or app.name

Yes

App/Site

Β 

The channel AppSite Name

Β 

AV_IDFV

Β 

Β 

No

Β 

device.ext.ifv
device.ext.idfv

No

AV_IDFV

Identifier of the device in that publisher for the Vendor

Β 

AV_ATTS

Β 

Β 

No

Β 

device.ext.atts

No

AV_ATTS

App Tracking Authorization Status - An integer passed to represent the App’s App Tracking Authorization Status. The possible values are:

0= Not Determined
1= Restricted
2= Denied
3= Authorized

Β 

[AVC_GTARGETING]

Β 

Β 

Β 

Β 

n/a

No

Β 

Is used to pass Google targeting params (if exist) to the Aniview platform

Β 

[AV_CONTENT_URL]

AV_CONTENT_URL=

Β 

No

Β 

app.content.url or site.content.url

No

AV_CONTENT_URLΒ 

URL of the content, for buy-side contextualization or review

Β 

[AV_CONTENT_%%ADVERTISING_IDENTIFIER_PLAIN%% %%ADVERTISING_IDENTIFIER_TYPE%%TITLE]

AV_CONTENT_TITLE=

Β 

No

Β 

app.content.title or site.content.title

No

AV_CONTENT_TITLEΒ 

Video Examples: β€œSearch Committee” (television), β€œA New Hope” (movie), or β€œEndgame” (made for web). Non-Video Example: β€œWhy an Antarctic Glacier Is Melting So Quickly” (Time magazine article).

%%VIDEO_TITLE%%

[AV_CONTENT_EPISODE]

AV_CONTENT_EPISODE=

Β 

No

Β 

app.content.episode or site.content.episode

No

AV_CONTENT_EPISODEΒ 

Episode number.

Β 

[AV_CONTENT_SERIES]

AV_CONTENT_SERIES=

Β 

No

Β 

app.content.series or site.content.series

No

AV_CONTENT_SERIESΒ 

Content series. Video Examples: β€œThe Office” (television), β€œStar Wars” (movie), or β€œArby β€˜N’ The Chief” (made for web). Non-Video Example: β€œEcocentric” (Time Magazine blog).

Β 

[AV_CONTENT_SEASON]

AV_CONTENT_SEASON=

Β 

No

Β 

app.content.season or site.content.season

No

AV_CONTENT_SEASONΒ 

Content season (e.g., β€œSeason 3”).

Β 

[AV_CONTENT_CATΒ ]

AV_CONTENT_CAT

Β 

No

Β 

app.content.cat or site.content.cat

Yes

IAB category

AV_CONTENT_CATΒ 

Array of IAB content categories that describe the content. The taxonomy to be used is defined by the cattax field. If no cattax field is supplied IAB Content Category Taxonomy 1.0 is assumed.

Should be passed as comma separated

Β 

[AV_CONTENT_KEYWORDS]Β 

AV_CONTENT_KEYWORDS=

Β 

No

Β 

app.content.keywords or site.content.keywords

No

AV_CONTENT_KEYWORDSΒ 

Comma separated list of keywords describing the content.

Β 

[AV_CONTENT_NETWORK]Β 

AV_CONTENT_NETWORK=

Β 

No

Β 

app.content.network or site.content.network

No

AV_CONTENT_NETWORKΒ 

network object Details about the network (Section 3.2.23) the content is on.
Refers to oRTB spec list 3.2.23

Β 

[AV_CONTENT_ID]Β 

AV_CONTENT_ID=

Β 

No

Β 

app.content.id or site.content.id

Yes

Video ID

Playlist ID

Video carousel ID

Feed ID

Β 

Β 

AV_CONTENT_IDΒ 

ID uniquely identifying the content

%%VIDEO_ID%%

[AV_CONTENT_CHANNEL]

AV_CONTENT_CHANNEL=

Β 

No

Β 

app.content.channel or site.content.channel

No

AV_CONTENT_CHANNELΒ 

Channel object Details about the Channel (Section 3.2.23) the content is on.
Refers to oRTB spec list 3.2.24

Β 

[AV_CONTENT_CONTEXT]

AV_CONTENT_CONTEXT=

Β 

No

Β 

app.content.context or site.content.context

No

AV_CONTENT_CONTEXTΒ 

Type of content (game, video, text, etc.). Refer to List: Content Contexts in AdCOM 1.0.

Β 

[AV_CONTENT_GENRE]

AV_CONTENT_GENRE=

Β 

No

Β 

app.content.genre or site.content.genre

No

AV_CONTENT_GENRE

Genre that best describes the content (e.g., rock, pop, etc).

Β 

[AV_CONTENT_LENGTH]

AV_CONTENT_LENGTH=

Β 

No

Β 

app.content.len or site.content.len

No

AV_CONTENT_LENGTHΒ 

Length of content in seconds; appropriate for video or audio.

%%VIDEO_DURATION%%

[AV_CONTENT_LANGUAGE]

AV_CONTENT_LANGUAGE=

Β 

No

Β 

pp.content.language or site.content.language

No

AV_CONTENT_LANGUAGEΒ 

Content language using ISO-639-1-alpha-2.

Β 

[AV_CONTENT_RATING]

AV_CONTENT_RATING=

Β 

No

Β 

pp.content.contentrating or site.content.contentrating

No

AV_CONTENT_RATINGΒ 

Content rating (e.g., MPAA).

Β 

[AV_METRO_CODE]

AV_METRO_CODE=

Β 

Yes

Β 

device.metro

Yes

AV_METRO_CODE

DMA code

Β 

[AV_NONCE]

AV_NONCE=

Β 

No

Β 

Β 

No

AV_NONCE

NONCE ID from the PAL SDK

Β 

[AV_POD_DURATION]

AV_POD_DURATION=

Β 

No

Β 

Β 

Yes with SSAI

Β 

The requested POD Duration

Β 

[AV_S_USER_ID]

-

Β 

Yes

Cookie / IDFA / IFA / AID / App advertising system

Β 

Internal

Β 

The resolved user ID.
In Web it is from the cookies or generated Aniview User ID.
In Apps/CTV it is the IFA.

In App -%%ADVERTISING_IDENTIFIER_PLAIN%%

Β 

Β 

Β 

Β 

Β 

Β 

Β 

Β 

Β 

Β 

Related articles

Related content

Macros with REPLACEMENTS.
Macros with REPLACEMENTS.
More like this
Guide
Guide
Read with this
VPAID Implementation Guide
VPAID Implementation Guide
More like this
Ad Server Reporting: Metrics and Dimensions
Ad Server Reporting: Metrics and Dimensions
Read with this
Aniview Prebid Adapter
Aniview Prebid Adapter
More like this
Server Side Ad Insertion (SSAI)
Server Side Ad Insertion (SSAI)
Read with this