Set up ROI Hunter

ROI Hunter is a SAN campaign manager that manages campaigns for the following self-attributing networks (SANs):

  • Facebook

To run a campaign with a SAN campaign manager, you don't need to create a link. Instead, you need to set up both the SAN whose platform your ads will run on, and the SAN campaign manager who is managing your campaign.

As soon as you start running campaigns with the SAN campaign managers, Adjust shares data for analysis and campaign optimization with both the SAN and SAN campaign manager.

Note:

Meta refers to SAN campaign managers as Preferred Marketing Developers (PMDs).

In this article, learn how to set up measurement with ROI Hunter for your app. This includes activating the integration and choosing what data Adjust can share with ROI Hunter.

Before you begin

Requirements

iOS / Android / Windows / Unity / React Native / Flutter / Adobe Air / Cordova / Marmalade / Xamarin / Cocos2d-x / Titanium / Corona

Credentials

ROI HUNTER ID

  • For help finding your credentials, contact your ROI Hunter representative.

Select ROI Hunter and app in Campaign Lab

  1. Under Campaign Lab, select Partners.
  2. Select New partner > ROI Hunter. Select Next to move to the next screen.
  3. In the App selection screen, choose the app for which you want to set up ROI Hunter.
  4. Select Next.

Enable data sharing

Enable data sharing to activate the integration with ROI Hunter. To enable data sharing:

  1. Enter your ROI HUNTER ID.

Once you enable data sharing with ROI Hunter, Adjust automatically sends ROI Hunter the following data, by default:

  • install
  • session
  • event

Set your data sharing options

If you’re working with a multi-platform app with data sharing enabled for multiple platforms, you can:

  1. Separate data sharing options at the platform-level by selecting Use platform-specific settings.
  2. 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 ROI Hunter by default:

  • install
  • session
  • event

Send additional data

Choose the amount and type of data that you want to share with ROI Hunter through callbacks. ROI Hunter 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 ROI Hunter 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 ROI Hunter will receive your app’s session activity.

Map events

Map events that you want to share to the values that ROI Hunter can receive. Data for unmapped events is not shared with ROI Hunter.

Under Map events, follow these steps to choose the in-app events you want to directly send to ROI Hunter.

  1. Select Map event.
  2. In the Adjust event list, choose the Adjust event that you want to share with ROI Hunter.
  3. 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.
  4. Select Apply.

Now ROI Hunter will receive in-app event data for each of your linked events.

Enable ROI Hunter 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 ROI Hunter for your app. This also enables data sharing, if you've set it up.

Set up your campaign with keyword in the ROI Hunter dashboard

Set up your campaign in the ROI Hunter dashboard. While setting up the campaign, you need to enter a keyword to the campaign name. Keywords are not case-sensitive.

If you do not add the keyword to the campaign name, Adjust cannot identify the campaigns that you're managing through ROI Hunter. This means the SAN still receives data for the campaign, but you can't see which campaigns are managed by ROI Hunter in your reporting and ROI Hunter will not receive any callbacks from Adjust.

Partner specific setup instructions

ROI Hunter only receives data on filtered Facebook traffic. This is designed so that you can manage your ROI Hunter Facebook traffic separately from other Facebook campaigns that you might be running.

Only Facebook campaigns that are named to include the keyword RoiHunter will be transmitted to ROI Hunter. That is, you must include the keyword in the campaign name of each campaign that you want to manage with ROI Hunter. Campaigns that do not include the keyword will not be transmitted to ROI Hunter.

List of all parameters forwarded to ROI Hunter

ROI Hunter requires Adjust to send the following parameters (data points) with your callbacks:

PlaceholderInformation
{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
{environment}Current Adjust SDK environment setting
{fb_adgroup_id}Facebook ad ID
{fb_campaign_group_id}Facebook campaign ID
{fb_campaign_id}Facebook ad set ID
{language}Device two-character language code
{os_name}Device operating system
{os_version}Operating system version number
{random_user_id}Random user ID (per device)
{random}Random number (unique per callback)
{reporting_currency}Dashboard reporting ISO 4217 currency code
{reporting_revenue}Revenue, as reported in the Adjust Dashboard, in whole currency units
{revenue_usd}Revenue, in US dollars
{revenue}Revenue, as sent from Adjust SDK in cents
{time_spent}Length of user's current session, in seconds
{timezone}Device time zone
{tracking_enabled}1 if tracking is enabled, 0 if not
{user_agent}Incoming raw user agent
{app_id}Store App ID or Google Play Store
{app_version}App version number (Android), build-version-number for the bundle (iOS)
{click_time_hour}Attributed click timestamp, rounded to the nearest hour
{impression_based}1 if impression-based engagement, 0 if not
{is_organic}1 if organic traffic, 0 if non-organic
{reattributed_at_hour}Reattribution timestamp, rounded to the nearest hour
{store}Target store of click