Skip to main content

Documentation Index

Fetch the complete documentation index at: https://agenticadvertisingorg-changeset-release-main.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Universal macros enable buyers to include dynamic tracking data in their creatives without needing to know each publisher’s ad server implementation details. Macros are placeholders that get replaced with actual values at impression time.

Overview

When you provide creative assets to AdCP, you can include universal macro placeholders in:
  • Impression tracking URLs
  • Click tracking URLs
  • VAST tracking events
  • Landing page URLs
Example:
https://track.brand.com/imp?
  campaign={MEDIA_BUY_ID}&
  creative={CREATIVE_ID}&
  device={DEVICE_ID}&
  cb={CACHEBUSTER}
At impression time, this becomes:
https://track.brand.com/imp?
  campaign=mb_spring_2025&
  creative=cr_video_30s&
  device=ABC-123-DEF&
  cb=87654321

Available Macros by Format

Different creative formats support different macros. Use list_creative_formats to see which macros are available for each format.

Common Macros (All Formats)

MacroDescriptionExample Value
{MEDIA_BUY_ID}Your AdCP media buy identifiermb_spring_2025
{PACKAGE_ID}Your AdCP package identifierpkg_ctv_prime
{CREATIVE_ID}Your AdCP creative identifiercr_video_30s
{CACHEBUSTER}Random number to prevent caching87654321
{TIMESTAMP}Unix timestamp in milliseconds1704067200000
{CLICK_URL}Publisher’s click tracking URL(auto-inserted by sales agent)

Privacy & Compliance Macros

Critical for regulatory compliance - Use these to respect user privacy choices in your creative logic.
MacroDescriptionExample Value
{GDPR}GDPR applicability flag1 (applies), 0 (doesn’t apply)
{GDPR_CONSENT}IAB TCF 2.0 consent stringCPc7TgPPc7TgPAGABC...
{US_PRIVACY}US Privacy (CCPA) string1YNN
{GPP_STRING}Global Privacy Platform consent stringDBABMA~CPXxRfAPXxRfAAfKABENB-CgAAAAAAAAAAYgAAAAAAAA
{GPP_SID}GPP Section ID(s) indicating applicable sections7, 7,8 (US National, US National + California)
{IP_ADDRESS}User IP address (often masked for privacy)203.0.113.42, "" (when restricted)
{LIMIT_AD_TRACKING}Limit Ad Tracking enabled1 (limited), 0 (allowed)
Privacy Warning: {IP_ADDRESS} is considered personal data under GDPR and many privacy regulations. This macro may return an empty string or masked/truncated IP depending on user privacy settings, publisher policies, and regional regulations. Use geo macros ({COUNTRY}, {REGION}, {CITY}) instead when possible.
Example - Privacy-aware tracking:
// In creative logic
if (GDPR == 1 && GDPR_CONSENT == '') {
  // No consent - don't load tracking pixels
} else {
  // Load tracking
}

Device & Environment Macros

MacroDescriptionExample Value
{DEVICE_TYPE}Device categorymobile, tablet, desktop, ctv, dooh
{OS}Operating systemiOS, Android, tvOS, Roku
{OS_VERSION}OS version17.2, 14.0
{DEVICE_MAKE}Device manufacturerApple, Samsung, Roku
{DEVICE_MODEL}Device modeliPhone15,2, Roku Ultra
{USER_AGENT}Full user agent stringMozilla/5.0 ...
{APP_BUNDLE}App bundle ID (domain or numeric)com.publisher.app, 123456789
{APP_NAME}Human-readable app namePublisher News App

Geographic Macros

