Enable Aura from Unity (New)

Overview

Aura from Unity connects OEMs and carriers with mobile advertisers to deliver app experiences to users right out of the box. Connect Aura from Unity to Branch to attribute clicks and installs, forward conversion events via postbacks, deep link users into your app, and import cost data.

For more information about integrating ad partners in general, visit our Ad Partner Integration Guide.

Note: this guide is for new Branch

Please note that this guide is about integrating Aura from Unity in the new Branch experience. For information on Aura from Unity in legacy Branch, visit our legacy guide.

Partner capabilities

Before you begin

To set up the Aura from Unity integration, you need:

• Branch's Performance product enabled for your Branch account. Contact your Branch account manager or visit https://branch.io/pricing.

• A Branch account with access to Configuration > Ad Partners and admin permissions to enable and configure integrations.

• The Branch SDK implemented in your app (Android) with event tracking configured.

• An Aura from Unity account with admin access and campaigns running through Aura from Unity.

Enable Aura from Unity

To begin, navigate to Configuration > Ad Partners > Aura from Unity.

Branch enables Aura from Unity's basic setup automatically. On the Status tab, the Ad Linking, Attribution, and Postbacks cards show Enabled. The Clicks and Impressions and Cost Data cards show Needs Setup until those features are configured (see Create a Branch Ad Link and Import cost data).

(Recommended) To configure the optional PAM for Publishers privacy setting, select Partner settings to open the Manage account dialog and enable the toggle. When enabled, PAM for Publishers removes advertiser-specific user identifiers from postbacks for users who haven't opted in via Apple's App Tracking Transparency (ATT) framework, prioritizing identifiers provided directly by Aura from Unity.

Configure attribution

By default, Aura from Unity uses your global app attribution settings. To set attribution windows specific to Aura from Unity, enable the Override global app settings toggle on the Attribution windows tab.

For more information, follow Configure attribution in the general Ad Partner Integration Guide.

Configure postbacks

Enabling Aura from Unity automatically activates postbacks for INSTALL, PURCHASE, OPEN, ACHIEVE_LEVEL, COMPLETE_TUTORIAL, and COMPLETE_REGISTRATION. The default postback URL template is:

https://postback.isappcloud.com/userActivity/custom1?src=branch&token=0b22a777-3b57-4b4a-b850-8402b48d231a&dynamicParameter=${ (last_attributed_touch_data.~click_id)! }&gaid=${ (user_data.aaid)! }&lat=<#if (user_data.limit_ad_tracking)! >1<#else>0</#if>&packageName=<@loop data=app.app_bundles val="bundle"><#if user_data.os == bundle.os><#if bundle.os=="ANDROID">${(bundle.android.package_name)!}<#elseif bundle.os == "IOS">${(bundle.ios.bundle_id)!}</#if><@break/></#if></@loop>&appVersion=${ (user_data.app_version)! }&country=${ (user_data.geo_country_code)! }&region=${(user_data.geo_region_code)!}&city=${(user_data.geo_city_code)!}&ip=${ (user_data.ip)! }&userAgent=${ (user_data.user_agent)! }&attrEventTime=${ (timestamp/1000)?long }&attrClickTime=${(last_attributed_touch_timestamp/1000)?long }&deviceLocale=${ (user_data.language)! }&deviceModel=${ (user_data.model)! }&deviceManufacturer=${(user_data.brand)!}&canClaim=<#if (last_attributed_touch_data.$3p)! == (ad_network.machine_name)!>1<#else>0</#if>&isViewThrough=<#if last_attributed_touch_type == "CLICK">0<#elseif last_attributed_touch_type == "IMPRESSION">1</#if>&osVersion=${ (user_data.os_version)! }&campaignID=${ (last_attributed_touch_data.~campaign_id)! }&campaignName=${ (last_attributed_touch_data.~campaign)! }&PublisherId=${(last_attributed_touch_data.~secondary_publisher_id)!}&customerID=${ (last_attributed_touch_data.~channel)! }&amount=${ (event_data.revenue)! }&currency=${ (event_data.currency)! }&itemName=<@urlencode><@jsonmap data=content_items></@jsonmap></@urlencode>&trackingCompanySDKVersion=${(user_data.sdk_version)!}

To add postbacks for additional events or to customize postback behavior, follow Configure postbacks in the general Ad Partner Integration Guide.

Import cost data

Aura from Unity cost ingestion uses API authentication with an Authorization Token. Contact your Aura from Unity account manager to obtain this value.

In Branch, locate the Cost Data card on the Status tab and select it (it displays a Needs Setup badge) to open the Enable Cost Data dialog. Enter your Authorization Token, then select Save. You can also set this credential from the Manage account dialog by selecting Partner settings. After saving, the Cost Data card on the Status tab updates to reflect the connected state.

Create a Branch Ad Link

Create a Branch Ad Link to use in your Aura from Unity campaigns. Branch uses the link to attribute clicks and impressions and deep link users into your app. Placing the Branch Ad Link in your Aura from Unity campaign will resolve the Clicks and Impressions: Needs Setup status on the Status tab.

Follow Create a Branch Ad Link in the general Ad Partner Integration Guide.

Verify your data

After your integration is connected and events are flowing, you can verify data is reaching Branch and Aura from Unity:

• In Branch Liveview: confirm that events from your app appear in real time. This is the fastest way to confirm SDK events are firing.

• In Branch Analysis dashboards: review attributed installs and events where Ad Partner Name = Aura from Unity. Cost data appears in cost-reporting views once ingestion is active. Allow up to 24 hours after setup for the first cost data to be pulled in.

• In Aura from Unity: confirm that forwarded events are appearing in your Aura from Unity attribution reporting.

Data mappings

Campaign data

Branch populates the following fields from Aura from Unity campaign data.