Creatives
Creative billing

Adding macros to the landing page URL or tracking pixel URL of creative allows passing on the information (e.g. country or page of the request) as a value of a macro.

You can find the list of available macros in the table below.

Using Macros

  1. Replace the advertiser’s placeholders with the corresponding macros in the Landing Page URL or Tracking Pixel URL
  2. Paste the updated URL into the Landing page field on the video creative page or into the corresponding field in Event tracking settings of the video creative.

User Data

Macros Description
[IP] User IP address
[DNT] Do not track
[YOB] Year of birth
[GENDER] User gender 
[GDPR] Indicates whether or not the GDPR (General Data Protection Regulation) applies to the ad request
[CONSENT] A consent string passed from various Consent Management Platforms (CMPs)
[PUBUID] Unique user ID for reuse in the 1st-party DMP
[VISITORKEY] or
[AM-UID]
Unique user ID or Cookie ID
[WS64VISTORKEY] Unique user ID or Cookie ID encoded in Base64

Geo Data

Macros Description
[GEOLOCATION] Geolocation of the user (country)
[LATITUDE] Device latitude. Along with longitude, it defines device location
[LONGITUDE] Device longitude. Along with latitude, it defines device location
[LOCATION] Location (latitude, longitude) of the device
[ACCURACY] Estimated latitude/longitude accuracy in meters
[COUNTRY] User country

Site Data

Macros Description
[PAGE] URL-encoded page
[FULL_PAGE_ESC] Full URL, protocol incl., encoded
[USERAGENT] URL-encoded User-Agent
[IAB_CATEGORY] Comma-separated array of IAB content categories for the application
[PROTOCOL] http or https protocol
[DOMAIN] 2nd-level domain + TLD
[REFERER] URL of the page where the impression occurs

Application Data

Macros Description
[APP_NAME], [APP_ID] Application name
[BUNDLE] Application ID
[APP_VER] Application version
[APP_STORE_ID] Platform-specific app store ID
[STOREURL] App store URL

Device Data

Macros Description
[DEVICE_W] Width of the screen in pixels
[DEVICE_H] Height of the screen in pixels
[IFA] Unique value that is completely disconnected from a hardware ID, MAC address, IMEI, or IP address
[DEVICEID] 32 hexadecimal digit string value, displayed in five groups and separated by hyphens, in the form of 8-4-4-4-12, for a total of 36 characters
[DEVICE_MAKE] Device manufacturer
[DEVICE_MODEL] Device model 
[DEVICE_OS] Device OS 
[DEVICE_OSV] Device OS version
[ISP] Internet provider (the same as Carrier by openRTB)
[CONNECTION] Type of user connection: 1 – Ethernet, 2 – WIFI, 3 – Unknown cellular, 4 – 2G, 5 – 3G, 6 – 4G

Video Ad Data

Macros Description
[VAST_PROTOCOLS] Supported VAST protocols according to IAB protocols
[PLAYER_WIDTH] Width of the video player in DIPS
[PLAYER_HEIGHT] Height of the video player in DIPS
[MUTED] Integer
[VIDEO_AUTOPLAY] Integer
[MINDURATION] Allowed minimum duration in seconds
[MAX_DURATION] Allowed maximum duration in seconds
[SKIP] Shows if the video is skippable by the user: 0 – false (default if not passed), 1 – true
[SKIP_MIN] Videos of total duration greater than this number of seconds can be skippable. Only applicable if the ad is skippable
[SKIP_AFTER] Defines the custom time in seconds after the ad can be skipped
[BREAKPOSITION] Indicates the position of the ad break within the underlying video/audio content that the ad is playing within. Values: 1 for pre-roll, 2 for mid-roll, 3 for post-roll, 4 for standalone, 0 for none of the above/other
[CONTENTID] Publisher-specific content identifier for the content asset into which the ad is being loaded or inserted. Only applicable to in-stream ads

Auction Data

Macros Description
[AUCTION_ID], [AM-RID] Unique request identifier. Automatically generated by the system as a UUID
[PUBLISHER_ID] Publisher ID
[SITE_ID] Site UUID
[UNIVERSAL_SITE_ID] Site ID
[ZONE_ID] Zone UUID
[ADVERTISER] Advertiser UUID
[CAMPAIGN_ID] Campaign ID
[PROFILE_ID] Profile UUID
[CREATIVE_ID] Creative UUID
[CACHEBUSTING], [TIMESTAMP], [RND]
Timestamp in milliseconds

Entity Data

To retrieve data by the entity (e.g. profile, site, or ad unit), use the entity ID macro.

Macros Description
[PUBLISHER_INT_ID] Publisher ID
[SITE_INT_ID] Site ID
[ZONE_INT_ID] Ad Unit ID
[ADVERTISER_INT_ID] Trading Desk ID
[CAMPAIGN_INT_ID] Campaign ID
[PROFILE_INT_ID] Profile ID
[CREATIVE_INT_ID] Ad Item ID
[PROFILE_NAME] Profile name
[CAMPAIGN_NAME] Campaign name
[CREATIVE_NAME] Creative name
Updated on August 13, 2024