MacroDescriptionExample Value
{COUNTRY}ISO 3166-1 alpha-2 country codeUS, GB, CA, FR, JP, AU
{REGION}State/province/region codeNY, CA (US states), ON (Canada), IDF (France), NSW (Australia)
{CITY}City nameNew York, London, Tokyo, Sydney
{ZIP}Postal code10001 (US), SW1A 1AA (UK), 75001 (France), 100-0001 (Japan)
{DMA}Nielsen DMA code (US TV markets)501 (New York), 803 (Los Angeles)
{LAT}Latitude40.7128, 51.5074, 35.6762
{LONG}Longitude-74.0060, -0.1278, 139.6503

Identity Macros

MacroDescriptionExample Value
{DEVICE_ID}Mobile advertising ID (IDFA/AAID)ABC-123-DEF-456
{DEVICE_ID_TYPE}Type of device IDidfa, aaid

Web Context Macros

For web-based inventory:
MacroDescriptionExample Value
{DOMAIN}Domain where ad is shownnytimes.com
{PAGE_URL}Full page URL (encoded)https%3A%2F%2F...
{REFERRER}HTTP referrer URLhttps://google.com
{KEYWORDS}Page keywords (comma-separated)business,finance,tech

Placement & Position Macros

MacroDescriptionExample Value
{PLACEMENT_ID}Global Placement ID (IAB standard)12345678
{FOLD_POSITION}Position relative to fold (display)above_fold, below_fold
{AD_WIDTH}Ad slot width300, 728
{AD_HEIGHT}Ad slot height250, 90

Video Content Macros

For video formats with content context:
MacroDescriptionExample Value
{VIDEO_ID}Content video identifiervid_12345
{VIDEO_TITLE}Content video titleBreaking News Story
{VIDEO_DURATION}Content duration in seconds600
{VIDEO_CATEGORY}IAB content categoryIAB1 (Arts & Entertainment)
{CONTENT_GENRE}Content genrenews, sports, comedy
{CONTENT_RATING}Content ratingG, PG, TV-14
{PLAYER_WIDTH}Video player width1920
{PLAYER_HEIGHT}Video player height1080

Video Ad Pod Macros

For video ads in commercial breaks:
MacroDescriptionExample Value
{POD_POSITION}Position within ad break1, 2, 3
{POD_SIZE}Total ads in this break3
{AD_BREAK_ID}Unique ad break identifierbreak_mid_1
Note: Video formats also support all IAB VAST 4.x macros like [CACHEBUSTING], [TIMESTAMP], [DOMAIN], [IFA], etc. These work natively in VAST XML.

Audio Content Macros

For audio formats with content context:
MacroDescriptionExample Value
{STATION_ID}Radio station or podcast identifierWXYZ-FM, pod_12345
{COLLECTION_NAME}Program or collection nameMorning Drive, Tech Talk Daily
{INSTALLMENT_ID}Podcast episode identifierep_2025_01_15
{AUDIO_DURATION}Content duration in seconds3600

TMP Exposure Tracking

MacroDescriptionExample Value
{TMPX}TMP exposure token (HPKE-encrypted)k1.dG1weC1leGFtcGxl...
The {TMPX} macro carries an encrypted exposure token from the Identity Match response. It contains the user’s resolved identity tokens encrypted via HPKE, enabling the buyer’s impression pixel to log per-user exposures for real-time frequency capping. Publishers substitute {TMPX} into tracking URLs exactly like other macros. The token is opaque β€” publishers MUST NOT parse, log, or make decisions based on its value. See TMPX Exposure Tokens for the encryption format and key management.

AXE Integration (Legacy)

MacroDescriptionExample Value
{AXEM}AXE contextual metadata (encoded blob)eyJjb250ZXh0IjoiLi4uIn0=
The {AXEM} macro is from the legacy AXE integration. In TMP, this is replaced by:
  • Structured creative assets move to the creative_manifest field on the Offer.
  • Per-user exposure tracking uses the {TMPX} macro from Identity Match.

Catalog Item Macros

