Skip to main content

Supported Macros

In this article, you will find the supported macros & learn how to incorporate them and URL parameters into your URLs and 3rd party tags

To better understand how effective your ads are, macros (also referred to as URL parameters) can be used in conjunction with web analytics tools, such as Google Analytics.

An example of an URL containing macros is shown below:

These macros can be used for Upper and Middle Funnel campaigns, and are supported for click-through and third-party tracking for creatives that are created within Creative Editor.

Please note that macros between Web and CTV based campaigns can differ. For an overview of the macros available for each channel, please see below.

Tracking macros for Web & CTV

These macros are replaced in all tracking URLs (impression pixels, click URLs, etc.) for both Web and CTV environments.

Supported Macros

Description

[WNAME]

Domain of the publisher where the ad was shown.

[CAMPAIGN_NAME]

Name of the campaign that served the ad.

[CAMPAIGN_ID]

ID of the campaign that served the ad.

[CID]

Teads ID of the creative that served the ad

[GID]

ID of the line item that served the ad

[PID]

ID of the placement where your ad was served

[DEVICE]

Platform where the ad was served.It will return Desktop, mobile, tablet or SmartTV. OpenRTB numeric device type (1=Mobile, 2=PC, 3=CTV, 5=Tablet, etc.)

[AUCTID]

A Teads unique auction identifier (bid request ID)

[TIMESTAMP]

UNIX timestamp of the selected event (click, impression, …)

[APP_NAME]

Name of the app where the ad was shown.

[APPBUNDLE]

Bundle ID of the app where the ad was shown.

[GDPR]

Determining whether GDPR applies;

1 - GDPR applies

0 - GDPR does not apply

Unset - Unknown

[GDPR_CONSENT]

Whether consent was given around GDPR requirements. TCF consent string (not URL-encoded)

[FORMAT]

Name of the ad format

[LOCAL_HOUR_OF_DAY]

Hour of the day in the user's local timezone

[OS]

Operating system of the device

[OSV]

Operating system version

[PCAT]

IAB Tier 1 content category

[PLATFORM]

Human-readable platform name (Desktop, Mobile, Tablet, SmartTV)

[STOREURL]

App store URL

[WID]

ID of the publisher website

Restricted Macros (Web & CTV — requires user consent)

These macros are only resolved when allowUserDataUsage and isUserTrackable are both true. Otherwise they resolve to an empty string.

Supported Macros

Description

[DEVICEID]

Advertising device ID (IDFA / GAID)

[VID]

Teads viewer ID

[IP_ADDRESS]

IP address of the device (URL-encoded)

CTV-Only Macros (Wrapped VAST URI)

These macros are only available in CTV / VAST contexts. They are applied on top of all tracking macros above.

Supported Macros

Description

[CITY]

City name of the user (URL-encoded)

[COUNTRY]

Country name of the user (URL-encoded)

[POSTAL_CODE]

Postal/Zip code of the user (URL-encoded)

Display Text Macros (Creative Rendering)

Used inside creative display text (dynamic creative optimization). Values are not URL-encoded.

Supported Macros

Description

[CITY]

City name

[COUNTRY]

Country name

[REGION]

Region / state name

[PLATFORM]

Human-readable platform name

[LOCAL_DAY_OF_WEEK]

Day of the week in the user's local language, capitalized (e.g. "Monday", "Lundi")

Did this answer your question?