Oscore.AppsFlyer.Maui 1.0.0

AppsFlyer.Maui

Professional integration of existing Xamarin binding libraries in a single cross-platform interface according to best practices. This library implements deferred deep linking and extended deferred deep linking without additional configuration.

Usage

• Add NuGet package to your project:

<PackageReference Include="Oscore.AppsFlyer.Maui" Version="1.0.0" />

• Add the following to your MauiProgram.cs CreateMauiApp method:

builder
    .UseMauiApp<App>()
+   .UseAppsFlyer(options =>
+   {
+       options.DeveloperKey = "YOUR_DEVELOPER_KEY"; // Replace with your DevKey
+       options.AppleApplicationId = "YOUR_APPLE_APP_ID"; // Replace with your Apple AppId
+   })
    .ConfigureFonts(fonts =>
    {
        fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
        fonts.AddFont("OpenSans-Semibold.ttf", "OpenSansSemibold");
    });

• iOS: Add "NSUserTrackingUsageDescription" to your Info.plist file:

	<key>NSUserTrackingUsageDescription</key>
	<string>We use this data to improve user experience</string>

• Use the following code to track events:

AppsFlyer.Current.LogEvent(Events.Purchase, new Dictionary<string, string>
{
    [EventParameters.Price] = "2",
    [EventParameters.Currency] = "USD",
    [EventParameters.Quantity] = "1",
    [EventParameters.Description] = "Description",
});

• Use the following code to handle deep links:

AppsFlyer.Current.DeepLinkResolved += (sender, args) =>
{
    Console.WriteLine($"Deep link resolved: {args.Url}");
};

Universal Links

First, you need to set up your app to handle Universal links.
This is a way for your app to be opened by a URL, and potentially receive some data from that URL.
This is useful for things like sharing links to content in your app, or for handling links from marketing campaigns.

// MauiProgram.cs
builder
    .UseMauiApp<App>()
    .UseAppsFlyer()
+   .HandleUniversalLinks() // Only required if you don't use your own Universal link handling
    .ConfigureFonts(fonts =>
    {
        fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
        fonts.AddFont("OpenSans-Semibold.ttf", "OpenSansSemibold");
    });

// App.xaml.cs
public partial class App : Application
{
    private readonly IAppsFlyer _appsFlyer;
    
    public App(IAppsFlyer appsFlyer)
    {
        _appsFlyer = appsFlyer;
        
        InitializeComponent();

		MainPage = new AppShell();
    }
    
    protected override void OnAppLinkRequestReceived(Uri uri)
    {
        base.OnAppLinkRequestReceived(uri);
 
        if (uri.AbsoluteUri.Contains("onelink"))
        {
            _appsFlyer.PerformOnAppAttributionAfterStart(uri);
        }
    }
}

Android

1. Check your .well-known Association file

https://your-project.onelink.me/.well-known/assetlinks.json should contain your app's package name.

2. Setup your Android Activity

You can reuse the Platforms/Android/MainActivity.cs in your MAUI app by adding the following class attribute to it:

[IntentFilter(
    new string[] { Intent.ActionView },
    AutoVerify = true,
    Categories = new[] { Intent.CategoryDefault, Intent.CategoryBrowsable },
    DataScheme = "https",
    DataHost = "your-project.onelink.me")]
[Activity(Exported = true, // other properties...)]

Note that you should use your own data scheme and host values. It's possible to associate multiple schemes/hosts here too.

3. Testing A URL

You can use adb to simulate opening a URL to ensure your app links work correctly:

adb shell am start -a android.intent.action.VIEW -c android.intent.category.BROWSABLE -d "https://your-project.onelink.me/Puun/2togg2t4"

iOS

1. Check your .well-known Association file

https://your-project.onelink.me/.well-known/apple-app-site-association should contain your app's bundle id and the associated domain(s).

2. Add Domain Association Entitlements to your App

You will need to add custom entitlements to your app to declare the associated domain(s).
You can do this either by adding an Entitlements.plist file to your app, or you can simply add the following to your .csproj file in your MAUI app:

<ItemGroup Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'ios' Or $([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'maccatalyst'">

    
    <CustomEntitlements
        Condition="$(Configuration) == 'Debug'"
        Include="com.apple.developer.associated-domains"
        Type="StringArray"
        Value="applinks:your-project.onelink.me?mode=developer" />

    
    <CustomEntitlements
        Condition="$(Configuration) != 'Debug'"
        Include="com.apple.developer.associated-domains"
        Type="StringArray"
        Value="applinks:your-project.onelink.me" />

</ItemGroup>

Be sure to replace the applinks:your-project.onelink.me with the correct value for your own domain.
Also notice the ItemGroup's Condition which only includes the entitlement when the app is built for iOS or MacCatalyst.

3. Testing a URL

Testing on iOS can be a bit more tedious than Android.
It seems many have mixed results with iOS Simulators working (I was not able to get the Simulator working), so a device may be required, but is at least recommended.

Once you've deployed your app to your device, you can test that everything is setup correctly by going to Settings -> Developer and under Universal Links, toggle on Associated Domains Development and then go into Diagnostics.
Here you can enter your URL (in this case https://your-project.onelink.me/Puun/2togg2t4) and if everything is setup correctly you should see a green checkmark with Opens Installed Application and the App ID of your app.

It's also worth noting again that from step 2, if you add the applink entitlement with ?mode=developer to your app, it will bypass Apple's CDN cache when testing/debugging, which is helpful for iterating on your apple-app-site-association json file.

Links

• https://github.com/AppsFlyerSDK/XamariniOSBinding
• https://github.com/AppsFlyerSDK/XamariniOSBinding/blob/master/samples/Sample.NuGet.Xamarin/AppDelegate.cs
• https://github.com/AppsFlyerSDK/XamarinAndroidBinding
• https://github.com/AppsFlyerSDK/appsflyer-MAUI-sample-app
• https://github.com/HavenDV/AppsFlyerSDK.Maui
• https://support.appsflyer.com/hc/en-us/articles/207031996-Registering-test-devices
• https://dev.appsflyer.com/hc/docs/testing-android#creating-an-android-debug-app
• https://dev.appsflyer.com/hc/docs/dl_android_unified_deep_linking
• https://dev.appsflyer.com/hc/docs/dl_android_ocds_ddl
• https://github.com/Redth/MAUI.AppLinks.Sample