For catalog-driven creatives (carousels, dynamic product ads, job boards, store locators). These macros resolve to the identifier of the specific catalog item being rendered at serve time β€” the same identifiers used in conversion event content_ids via the content_id_type field.
MacroDescriptionExample Value
{CATALOG_ID}Buyer-defined catalog identifiergmc-primary, job-feed
{SKU}Product SKU identifierSKU-12345
{GTIN}Global Trade Item Number00013000006040
{OFFERING_ID}AdCP offering identifiersummer-sale
{JOB_ID}Job posting identifiervacancy-amsterdam-chef-42
{HOTEL_ID}Hotel property identifiergrand-amsterdam
{FLIGHT_ID}Flight route identifierAMS-BCN-2025-06
{VEHICLE_ID}Vehicle listing identifierVIN-1234
{LISTING_ID}Real estate listing identifierprop-amsterdam-01
{STORE_ID}Store location identifieramsterdam-flagship
{PROGRAM_ID}Education program identifiermba-2025
{DESTINATION_ID}Travel destination identifierbarcelona
Use the macro that matches your catalog’s content_id_type. For example, a product catalog with content_id_type: "gtin" uses {GTIN} in tracker URLs; a job catalog uses {JOB_ID}.

Substitution safety (catalog-item macros)

Catalog-item macros are the one macro class where the value originates in buyer-controlled data (the catalog feed) and expands at impression time into publisher-controlled contexts (impression tracker URLs, click tracker URLs, VAST tracking-event URLs, AND landing / clickthrough URLs β€” the full set of URL substitution targets above). That flow is attacker-adjacent: a catalog value containing &, #, ?, CR/LF, a stray URL fragment, or a Unicode bidi override can break out of the URL context, inject a Host-header via CRLF, or spoof audit-log rendering if substituted raw. The following rules apply to all catalog-item macros listed above ({CATALOG_ID}, {SKU}, {GTIN}, {OFFERING_ID}, {JOB_ID}, {HOTEL_ID}, {FLIGHT_ID}, {VEHICLE_ID}, {LISTING_ID}, {STORE_ID}, {PROGRAM_ID}, {DESTINATION_ID}):
  • Normalize to Unicode NFC before encoding. Prior to percent-encoding, catalog-item values that are not already in Unicode Normalization Form C (NFC) MUST be normalized to NFC per Unicode Standard Annex #15. Sellers and buyers MAY send catalog values in any normalization form at sync_catalogs ingest (the catalog is stored as-supplied); the normalization to NFC is a step in the substitution pipeline immediately before percent-encoding, not a catalog-ingest requirement. Without this step, two implementations that both satisfy the unreserved-whitelist rule below produce different bytes for the same visual string β€” cafΓ© (NFC: U+00E9) and cafe\u0301 (NFD: U+0065 + combining U+0301) encode to caf%C3%A9 vs e%CC%81 respectively. NFC matches web-platform convention (WHATWG URL, HTML5 DOM, W3C Character Model). NFKC / NFKD are not acceptable substitutes β€” their compatibility folding silently mutates fullwidth/halfwidth variants and other visually-distinct glyphs that legitimately appear in Japanese/Korean retailer catalogs.
  • Percent-encode every octet that is not in the RFC 3986 unreserved set. Sales agents MUST percent-encode the NFC-normalized catalog-item value such that only RFC 3986 unreserved characters (ALPHA / DIGIT / "-" / "." / "_" / "~") remain unescaped before substituting it into a URL context (query string, path segment, or fragment). Non-ASCII octets MUST be percent-encoded after UTF-8 encoding per RFC 3986 Β§2.5. This is the encodeURIComponent-equivalent contract: reserved characters (: / ? # [ ] @ ! $ & ' ( ) * + , ; =) are escaped as one would expect, but so are CR (%0D), LF (%0A), space (%20), C0/C1 control characters, and Unicode bidi overrides β€” the broader enumeration closes CRLF-injection and bidi-spoofing vectors that a reserved-only rule would leave open. Encoding is applied exactly once at substitution time; downstream VAST players and ad servers firing the URL verbatim is the expected contract β€” they do not and MUST NOT re-decode before firing.
  • Nested macro expansion is prohibited. A catalog-item value that itself contains text matching AdCP’s {MACRO_NAME} syntax MUST NOT be re-expanded. Sales agents perform AdCP macro substitution in one pass: source placeholders are replaced with literal values, and those literal values are not re-scanned. A {JOB_ID} value of vacancy-{DEVICE_ID}-42 produces the literal string vacancy-%7BDEVICE_ID%7D-42 (after percent-encoding of the braces) in the emitted URL, not a second-round expansion. This rule binds AdCP’s {...} syntax only; catalog-item values containing downstream ad-server macro syntaxes (%%...%%, ${...}, [...], {{...}}) remain the sales agent’s responsibility to neutralize when targeting an ad server that would interpret them β€” percent-encoding per the rule above typically suffices, since %, $, [, ], and { all land outside the unreserved set.
  • Scope is URL contexts only. These rules apply when a catalog-item macro is substituted into a URL context. When a catalog-item macro is substituted into an HTML-attribute context (for example, a banner template’s href or data-* attribute rendered server-side), percent-encoding per this section does not by itself prevent attribute-context breakout; the renderer MUST additionally apply HTML-attribute escaping β€” the two encodings are layered, not alternatives, because the value must survive both the URL parser and the HTML attribute parser. AdCP’s normative contract bounds to the URL-context case; publisher-side HTML-attribute handling is out of scope for this spec.
Non-catalog macros ({MEDIA_BUY_ID}, {PACKAGE_ID}, {CREATIVE_ID}, {GEO}, {COUNTRY}, {DEVICE_TYPE}, etc.) are populated from publisher- or ad-server-mediated state, not from buyer-supplied feed data. Their encoding contract is governed by the ad-server integration (OpenRTB, VAST), which percent-encodes by convention. Some macros in this class derive from attacker-spoofable inputs ({USER_AGENT}, {REFERRER}, {PAGE_URL}, {DOMAIN}, {APP_BUNDLE} come from request headers or page metadata); the OpenRTB / ad-server encoding convention is the control today. This spec’s normative MUST deliberately scopes to the buyer-controlled catalog-item class β€” a narrower, verifiable contract than a universal canonicalization rule. Conformance fixture. Reference test vectors pinning the encoding behavior β€” reserved-character breakout, nested-expansion literal preservation, CRLF injection, non-ASCII β€” are tracked at static/test-vectors/catalog-macro-substitution.json. Sales agents SHOULD validate their substitution code against these vectors before shipping.

Creative Variant Macros

MacroDescriptionExample Value
{CREATIVE_VARIANT_ID}Seller-assigned creative variant identifiervariant_a, v2_mobile
Note: Publisher-specific custom macros may be defined in individual creative format specifications as extra supported macros.

Usage Examples

Video Creative with Tracking

{
  "creative_id": "cr_video_30s",
  "format_id": {
    "agent_url": "https://creative.adcontextprotocol.org",
    "id": "video_30s_vast"
  },
  "assets": {
    "vast_xml": {
      "asset_type": "vast",
      "delivery_type": "inline",
      "content": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<VAST version=\"4.2\">\n  <Ad>\n    <InLine>\n      <Impression><![CDATA[https://track.brand.com/imp?buy={MEDIA_BUY_ID}&pkg={PACKAGE_ID}&cre={CREATIVE_ID}&device={DEVICE_ID}&domain={DOMAIN}&cb=[CACHEBUSTING]]]></Impression>\n      <Creatives>\n        <Creative>\n          <Linear>\n            <Duration>00:00:30</Duration>\n            <TrackingEvents>\n              <Tracking event=\"firstQuartile\"><![CDATA[https://track.brand.com/q1?buy={MEDIA_BUY_ID}&cb=[CACHEBUSTING]]]></Tracking>\n              <Tracking event=\"complete\"><![CDATA[https://track.brand.com/complete?buy={MEDIA_BUY_ID}&cb=[CACHEBUSTING]]]></Tracking>\n            </TrackingEvents>\n            <VideoClicks>\n              <ClickThrough><![CDATA[https://brand.com/spring?campaign={MEDIA_BUY_ID}]]></ClickThrough>\n            </VideoClicks>\n            <MediaFiles>\n              <MediaFile delivery=\"progressive\" type=\"video/mp4\" width=\"1920\" height=\"1080\">\n                <![CDATA[https://cdn.brand.com/videos/spring_30s.mp4]]>\n              </MediaFile>\n            </MediaFiles>\n          </Linear>\n        </Creative>\n      </Creatives>\n    </InLine>\n  </Ad>\n</VAST>",
      "vast_version": "4.2"
    }
  }
}
Key Points:
  • Mix AdCP macros ({MEDIA_BUY_ID}) with VAST macros ([CACHEBUSTING])
  • AdCP macros use {CURLY_BRACES}
  • VAST macros use [SQUARE_BRACKETS]
  • Both work together seamlessly

Display Creative with Tracking

{
  "creative_id": "cr_banner_300x250",
  "format_id": {
    "agent_url": "https://creative.adcontextprotocol.org",
    "id": "display_banner_300x250"
  },
  "assets": {
    "banner_image": {
      "url": "https://cdn.brand.com/banners/spring_300x250.jpg",
      "width": 300,
      "height": 250
    },
    "impression_pixel": {
      "url": "https://track.brand.com/imp?buy={MEDIA_BUY_ID}&pkg={PACKAGE_ID}&cre={CREATIVE_ID}&device={DEVICE_ID}&domain={DOMAIN}&cb={CACHEBUSTER}"
    },
    "landing_url": {
      "url": "https://brand.com/spring?campaign={MEDIA_BUY_ID}"
    }
  }
}

Audio Creative with Tracking

{
  "creative_id": "cr_audio_30s",
  "format_id": {
    "agent_url": "https://creative.adcontextprotocol.org",
    "id": "audio_streaming_30s"
  },
  "assets": {
    "audio_file": {
      "url": "https://cdn.brand.com/audio/spring_30s.mp3",
      "duration_ms": 30000
    },
    "impression_tracker": {
      "url": "https://track.brand.com/imp?buy={MEDIA_BUY_ID}&pkg={PACKAGE_ID}&station={STATION_ID}&show={COLLECTION_NAME}&cb={CACHEBUSTER}"
    }
  }
}

Catalog-Driven Creative with Item Tracking

{
  "creative_id": "cr_product_carousel",
  "format_id": {
    "agent_url": "https://creative.retailer.com/adcp",
    "id": "product_carousel"
  },
  "catalogs": [{
    "catalog_id": "gmc-primary",
    "type": "product",
    "content_id_type": "gtin",
    "tags": ["summer"]
  }],
  "assets": {
    "impression_pixel": {
      "url": "https://track.brand.com/imp?buy={MEDIA_BUY_ID}&catalog={CATALOG_ID}&item={GTIN}&cb={CACHEBUSTER}",
      "url_type": "tracker_pixel"
    },
    "click_tracker": {
      "url": "https://track.brand.com/click?buy={MEDIA_BUY_ID}&catalog={CATALOG_ID}&item={GTIN}",
      "url_type": "tracker_pixel"
    }
  }
}
Key point: {GTIN} resolves to the specific product’s GTIN at serve time. For a carousel showing 5 products, each product impression/click fires with that product’s identifier β€” enabling per-item attribution.

Macro Availability by Inventory Type

Not all macros are available in all inventory types. Check format specifications to see which macros are supported. Important: The columns below represent format types (Display, Video, etc.) which can run in different environments (app vs web). For example:
  • Display ads in mobile apps have DEVICE_ID (βœ…*), but display ads on web do not
  • The βœ…* notation means β€œavailable in-app contexts only”
  • Format type + inventory environment determine actual macro availability
Macro CategoryDisplayVideoAudioNativeCTV/OTTDOOHMobile AppMobile WebDesktop Web
Commonβœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…
{MEDIA_BUY_ID}βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…
{PACKAGE_ID}βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…
{CREATIVE_ID}βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…
{CACHEBUSTER}βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…
{TIMESTAMP}βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…
Privacy
{GDPR}βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…
{GDPR_CONSENT}βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…
{US_PRIVACY}βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…
{GPP_STRING}βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…
{GPP_SID}βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…
{IP_ADDRESS}βœ…β€‘βœ…β€‘βœ…β€‘βœ…β€‘βœ…β€‘βŒβœ…β€‘βœ…β€‘βœ…β€‘
{LIMIT_AD_TRACKING}βœ…*βœ…*βœ…*βœ…*βœ…βŒβœ…βŒβŒ
Identity
{DEVICE_ID}βœ…*βœ…*βœ…*βœ…*βœ…βŒβœ…βŒβŒ
{DEVICE_ID_TYPE}βœ…*βœ…*βœ…*βœ…*βœ…βŒβœ…βŒβŒ
Geographic
{COUNTRY}βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…
{REGION}βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…
{CITY}βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…
{ZIP}βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…
{DMA}βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…
{LAT}/{LONG}βœ…β€ βŒβŒβœ…β€ βŒβœ…βœ…β€ βŒβŒ
Device
{DEVICE_TYPE}βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…
{OS}βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…
{OS_VERSION}βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…
{APP_BUNDLE}βœ…*βœ…*βœ…*βœ…*βœ…βŒβœ…βŒβŒ
{USER_AGENT}βœ…βœ…βœ…βœ…βœ…βŒβŒβœ…βœ…
Web Context
{DOMAIN}βœ…βœ…βœ…βœ…βŒβŒβŒβœ…βœ…
{PAGE_URL}βœ…βœ…βœ…βœ…βŒβŒβŒβœ…βœ…
{REFERRER}βœ…βœ…βœ…βœ…βŒβŒβŒβœ…βœ…
{KEYWORDS}βœ…βœ…βœ…βœ…βŒβŒβŒβœ…βœ…
Placement
{PLACEMENT_ID}βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…βœ…
{FOLD_POSITION}βœ…βŒβŒβœ…βŒβŒβœ…βœ…βœ…
Video Content
{VIDEO_ID}βŒβœ…βŒβŒβœ…βŒβŒβŒβŒ
{VIDEO_CATEGORY}βŒβœ…βŒβŒβœ…βŒβŒβŒβŒ
{CONTENT_GENRE}βŒβœ…βœ…βŒβœ…βŒβŒβŒβŒ
Video Ad Pods
{POD_POSITION}βŒβœ…βŒβŒβœ…βŒβŒβŒβŒ
{POD_SIZE}βŒβœ…βŒβŒβœ…βŒβŒβŒβŒ
{AD_BREAK_ID}βŒβœ…βŒβŒβœ…βŒβŒβŒβŒ
Audio Content
{STATION_ID}βŒβŒβœ…βŒβŒβŒβŒβŒβŒ
{COLLECTION_NAME}βŒβŒβœ…βŒβŒβŒβŒβŒβŒ
TMP Exposure
{TMPX}βœ…βœ…βœ…βœ…βœ…βœ…Β§βœ…βœ…βœ…
Legend:
  • βœ… = Available
  • ❌ = Not available
  • βœ…* = In-app only (not mobile web)
  • βœ…β€  = When location permission granted
  • βœ…β€‘ = Often restricted due to privacy regulations (may return empty or masked value)
  • βœ…Β§ = DOOH uses play-log-based reporting rather than pixel URLs
Important Notes:
  • Privacy macros ({LIMIT_AD_TRACKING}, {DEVICE_ID}) may return empty values based on user privacy settings
  • Geographic macros accuracy varies by publisher’s data capabilities
  • {PLACEMENT_ID} refers to the IAB Global Placement ID standard

How Macros Work

1. Discovery

Query list_creative_formats to see which macros each format supports:
{
  "format_id": {
    "agent_url": "https://creative.adcontextprotocol.org",
    "id": "video_30s_vast"
  },
  "type": "video",
  "supported_macros": [
    {
      "macro": "{MEDIA_BUY_ID}",
      "category": "identity",
      "description": "AdCP media buy identifier",
      "required": false,
      "privacy_sensitive": false,
      "example_value": "mb_spring_2025"
    },
    {
      "macro": "{DEVICE_ID}",
      "category": "identity",
      "description": "Mobile advertising ID (IDFA/AAID)",
      "required": false,
      "privacy_sensitive": true,
      "example_value": "ABC-123-DEF-456"
    },
    {
      "macro": "{GDPR}",
      "category": "privacy",
      "description": "GDPR applicability flag",
      "required": true,
      "privacy_sensitive": false,
      "example_value": "1"
    }
  ],
  "vast_macros_supported": true
}

2. Include Macros in Creatives

Add macro placeholders in your tracking URLs using {MACRO_NAME} syntax:
https://track.brand.com/imp?campaign={MEDIA_BUY_ID}&device={DEVICE_ID}

3. Sales Agent Processing

When you create a media buy via create_media_buy, the sales agent:
  1. Replaces AdCP ID macros with your actual IDs:
    • {MEDIA_BUY_ID} β†’ mb_spring_2025
    • {PACKAGE_ID} β†’ pkg_ctv_prime
    • {CREATIVE_ID} β†’ cr_video_30s
  2. Translates platform macros to their ad server’s syntax:
    • {CACHEBUSTER} β†’ %%CACHEBUSTER%% (GAM) or {{timestamp}} (Kevel)
    • {DEVICE_ID} β†’ %%ADVERTISING_IDENTIFIER_PLAIN%% (GAM)
    • {DOMAIN} β†’ %%SITE%% (GAM)
  3. Inserts click trackers automatically into clickable elements
  4. Leaves VAST macros unchanged (for video formats)

4. Impression Time

The publisher’s ad server replaces remaining macros with actual values:
https://track.brand.com/imp?
  campaign=mb_spring_2025&
  device=ABC-123-DEF-456&
  cb=87654321

Best Practices

Use Macros Consistently

Include the same core set of macros across all your creatives:
?buy={MEDIA_BUY_ID}&pkg={PACKAGE_ID}&cre={CREATIVE_ID}&cb={CACHEBUSTER}
This makes your tracking data consistent and easier to analyze.

Check Format Support

Always query list_creative_formats to see which macros are available. Not all formats support all macros.

Combine VAST and AdCP Macros

For video, use both systems together:
  • VAST macros [CACHEBUSTING], [TIMESTAMP] - for standard video tracking
  • AdCP macros {MEDIA_BUY_ID}, {DEVICE_ID} - for your campaign tracking

Privacy Compliance

Critical: Always respect user privacy choices in your creative logic.

GDPR Compliance (EU Traffic)

For campaigns serving in the EU:
// Check consent before loading tracking
if (GDPR == 1) {
  if (GDPR_CONSENT && GDPR_CONSENT != '') {
    // User has consented - load tracking pixels
    loadTracking();
  } else {
    // No consent - skip tracking
    console.log('Tracking skipped - no GDPR consent');
  }
} else {
  // GDPR doesn't apply - load tracking
  loadTracking();
}

US Privacy / CCPA Compliance

For US traffic:
// Check US Privacy string
if (US_PRIVACY == '1YYN') {
  // User has opted out - don't sell personal info
  skipPersonalizedTracking();
} else {
  // Load normal tracking
  loadTracking();
}

Device-Level Privacy

Respect Limit Ad Tracking settings:
// Check if device ID is available
if (LIMIT_AD_TRACKING == 1 || DEVICE_ID == '' || DEVICE_ID == '00000000-0000-0000-0000-000000000000') {
  // User has limited tracking - use contextual attribution
  useContextualTracking();
} else {
  // Device ID available
  useDeviceTracking(DEVICE_ID);
}

Privacy Macro Behavior

Empty Values: Privacy-restricted macros return empty strings or zeros:
  • {DEVICE_ID} β†’ "" or 00000000-0000-0000-0000-000000000000 when LAT enabled
  • {GDPR_CONSENT} β†’ "" when no consent provided
  • {IP_ADDRESS} β†’ "" or masked/truncated IP when privacy restricted
Always test for empty values before using privacy-sensitive macros.

URL Encoding

No need to URL-encode macro placeholders. The ad server handles encoding of actual values automatically. Example:
❌ WRONG: https://track.com/imp?device=%7BDEVICE_ID%7D
βœ… CORRECT: https://track.com/imp?device={DEVICE_ID}
The ad server will URL-encode the actual value when replacing the macro.

Template Syntax

AdCP macro-bearing URLs validate as RFC 6570 URI templates (Level 1) β€” simple {var} substitution only. Level 2–4 operators ({+SKU}, {#SKU}, {.SKU}, {/SKU}, {;SKU}, {?SKU}, {&SKU}) are not used by AdCP and must not appear in manifests. The ad server performs literal string replacement, not RFC 6570 expansion.

Implementation Notes for Sales Agents

This section is for AdCP implementers, not buyers.

Macro Translation Approach

Sales agents must translate universal macros to their ad server’s native syntax. The recommended approach: Option 1: Hard-Code During Trafficking (MVP)
  • When creating ad server creatives, replace AdCP ID macros with actual values
  • Translate platform macros to ad server syntax
  • Creates one creative per line item but is simple and reliable
Option 2: Dynamic Wrapper (Future)
  • Intercept ad calls and inject values dynamically
  • More complex but avoids creative duplication

Translation Examples

Google Ad Manager:
{
  '{CACHEBUSTER}': '%%CACHEBUSTER%%',
  '{DEVICE_ID}': '%%ADVERTISING_IDENTIFIER_PLAIN%%',
  '{DEVICE_ID_TYPE}': '%%ADVERTISING_IDENTIFIER_TYPE%%',
  '{DOMAIN}': '%%SITE%%',
  '{VIDEO_ID}': '%%VIDEO_ID%%'
}
Kevel:
{
  '{CACHEBUSTER}': '{{timestamp}}',
  '{DEVICE_ID}': '{{device.ifa}}',
  '{DEVICE_ID_TYPE}': '{{device.ifaType}}',
  '{DOMAIN}': '{{request.domain}}'
}
Xandr Monetize:
{
  '{CACHEBUSTER}': '${CACHEBUSTER}',
  '{DEVICE_ID}': '${DEVICE_APPLE_IDA}',  // or ${DEVICE_AAID}
  '{DOMAIN}': '${DOMAIN}'
}

Click Tracker Insertion

Sales agents must automatically insert click tracking macros into clickable elements: Original creative:
<a href="https://brand.com/product">Click here</a>
After insertion (GAM):
<a href="%%CLICK_URL_UNESC%%https://brand.com/product">Click here</a>

Mapping Storage

Store the mapping between AdCP IDs and ad server IDs for reconciliation:
{
  media_buy_id: "mb_spring_2025",
  ad_server_order_id: "1234567",
  packages: [
    {
      package_id: "pkg_ctv_prime",
      ad_server_line_item_id: "8901234"
    }
  ]
}
Return this in create_media_buy responses and make it queryable for reconciliation.