Troubleshooting - Unity SDK (Deprecated)

Android

Airbridge Unity SDK does not seem to initialize correctly

The Airbridge Unity SDK for Android initializes automatically through Content Provider. For proper initialization, the following XML tag must be correctly placed in “Project → Plugins → Android → AndroidManifest.xml”.

<provider
    android:authorities="${applicationId}.co.ab180.airbridge.unity.AirbridgeContentProvider"
    android:name="co.ab180.airbridge.unity.AirbridgeContentProvider"
    android:exported="false" />

Using your own custom activity class

The Airbridge Unity SDK uses custom activities in “UnityPlayerActivity” to get deep link data. If you are using your own custom activity class, please override the following codes inside your custom activity class.

@Override
protected void onNewIntent(Intent intent) {
  super.onNewIntent(intent);
  setIntent(intent);
}

@Override
protected void onResume() {
  super.onResume();
  AirbridgeUnity.processDeeplinkData(getIntent());
}

The AndroidManifest file does not seem to merge properly

The “AndroidManifest Merger” that the Airbridge Unity SDK provides is a simple component that merges “Project → Plugins → Android → AndroidManifest.xml” and “Project → Plugins → Airbridge → Android → AndroidManifest.xml”. The merge may not satisfy all cases, and you will have to separately merge your “AndroidManifest.xml” file with reference to “Project → Plugins → Airbridge → Android → AndroidManifest.xml”.

Missing 'package' key attribute on element package at ...

Due to the addition of Android 11’s Package Visibility policy, applications should be properly informed by <queries> inside the manifest file about which packages are used in order to properly interact with another applications.The Airbridge SDK is compliant with the policy and requires Gradle v5.6.4+ and Android Gradle Plugin v3.6.0+ to support the <queries> tag.Please refer to this page for information on which version of Gradle is used by Unity.

Unity 2020.1 or later

No further action is required because the necessary Gradle and Android Gradle plugin exists.

Unity 2019.3 to 2019.4

The following customization is supported only on Unity 2019.3 patch 7 and later.

Go to the Gradle Build Tool page and download Gradle v5.6.4 or higher
Go to “Preferences → External Tools” to uncheck “Gradle Installed with Unity (recommended)” and set the path to the downloaded Gradle file as below.

Go to “Project Settings → Player → Android Tab → Publishing Settings → Build” and select the following options:
1. Custom Main Gradle Template
2. Custom Launcher Gradle Template

Please change both of the following auto-generated files as follows
1. Assets/Plugins/Android/mainTemplate.gradle
2. Assets/Plugins/Android/launcherTemplate.gradle

buildscript {
    repositories {
        google()
        jcenter()
    }
    dependencies {
        // Must be Android Gradle Plugin 3.6.0 or later. For a list of
        // compatible Gradle versions refer to:
        // https://developer.android.com/studio/releases/gradle-plugin
        classpath 'com.android.tools.build:gradle:3.6.0'
    }
}
allprojects {
   repositories {
      google()
      jcenter()
      flatDir {
        dirs 'libs'
      }
   }
}

Unity 2019.1 to 2019.2

Go to the Gradle Build Tool page and download Gradle v5.6.4 or higher.
Go to “Preferences → External Tools” to uncheck “Gradle Installed with Unity (recommended)” and set the path to the downloaded Gradle file as below.

Go to “Project Settings → Player → Android Tab → Publishing Settings → Build” and select “Custom Gradle Template”.

Go to the auto generated “Assets/Plugins/Android/MainTemplate.gradle” file and make the following changes.

buildscript {
    dependencies {
        // Must be Android Gradle Plugin 3.6.0 or later. For a list of
        // compatible Gradle versions refer to:
        // https://developer.android.com/studio/releases/gradle-plugin
        classpath 'com.android.tools.build:gradle:3.6.0'
    }
}

Unity 2018.4

The following customization is supported only on Unity 2018.4 patch 24 and later

Go to the Gradle Build Tool page and download Gradle v5.6.4 or higher.
Go to “Build Settings → Android” and set “Build System” to “Gradle” to use a custom version of Gradle.

Go to “Preferences → External Tools”, uncheck “Gradle Installed with Unity (recommended)” and set the path to the downloaded “Gradle” file.

Go to “Project Settings → Player → Android Tab → Publishing Settings → Build” and select the “Custom Gradle Template” option.

Go to the auto generated “Assets/Plugins/Android/MainTemplate.gradle” file and make the following changes.

