MAUI SDK integration guide

The Adjust MAUI SDK enables you to measure attribution, events, and much more in your Flutter app. Follow the steps in this guide to set up your app to work with the Adjust SDK. You can also check out the example app on GitHub.

1. Get the Adjust SDK

The most straightforward way to install the Adjust SDK is via the NuGet Package Manager. Alternatively, you can add the Adjust SDK as a project reference.

Install NuGet package

There are several ways to install packages using NuGet, depending on your environment and preferences. Whether you use the Package Manager UI, Package Manager Console, .NET CLI, or Visual Studio Code, you can choose the method that works best for you.

Use the NuGet package manager to install the Adjust MAUI SDK into your app.

Once installed, your project file should include the following:

1
<PackageReference Include="Adjust.Maui.Sdk" Version="5.1.0" />

Since the Adjust SDK supports only Android and iOS, if your project targets additional platforms — such as macOS — you’ll need to conditionally include the SDK for supported targets using an ItemGroup, like this:

1
<ItemGroup Condition="$(TargetFramework.StartsWith('net8.0-android')) Or $(TargetFramework.StartsWith('net8.0-ios'))">
2
   <PackageReference Include="Adjust.Maui.Sdk" Version="5.1.0" />
3
</ItemGroup>

Add as a project reference

If you prefer to add the Adjust SDK as a project reference instead of using the NuGet package, you can replace the package identifier with the path to the Adjust SDK project:

1
<ProjectReference Include="..\maui_sdk\AdjustSdk\AdjustSdk.csproj" />

There is also an alternative project reference that has been found to work well with projects migrated from Xamarin which are using .NET for iOS / Android. You can include it as follows:

1
<ProjectReference Include="..\maui_sdk\AdjustSdk\AdjustSdk-NonMaui.csproj" />

You can find the latest version of the Adjust MAUI SDK project in its GitHub repository.

2. Set up Android devices

Add Google Play Services

Apps that target the Google Play Store must use the Google Advertising ID (gps_adid) to identify devices.

Following the same procedure used to integrate the Adjust SDK via NuGet, install the required Microsoft package that provides the necessary bindings.

Once installed, your project file should include the following entry:

1
<PackageReference Include="Xamarin.GooglePlayServices.Ads.Identifier" Version="118.2.0.1" />

Add permissions

AndroidManifest.xml file where you can add permissions is usually located in the Platforms/Android directory of your app.

The Adjust SDK requires certain permissions to access information.

• INTERNET: Added automatically by the Adjust SDK. You don’t need to add it manually.

You can also add optional permissions that allow you to access additional information.

• ACCESS_NETWORK_STATE (Optional): You can add this to your AndroidManifest.xml file to read certain parameters that might be useful for you.

1
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

The Adjust SDK includes the com.google.android.gms.AD_ID permission by default. You can remove it by adding a remove directive if need to make your app COPPA-compliant or if you don’t target the Google Play Store.

1
<uses-permission android:name="com.google.android.gms.permission.AD_ID"/>

Set up install referrer

The install referrer is a unique identifier that helps attribute an app install to its source. The Adjust SDK relies on this information to perform accurate attribution. This data can be obtained using the Google Play Referrer API.

Following the same procedure used to integrate the Adjust SDK via NuGet, install the required Microsoft package that provides the necessary bindings.

Once installed, your project file should include the following:

1
<PackageReference Include="Xamarin.Google.Android.InstallReferrer" Version="2.2.0.2" />

Collect App Set Identifier

The App Set Identifier is a unique identifier that allows you to measure data across any of your apps installed on a user’s device. All apps published by the same developer share the same App Set ID, enabling you to gain meaningful insights from users across your app portfolio.

To access a device’s App Set ID, install the corresponding Microsoft package that provides the required bindings.

Once installed, your project file should include the following:

1
<PackageReference Include="Xamarin.GooglePlayServices.AppSet" Version="116.1.0.4" />

3. Set up iOS devices

iOS frameworks

The Adjust SDK automatically weakly links the following frameworks on iOS devices:

If you prefer not to weakly link any of these frameworks with your iOS app, you can add the Adjust SDK as a project reference. Then, you can either remove all the frameworks — or only specific ones — by modifying the AdjustSdk.iOSBinding.csproj file. To remove all weak frameworks, delete the following line:

1
<WeakFrameworks>AdSupport AdServices AppTrackingTransparency StoreKit</WeakFrameworks>

4. Initialize the Adjust SDK

Make sure you initialize the Adjust SDK as soon as possible in your app. To do this, initialize your config object with your app token and the environment you want to run your application in.

In case you are planning to initialize the SDK in platform-specific files, you can do this inside of:

• Platforms/Android/MainApplication.cs file for Android
• Platforms/iOS/AppDelegate.cs file for iOS
• your MainPage.xaml.cs file if you want to initialize it in the code that runs on both platforms

1
using AdjustSdk;
2
using Android.App;
3
using Android.Runtime;
4

5
namespace ExampleApp;
6

7
[Application]
8
public class MainApplication : MauiApplication
9
{
10
    public MainApplication(IntPtr handle, JniHandleOwnership ownership)
11
        : base(handle, ownership)
12
    {
13
    }
14

15
    protected override MauiApp CreateMauiApp() => MauiProgram.CreateMauiApp();
16

17
    public override void OnCreate()
18
    {
19
        base.OnCreate();
20

21
        // Initialize Adjust SDK
22
        var adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox);
23
        Adjust.InitSdk(adjustConfig);
24
    }
25
}

1
using AdjustSdk;
2
using Foundation;
3
using UIKit;
4

5
namespace ExampleApp;
6

7
[Register("AppDelegate")]
8
public class AppDelegate : MauiUIApplicationDelegate
9
{
10
    protected override MauiApp CreateMauiApp() => MauiProgram.CreateMauiApp();
11
}
12

13
public override bool FinishedLaunching(UIApplication application, NSDictionary launchOptions)
14
{
15
    // Initialize Adjust SDK
16
    var adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox);
17
    Adjust.InitSdk(adjustConfig);
18

19
    // Always call base to ensure MAUI initialization continues
20
    return base.FinishedLaunching(application, launchOptions);
21
}

1
namespace ExampleApp;
2

3
using AdjustSdk;
4

5
public partial class MainPage : ContentPage
6
{
7
    int count = 0;
8

9
    public MainPage()
10
    {
11
        InitializeComponent();
12

13
#if ANDROID || IOS
14
        // Initialize Adjust SDK
15
        var adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox);
16
        Adjust.InitSdk(adjustConfig);
17
#endif
18
    }
19
}

5. Build your app

Well done! You should now be able to build and run your app. Enable logging to check for any issues. Check your logs to see the Install tracked message.

You are ready to start attributing your users with the Adjust SDK.