Postback URL for Installs and Post-Install Events

511 views 10/04/2018 Shay Karpeles 0

Objective

This document provides the specifications for integrating server-to-server and 3rd party tracking systems with YouAppi. The integration is based on the use of a Callback HTTP call with a dynamic URL.

How does it work?

The process can be divided into three parts:

  1. Storing YouAppi’s callback URL:The advertiser or 3rd party tracking vendor stores YouAppi’s callback URL in their system.
  2. The click:Whenever a user clicks on an app recommendation, YouAppi redirects them to the advertiser using the advertiser’s click link, while appending to it special click ID parameters.
  3. The install:When the advertiser’s tracking system identifies a qualified installation, it calls on the stored callback URL and sends back to YouAppi its relevant click ID (and possibly other parameters), so that YouAppi can associate the install with the correct click.

 

Install Callback URL

Callback Format

YouAppi’s install callback URL looks like this:

http://service.youappi.com/tracking/report?params=&trackertoken=&deviceadid=&deviceidfa=&install_ts=

Parameters

The parameters marked in RED are required. The advertiser must populate these parameters with their own macros or values.
If you are unable to populate these values, please notify your account manager.

Parameter Name Description Value Type
params YouAppi’s unique click ID (or “transaction ID”) which was passed to the advertiser on the click. It is used to match the install with the click. Its value is a string incorporating all the required click-through information; the advertiser needs to support up to a length of 50 characters (decoded). String
trackertoken A unique identifying token (or “advertiser ID”) that will be provided to the advertiser or 3rd party by YouAppi. The advertiser must populate this field with the token provided. Please note that the value for this parameter should be hardcoded into the link once, and then remain unchanged. String
deviceadid Google advertising ID String
deviceidfa IDFA, iOS advertising ID String
bundle_id The app’s ID in the relevant store (i.e., Google Play or iTunes) String
install_ip IP of the device IPv4
country Country origin of the install ISO Alpha-2
city City origin of the install String
google_ref Google referrer String
user_agent User agent String
install_ts The timestamp of the install Epoch / Epoch with MS / YYYY-MM-DD HH:MM:SS / YYYY-MM-DD HH:MM:SS.MS
click_ts The timestamp of the click Epoch / Epoch with MS / YYYY-MM-DD HH:MM:SS / YYYY-MM-DD HH:MM:SS.MS

Post-Install Event Callback URL

We encourage you to send us post-install events to track on your campaign, as this will give our optimizing algorithms insight into the quality of the traffic sent to you.

Examples for post-install events include users that make an in-app purchase or users who engage with a certain section of your app.

Callback Format

YouAppi’s callback URL for post-install events looks like this:

http://service.youappi.com/tracking/event?params=&eventid=&eventidseq=&eventvalue=&trackertoken=&deviceadid=&deviceidfa=&event_ts=

Parameters

The parameters marked in RED are required. The advertiser must populate these parameters with their own macros or values.
If you are unable to populate these values, please notify your account manager.

Parameter Name Description Value Type
params YouAppi’s unique click ID (or “transaction ID”) which was passed to the advertiser on the click. It is used to match the install with the click. This is the same as the “params” used in the install callback URL. String
eventid A string describing the type of post-install event (e.g. “purchase” or “page_view”). Please note that the event name may include only URL-safe characters! String
eventidseq A string that uniquely identifies the event instance (e.g. “1” or “a”). String
eventvalue An optional value that may accompany an event type (“eventid”) instance. For example, this may be the sum of the purchase (e.g. “199.99”) or the number of the page that was viewed. Please note that the value for this parameter must be in the double data type format. Double Data
trackertoken A unique identifying token (or “advertiser ID”) that will be provided to the advertiser or 3rd party by YouAppi. The advertiser needs to populate this field with the token provided. Please note that the value for this parameter should be hardcoded into the link once, and then remain unchanged. This is the same as the “trackertoken” used in the install callback URL. String
deviceadid Google advertising ID String
deviceidfa IDFA, iOS advertising ID String
event_ts The timestamp of the post-install event Epoch / Epoch with MS / YYYY-MM-DD HH:MM:SS / YYYY-MM-DD HH:MM:SS.MS
country Country origin of the install ISO Alpha-2
city City origin of the install String
user_agent User agent String

 

Tracker’s pre-defined postbacks

TUNE

Install

http://service.youappi.com/tracking/report?trackerToken={advertiser_id}&params={publisher_ref_id}&click_ts={click_timestamp}&install_ts={conversion_timestamp}&install_ip={device_ip}&deviceadid={google_aid}&deviceidfa={ios_ifa}&country={country_code}&bundle_id={package_name}&google_ref={conversion_referral}&user_agent={user_agent}&tracker=tune

Event

http://service.youappi.com/tracking/event?eventid={event_name}&params={publisher_ref_id}&trackerToken={advertiser_id}&click_ts={click_timestamp}&install_ts={install_datetime}&event_ts={conversion_timestamp}&event_ip={device_ip}&deviceadid={google_aid}&deviceidfa={ios_ifa}&country={country_code}&bundle_id={package_name}&eventvalue={revenue_usd}&user_agent={user_agent}&google_ref={conversion_referral}&tracker=tune&is_install_attributed={is_install_attributed}