buildscript {
    dependencies {
        // Must be Android Gradle Plugin 3.6.0 or later. For a list of
        // compatible Gradle versions refer to:
        // https://developer.android.com/studio/releases/gradle-plugin
        classpath 'com.android.tools.build:gradle:3.6.0'
    }
}

Unity 2018.3 or earlier

Gradle customizations are not supported on these versions of Unity and are not compatible with the necessary changes to support Android 11 (API level 30).

Resolve Airbridge SDK backup rules merge conflict issue

Reference : Android SDK Auto Backup

If you are experiencing build errors caused by overlapping of the Airbridge SDK backup rules and third-party SDK backup rules, please refer to the workaround below.e.g) If you have an Airbridge SDK backup rule and an Appsflyer SDK backup rule that overlap, you will see the build error below.

Attribute application@fullBackupContent value=(@xml/appsflyer_backup_rules) from [com.appsflyer:af-android-sdk:6.6.1] AndroidManifest.xml:14:18-73
is also present at [io.airbridge:sdk-android:2.14.0] AndroidManifest.xml:27:18-78 value=(@xml/airbridge_auto_backup_rules).
Suggestion: add 'tools:replace="android:fullBackupContent"' to <application> element at AndroidManifest.xml:7:5-13:19 to override.

To resolve this issue, please set up as follows.

backup_rules.xml setup

Create an Android Library project (Assets/Plugins/Android/res.androidlib) to store your resource files.
Add an AndroidManifest.xml file in the created Android Library Project as follows.

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
          package="custom.android.res"
          android:versionCode="1"
          android:versionName="1.0">
</manifest>

Create a res/xml folder inside the created Android Library Project.
Create a file (e.g. custom_backup_rules.xml) within the created xml folder.
Add the data backup rules defined by the Airbridge SDK as follows.

<?xml version="1.0" encoding="utf-8"?>
<full-backup-content>
    <!-- Airbridge Backup Rules -->
    <exclude domain="sharedpref" path="airbridge-internal" />
    <exclude domain="sharedpref" path="airbridge-install" />
    <exclude domain="sharedpref" path="airbridge-user-info" />
    <exclude domain="sharedpref" path="airbridge-user-alias" />
    <exclude domain="sharedpref" path="airbridge-user-attributes" />
    <exclude domain="sharedpref" path="airbridge-device-alias" />
    <exclude domain="database" path="airbridge.db" />
    <!-- Appsflyer Backup Rules -->
    <exclude domain="sharedpref" path="appsflyer-data"/>

    <!-- Your Custom Backup Rules -->
</full-backup-content>

AndroidManifest.xml setup

Apply the data backup rules to the Android App Manifest file (Assets/Plugins/Android/AndroidManifest.xml) as follows.

<manifest
    ...
    xmlns:tools="http://schemas.android.com/tools">

    <application
        ...
        android:allowBackup="true"
        android:fullBackupContent="@xml/custom_backup_rules"
        tools:replace="android:fullBackupContent">

For more guidance, refer to the articles below.

iOS

[Xcode 27] SceneDelegate Migration Required — Additional Setup Needed for Airbridge Deep Links

AttentionThis troubleshooting guide is for customers who need to migrate an existing AppDelegate-based app to UIScene(SceneDelegate) lifecycle.

Symptoms

When an app built with Xcode 27 is launched, the app may not run properly.
Airbridge deep link events are not collected even when the app is opened through a scheme deep link or Universal Link.
The app does not work even though the code was added to AppDelegateas shown in the Initialize SDK and Collect deep link events in your app developer guide examples.

Cause

Apple is moving the app lifecycle from the UIApplicationDelegate-only AppDelegate model to the UIScene-based SceneDelegate model, and adopting the Scene lifecycle has effectively become required in the latest Xcode and iOS environments.When an app adopts the Scene lifecycle through UIApplicationSceneManifest, the following AppDelegate deep link callbacks are no longer called.

Solution

The required steps depend on the Unity Engine and Airbridge SDK versions. Starting with the Unity Engine versions listed below, Unity generates UnityScene when creating an Xcode project.

Unity versions that support UnityScene

2022.3 LTS	`2022.3.72f1`
6000.0.x (LTS)	`6000.0.75f1`
6000.1.x ~ 6000.3.x	Not supported
6000.4.x	`6000.4.0f1`
6000.5.x	`6000.5.0f1`

Use one of the listed versions or later. If you are using a version that does not support UnityScene, you need to add a separate UIScene.

