Set up Tapjoy
Tapjoy is a network and Adjust module partner. Our integration lets Tapjoy receive attribution and in-app event data through automated callbacks.
Use our basic setup instructions to turn on Adjust’s integration and send callbacks to Tapjoy. Then, use our advanced setup instructions to customize what information Tapjoy receives.
Basic setup
To turn on Adjust’s integration with Tapjoy, follow these steps.
- Find your app and select your app options caret (^)
- Select Partner Setup > ADD PARTNERS
- Select the add (+) icon next to Tapjoy
- Enter your APP ID (for help finding this, contact your Tapjoy representative)
- Optional: see advanced setup to customize your callbacks
- Select Save
Well done! Basic setup is complete. Now you can create an Adjust tracker URL and submit it to Tapjoy to launch your campaign.
Tapjoy will receive callbacks for these activities:
- install
- session
- event
- rejectedInstall
Advanced setup
Choose which data Tapjoy receives from Adjust by customizing your setup.
Only forward data attributed to Tapjoy
Adjust sends Tapjoy your installs and reattributions across all ad platforms.
To stop Tapjoy from receiving data attributed to other ad platforms, follow these steps.
- Find your app and select your app options caret (^)
- Select Partner Setup > Tapjoy
- Turn on Attributed Only
Now Tapjoy will only receive data attributed to their own platform.
Forward in-app revenue
In-app revenue forwarding lets Tapjoy receive revenue amounts along with your revenue event data.
To forward in-app revenue to Tapjoy, follow these steps.
- Find your app and select your app options caret (^)
- Select Partner Setup > Tapjoy
- Turn on In-App Revenue Forwarding
Now Tapjoy will receive the revenue amount for every tracked transaction.
Note: Link at least one revenue event to Tapjoy before turning on In-App Revenue Forwarding.
Forward sessions
Adjust does not automatically send session callbacks due to the high volume of sessions.
To forward in-app sessions to Tapjoy, follow these steps.
- Find your app and select your app options caret (^)
- Select Partner Setup > Tapjoy
- Turn on Session Forwarding
Now Tapjoy will receive your app’s session activity.
Forward custom data
Partner parameters (available in Adjust SDK version 4.0+) let Adjust collect custom data points from your app and send them to Tapjoy.
Note: Before adding new partner parameters to the Adjust SDK, make sure no pre-existing partner parameters already fit your requirements.
To forward partner parameters to Tapjoy, follow these steps.
- Set up partner parameters within the Adjust SDK (instructions for iOS and Android)
- In the Adjust dashboard, find your app and select your app options caret (^)
- Select Partner Setup > Tapjoy
- Turn on Parameter Forwarding
- Select Partner Parameter Mapping
- In the FROM APP field, enter the name of your Adjust parameter (as written into the Adjust SDK). In the TO PARTNER field, enter your corresponding Tapjoy name.
- Select Save
Now Tapjoy will receive custom event details for each of your linked events.
Note: If you set up partner parameters within the Adjust SDK without turning on Partner Parameter Mapping, Adjust forwards the parameters as named in the Adjust SDK.
Forward in-app events
Event linking lets Tapjoy receive in-app event data. You can link every in-app event in Adjust to a preset Tapjoy name or a custom event name.
To forward in-app events to Tapjoy, follow these steps.
- Find your app and select your app options caret (^)
- Select Partner Setup > Tapjoy > Event Linking
- Find the event you want to link and update the field with a Tapjoy event or your own custom name
- When you finish linking events, select OK
- Select Save
Now Tapjoy will receive in-app event data for each of your linked events.
Partner specific setup instructions
If you would like to send attributed-only traffic to Tapjoy, toggle the relevant switch – note that this toggle applies to all activities sent to Tapjoy.
Please note that Tapjoy App ID and Engagement IDs for event names must have the following format:
- 8 characters followed by a dash followed by three sets of 4 characters delimited by a dash, followed by the final 12 characters.
- All characters must be in hexadecimal.
An example value would look like: c8196876-64ef-4fab-bed6-c9306fe35b05
Additionally, please be aware of that Adjust will not fire any callbacks to Tapjoy when the IDFA is empty, which mainly refers to IOS LAT users where IDFA are all zeros.
List of all parameters forwarded to Tapjoy
Tapjoy requires Adjust to send the following parameters (data points) with your callbacks:
Placeholder | Information |
{adid} | Adjust device ID (all platforms) |
{android_id} | Android ID (Android only) |
{click_attribution_window} | Attribution window settings for device matching (hours) |
{country} | Device two-character country code |
{currency} | Original ISO 4217 currency code sent from Adjust SDK |
{device_name} | Device model number |
{device_type} | Device type |
{idfa||gps_adid} | IDFA, or GPS ADID if IDFA is empty |
{impression_attribution_window} | Attribution window settings for impression matching (hours) |
{ip_address} | Device IP address |
{label} | Value of the Adjust "label" parameter sent on click |
{language} | Device two-character language code |
{mac_sha1} | Uppercase MAC SHA-1 hash |
{match_type} | Attribution method |
{mcc} | Mobile country code: three-digit code identifying a device's country. Use with the mobile network code to identify a device's carrier. |
{mnc} | Mobile network code: two-digit code. Use with the mobile country code to identify a device's carrier. |
{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 |
{revenue} | Revenue, as sent from Adjust SDK in cents |
{sdk_version} | Adjust SDK version (per app) |
{timezone} | Device time zone |
{tracking_limited} | 1 if tracking is limited, 0 if not |
{user_agent} | Incoming raw user agent |
{activity_kind} | Type of user activity |
{app_id} | Store App ID or Google Play Store |
{app_name} | Name of the app |
{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) |
{click_time} | Attributed click timestamp |
{connection_type} | Internet connection type |
{cpu_type} | CPU type |
{created_at} | Activity timestamp |
{hardware_name} | Hardware name |
{impression_based} | 1 if impression-based engagement, 0 if not |
{install_begin_time} | App download began timestamp (Android and Google Play Store only) |
{install_finish_time} | App download completion timestamp |
{referral_time} | User landed on app Play Store page timestamp (Android and Google Play Store only) |
{rejection_reason} | Reason for a rejected attribution |