Feature Guide
⚙️ Platform Macros Reference Guide

Platform Macros Reference Guide

Macros are dynamic placeholders used within tracking URLs, VAST tags,and creative markups. When an ad is served on the POKKT Platform, our system replaces these macros in real-time with actual data.

Campaign & Creative Macros

These macros pass data regarding the specific ad, campaign and creative elements being served.

MacroDescription
[HEIGHT]Creative Height (in pixels).
[WIDTH]Creative Width (in pixels).
[HEIGHT_MIN] / [HEIGHT_MAX]Minimum and maximum acceptable creative height.
[WIDTH_MIN] / [WIDTH_MAX]Minimum and maximum acceptable creative width.
[ADVERTISER_ID]Unique identifier for the Advertiser.
[ADVERTISER_NAME]Name of the Advertiser.
[CAMPAIGN_ID]Unique identifier for the Ad Campaign.
[CAMPAIGN_TITLE]Name/Title of the Ad Campaign.
[CREATIVE_ID]Unique identifier for the served Creative.
[OFFER_ID]Unique identifier for the specific Offer.
[OFFER_TITLE]Title or name of the Offer.
[AD_FORMAT]Format of the ad (e.g., video, display, native).
[ADTYPE]Specific type of the ad being served.

Supply, App & Publisher Macros

These macros pass data related to the app, publisher, and placement where the ad is being served.

MacroDescription
[SUPPLY_PUB_ID]Unique identifier for the Publisher.
[SUPPLY_NAME]Name of the Supply source or Publisher.
[SUPPLY_TAG] / [SUPPLY_TAG_ID]Name and ID of the specific Supply Tag used.
[SUPPLY_COMP_ID]Supply Company/Partner ID.
[APP_ID]Unique identifier for the Application (e.g., App Store ID or Play Store ID).
[APP_NAME]Name of the App where the ad is served.
[APP_BUNDLE]The application bundle or package name (e.g., com.developer.app).
[APP_STOREURL]URL of the App in its respective app store.
[APP_DOMAIN]The domain associated with the App.
[PLACEMENT_ID]Unique identifier for the Ad Placement.
[AD_PLACEMENT]Type of placement (e.g., in-feed, interstitial).
[AD_POS]Ad position (e.g., fullscreen, above the fold).
[CATEGORY_IAB]IAB content category of the app/publisher.
[BLOCKEDADCATEGORIES]IAB categories that the publisher has explicitly blocked.
[CHANNEL_ID]Identifier for the specific traffic channel.

Device, Network & Identity Macros

These macros identify the user's hardware, operating system, network connection and device IDs.

MacroDescription
[DEVICE_ID] / [DEVICE_ID_VAL]The unique Device ID (automatically detects IDFA/GAID).
[DEVICE_ID_TYPE] / [DEVICE_ID_TYPE2]The type of Device ID being passed (e.g., Apple IDFA, Google AID).
[DEVICE_OS]Operating System of the device (e.g., iOS, Android).
[OS_VERSION]Version of the Operating System.
[DEVICE_TYPE]Hardware type (e.g., Mobile, Tablet, Connected TV).
[CONNECTION_TYPE]User's network connection type (e.g., WiFi, Cellular).
[CONNECTION_TYPE_RTB]OpenRTB integer code for the connection type.
[CARRIER_NAME]Name of the mobile carrier or ISP.
[USER_AGENT]The raw User-Agent string of the device browser or app.
[IP_ADDRESS] / [IPADDRESS] / [DEVICEIP]The public IPv4/IPv6 address of the user.
[IDFA]Apple Identifier for Advertisers (iOS).
[AID]Google Advertising ID (Android).
[ANDROID_ID]Android hardware ID (fallback when AID is unavailable).
*[IDFA/AID/DEVICE_ID]_MD5*MD5 hashed version of the respective device ID.
*[IDFA/AID/DEVICE_ID]_SHA1*SHA1 hashed version of the respective device ID.
*[IDFA/AID/DEVICE_ID]_SHA256*SHA256 hashed version of the respective device ID.

Location & Demographics Macros

These macros provide geographic and demographic targeting data.

MacroDescription
[DEVICE_COUNTRY] / [DEVICE_COUNTRY_RTB]Country name / OpenRTB country code.
[DEVICE_COUNTRY_CODE]Two-letter or three-letter country code (ISO standard).
[DEVICE_CITY]City of the user.
[DEVICE_STATE]State or region of the user.
[DEVICE_ZIP]Postal/Zip code of the user.
[LATITUDE] / [LONGITUDE]Exact GPS coordinates.
[LATLONG]Combined string of Latitude and Longitude.
[GEO_TYPE_RTB]Source of the geo data (e.g., GPS, IP lookup) mapped to OpenRTB codes.
[AGE]Age or age range of the user.
[LANGUAGE]Primary language of the device.

Privacy Consent & Transparency Macros

Crucial for maintaining compliance with global privacy laws and OpenRTB supply chain standards.

MacroDescription
[GDPR]Indicates if the user is subject to GDPR (1 = Yes, 0 = No).
[CONSENT] / [GDPRCONSENT]The IAB TCF Consent String provided by the CMP.
[REGULATIONS]Other applicable privacy regulations (e.g., CCPA/CPRA).
[DNT] / [LIMITADTRACKING]Limit Ad Tracking / Do Not Track status (1 = Tracking Limited).
[PCHAIN]OpenRTB Supply Chain Object detailing the flow of the inventory.
[P_SCO]Compact pchain (Supply Chain Object) string.

VAST & Measurement Macros

Specific to video ad serving, Open Measurement, and ad verification.

MacroDescription
[DURATION] / [DURATION_VAST]Duration of the video ad in seconds.
[VIDEO_MIN] / [VIDEO_MAX]Minimum and maximum allowed video duration.
[VIDEO_MIN_BR] / [VIDEO_MAX_BR]Minimum and maximum allowed video bitrate.
[VASTVERSIONS]Supported VAST versions (e.g., 2.0, 3.0, 4.0).
[APIFRAMEWORKS]Supported API frameworks (e.g., VPAID, OMID, MRAID).
[MEDIAMIME]Accepted media MIME types (e.g., video/mp4).
[OMIDPN]Open Measurement SDK Partner Name.
[OMIDPV]Open Measurement SDK Partner Version.
[VERIFICATIONVENDORS]Supported ad verification vendors (e.g., IAS, DoubleVerify).
[EXTENSIONS]VAST or OpenRTB extensions present in the request.

System & Custom Tracking Macros

Used for logging, auction dynamics, and preventing caching issues.

MacroDescription
[timestamp] / [TIMESTAMP]Current Unix timestamp at the time of the event.
[CACHE_BREAKER] / [CACHE_BUSTER]A random string/number generated to bypass browser caching.
[AUCTION_CURRENCY]Currency used in the auction (default: USD).
[TRACK_ID]Unique system ID for tracking the impression/click lifecycle.