Versions that do not support UnityScene

In the SceneDelegate file where a UIScene has been added in Unity, call the public deep link interface in AirbridgeUnity.h.

#import "AirbridgeUnity.h"

@implementation MyUnityScene

- (void)scene:(UIScene *)scene willConnectToSession:(UISceneSession *)session options:(UISceneConnectionOptions *)connectionOptions {
    for (UIOpenURLContext *context in connectionOptions.URLContexts) {
        if (context.URL == nil) {
            continue;
        }

        [AirbridgeUnity.deeplink handleURLSchemeDeeplink:context.URL];
    }

    for (NSUserActivity *userActivity in connectionOptions.userActivities) {
        [AirbridgeUnity.deeplink handleUniversalLink:userActivity.webpageURL];
    }
}

- (void)scene:(UIScene *)scene openURLContexts:(NSSet<UIOpenURLContext *> *)URLContexts {
    for (UIOpenURLContext *context in URLContexts) {
        if (context.URL == nil) {
            continue;
        }

        [AirbridgeUnity.deeplink handleURLSchemeDeeplink:context.URL];
    }
}

- (void)scene:(UIScene *)scene continueUserActivity:(NSUserActivity *)userActivity {
    [AirbridgeUnity.deeplink handleUniversalLink:userActivity.webpageURL];
}

@end

Versions that support UnityScene

In the UnityScene file of the Xcode project generated by Unity, call the public deep link interface in AirbridgeUnity.h.

#import "UnityScene.h"
#import "UnityAppController.h"
#import "AirbridgeUnity.h"

@implementation UnityScene

- (void)scene:(UIScene *)scene willConnectToSession:(UISceneSession *)session options:(UISceneConnectionOptions *)connectionOptions {
    for (UIOpenURLContext *context in connectionOptions.URLContexts) {
        if (context.URL == nil) {
            continue;
        }

        [AirbridgeUnity.deeplink handleURLSchemeDeeplink:context.URL];
    }

    for (NSUserActivity *userActivity in connectionOptions.userActivities) {
        [AirbridgeUnity.deeplink handleUniversalLink:userActivity.webpageURL];
    }
}

- (void)scene:(UIScene *)scene openURLContexts:(NSSet<UIOpenURLContext *> *)URLContexts {
    for (UIOpenURLContext *context in URLContexts) {
        if (context.URL == nil) {
            continue;
        }

        [AirbridgeUnity.deeplink handleURLSchemeDeeplink:context.URL];
    }
}

- (void)scene:(UIScene *)scene continueUserActivity:(NSUserActivity *)userActivity {
    [AirbridgeUnity.deeplink handleUniversalLink:userActivity.webpageURL];
}

@end

Using your own custom AppController

Airbridge Unity SDK uses IMPL_APP_CONTROLLER_SUBCLASS to create a custom AppController. If you are using your own custom AppController, add the following code to your custom AppController.

- (BOOL) application:(UIApplication*)application
continueUserActivity:(NSUserActivity*)userActivity
  restorationHandler:(void (^)(NSArray<id<UIUserActivityRestoring>>* _Nullable))restorationHandler
{
    [AUAppDelegate.instance application:application
                   continueUserActivity:userActivity
                     restorationHandler:restorationHandler];

    return YES;
}

Please remove the “Assets → Plugins → Airbridge → iOS → Delegate → AUAppController.mm” file once the above change has been made.

The issue with the app closing instantly upon launch on iOS

Text

Error loading /var/containers/Bundle/Application/…/Frameworks/UnityFramework.framework/UnityFramework (…)
: dlopen(/var/containers/Bundle/Application/…/Frameworks/UnityFramework.framework/UnityFramework, …)
: Library not loaded: @rpath/AirBridge.framework/AirBridge

If you are using Airbridge Unity SDK version 1.14.1 or 1.16.2, Please update to version 1.16.3.

The issue with no compatible version found for AirBridge on iOS

Text

[!] CocoaPods could not find compatible versions for pod "AirBridge":
    In Podfile:
        AirBridge (= {MISSING_VERSION})

If you can’t find a compatible AirBridge version on iOS, execute the command below to update the source repository.

pod repo update
pod install --repo-update

After updating your source repository, run the pod search AirBrdige command to verify that the correct AirBridge version exists in your repository, and then proceed with the iOS build.

​Android

​iOS

Symptoms

Cause

Solution

Unity versions that support UnityScene

Versions that do not support UnityScene

Versions that support UnityScene

Android

iOS