Set up Unity Ads

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

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

Before you begin

Requirements

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

Credentials

GAME ID

  • For help finding your credentials, contact your Unity Ads representative.

Select Unity Ads and your app in Campaign Lab

  1. Under Campaign Lab, select Partners.
  2. Select New partner > Unity Ads. Select Next to move to the next screen.
  3. In the App selection screen, choose the app for which you want to create the link, and enable the integration to share data with Unity Ads.
  4. Select Next.

Enable data sharing

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

  1. Enter your GAME ID.

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

  • install
  • session
  • reattribution
  • 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:

  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 Unity Ads by default.

  • install
  • session
  • reattribution
  • event
  • rejectedInstall

Send additional data

Choose the amount and type of data that you want to share with Unity Ads through callbacks. Unity Ads may use this information to optimize performance.

  1. Under What sources of data do you want to share?, choose the attribution source of the data you are sharing with Unity Ads:
  • Data from all attribution sources
  • Only data attributed to Unity Ads

Ad revenue (from ad views)

Ad revenue sharing lets Unity Ads receive user ad revenue data. This lets Unity Ads use ad revenue data to optimize your user targeting and campaigns.

Growth solution:

This feature is available with Adjust’s Ad Revenue package. To purchase our Ad Revenue package, contact your sales representative.

To share ad revenue to Unity Ads, select one or more Ad Revenue Sources.

  • If you leave this field empty, we send ad revenue data from all integrated mediation sources.

Sessions

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

In-app revenue (from in-app purchases)

Sharing in-app revenue lets Unity Ads 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 Unity Ads can receive. Data for unmapped events is not shared with Unity Ads.

Map individual events

If you have a multi-platform app, you can choose to share different events per platform with Unity Ads. 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 Unity Ads.

  1. Select Map event.
  2. In the Adjust event list, choose the Adjust event that you want to share with Unity Ads.
  3. Under Partner event, you need to select the Unity Ads event that corresponds to the Adjust event.
    1. 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.
    2. In the Partner event list, choose or enter a custom event name, that you want to map the Adjust event to.
  4. Select Apply.

Now Unity Ads will receive in-app event data for each of your linked events.

Map all events

If Unity Ads supports mapping all events automatically, under Map events, select Map all events. This saves time in mapping individual events.

Now Unity Ads will receive in-app event data for all your linked events.

Map subscription events

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

If you have a multi-platform app, you can choose to share different events per platform with your network. This lets you:

  • Set individual events to manage campaign strategies for each platform.
  • Customize data sharing per platform.

Under Map subscription events, follow these steps to choose the subscription events you want to directly send to your network.

  1. Select Map event.
  2. In the Adjust event list, choose the Adjust event that you want to share with your network.
  3. Under Partner event, you need to select the partner event that corresponds to the Adjust event.
    1. 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.
    2. In the Partner event list, choose or enter a custom event name that you want to map the Adjust event to.
  4. Select Apply.

Now your network will receive subscription event data for each of your linked events.

Subscription events - No revenue

Subscription events - Positive revenue

Map parameters

You usually need to map parameters to share custom data with Unity Ads.

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

  1. Set up partner parameters within the Adjust SDK.
  2. Under Set your data sharing options, select Parameters.
  3. Under Map parameters, you can specify how you want to send partner parameters defined in the SDK to the network:
    1. Select Map parameter.
    2. In the SDK parameter field, enter the name of the SDK parameter you want to share with the network.
    3. In the Partner parameter field, enter the network parameter that corresponds to the SDK parameter.
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 Unity Ads

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 Unity Ads.

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

Partner specific setup instructions

In order to support scenarios with agency accounts, which contain several game_ids from Unity Ads Platform, please follow the instructions below:

If one of the agency game_id is abcde, you can append &unityads_game_id=abcde on the Adjust tracker URL, Adjust will send attributed callback to Unity Ads with game_id: abcde

List of all parameters forwarded to Unity Ads

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

PlaceholderInformation
{android_id_md5}Lowercase Android ID hex MD5 hash
{android_id}Android ID (Android only)
{api_level}API level (Android only)
{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
{ip_address}Device IP address
{is_reattributed}1 if user was reattributed at least once from an earlier source. 0 if user has never been reattributed
{language}Device two-character language code
{match_type}Attribution method
{os_name}Device operating system
{os_version}Operating system version number
{revenue_float}Revenue, as sent from Adjust SDK, in whole currency units
{revenue_usd}Revenue, in US dollars
{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_name_dashboard}Name of the app in the Adjust Dashboard
{app_name}Name of the app
{app_version_raw}App version number (Android), build-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
{created_at}Activity timestamp
{fingerprint_attribution_window}Attribution window settings for device fingerprinting (hours)
{impression_based}1 if impression-based engagement, 0 if not
{is_organic}1 if organic traffic, 0 if non-organic
{rejection_reason}Reason for a rejected attribution
{ad_impressions_count}Number of mobile ads served to end users
{ad_revenue_network}Ad network that displayed the ad
{ad_revenue_unit}Ad unit that generated the revenue
{ad_revenue_placement}User placement, as defined on the platform
{ad_mediation_platform}Mediation platform name
{ad_revenue_payload}Impression-level revenue data (ILRD) as a JSON