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 | Supply Tag Query Parameter | Support Targeting | Auto | Detection Method | oRTB | Reportable | Player configuration Parameter | Description |
---|---|---|---|---|---|---|---|---|
[AV_PUBLISHERID] [AV_PUBLISHER_ID] | AV_PUBLISHERID= |
|
|
| n/a | Yes
| publisherId or AV_PUBLISHERID in vast | Aniview publisher id |
[AV_CHANNELID] [AV_CHANNEL_ID] | AV_CHANNELID= |
|
|
| n/a | Yes
| channelId or AV_CHANNELID in vast | Aniview channel id |
[AV_URL] | AV_URL= | Yes (Domain) | Player, VPAID |
|
| 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 |
| Yes
| 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 |
| Yes
|
| The full host name For example, for https://www.cnn.com/news it is www.cnn.com |
[AV_WIDTH] | AV_WIDTH= | Yes | Player, VPAID |
|
| Yes | width or AV_WIDTH in vast mode | The player width |
[AV_HEIGHT] | AV_HEIGHT= | Yes | Player, VPAID |
|
| Yes
| height or AV_HEIGHT in vast mode | The player height |
[AV_USERAGENT] | AV_USERAGENT= |
| Yes |
|
| No | AV_USERAGENT | Browser user agent |
[AV_IP] | AV_IP= |
| Yes |
|
| no |
| Device ip address |
[AV_COUNTRY] | AV_COUNTRY= | Yes | Yes |
|
| Yes
|
| Device country |
[AV_REGION] | AV_REGION= | Yes | Yes |
|
| Yes
|
| Region code |
[AV_BROWSER] | AV_BROWSER= |
| Yes |
|
| Yes
|
| Browser name |
[AV_RANDOM] |
|
| Yes |
| n/a | No |
| Random number generated on the server |
[AVC_RANDOM] |
|
| Yes |
| n/a | No |
| Random number generated on the client side |
[AV_TIMESTAMP] |
|
| Yes |
| n/a | No |
| Unique timestamp generated on the server |
[AV_OS] | AV_OS | Yes | Yes |
|
| Yes
|
| Device operating system |
[AV_OSVERS] | AV_OSVERS |
| Yes |
|
| Yes
|
| Device operating system version |
AV_DNT |
|
| No |
|
| No | AV_DNT | Do not track flag |
AV_DTRACK |
|
| No |
|
| No | AV_DTRACK | Do track flag |
AV_PLACEMENT |
|
| Partially |
|
| Yes
| AV_PLACEMENT | Player 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_CATEGORY |
|
| No |
|
| Yes
| AV_CATEGORY | Web site IAB category |
AV_CARRIER |
|
| Yes |
|
| No |
| Network carrier name |
AV_CONNECTIONTYPE |
|
| Yes |
|
| No |
| Device connection type eg wifi, cell, etc… |
AV_APPNAME |
|
| Yes |
|
| Yes
| AV_APPNAME | Inapp app name Can be autodetected |
AV_APPPKGNAME |
| yes | No |
|
| Yes
| AV_APPPKGNAME | App bundle/package name. Must be provided in inapp (e.g. iOS 591560124, Android: com.pic.photoeditor) |
AV_APPSTOREURL |
|
| Yes |
|
| No | AV_APPSTOREURL | App store url |
AV_IDFA, AV_AID |
| Yes | No |
|
| No | AV_IDFA, AV_AID | Device idfa or android id, must be provided in inapp |
AV_IDFAMD5, AV_AIDMD5 |
|
| No |
|
| No | AV_IDFAMD5, AV_AIDMD5 | MD5 encoded Idfa. Recommended to pass in inapp |
AV_IDFASHA1, AV_AIDSHA1 |
|
| No |
|
| No | AV_IDFASHA1, AV_AIDSHA1 | Sha1 encoded Idfa, Recommended to pass in inapp |
AV_IFA_TYPE |
|
| Yes |
|
| No | AV_IFA_TYPE |
|
AV_MODEL |
|
| Yes |
|
| Yes
| AV_MODEL | Device model |
AV_MAKE |
|
| No |
|
| Yes
| AV_MAKE | Device maker |
AV_APPVERS |
|
| No |
|
| No | AV_APPVERS | inapp app version |
AV_LATITUDE |
|
| Yes (IP based) |
|
| Yes
| AV_LATITUDE | Latitude |
AV_LONGITUDE |
|
| Yes (IP based) |
|
| Yes
| AV_LONGITUDE | Longitude |
AV_VIDEOID |
|
| No |
| n/a | Yes
| AV_VIDEOID | Content video id |
AV_VIDEOURL |
|
| No |
| n/a | No | AV_VIDEOURL | Content video url |
AV_DESCRIPTION |
|
| No |
| n/a | No | AV_DESCRIPTION | Content description |
AV_DURATION |
|
| Yes - with aniview content player |
| n/a | Yes
| AV_DURATION | Content duration |
AV_KEYWORDS |
|
| No |
|
| No | AV_KEYWORDS | Content/Page keywords |
AV_LANGUAGE |
|
| Yes |
|
| No | AV_LANGUAGE | 2 lowercase letter language code For example, en |
AV_TITLE |
|
| No |
| n/a | No | AV_TITLE | Content title |
AV_GPP |
|
| Yes |
|
| No | AV_GPP | Sting of IAB Global Privacy Platform |
AV_GPP_SID |
|
| Yes |
|
| No | AV_GPP_SID | The actual used section of the GPP string |
AV_SUBID |
|
| No |
|
| Yes
| 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 that can be used in Core Settings | Report Custom Metrics |
AV_CUSTOM1-AV_CUSTOM16 or AVC_CUSTOM1-16 |
|
| No |
| n/a | Yes
|
| 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
|
| 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 |
|
| No | AV_GDPR | 1 if gdpr applies, 0 if not |
AV_CONSENT |
|
| Yes |
|
| Yes
| AV_CONSENT | Consent string as detected using IAB CMP api if implemented on the publisher page |
AV_CCPA |
|
| Yes |
|
| Yes
| AV_CCPA | Use privacy |
AV_SCHAIN |
|
|
|
| oRTB <(below) 2.5 oRTB =(equal) 2.5 oRTB >(above) 2.5 | 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 |
|
| 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 |
|
| No |
| The protocol that the page was load in. http/https |
AV_CPM |
|
| Yes |
|
| Yes |
| CPM as configured in the ad source |
AVC_CPM |
|
| Yes |
| n/a | 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 in the format yyy-mm-dd |
AVC_TIME |
|
| Yes |
| n/a | Yes
|
| Time in the format hh-mm-ss |
AV_CHANNEL_NAME |
|
| Yes |
| n/a | Yes
|
| The channel name |
AV_ADSOURCE_ID |
|
| Yes |
| n/a | Yes
|
| The AdSource ID |
AV_ADSOURCE_NAME |
|
| Yes |
| n/a | Yes
|
| The AdSource Name |
AV_PUB_CON_ID |
|
| Yes |
| n/a | Yes
|
| The Publisher/Partner INSTANCE ID where the traffic came from |
AV_CON_ID |
|
| Yes |
| n/a | Yes
|
| Publisher/Partner CONNECTION ID |
AV_ADVERTISER_ID |
|
| Yes, Need to Be configured on the server or sent in ref1 |
| n/a | Yes
| , | Advertiser ID |
AV_APPSITE_ID |
|
| Yes, Need to Be configured on the server or sent in ref1 |
|
| Yes
|
| The channel AppSite ID |
AV_APPSITE_NAME |
|
| Yes, Need to Be configured on the server or sent in ref1 |
|
| Yes
|
| The channel AppSite Name |
AV_IDFV |
|
| No |
|
| No | AV_IDFV | Identifier of the device in that publisher for the Vendor |
AV_ATTS |
|
| No |
|
| 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 |
AVC_GTARGETING |
|
|
|
| n/a | No |
| Is used to pass Google targeting params (if exist) to the Aniview platform |
AV_CONTENT_URL |
|
| No |
|
| No | AV_CONTENT_URL | URL of the content, for buy-side contextualization or review |
AV_CONTENT_TITLE |
|
| No |
|
| 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). |
AV_CONTENT_EPISODE |
|
| No |
|
| No | AV_CONTENT_EPISODE | Episode number. |
AV_CONTENT_SERIES |
|
| No |
|
| 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 |
|
| No |
|
| No | AV_CONTENT_SEASON | Content season (e.g., “Season 3”). |
AV_CONTENT_CAT |
|
| No |
|
| Yes
| 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. |
AV_CONTENT_KEYWORDS |
|
| No |
|
| No | AV_CONTENT_KEYWORDS | Comma separated list of keywords describing the content. |
AV_CONTENT_NETWORK |
|
| No |
|
| No | AV_CONTENT_NETWORK | network object Details about the network (Section 3.2.23) the content is on. |
AV_CONTENT_ID |
|
| No |
|
| Yes
| AV_CONTENT_ID | ID uniquely identifying the content |
AV_CONTENT_CHANNEL |
|
| No |
|
| No | AV_CONTENT_CHANNEL | Channel object Details about the Channel (Section 3.2.23) the content is on. |
AV_CONTENT_CONTEXT |
|
| No |
|
| No | AV_CONTENT_CONTEXT | Type of content (game, video, text, etc.). Refer to List: Content Contexts in AdCOM 1.0. |
AV_CONTENT_GENRE
|
|
| No |
|
| No | AV_CONTENT_GENRE | Genre that best describes the content (e.g., rock, pop, etc). |
AV_CONTENT_LENGTH |
|
| No |
|
| No | AV_CONTENT_LENGTH | Length of content in seconds; appropriate for video or audio. |
AV_CONTENT_LANGUAGE |
|
| No |
|
| No | AV_CONTENT_LANGUAGE | Content language using ISO-639-1-alpha-2. |
AV_CONTENT_RATING |
|
| No |
|
| No | AV_CONTENT_RATING | Content rating (e.g., MPAA). |
AV_METRO_CODE |
|
| Yes |
|
| Yes | AV_METRO_CODE | DMA code |
[AV_NONCE] | AV_NONCE |
| No |
|
| No | AV_NONCE | NONCE ID from the PAL SDK |