Set up Firefly
Firefly is an ad network integrated with Adjust. Our integration lets Firefly receive attribution and in-app event data through automated callbacks.
In this article, learn how to set up measurement with Firefly for your app. This includes activating the integration, creating a campaign link, and choosing what data Adjust can share with Firefly.
Before you begin
Requirements
- Admin, Editor, or Custom Editor permissions in Adjust.
- Adjust SDK v4.0.0 and later to map SDK parameters to Firefly 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
Firefly Account Id
- For help finding your credentials, contact your Firefly representative.
Select Firefly and your app in Campaign Lab
- Under Campaign Lab, select Partners.
- Select New partner > Firefly. 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 Firefly.
- Select Next.
Enable data sharing
Enable data sharing to activate the integration with Firefly. To enable data sharing:
- Enter your Firefly Account Id.
Once you enable data sharing with Firefly, Adjust automatically sends Firefly the following data, by default:
- install
- uninstall
- reinstall
- reattribution
- event
- rejectedInstall
- rejectedReattribution
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 Firefly by default.
- install
- uninstall
- reinstall
- reattribution
- event
- rejectedInstall
- rejectedReattribution
Send additional data
Choose the amount and type of data that you want to share with Firefly through callbacks. Firefly 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 Firefly:
- Data from all attribution sources
- Only data attributed to Firefly
Ad spend
Ad spend sharing lets Firefly receive user ad spend data. This lets Firefly use ad spend data to optimize your campaigns.
Adjust sends Firefly the ad spend data received through callbacks only. This data comes from the following solutions that you’ve set up, as applicable for Firefly:
If Firefly wants complete ad spend data, then you can set up Ad spend third-party storage exports for Firefly.
This feature is available with Adjust’s SpendWorks package. To purchase our SpendWorks package, contact your sales representative.
Uninstalls or reinstalls
Sharing uninstalls or reinstalls lets Firefly receive your app’s uninstall and/or reinstall data measured by Adjust.
For iOS apps, you might expect a low record of uninstalls and/or reinstalls. For more information, visit Uninstall and reinstall measurement.
Map events
Map events that you want to share to the values that Firefly can receive. Data for unmapped events is not shared with Firefly.
Map individual events
If you have a multi-platform app, you can choose to share different events per platform with Firefly. 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 Firefly.
- Select Map event.
- In the Adjust event list, choose the Adjust event that you want to share with Firefly.
- Under Partner event, you need to select the Firefly 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 Firefly will receive in-app event data for each of your linked events.
Map all events
If Firefly supports mapping all events automatically, under Map events, select Map all events. This saves time in mapping individual events.
Now Firefly will receive in-app event data for all your linked events.
Configure your link and settings
You have the option to set your:
Create your link and share it with Firefly
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 Firefly.
Once you’ve created your link, share it with Firefly for placement in campaigns.
List of all parameters forwarded to Firefly
Firefly requires Adjust to send the following parameters (data points) with your callbacks:
| Placeholder | Information |
{adid} | Adjust device ID (all platforms) |
{city} | Device city |
{cost_amount} | Cost of the user engagement (available for ad spend tracking only) |
{cost_currency} | ISO 4217 currency code of the cost data (available for ad spend tracking only) |
{cost_type} | The campaign pricing model (available for ad spend tracking only) |
{country_subdivision} | Device subdivision of country, e.g., state |
{country} | Device two-character country code |
{device_name} | Device model number |
{device_type} | Device type |
{fire_adid} | Fire OS advertising identifier |
{gps_adid} | Google Play Store advertising ID |
{idfa||android_id} | IDFA, or Android ID if IDFA is empty |
{idfv} | Uppercase iOS ID for vendors |
{ip_address} | Device IP address |
{language} | Device two-character language code |
{os_name} | Device operating system |
{os_version} | Operating system version number |
{postal_code} | Device postal code of IP address |
{region} | Device region code |
{user_agent} | Incoming raw user agent |
{win_udid} | Windows Phone unique device ID |
{activity_kind} | Type of user activity |
{app_id} | Store App ID or Google Play Store |
{app_name} | Name of the app |
{app_version} | App version number (Android), build-version-number for the bundle (iOS) |
{campaign_name} | Campaign name, as taken from the tracker |
{created_at} | Activity timestamp |
{device_manufacturer} | Device manufacturer name |
{installed_at} | Install (i.e., first app open) timestamp |
{tracker_name} | Current tracker name |