We constantly publish updates to our documentation, which may not yet be available in your language. For the most current information, use the English version.

for Marketers

Set up Herolens

Herolens is an ad network integrated with Adjust. Our integration lets Herolens receive attribution and in-app event data through automated callbacks.

In this article, learn how to set up measurement with Herolens for your app. This includes activating the integration, creating a campaign link, and choosing what data Adjust can share with Herolens.

Before you begin

Requirements

Admin, Editor, or Custom Editor permissions in Adjust.
Adjust SDK v4.0.0 and later to map SDK parameters to Herolens 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

ACCOUNT ID

For help finding your credentials, contact your Herolens representative.

Select Herolens and your app in Campaign Lab

Under Campaign Lab, select Partners.
Select New partner > Herolens. 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 Herolens.
Select Next.

Enable data sharing

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

Enter your ACCOUNT ID.

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

install
session
reattribution
event

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 Herolens by default.

install
session
reattribution
event

Send additional data

Choose the amount and type of data that you want to share with Herolens through callbacks. Herolens 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 Herolens:

Data from all attribution sources
Only data attributed to Herolens

Sessions

Adjust does not automatically send session callbacks due to the high volume of sessions. Sharing sessions means Herolens will receive your app’s session activity.

Map parameters

You usually need to map parameters to share custom data with Herolens.

Map events

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

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

Select Map event.
In the Adjust event list, choose the Adjust event that you want to share with Herolens.
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 Herolens will receive in-app event data for each of your linked events.

Partner parameters (available in Adjust SDK version 4.0+) let Adjust collect custom data points from your app and send them to Herolens. This lets Herolens 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 Herolens, follow these steps.

Set up partner parameters within the Adjust SDK: iOS, Android
Check the Parameters data sharing checkbox.
Map your events.

Note:

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 Herolens

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 Herolens.

Once you’ve created your link, share it with Herolens for placement in campaigns.

List of all parameters forwarded to Herolens

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

Placeholder	Information
`{country}`	Device two-character country code
`{idfa\|\|gps_adid}`	IDFA, or GPS ADID if IDFA is empty
`{partner_parameters}`	Custom partner parameters collected by the Adjust SDK or S2S request and transmitted to third party providers via postbacks
`{win_adid}`	Windows advertising identifier
`{adgroup_name}`	Adgroup name, as taken from the tracker
`{campaign_name}`	Campaign name, as taken from the tracker
`{creative_name}`	Creative name, as taken from the tracker
`{network_name}`	Network name, as taken from the tracker