AppsFlyer

Install

http://service.youappi.com/tracking/report?trackerToken={trackerToken_dashboard}&params={params}&click_ts=(click-ts)&install_ts=(install-unix-ts)&install_ip=(ip)&deviceadid=(advertiserId)&deviceidfa=(idfa)&country=(country-code)&city=(city)&bundle_id=(app-id)&user_agent=(user-agent)&tracker=appsflyer

Event

http://service.youappi.com/tracking/event?eventid=(event-name)&eventvalue=(monetary)&trackertoken={trackerToken_dashboard}&params={params}&click_ts=(click-ts)&install_ts=(install-unix-ts)&event_ts=(eventtime)&event_ip=(ip)&deviceadid=(advertiserId)&deviceidfa=(idfa)&country=(country-code)&city=(city)&bundle_id=(app-id)&user_agent=(user-agent)&tracker=appsflyer

Kochava

Install

http://service.youappi.com/tracking/report?trackerToken={cpi_youappiios_token}&params={click_id}&install_ts={install_timestamp}&click_ts={click_timestamp}&install_ip={device_ip}&deviceadid={adid}&deviceidfa={idfa}&country={country_code}&city={city}&bundle_id={package_name|bundle_id}&google_ref={google referrer}&user_agent={device_ua}&tracker=kochava

Event

http://service.youappi.com/tracking/event?eventid={event_name}&eventidseq={event_timestamp}&eventvalue={event_sum}&trackertoken={youappi_token}&params={click_id}&event_ts={event_timestamp}&click_ts={click_timestamp}&install_ts={install_timestamp}&event_ip={ip_address}&deviceadid={adid}&deviceidfa={idfa}&country={country_code}&city={city}&bundle_id={package_name|bundle_id}&user_agent={device_ua}&google_ref={google referrer}&tracker=kochava

Apsalar

Install

http://service.youappi.com/tracking/report?trackerToken={{token}}&params={cl?youAPPi}&deviceidfa={IDFA}&deviceadid={AIFA}&install_ts={TIME}&click_ts={CLICK_TIME}&install_ip={IP}&country={COUNTRY}&bundle_id={LONGNAME}&tracker=apsalar

Event

http://service.youappi.com/tracking/event?params={cl?youAPPi}&eventid={EVTNAME}&trackertoken={{token}}&deviceidfa={IDFA}&deviceadid={AIFA}&event_ts={TIME}&install_ts={INSTALL_TIME}&click_ts={CLICK_TIME}&install_ip={IP}&country={COUNTRY}&bundle_id={LONGNAME}&tracker=apsalar

TapStream

Install

http://service.youappi.com/tracking/report?trackerToken=TS{hit.custom_parameters.trackerToken}&params={hit.custom_parameters.params}&click_ts=TS{hit.created}&install_ts=TS{event.timestamp}&install_ip=TS{event.ip}&deviceadid=TS{event.android_advertising_id}&deviceidfa=TS{event.ios_idfa}&bundle_id=TS{event.package_name}&google_ref=TS{hit.referrer}&tracker=tapstream

AppMetrica

Install

http://service.youappi.com/tracking/report?trackerToken=REPLACE_THIS&params={click_id}&click_ts={click_timestamp}&install_ts={install_timestamp}&deviceadid={google_aid}&deviceidfa={ios_ifa}&bundle_id={app_package_name}&user_agent={click_user_agent}&tracker=appmetrica

Event

http://service.youappi.com/tracking/event?eventid={conversion_event_name}&params={click_id}&trackerToken=REPLACE_THIS&click_ts={click_timestamp}&install_ts={install_timestamp}&event_ts={conversion_timestamp}&deviceadid={google_aid}&deviceidfa={ios_ifa}&bundle_id={app_package_name}&user_agent={click_user_agent}&tracker=appmetrica

Branch.io

Install

https://service.youappi.com/tracking/report?params={params}&trackertoken={trackertoken}&click_ts={click_ts}&install_ts={install_ts}install_ip={install_ip}&deviceadid={deviceadid}&deviceidfa={deviceidfa}&country={country}&bundle_id={bundle_id}&google_ref=youappi_referrer&user_agent={user_agent}&tracker=branch

Event

https://service.youappi.com/tracking/event?params={params}&trackertoken={trackertoken}&eventid={eventid}&eventvalue={eventvalue}&deviceadid={deviceadid}&deviceidfa={deviceidfa}&click_ts={click_ts}&install_ts={install_ts}&event_ts={event_ts}&event_ip={event_ip}&country={country}&bundle_id={bundle_id}&google_ref=youappi_referrer&user_agent={user_agent}&tracker=branch

Tenjin.io

iOS

http://service.youappi.com/tracking/report?params={click_id}&trackertoken={callback_token}&deviceidfa={advertising_id}&install_ts={time_in_seconds}&bundle_id={store_id}&install_ip={ip_address}&tracker=tenjin

Android

http://service.youappi.com/tracking/report?params={click_id}&trackertoken={callback_token}&deviceadid={advertising_id}&install_ts={time_in_seconds}&bundle_id={bundle_id}&install_ip={ip_address}&tracker=tenjin

 

For additional information and support please contact support@youappi.com.