Campaign link parameters

Tapstream reserves several query string parameter keys on campaign links, prepended by __ts. You can add values to these reserved keys to improve Tapstream's performance or alter its behavior.

You can also add an unlimited number of other parameters to campaign links. Key-value pairs (sometimes referred to as "sub IDs") that you add at click time to a Tapstream campaign link's query string will be saved, and if a conversion is generated, they will be available via all of Tapstream's APIs and its postback system.

In general, Tapstream forwards all query string parameters to the destination URL.

Parameter access

The following systems expose the query string parameters of conversions. Note that some of these require an upgraded Tapstream account.

  • Rollup reports, a dashboard screen that groups conversions by custom parameter
  • Postbacks, as TS{hit.custom_parameters.your_key}
  • Conversion API, which shows all custom parameters for every conversion
  • Conversion rollup API, which groups conversions by custom parameter
  • Onboarding links, which gives your app, via the Tapstream SDK, all custom parameters associated with that app session
  • Dynamic redirection, which allows you to dynamically route inbound clicks based on their query string values

Hardware IDs

Tapstream campaign links can collect any industry-standard mobile device hardware identifier, and use the hardware ID to make conversion decisions.

The following parameters can be added in the query string of your campaign links:

Query string keyUse
__tshardware-wifi-mac[-md5|-sha1]The raw, MD5 hash, or SHA-1 hash of the device's WiFi MAC
__tshardware-ios-idfa[-md5|-sha1]The raw, MD5 hash, or SHA-1 hash of an iOS device's IDFA
__tshardware-android-advertising-id[-md5|-sha1]The raw, MD5 hash, or SHA-1 hash of an Android device's Google Advertising ID
__tshardware-android-android-id[-md5|-sha1]The raw, MD5 hash, or SHA-1 hash of an Android device's Android ID
__tshardware-android-device-id[-md5|-sha1]The raw, MD5 hash, or SHA-1 hash of an Android device's IMEI or MEID

Other reserved IDs

Tapstream also reserves the following IDs:

KeyDescription
__tspackage-name The advertised app's bundle ID or package name. Used for restricting conversions to installs of a particular target app.
__tsip The end user device's string-form IP address. Used for server-to-server (asynchronous) click tracking.
__tsredirect Set this to 0 to have Tapstream return a 200 OK response to your campaign link instead of a redirect. Used for server-to-server (asynchronous) click tracking.
__tsid A Tapstream session. Used for cross-device tracking, among other flows. Only respected if __tsoverride is set to 1.
__tsoverride Set to 1 to tell Tapstream to respect the value of the __tsid key.
__tstest Set to any value to tell Tapstream to ignore previous hit sessions. Useful for simulating conversions repeatedly on the same device.