Advertiser events are actions on your websites to achieve a business goal, like adding an item to a wishlist or filling out a form. Event metadata has been introduced to go deeper into your performance insights and better understand customers' intentions.
Before going further, make sure that your Teads Universal Pixel is properly installed on your website: Please check this documentation.
Supported Event Metadata
Below is the list of advertiser events with corresponding supported metadata.
Additional parameters will be added in the future; stay tuned!
Advertiser event | Metadata | Field type |
Add to cart | name
price currency | string (max 100 characters) number (e.g., 50.99) string ISO 4217 currency code (e.g., "USD") |
Add to wishlist | name | string (max 100 characters) |
Complete registration | name | string (max 100 characters) |
Initiate checkout | name | string (max 100 characters) |
Lead | name | string (max 100 characters) |
Purchase | name
price currency | string (max 100 characters) number (e.g., 50.99) string ISO 4217 currency code (e.g., "USD") |
View content | name | string (max 100 characters) |
Search | name | string (max 100 characters) |
How to setup Metadata on Code Event
Log in to your Teads Ads Manager account at
https://ads.teads.com.Click On Events Manager in the top bar.
Select your pixel.
Copy the code-based event snippet
Add wanted metadata according to the list above and install it on your website
For example, if you want to name a specific Purchase event, and precise your revenue, you must update the code snippet like this:
<script> window.teads_e.push({ conversionType: "Purchase", name: "Awesome Teapot", price: 459.99, currency: "USD" }); </script> |
for events "conversionType" the parameter in the URL is named "conversion_type"
for events "name" (not type!) the parameter in the URL is named "aepn"
for events "price" the parameter in the URL is named "aepp"
for events "currency" the parameter in the URL is named "aepc"
Note: In case of spaces or special characters, it needs to be "URL encoded", yes, so a name with a space will be indeed conversion_type=View Content
How to setup Metadata on URL mapped Event
Log in to your Teads Ads Manager account at
https://ads.teads.com.Click On Events Manager in the top bar.
Select your pixel.
Click on URL Based Event > Add URL
Fill in the URL where an event is expected. Note that it is also possible (and recommended) to use the rule URL Contains:
Using Equals rule:
Using Contains rule
Click on Conversion Parameters and fill in the available metadata. Please note that while this parameter is optional, it is strongly recommended to name your conversion events to ensure you can report on them separately from other events within the same conversion type.
(At this time only the metadata name is available, additional parameters will be added soon)
How to setup Event Metadata automatically with Google Tag Manager
First, make sure Teads Universal Pixel is properly installed with Google Tag Manager; you can refer to this documentation for detailed information.
Select your event
Go to Advanced conversion tracking and fill in the relevant metadata.
