AppsFlyerXamarinBinding 6.9.3-beta1

Xamarin iOS Binding

Xamarin Binding integration guide For iOS

AppsFlyer Xamarin Binding version v6.9.2 <br> Built with AppsFlyer iOS SDK v6.9.2

❗ v6 Breaking Changes

We have renamed some of the APIs. For more details, please check out our Help Center

Overview

AppsFlyer SDK provides app installation and event logging functionality. We have developed an SDK that is highly robust (7+ billion SDK installations to date), secure, lightweight and very simple to embed.

You can measure installs, updates and sessions and also log additional in-app events beyond app installs (including in-app purchases, game levels, etc.) to evaluate ROI and user engagement levels.

AppsFlyer’s Xamarin binding provides application installation and events logging functionality.

The API for the binding coincides with the native iOS API, which can be found here.

Table of content

• Nuget
• Quick Start
• API Methods
  • SDK Initialization
  • Logging In-App Events
  • Get Conversion Data
  • Stop
• Sample App

Nuget

Install-Package AppsFlyerXamarinBinding <br> https://www.nuget.org/packages/AppsFlyerXamarinBinding

Quick Start

Adding the Plugin to your Project

1. Go to Project > Add NuGet Packages...
2. Select the AppsFlyerXamarinBinding
3. Select under version -  6.9.2
4. Click `Add Package`

To Embed SDK into your Application Manually:

1. Copy AppsFlyerXamarinBinding.dll into your project.
2. On Xamarin Studio go to References and click on Edit References.
3. Go to .Net Assembly tab and click on Browse… button.
4. Locate AppsFlyerXamarinBinding.dll and chose it.

API Methods

SDK Initialization

Go to your AppDelegate.cs and add:

1. using AppsFlyerXamarinBinding; at the top of the file.

2. Add the following code to the FinishedLaunching() method:

public override bool FinishedLaunching(UIApplication application, NSDictionary launchOptions)
{           
    AppsFlyerLib.Shared.AppleAppID = "<APP_ID>";
    AppsFlyerLib.Shared.AppsFlyerDevKey = "<YOUR_DEV_KEY>";
    /* AppsFlyerLib.Shared.Delegate = af_delegate; */
    /* AppsFlyerLib.Shared.IsDebug = true; */
  

    return true;
}

3. Add the following code in the OnActivated method:

public override void OnActivated(UIApplication application)
{
    AppsFlyerLib.Shared.Start();
}

Logging In-App Events

Logging in-app events is performed by calling LogEvent with event name and value parameters. See In-App Events documentation for more details.

Event Example:

var addToCartEvent = new NSDictionary(AFEventParameter.AFEventParamContentId, "id 1",
                                      AFEventParameter.AFEventParamContentType, "type 1", 
                                      AFEventParameter.AFEventParamCurrency, "USD", 
                                      AFEventParameter.AFEventParamDescription, "description");

AppsFlyerLib.Shared.LogEvent(AFEventName.AFEventAddToCart, addToCartEvent);

Get Conversion Data

First add to the class-level declarations:

AppsFlyerLibDelegate af_delegate = new AppsFlyerConversionDataDelegate();

Then set up the delegate in FinishedLaunching:

AppsFlyerLib.Shared.Delegate = af_delegate;

AppsFlyerConversionDataDelegate.cs can be found here:

public class AppsFlyerConversionDataDelegate : AppsFlyerLibDelegate
{
    public override void OnAppOpenAttribution(NSDictionary attributionData)
    {
        Console.WriteLine("deeplink data in xamarin = " + attributionData.Description);
    }
    
    public override void OnAppOpenAttributionFailure(NSError error) { }
    
    public override void OnConversionDataSuccess(NSDictionary conversionInfo)
    {
        Console.WriteLine("conversion data in xamarin = " + installData.Description);
    }
    
    public override void OnConversionDataFail(NSError error) { }
}

Opt-Out

For complete opt out of the SDK use the following method call

AppsFlyerLib.Shared.IsStopped = true;

This will prevent any data from being sent out of the AppsFlyer SDK.

User invite

Allowing your existing users to invite their friends and contacts as new users to your app can be a key growth factor for your app. AppsFlyer allows you to attribute and record new installs originating from user invites within your app. Set the OneLink ID, before calling Start().

AppsFlyerLib.Shared.AppInviteOneLinkID = "<OneLinKID>";

AppsFlyerXamarinBinding.AppsFlyerShareInviteHelper.generateInviteUrlWithLinkGenerator ((linkGenerator) => {
        linkGenerator.setChannel ("channel_name");
        linkGenerator.setReferrerName ("ref_name");
        return linkGenerator;
    }, completionHandler: (NSURL) => {
        Console.WriteLine (NSURL);
    }
);

Sample App

Sample apps for xamarin.ios10 and net6.0-ios can be found here:

XamariniOSBinding/samples

In order for us to provide optimal support, we would kindly ask you to submit any issues to support@appsflyer.com.

When submitting an issue please specify your AppsFlyer sign-up (account) email, your app ID, production steps, logs, code snippets and any additional relevant information.