{"id":15078,"date":"2026-09-04T14:19:35","date_gmt":"2026-09-04T14:19:35","guid":{"rendered":"https:\/\/wiki.pontiac.media\/?docs=ctv-documentation\/macros\/supported-macros"},"modified":"2026-09-04T15:12:14","modified_gmt":"2026-09-04T15:12:14","slug":"supported-macros","status":"publish","type":"docs","link":"https:\/\/wiki.pontiac.media\/?docs=ctv-documentation\/macros\/supported-macros","title":{"rendered":"Supported Macros"},"content":{"rendered":"\n<p class=\"wp-block-paragraph\">The following macros are supported by Pontiac and may be used in applicable third-party tags, pixels, and trackers.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Macros must be implemented using the exact format shown below. Incorrect formatting may prevent the macro from being replaced or result in missing data.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Some macro values depend on information provided by the Exchange, publisher, device, or bid request and may not be available for every impression.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">Pontiac IDs<\/h4>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th><strong>Macro<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>${ADVERTISER_ID}<\/code><\/td><td>Pontiac Advertiser ID<\/td><\/tr><tr><td><code>${CAMPAIGN_ID}<\/code><\/td><td>Pontiac Campaign ID<\/td><\/tr><tr><td><code>${LINE_ID}<\/code><\/td><td>Pontiac Line ID<\/td><\/tr><tr><td><code>${CREATIVE_ID}<\/code><\/td><td>Pontiac Creative ID<\/td><\/tr><tr><td><code>${TAG_ID}<\/code><\/td><td>Unique identifier of the ad tag used for serving the impression<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\">Inventory &amp; Content<\/h4>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th><strong>Macro<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>${SITE_DOMAIN}<\/code><\/td><td>The site domain associated with the impression<\/td><\/tr><tr><td><code>${APP_BUNDLE_ID}<\/code><\/td><td>The app\u2019s bundle identifier where the impression served<\/td><\/tr><tr><td><code>${PUBLISHER_NAME}<\/code><\/td><td>The name of the publisher serving the impression<\/td><\/tr><tr><td><code>${PUBLISHER_ID}<\/code><\/td><td>Unique ID of the publisher serving the impression<\/td><\/tr><tr><td><code>${SERIES}<\/code><\/td><td>The series name associated with the content where the impression served<\/td><\/tr><tr><td><code>${CHANNEL}<\/code><\/td><td>The channel name or identifier where the impression served<\/td><\/tr><tr><td><code>${NETWORK}<\/code><\/td><td>The TV or media network associated with the impression<\/td><\/tr><tr><td><code>${GENRE}<\/code><\/td><td>The genre classification of the content (e.g., Sports, News, Entertainment)<\/td><\/tr><tr><td><code>${TITLE}<\/code><\/td><td>The specific title of the content where the impression served<\/td><\/tr><tr><td><code>${CONTENT_ID}<\/code><\/td><td>The content ID of the impression<\/td><\/tr><tr><td><code>${GPID}<\/code><\/td><td>A custom index specific placement identifier<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\">Geography<\/h4>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th><strong>Macro<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>${GEO_POSTAL_CODE}<\/code><\/td><td>The postal or ZIP code of the user\u2019s location for the impression<\/td><\/tr><tr><td><code>${GEO_COUNTRY}<\/code><\/td><td>The country of the user\u2019s location for the impression<\/td><\/tr><tr><td><code>${GEO_REGION}<\/code><\/td><td>The state, province, or region of the user\u2019s location for the impression<\/td><\/tr><tr><td><code>${GEO_LAT}<\/code><\/td><td>Latitude of the user\u2019s location for the impression<\/td><\/tr><tr><td><code>${GEO_LONG}<\/code><\/td><td>Longitude of the user\u2019s location for the impression<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\">Device<\/h4>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th><strong>Macro<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>${DEVICE_TYPE}<\/code><\/td><td>The numeric IAB category code representing the type of device (e.g., mobile, desktop, CTV, set-top)<\/td><\/tr><tr><td><code>${DEVICE_IFA}<\/code><\/td><td>Identifier for the device if available<\/td><\/tr><tr><td><code>${DEVICE_OS}<\/code><\/td><td>The numeric IAB category code representing operating system of the device (e.g., iOS, Android, Roku OS)<\/td><\/tr><tr><td><code>${DEVICE_MAKE}<\/code><\/td><td>Manufacturer of the device (e.g., Apple, Samsung, LG)<\/td><\/tr><tr><td><code>${DEVICE_MODEL}<\/code><\/td><td>Model of the device (e.g., iPhone 14, Fire TV Stick 4K)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\">Auction &amp; Deal<\/h4>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th><strong>Macro<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>${BID_PRICE}<\/code><\/td><td>Bid price associated with the impression<\/td><\/tr><tr><td><code>${BID_ID}<\/code><\/td><td>Unique identifier for the bid generated in the auction<\/td><\/tr><tr><td><code>${AUCTION_ID}<\/code><\/td><td>The auction ID of the impression<\/td><\/tr><tr><td><code>${DEAL_ID}<\/code><\/td><td>Identifier for the Deal associated with the impression<\/td><\/tr><tr><td><code>${EXCHANGE_ID}<\/code><\/td><td>The Exchange ID serving the impression<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\">Creative, Click &amp; Utility<\/h4>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th><strong>Macro<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>${HEIGHT}<\/code><\/td><td>Pixel height of the Creative<\/td><\/tr><tr><td><code>${WIDTH}<\/code><\/td><td>Pixel width of the Creative<\/td><\/tr><tr><td><code>${CLICK_URL}<\/code><\/td><td>The destination click-through URL for the ad<\/td><\/tr><tr><td><code>${CLICK_URL_ENCODED}<\/code><\/td><td>The destination click-through URL encoded for the ad<\/td><\/tr><tr><td><code>${CACHEBUSTER}<\/code><\/td><td>Inserts a random value to help prevent cached responses and ensure each impression generates a new request<\/td><\/tr><tr><td><code>${TIMESTAMP}<\/code><\/td><td>Timestamp when the impression was served (UTC)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\">Page &amp; Referrer<\/h4>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th><strong>Macro<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>${SITE_PAGE}<\/code><\/td><td>The full URL of the page where the request originated. Returned in lowercase and not URL-encoded.<\/td><\/tr><tr><td><code>${SITE_PAGE_ENC}<\/code><\/td><td>The full URL of the page where the request originated, URL-encoded. Returned in lowercase and encoded using UTF-8 (e.g., <code>https%3A%2F%2Fexample.com%2Fpage<\/code>).<\/td><\/tr><tr><td><code>${SITE_REFERRER}<\/code><\/td><td>The referrer URL indicating the page that led to the current request. Returned in lowercase and not URL-encoded.<\/td><\/tr><tr><td><code>${SITE_REFERRER_ENC}<\/code><\/td><td>The referrer URL indicating the page that led to the current request, URL-encoded. Returned in lowercase and encoded using UTF-8.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\">Privacy &amp; GDPR<\/h4>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th><strong>Macro<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>${GDPR}<\/code><\/td><td>Flag indicating whether the impression falls under GDPR regulation<\/td><\/tr><tr><td><code>${GDPR_CONSENT_X}<\/code><\/td><td>GDPR consent value for the specified vendor. Replace <code>X<\/code> with the applicable vendor ID. For example, <code>${GDPR_CONSENT_508}<\/code> uses vendor ID <code>508<\/code>.<\/td><\/tr><tr><td><code>${IP_HASH}<\/code><\/td><td>Salted hash of the IP address (blocked for GDPR compliance)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\">Pixel Query String Macro Parameters<\/h4>\n\n\n\n<p class=\"wp-block-paragraph\">Pontiac Pixels also support optional query string parameters that can be used to pass additional conversion, visitor, and site data when the Pixel fires. Unlike the Pontiac-populated macros listed above, these values must be populated by the website, tag manager, or other Pixel implementation.<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th><strong> Parameters<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>ORDER_ID<\/code><\/td><td>Passes the unique order or transaction ID generated by your site.<\/td><\/tr><tr><td><code>ORDER_AMOUNT<\/code><\/td><td>Passes the value associated with the conversion or order. This value can be used in reporting for metrics such as revenue and ROAS.<\/td><\/tr><tr><td><code>CONSUMER_ID<\/code><\/td><td>Passes a unique customer identifier generated by your site.<\/td><\/tr><tr><td><code>CLIENT_IP<\/code><\/td><td>Passes the visitor IP address observed by your website when the Pixel fires. This can be useful when the Pixel is implemented through a container or another environment where the IP address detected directly by the Pixel may not accurately represent the visitor. When provided, the Client IP value is used for attribution and reporting.<\/td><\/tr><tr><td><code>GDPR<\/code><\/td><td>Indicates whether GDPR applies to the visitor associated with the Pixel fire, typically using 1 when GDPR applies and 0 when it does not. For additional information, see <a href=\"https:\/\/wiki.pontiac.media\/?docs=ctv-documentation\/seats\/gdpr-compliant-seats\/gdpr-query-string-macros\">GDPR Query String Macros<\/a><\/td><\/tr><tr><td><code>GDPR_CONSENT<\/code><\/td><td>Passes the visitor\u2019s IAB TCF consent string when applicable. Populate this value dynamically using consent information collected by the website or Consent Management Platform (CMP).<\/td><\/tr><tr><td><code>VAR1, VAR2, VAR3, VAR4<\/code><\/td><td>Passes additional custom values to the Pixel using <code>var1<\/code>, <code>var2<\/code>, <code>var3<\/code>, and <code>var4<\/code>. These values are available in Custom Reporting as Custom Variable 1\u20134. <strong>Applicable Report Types:<\/strong> IP Conversion Pixel: Path to Conversion, IP Conversion Pixel: Page Visits, Cookies: Path to Conversion<\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"author":17,"featured_media":0,"parent":15074,"menu_order":1,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_is_vendor_doc":"0","footnotes":""},"doc_tag":[],"class_list":["post-15078","docs","type-docs","status-publish","hentry","no-post-thumbnail"],"comment_count":0,"_links":{"self":[{"href":"https:\/\/wiki.pontiac.media\/index.php?rest_route=\/wp\/v2\/docs\/15078","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/wiki.pontiac.media\/index.php?rest_route=\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/wiki.pontiac.media\/index.php?rest_route=\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/wiki.pontiac.media\/index.php?rest_route=\/wp\/v2\/users\/17"}],"replies":[{"embeddable":true,"href":"https:\/\/wiki.pontiac.media\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=15078"}],"version-history":[{"count":11,"href":"https:\/\/wiki.pontiac.media\/index.php?rest_route=\/wp\/v2\/docs\/15078\/revisions"}],"predecessor-version":[{"id":15120,"href":"https:\/\/wiki.pontiac.media\/index.php?rest_route=\/wp\/v2\/docs\/15078\/revisions\/15120"}],"up":[{"embeddable":true,"href":"https:\/\/wiki.pontiac.media\/index.php?rest_route=\/wp\/v2\/docs\/15074"}],"prev":[{"title":"Macros Overview","link":"https:\/\/wiki.pontiac.media\/?docs=ctv-documentation\/macros\/macros-overview","href":"https:\/\/wiki.pontiac.media\/index.php?rest_route=\/wp\/v2\/docs\/15076"}],"wp:attachment":[{"href":"https:\/\/wiki.pontiac.media\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=15078"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/wiki.pontiac.media\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_tag&post=15078"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}