Ads exposure tracking

You can track the exposition of users to the different kind of Ads format that exist today:

  • Display Ads: All Ads that are either static image/animations or HTML5 animated Ads

  • Video Ads: All Video Ads that the User can see through a marketing campaign

All Ads tracking is done using Pixels and Click Tracking URLs.

You should consider using this feature to get ad view and ad click directly within your datamart when using DSPs .

Activities tracked through this method will be of DISPLAY_AD $type and NO_SESSION $session_status. See User activity object for more information.

Associated user events

There are two predefined user events that should be tracked during the exposition of a user to an Ad :

Event nameTracking methodDescription

$ad_view

Pixel

The 'view/impression' of the Display Ad to the User

$ad_click

Click Tracking URL

The 'click' of the Ad by the User

Display Ad Pixel

Use the following URL in your tracking pixel to send an $ad_view event to the platform.

https://events.mediarithmics.com/v1/touches/pixel? \
	$ev=$ad_view& \
	$dat_token=<DATAMART_TOKEN>&
	$catn=<CAMPAIGN_TECHNICAL_NAME>&
	$scatn=<AD_GROUP_TECHNICAL_NAME>&
	$crtn=<CREATIVE_TECHNICAL_NAME>&
	$cb=<CACHEBUSTER>&
	gdpr=<GDPR>&
	gdpr_consent=<GDPR_CONSENT_184>
	... any custom property
FieldTypeDescription

$ev

String

The event name. $ad_view for Display Ad impression tracking

$dat_token

String

The token (not the ID) of the datamart in the mediarithmics platform.

$catn

String

Campaign technical name

$scatn

String

Sub-campaign technical name

$crtn

String

Creative technical name

$cb

String

The cache buster parameter. It should contain a random string. optional

$cuid

String

User account identifier of the user

$uaid

String

Mobile identifier of the user to identify the User agent

$email_hash

String

Email Hash identifier of the user

$comp_token

String

Compartment token (not the ID)

$uids

JSON as string (Optional)

The list of user identifiers of the user.

gdpr

Number

TCF v2.2 parameter to indicate if gdpr applies or not (values: 1 or 0)

gdpr_consent

String

TCF v2.2 parameter containing the encoded consent string

any custom property name

Any Type

Any custom property. optional

Ad Click tracking URL

Use the following click-tracking URL to send an $ad_click event to the platform.

https://events.mediarithmics.com/v1/touches/click?
	$ev=$ad_click&
	$dat_token=<DATAMART_TOKEN>&
	$catn=<CAMPAIGN_TECHNICAL_NAME>&
	$scatn=<AD_GROUP_TECHNICAL_NAME>&
	$crtn=<CREATIVE_TECHNICAL_NAME>&
	$cb=<CACHEBUSTER>&
	$redirect=<CLICK_URL>&
	gdpr=<GDPR>&
	gdpr_consent=<GDPR_CONSENT_184>
	... any custom property
FieldTypeDescription

$ev

String

The event name. $ad_click for Display Ad click tracking

$dat_token

String

The id of the audience datamart in the mediarithmics platform.

$redirect

String

The redirect url. This string should URL Encoded. (RFC 3986)

$catn

String

Campaign technical name

$scatn

String

Sub-campaign technical name

$crtn

String

Creative technical name

$cb

String

The cache buster parameter. It should contain a random string. optional

$cuid

String

User account ID identifier of the user

$email_hash

String

Email Hash identifier of the user

$comp_token

String

Compartment token (not the ID)

$uids

JSON as string (Optional)

The list of user identifiers of the user.

gdpr

Number

TCF v2.2 parameter to indicate if gdpr applies or not (values: 1 or 0)

gdpr_consent

String

TCF v2.2 parameter containing the encoded consent string

any custom property name

Any Type

Any custom property. optional

If you want to integrate with an external DSP / Ad Server such as Google Ad Manager or App Nexus, you can use the ids of the creative ad groups and campaign from your external DSP as technical names. See the integrations below for examples.

Campaign tracking on Google

Display Video 360

You can use the following macros as a minimum configuration for tracking on DV 360 (ex-Doubleclick Bid Manager):

https://events.mediarithmics.com/v1/touches/pixel?
	$ev=$ad_view&
	$dat_token=<DATAMART_TOKEN>&
	$catn=${CAMPAIGN_ID}&
	$scatn=${INSERTION_ORDER_ID}&
	$crtn=${CREATIVE_ID}&
	gdpr=${GDPR}&
	gdpr_consent=${GDPR_CONSENT_184}&
	$cb=${CACHEBUSTER}
https://events.mediarithmics.com/v1/touches/click?
	$ev=$ad_click&
	$dat_token=<DATAMART_TOKEN>&
	$catn=${CAMPAIGN_ID}&
	$scatn=${INSERTION_ORDER_ID}&
	$crtn=${CREATIVE_ID}&
	gdpr=${GDPR}&
	gdpr_consent=${GDPR_CONSENT_184}&
	$cb=${CACHEBUSTER}&
	$redirect=${CLICK_URL_ENC}

