Set up Tapjoy
Tapjoy is an ad network integrated with Adjust. Our integration lets Tapjoy receive attribution and in-app event data through automated callbacks.
In this article, learn how to set up measurement with Tapjoy for your app. This includes activating the integration, creating a campaign link, and choosing what data Adjust can share with Tapjoy.
Before you begin
Requirements
- Admin, Editor, or Custom Editor permissions in Adjust.
- Adjust SDK v4.0.0 and later to map SDK parameters to Tapjoy 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
APP ID
- For help finding your credentials, contact your Tapjoy representative.
Select Tapjoy and your app in Campaign Lab
- Under Campaign Lab, select Partners.
- Select New partner > Tapjoy. 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 Tapjoy.
- Select Next.
Enable data sharing
Enable data sharing to activate the integration with Tapjoy. To enable data sharing:
- Enter your APP ID.
Once you enable data sharing with Tapjoy, Adjust automatically sends Tapjoy 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 Tapjoy by default.
- install
- session
- event
- rejectedInstall
Send additional data
Choose the amount and type of data that you want to share with Tapjoy through callbacks. Tapjoy may use this information to optimize performance.
- Under What sources of data do you want to share?, choose the attribution source of the data you are sharing with Tapjoy:
- Data from all attribution sources
- Only data attributed to Tapjoy
Sessions
Adjust does not automatically send session callbacks due to the high volume of sessions. Sharing sessions means Tapjoy will receive your app’s session activity.
In-app revenue (from in-app purchases)
Sharing in-app revenue lets Tapjoy receive revenue amounts along with your revenue event data. You need to map events that generate revenue to share this data.
Map events
Map events that you want to share to the values that Tapjoy can receive. Data for unmapped events is not shared with Tapjoy.
Map individual events
If you have a multi-platform app, you can choose to share different events per platform with Tapjoy. This lets you:
- Set individual events to manage campaign strategies for each platform.
- Customize data sharing per platform.
Under Map events, follow these steps to choose the in-app events you want to directly send to Tapjoy.
- Select Map event.
- In the Adjust event list, choose the Adjust event that you want to share with Tapjoy.
- Under Partner event, you need to select the Tapjoy event that corresponds to the Adjust event.
- For single platform apps and multi-platform apps with data sharing enabled for a single platform only, you map events for that platform only. For multi-platform apps with data sharing enabled for multiple platforms, you can:
- Select Use platform-specific mapping to map separate events at the platform-level or to not map events for certain platforms.
- Select Use global mapping to map the same events for all platforms.
- In the Partner event list, choose or enter a custom event name, that you want to map the Adjust event to.
- For single platform apps and multi-platform apps with data sharing enabled for a single platform only, you map events for that platform only. For multi-platform apps with data sharing enabled for multiple platforms, you can:
- Select Apply.
Now Tapjoy will receive in-app event data for each of your linked events.
Map all events
If Tapjoy supports mapping all events automatically, under Map events, select Map all events. This saves time in mapping individual events.
Now Tapjoy will receive in-app event data for all your linked events.
Map parameters
You usually need to map parameters to share custom data with Tapjoy.
Partner parameters (available in Adjust SDK version 4.0+) let Adjust collect custom data points from your app and send them to Tapjoy. This lets Tapjoy 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 Tapjoy, follow these steps.
- Set up partner parameters within the Adjust SDK.
- Check Before you begin for all SDK development platform links.
- Under Set your data sharing options, select Parameters.
- Under Map parameters, you can specify how you want to send partner parameters defined in the SDK to the network:
- Select Map parameter.
- In the SDK parameter field, enter the name of the SDK parameter you want to share with the network.
- In the Partner parameter field, enter the network parameter that corresponds to the SDK parameter.
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.
Configure your link and settings
You have the option to set your:
Create your link and share it with Tapjoy
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
- Link structure parameters
- User destinations
- Attribution settings
Select Create link to create your click URL, impression URL, QR code and link token. Creating a link also enables data sharing and the integration with Tapjoy.
Once you’ve created your link, share it with Tapjoy for placement in campaigns.
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 |