Partner postback macros

Become a TrafficGuard integrated partner.

Introduction

To receive notification of attributions from TrafficGuard you can use the following macros

Unique identifier parameters

Macro Description
{idfa} iOS Only - iOS unique identifier
{idfa_sha1} iOS Only - iOS unique identifier in SHA1 format
{idfa_md5} iOS Only - iOS unique identifier in MD5 format
{aaid} Android only. Android advertiser unique identifier
{aaid_sha1} Android only. Android advertiser unique identifier in SHA1 format
{aaid_md5} Android only. Android advertiser unique identifier in MD5 format

Example values

aaid=4c30c866-30d6-4418-a6dc-0f702737bf59

idfa=6D92078A-8246-4BA4-AE5B-76104861E7DC

Campaign metadata parameters

Macro Description
{site_id} ID of the site or mobile app where the user was engaged
{campaign_id} Campaign name or ID
{creative_id} Identifier of the ad creative
{placement_id} Identifier of the ad placement

Note: 

{partner_id} - Partner ID is required if source_id is not specified.

Event metadata parameters


Macro Description
{event_name} Name of the event triggered from the app
{event_param} Additional meta information related to the event parameter/s
{event_revenue_usd} Event revenue in USD

Example values

event_name=open

event_param={"level":"2","level_name":"big battle","score":"10000"}

event_revenue_usd=1.25

Device parameters

Macro Description
{user_agent} The device user agent
{user_ip} The user's IP address
{is_wifi} The connection type of the user
{country_code}

Two-character abbreviated country code that user is located in (on conversion) ISO 3166-1 alpha-2

{device_type} The user's device type

{platform}

{platform_version}

{device_brand}

{brand_model}

{browser_language}

The platform of user's device

The platform version / os version of user's device 

The brand of the user's device 

Model number of the user's device

The device browser language

Example values

user_agent=Mozilla/5.0 (Linux; Android 8.0; Pixel 2 Build/OPD3.170816.012) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.181 Mobile Safari/537.36

user_ip=154.674.111.34

is_wifi=TRUE

country_code=AU

device_type=smartphone, desktop, phablet, etc

platform=android, ios, windows, etc

platform_version=10.

device_brand=Apple, samsung, oppo, etc

brand_model=iphone, GALAXY A71, etc

browser_language=en-AU, id-ID, etc

App parameters

Macro Description
{app_id} App ID - App package name or app id in the store
{app_version} The version of the app defined by the app developer in the app’s code

Example values 

app_version=12.2.1

// iOS
app_id=id123456789

//Android
app_id=com.appenture.awesomeapp

Reference ID parameters

Macro Description
{tg_transaction_id} TrafficGuard unique transaction identifier
{partner_click_id} Partners unique click identifier

Example values

tg_transaction_id=09010041-9abf-47d5-9f00-11405b1dd331

partner_click_id=

Additional parameters

Macro Description
{sub_param_1} Custom Parameter 1
{sub_param_2} Custom Parameter 2
{sub_param_3} Custom Parameter 3
{sub_param_4} Custom Parameter 4
{sub_param_5} Custom Parameter 5

Example values

sub_param_1=

sub_param_2=

sub_param_3=

sub_param_4=

sub_param_5=

Timing parameters

Macro Description
{click_time} The time of the click ISO 8601
{click_time_seconds} The time of the click (Seconds since the Unix Epoch)
{click_time_milliseconds} The time of the click (Milliseconds since the Unix Epoch)
{event_time} The time of the in-app event ISO 8601
{event_time_seconds} The time of the in-app event (Seconds since the Unix Epoch)
{event_time_milliseconds} The time of the in-app event (Milliseconds since the Unix Epoch)

 

Example values

click_time_seconds=1538109117

click_time_milliseconds=1528876031

event_time=2018-06-13T15:52:12+08:00

event_time_seconds=1538109117

event_time_milliseconds=1528876031

MMP metadata parameters

Macro Description
{mmp_attribution_method} The method of attribution used by the MMP
{mmp_attribution_type} The MMP's attribution type
{mmp_impression_based} The MMP's based Impression 
{mmp_event_time} The MMP's event time
{mmp_transaction_id} The MMP's transaction id

Example values

Note - The values received from the MMP depends on the MMP the customer is using and whether the MMP is passing them to TrafficGuard consistently. 

mmp_attribution_method=id_matching, click, impression, google_ads, gp_referrer, probablistic, etc

mmp_attribution_type=impression or click

mmp_impression_based=1, 0

mmp_event_time=

mmp_transaction_id=

Rejected Postbacks 

Macro Description
{is_rejected} Rejection status of an install or an event. 0 = no, 1 = yes. 
{rejection_reason} Reason why the install or an event was rejected 

Example values

is_rejected=1, 0 

rejection_reason=known_malware_appid