More info on DV360 macros available here: https://support.google.com/displayvideo/answer/2789508

Campaign Manager 360 integration

You can use the following macros as a minimum configuration for tracking on Campaign Manager 360 (ex-Doubleclick Campaign Manager):

https://events.mediarithmics.com/v1/touches/pixel?
	$ev=$ad_view&
	$dat_token=<DATAMART_TOKEN>&
	$catn=%ebuy!&
	$scatn=%eaid!&
	$crtn=%ecid!&
	gdpr=${GDPR}&
	gdpr_consent=${GDPR_CONSENT_184}&
	$cb=%n
https://events.mediarithmics.com/v1/touches/click?
	$ev=$ad_click&
	$dat_token=<DATAMART_TOKEN>&
	$catn=%ebuy!&
	$scatn=%eaid!&
	$crtn=%ecid!&
	gdpr=${GDPR}&
	gdpr_consent=${GDPR_CONSENT_184}&
	$cb=%n&
	$redirect=<CLICK_URL>

More info on Google Campaign Manager 360 macros can be found here: https://support.google.com/campaignmanager/table/6096962

And for TCF integration: https://support.google.com/campaignmanager/answer/10031693?hl=en

Ad Manager integration

You can use the following macros as a minimum configuration for tracking on Ad Manager:

https://events.mediarithmics.com/v1/touches/pixel?
	$ev=$ad_view&
	$dat_token=<DATAMART_TOKEN>&
	$catn=%ebuy!&
	$scatn=%eaid!&
	$crtn=%ecid!&
	gdpr=${GDPR}&
	gdpr_consent=${GDPR_CONSENT_184}&
	$cb=%%CACHEBUSTER%%
https://events.mediarithmics.com/v1/touches/click?
	$ev=$ad_click&
	$dat_token=<DATAMART_TOKEN>&
	$catn=%ebuy!&
	$scatn=%eaid!&
	$crtn=%ecid!&
	gdpr=${GDPR}&
	gdpr_consent=${GDPR_CONSENT_184}&
	$cb=%%CACHEBUSTER%%&
	$redirect=<CLICK_URL>

More info on Google Ad Manager macros can be found here: https://support.google.com/admanager/answer/2376981

Campaign tracking on Xandr

You can use the following macros as a minimum configuration for tracking on Xandr:

https://events.mediarithmics.com/v1/touches/pixel?
	$ev=$ad_view&
	$dat_token=<DATAMART_TOKEN>&
	$catn=${CP_CODE}&
	$scatn=${CPG_CODE}&Not 
	$crtn=${CREATIVE_CODE}&
	gdpr=${GDPR}&
	gdpr_consent=${GDPR_CONSENT}&
	$cb=${CACHEBUSTER}
https://events.mediarithmics.com/v1/touches/click?
	$ev=$ad_click&
	$dat_token=<DATAMART_TOKEN>&
  	$catn=${CP_CODE}&
	$scatn=${CPG_CODE}&
	$crtn=${CREATIVE_CODE}&
	$cb=${CACHEBUSTER}&
	gdpr=${GDPR}&
	gdpr_consent=${GDPR_CONSENT}&
	$redirect=${CLICK_URL_ENC}

Video Ad Tracking

Basic video ad tracking can be achieved by integrating the display ad pixel (with $ad_view events) and the click-tracking URL (with $ad_click events) into your video ad format.

For more advanced capabilities, a specific integration can be setup based on the visit pixel (with custom completion events) and an Activity Analyzer. Please advise with your Account Representatives during the design phase.

Passing user identifiers in pixel-based tracking

The following is true for all types of pixel-based tracking (events, ads, email, conversions, ...) which use the events.mediarithmics.com/v1/touches/pixel API endpoint

You can pass one or more user identifiers when using the $uids field.

https://events.mediarithmics.com/v1/touches/pixel? \
	$ev=$ad_view& \
	$dat_token=<DATAMART_TOKEN>&
	$catn=<CAMPAIGN_TECHNICAL_NAME>&
	$scatn=<AD_GROUP_TECHNICAL_NAME>&
	$crtn=<CREATIVE_TECHNICAL_NAME>&
	gdpr=<GDPR>&
	gdpr_consent=<GDPR_CONSENT>&
	$cb=<CACHEBUSTER>&
	$uids=jso-[{"$tpe":"AG","$agid":"vec:1234"}]&
	... any custom property

jso- prefix means that the rest of the string will be interpreted as a json object.

Don't forget to correctly encode the URL

User Account

FieldTypeDescription

$tpe

Constant String

AC

$ctok

String

The token of the compartment

$acid

String

The user account id of the user

User Email

FieldTypeDescription

$tpe

Constant String

EM

$eh

String

The email hash

$e

String (Optional)

The "raw" email

User Agent

FieldTypeDescription

$tpe

Constant String

AG

$agid

String

Use the registry token, not the id, when formatting the user agent id.

Eg: dev:<registry_token>:<value>

Last updated