Set up TrafficGuard
TrafficGuard is an analytics network integrated with Adjust. Our integration lets TrafficGuard receive attribution and in-app event data through automated callbacks. Use this data with the partners' tools for analytics and insights.
In this article, learn how to set up measurement with TrafficGuard for your app. This includes activating the integration and choosing what data Adjust can share with TrafficGuard.
Before you begin
Requirements
- Admin, Editor, or Custom Editor permissions in Adjust.
- Adjust SDK v4.0.0 and later to map SDK parameters to TrafficGuard parameters. Follow the guides linked below to use this feature.
iOS / Android / Windows / Unity / React Native / Flutter / Adobe Air / Cordova / Marmalade / Xamarin / Cocos2d-x / Titanium / Corona
Credentials
IDENTIFIER and MEASUREMENT API KEY
- For help finding your credentials, contact your TrafficGuard representative.
Select TrafficGuard and your app in Campaign Lab
- Under Campaign Lab, select Partners.
- Select New partner > TrafficGuard. Select Next to move to the next screen.
- In the App selection screen, choose the app for which you want to create the link, and enable the integration to share data with TrafficGuard.
- Select Next.
Enable data sharing
Enable data sharing to activate the integration with TrafficGuard. To enable data sharing:
- Enter your IDENTIFIER and MEASUREMENT API KEY.
Once you enable data sharing with TrafficGuard, Adjust automatically sends TrafficGuard the following data, by default:
- install
- session
- event
- rejectedInstall
Set your data sharing options
If you’re working with a multi-platform app with data sharing enabled for multiple platforms, you can:
- Separate data sharing options at the platform-level by selecting Use platform-specific settings.
- Set the same data sharing settings for multiple platforms by selecting Use global settings.
Now, under What will be shared by default?, review the activities that Adjust shares with TrafficGuard by default:
- install
- session
- event
- rejectedInstall
Send additional data
Choose the amount and type of data that you want to share with TrafficGuard through callbacks. TrafficGuard may use this information to optimize performance.
To send additional data, you can review and customize the following:
In-app revenue (from in-app purchases)
Sharing in-app revenue lets TrafficGuard receive revenue amounts along with your revenue event data. You need to map events that generate revenue to share this data.
Sessions
Adjust does not automatically send session callbacks due to the high volume of sessions. Sharing sessions means TrafficGuard will receive your app’s session activity.
Map parameters
You usually need to map parameters to share custom data with TrafficGuard.
Map events
Map events that you want to share to the values that TrafficGuard can receive. Data for unmapped events is not shared with TrafficGuard.
Under Map events, follow these steps to choose the in-app events you want to directly send to TrafficGuard.
- Select Map event.
- In the Adjust event list, choose the Adjust event that you want to share with TrafficGuard.
- In the Partner event list, choose or enter a custom event name that you want to map the Adjust event to. You might have to map an event to several values.
- Select Apply.
Now TrafficGuard will receive in-app event data for each of your linked events.
Map parameters
Partner parameters (available in Adjust SDK version 4.0+) let Adjust collect custom data points from your app and send them to TrafficGuard. This lets TrafficGuard receive custom event details for each of your linked events.
Before adding new partner parameters to the Adjust SDK, make sure no pre-existing partner parameters already fit your requirements.
To share partner parameters to TrafficGuard, follow these steps.
- Set up partner parameters within the Adjust SDK: iOS, Android
- Check the Parameters data sharing checkbox.
- Map your events.
If you set up partner parameters within the Adjust SDK without setting up parameter sharing in the dashboard, Adjust forwards the parameters as named in the Adjust SDK.
Enable TrafficGuard for your app
In the Setup review screen, you can review your choices. You can also go back and make changes to:
- Your selected app
- Data sharing options
Select Enable partner to enable TrafficGuard for your app. Analytics partners don't work with links for campaigns. Once enabled, our integration sends attribution and in-app event data via automated callbacks.
List of all parameters forwarded to TrafficGuard
TrafficGuard requires Adjust to send the following parameters (data points) with your callbacks:
| Placeholder | Information |
{api_level} | API level (Android only) |
{city} | Device city |
{click_attribution_window} | Attribution window settings for device matching (hours) |
{country_subdivision} | Device subdivision of country, e.g., state |
{country} | Device two-character country code |
{currency} | Original ISO 4217 currency code sent from Adjust SDK |
{deeplink} | Deeplink URL appended to click URL |
{device_name} | Device model number |
{device_type} | Device type |
{environment} | Current Adjust SDK environment setting |
{gclid} | Google click ID |
{gps_adid} | Google Play Store advertising ID |
{idfa} | ID for advertisers (iOS only) |
{impression_attribution_window} | Attribution window settings for impression matching (hours) |
{ip_address} | Device IP address |
{is_reattributed} | 1 if user was reattributed at least once from an earlier source. 0 if user has never been reattributed |
{language} | Device two-character language code |
{last_time_spent} | Length of user's last session, in seconds |
{lifetime_session_count} | Number of sessions recorded across entire user lifetime |
{match_type} | Attribution method |
{nonce} | Random lowercase alphanumeric string (unique per callback) |
{os_name} | Device operating system |
{os_version} | Operating system version number |
{partner_parameters} | Custom partner parameters collected by the Adjust SDK or S2S request and transmitted to third party providers via postbacks |
{postal_code} | Device postal code of IP address |
{random_user_id} | Random user ID (per device) |
{random} | Random number (unique per callback) |
{referrer} | Google Play Store referrer (Android only) |
{region} | Device region code |
{reporting_currency} | Dashboard reporting ISO 4217 currency code |
{reporting_revenue} | Revenue, as reported in the Adjust Dashboard, in whole currency units |
{revenue_float} | Revenue, as sent from Adjust SDK, in whole currency units |
{revenue_usd_cents} | Revenue, in US cents |
{revenue_usd} | Revenue, in US dollars |
{revenue} | Revenue, as sent from Adjust SDK in cents |
{sdk_version} | Adjust SDK version (per app) |
{search_term} | Google organic search term |
{session_count} | Number of sessions recorded by current Adjust SDK |
{time_spent} | Length of user's current session, in seconds |
{timezone} | Device time zone |
{tracking_enabled} | 1 if tracking is enabled, 0 if not |
{tracking_limited} | 1 if tracking is limited, 0 if not |
{user_agent} | Incoming raw user agent |
{activity_kind} | Type of user activity |
{adgroup_name} | Adgroup name, as taken from the tracker |
{app_id} | Store App ID or Google Play Store |
{app_name} | Name of the app |
{app_version_raw} | App version number (Android), build-version-number for the bundle (iOS) |
{app_version_short} | App version number (Android), release-version-number for the bundle (iOS) |
{app_version} | App version number (Android), build-version-number for the bundle (iOS) |
{campaign_name} | Campaign name, as taken from the tracker |
{click_time_hour} | Attributed click timestamp, rounded to the nearest hour |
{click_time} | Attributed click timestamp |
{connection_type} | Internet connection type |
{conversion_duration} | Time between click and install or reattribution in seconds |
{cpu_type} | CPU type |
{created_at_hour} | Activity timestamp, rounded down to the nearest hour |
{created_at_milli} | Activity timestamp with millisecond placeholders |
{created_at} | Activity timestamp |
{creative_name} | Creative name, as taken from the tracker |
{engagement_time_hour} | Engagement timestamp rounded to the nearest hour |
{engagement_time} | Engagement timestamp |
{impression_based} | 1 if impression-based engagement, 0 if not |
{impression_time_hour} | Attributed impression timestamp, rounded to the nearest hour |
{impression_time} | Attributed impression timestamp |
{install_begin_time} | App download began timestamp (Android and Google Play Store only) |
{install_finish_time} | App download completion timestamp |
{installed_at_hour} | Install (i.e., first app open) timestamp rounded to the nearest hour |
{installed_at} | Install (i.e., first app open) timestamp |
{is_organic} | 1 if organic traffic, 0 if non-organic |
{network_name} | Network name, as taken from the tracker |
{reattributed_at_hour} | Reattribution timestamp, rounded to the nearest hour |
{reattributed_at} | Reattribution timestamp |
{referral_time} | User landed on app Play Store page timestamp (Android and Google Play Store only) |
{rejection_reason} | Reason for a rejected attribution |
{tracker_name} | Current tracker name |
{tracker} | 6-character Adjust tracker token |
{google_ads_adgroup_id} | Google Ads adgroup ID |
{google_ads_campaign_id} | Google Ads campaign ID |
{google_ads_campaign_name} | Google Ads campaign name |
{google_ads_campaign_type} | Google Ads campaign type |
{google_ads_creative_id} | Google Ads creative ID |
{google_ads_keyword} | Google Ads search keyword |
{google_ads_matchtype} | Google Ads search keyword and match type |
{google_ads_network_subtype} | Google Ads network subtype |
{google_ads_placement} | Google Ads ad placement |
{google_ads_video_id} | Google Ads video ID |
{att_status} | App Tracking Transparency Status. Possible values are 0 (Not determined), 1 (Restricted), 2 (Denied), 3 (Authorized), unknown |
{third_party_tracking_disabled} | 1 if third party sharing is disabled, 0 if not |