Attribution link parameters reference

Define attribution link parameters for Unity Ads campaigns by specifying values within your tracking URLs.

Read time 3 minutes

Last updated a day ago

Attribution links allow you to pass engagement data from your app's servers to your Unit Ads User Acquisition campaigns. Refer to the following requirements for these attribution tracking links. For instructions on how to retrieve attribution links, refer to the Partner integration documentation for your preferred partner or the Custom integration documentation.

URL requirements

Ensure that your attribution tracking links meet with the following requirements:

Use HTTPS for the URL and redirects.
Include the
```
{ifa}
```
dynamic custom token. Refer to the Dynamic custom tokens below for more information.
Use HTTP 3XX redirect codes. Don't use HTML or JavaScript redirects.
Don't redirect URLs to the Apple App Store or the Google Play Store.

If your MMP doesn't support HTTPS, contact Unity for assistance.

Dynamic custom URL tokens

Unity supports the following dynamically replaced tokens in attribution tracking URLs:

Token	Description	Example	Notes
`{ifa}` (iOS)	The iOS Identifier for Advertising (IDFA) in plain text in its original uppercase form.	`1234ABCD-1234-5678-ABCD-1A2B3C4D5E6F`
`{ifa}` (Android)	The Google Advertising ID in its original lowercase form. This will replace the Android ID as the primary identification method on Android. During the transition phase, both identifiers need to run in parallel.	`1234abcd-1234-5678-abcd-1a2b3c4d5e6f`
`{ifa_md5}` (iOS)	The iOS Identifier for Advertising (IDFA) MD5-hashed from its original uppercase form.	`9dd6df49d764d6ada0b250a6376d7b44`
`{ifa_md5}` (Android)	The Google Advertising ID MD5-hashed from its original lowercase form.	`9a6a0a84bd8003a97a2109f6c4`
`{android_id_md5}`	The MD5 hashed Android ID of the Android devices, in MD5 hashed form. This should only be used when the Google Advertising ID `{ifa}` is not available, such as instances when Google Play Services is not installed on the Android device.	MD5 `12345678ABCDEFGH` = `5756ae9022b2ea1e47d84fead75220c8`
`{mmp}`	The name of your Mobile Measurement Partner.	`appsflyer` `adjust` `branch` `tenjin` `singular`
`{platform}`	The platform where the install occurred.	`ios` `android`
`{ip}`	The IP address of the end-user.	`123.123.123.123`	This is provided for informational purposes only, and is not suitable for user identification in install tracking.
`{organic}`	A flag denoting whether this install is attributed to organic traffic. Refer to the following values for the flag: `organic=1` indicates that the install is not attributed to any ads from any ad network, Unity Ads or otherwise. `organic=0` indicates that the install is attributed to an ad network.	`organic=1` (true) `organic=0` (false)
`{country_code}`	The user's ISO 3166-1 alpha-2 country code in upper case.	`GB`	`GB` indicates the United Kingdom of Great Britain and Northern Ireland.
`{campaign_id}`	The Unity Ads campaign ID.	`12345678abcdefgh9012ijkl`
`{campaign_name}`	The Unity Ads campaign name.	`my_ad_campaign`
`{game_id}`	The Unity Ads Game ID of the advertised game.	`1234567`
`{gamer_id}`	The unique Unity Ads identifier mandatory for attributing users that have Limited Ad Tracking (LAT) on, where the value of the advertising identifier is `00000000-0000-0000-0000-000000000000` . If the gamer ID is not found in this case, you will receive a malformed error, response code 400.	`Malformed` or `missing input data`
`{source_app_id}`	The universal source identifier of the app showing the ad. This is a case-sensitive alphanumeric string.	`9g74cAw7WM1L`	Prior to migration in May 2020, this was represented by `source_game_id` .
`{source_game_id}`	This field is deprecated as of May 2020. The `{source_app_id}` token replaces `{source_game_id}` .	`7654321`	`{source_app_id}` replaces this token.
`{os}`	The operating system of the end-user's device.	`9.2.1` (iOS) `4.4.0` (Android)
`{device_type}`	The end-user's device type.	`iPad4,1` `motorola XT1254` `samsung SM-G900F`
`{creative_pack}`	The name of the creative pack used in the ad.	`Video Creatives Pack - EN - 15s`
`{creative_pack_id}`	The unique identifier for the creative pack used in the ad.	`5beafbce74ed83001acb258c`
`{language}`	The end-user's device language.	`en-GB`
`{user_agent}`	The end-user's device user agent.	`Mozilla/5.0` (iPhone; CPU iPhone OS 9_3_5 like Mac OS X) `AppleWebKit/601.1.46` (KHTML, like Gecko) `Mobile/13G36` (iOS) `Mozilla/5.0` (Linux; Android 6.0.1; SM-G920V Build/MMB29K) `AppleWebKit/537.36` (KHTML, like Gecko) `Chrome/52.0.2743.98 Mobile Safari/537.36` (Android)
`{device_make}`	The end-user's device make.	`Apple` (iOS) `samsung` (Android)
`{device_model}`	The end-user's device model.	`iPhone7,2` (iOS) `SM-G900F` (Android)
`{is_skadnetwork_supported}`	The SKAdNetwork support status.	`true` or empty.	This field is only available for iOS devices.
`{video_orientation}`	The orientation of the creative shown in the ad.	`portrait` `landscape`
`{screen_size}`	The screen size based on device targeting.	`small` `normal` `large` `xlarge`	This field is only available for Android devices.
`{screen_density}`	The screen density based on device targeting.	`ldpi` `mdpi` `hdpi` `xhdpi` `xxhdpi` `xxxhdpi`	This field is only available for Android devices.

Documentation

Development

User Acquisition

Monetization

Industry

Documentation

Development

User Acquisition

Monetization

Industry

Unity Ads User Acquisition

Advertising Management API

Advertising Statistics API

Unity Ads User Acquisition

Attribution link parameters reference

URL requirements

Dynamic custom URL tokens

Token

Description

Example

Notes