Integrate AppsFlyer with Unity

Activate the Unity Ads integration in the AppsFlyer dashboard, enable full data-sharing, map events, and set partner permissions.

Read time 5 minutes

Last updated 16 days ago

Important

The following documentation discusses products or services (“Third-party Products”) not developed, owned, or operated by Unity. This information might be outdated or incomplete and is provided for your convenience. Your use of any Third-party Product is subject to its own terms. Unity makes no warranties regarding these products and isn't liable for any damages or losses arising from their use, including issues related to content, advertising, or materials from Third-party providers.

Set up AppsFlyer as your Mobile Measurement Partner (MMP) for Unity User Acquisition campaigns. Integration includes the following setup tasks:

Activate Unity Ads in the AppsFlyer dashboard.
Configure general integration settings.
Configure data-sharing settings and map post-install events.
Set partner permissions.

For the most up-to-date AppsFlyer integration information, consult the AppsFlyer Help Center.

Prerequisites

Before setup, ensure you meet the following requirements:

Add at least one app in the Unity User Acquisition dashboard.
Retrieve your Game ID from the User Acquisition dashboard.
Download the latest version of the AppsFlyer SDK.

Integrate Unity with AppsFlyer

Complete the following steps to integrate AppsFlyer with your User Acquisition campaign:

Activate Unity Ads in the AppsFlyer dashboard

To activate Unity Ads in the AppsFlyer dashboard, follow these steps:

In the AppsFlyer dashboard, go to Collaborate > Partner Marketplace.
Search for Unity Ads and select Set up integration to open in the Integration tab.
Activate the Activate Partner toggle.
Some advertisers might have an Advanced Privacy toggle in the Integration tab. If your dashboard contains this toggle, ensure that you deactivate it.

Important

If the Advanced Privacy toggle is activated in your integration setup, AppsFlyer can't share any event data with your campaign.

The Advanced Privacy toggle in the AppsFlyer integration setup. — Deactivate the Advanced Privacy toggle

Configure general integration settings

In the Integration tab, configure both the General settings and Install attribution sections as follows:

General settings

Configure the General settings section as follows:

Activate the Share organic/non-organic indication toggle.

The Share organic/non-organic toggle in the AppsFlyer integration setup. — Share organic and non-organic

Enter your Unity Game ID.

Note

Enter your Game ID exactly as shown in the User Acquisition dashboard. Mismatched Game IDs prevent Unity from receiving events correctly.

Install attribution

Configure the Install attribution section as follows:

Set the Install engaged click-through lookback window interval to Days.
Use the slider to set the lookback window length to 2 days.
Activate the Install view-through attribution toggle.
Set the Install engaged view-through lookback window interval to Days.
Use the slider to set the lookback window length to 7 days.

The click-through lookback window slider in the AppsFlyer Integration tab. — Set attribution lookback windows

In the Integration tab, configure the following data-sharing settings:

Default postbacks

In the Default postbacks section, use the for users from dropdown to select All media sources, including organic for Install events.

Map events

In the Integration tab > In-app event postbacks section, map AppsFlyer events to Unity events.You can map any in-app event you set up in the AppsFlyer dashboard. Refer to AppsFlyer's In-app events documentation for a list of AppsFlyer event names.

Important

Ensure that your AppsFlyer event name matches the event identifiers in your app's code exactly. If you incorrectly map an event, your campaign ignores the data.

Refer to the following example of correct event mapping:

AppsFlyer event	mapped to partner event	for users from	including
`af_purchase`	`purchase`	All media sources, including organic	Values & revenue
`milestone_event_name`	`level_complete`	All media sources, including organic	Values & revenue
`af_app_opened`	`session`	All media sources, including organic	Values & no revenue

The AppsFlyer event mapping table. — Map events to Unity event names

Ensure that you make the following selections:

For all events, select All media sources, including organic in the for users from dropdown.
For Level Complete and Purchase events, select Values & revenue from the including dropdown.
For Session events, select Values & no revenue from the including dropdown.

Enable ad revenue data

Important

To access the AppsFlyer Revenue Settings menu and share ad revenue data with Unity, you need an AppsFlyer ROI360 subscription. Refer to the Ad revenue attribution documentation in the AppsFlyer Help Center for details and instructions.

To share ad revenue event data with your campaign, follow these steps:

Go to the Ad revenue tab of your AppsFlyer integration setup.
Activate the Get ad revenue data toggle.

The Get ad revenue toggle in the AppsFlyer integration setup. — Enable Ad revenue

From the AppsFlyer dashboard side menu, go to Settings > Revenue Settings.
In the Ad revenue tab of the Revenue settings page, select New ad revenue integration.
Select Unity Ads from the list of revenue partners.
In the partner configuration, select Impression-level (via SDK) with Device-level (via S2S API) as the report type.

The ad revenue setup in the AppsFlyer dashboard. — Send impression-level and device-level reports

Enter your API credentials. Enter your Game ID in the App Key field. To retrieve your Secret key from the Unity dashboard, refer to the following steps:
To retrieve your Secret key from the Unity Dashboard, follow these steps:

From the left navigation menu, go to API Management.

Select Advertising Management API > Service account.

Retrieve secret keys from your Advertising Management Service account

If you don't have a service account, select + New. If you have a service account already, select it from the table.

In the service account page, go to the Keys section.

Select + Add key to generate a new key.

Select the copy buttons following the Secret key to copy the ID.
Go back to the Integration tab of the AppsFlyer dashboard.
In the In-app event postbacks section, map Ad Revenue events to
```
ad_revenue
```
. Refer to the following example of correct ad revenue mapping:

AppsFlyer event	mapped to partner event	for users from	including
`af_ad_revenue`	`ad_revenue`	All media sources, including organic	Values & revenue

Set partner permissions

In the Permissions tab, configure the following permissions settings:

Activate the Toggle Ad Network Permissions toggle to enable all other toggles.
Activate the following toggles:

Configure integration
Configure in-app event postbacks
Access retention report
Access aggregate conversions and in-app event data
Access aggregate revenue data
View validation rules
Access Protect360 dashboard and raw data
Access ad revenue raw data (UA signals)

For descriptions of each permission, refer to the Permissions tab documentation in the AppsFlyer Help Center.

Documentation

Development

User Acquisition

Monetization

Industry

Documentation

Development

User Acquisition

Monetization

Industry

User Acquisition

Advertising Management API

Advertising Statistics API

User Acquisition

Integrate AppsFlyer with Unity

Prerequisites

Integrate Unity with AppsFlyer