Contents

segment-integrations/analytics-swift-appsflyer

Add AppsFlyer device mode support to your applications via this plugin for [Analytics-Swift](https://github.com/segmentio/analytics-swift)

Adding the dependency

Note: the AppsFlyer library itself will be installed as an additional dependency.

via Xcode

In the Xcode File menu, click Add Packages. You'll see a dialog where you can search for Swift packages. In the search field, enter the URL to this repo.

https://github.com/segment-integrations/analytics-swift-appsflyer

You'll then have the option to pin to a version, or specific branch, as well as which project in your workspace to add it to. Once you've made your selections, click the Add Package button.

via Package.swift

Open your Package.swift file and add the following do your the dependencies section:

.package(
            name: "Segment",
            url: "https://github.com/segment-integrations/analytics-swift-appsflyer.git",
            from: "1.1.3"
        ),

Note the AppsFlyer library itself will be installed as an additional dependency.

Using the Plugin in your App

Open the file where you setup and configure the Analytics-Swift library. Add this plugin to the list of imports.

import Segment
import SegmentAppsFlyer // <-- Add this line

Just under your Analytics-Swift library setup, call analytics.add(plugin: ...) to add an instance of the plugin to the Analytics timeline.

let analytics = Analytics(configuration: Configuration(writeKey: "<YOUR WRITE KEY>")
                    .flushAt(3)
                    .trackApplicationLifecycleEvents(true))
analytics.add(plugin: AppsFlyerDestination())

Your events will now begin to flow to AppsFlyer in device mode.

Appsflyer SDK documentation

Please go here to see the Appsflyer Native iOS documentation here

<a id="manual"> Manual mode

We support a manual mode to seperate the initialization of the AppsFlyer SDK and the start of the SDK. In this case, the AppsFlyer SDK won't start automatically, giving the developer more freedom when to start the AppsFlyer SDK. Please note that in manual mode, the developper is required to implement the API `startAppsflyerSDK()` in order to start the SDK. <br>If you are using CMP to collect consent data this feature is needed. See explanation here.

Example:

swift
struct NewAnalyticsAppsflyerIntegrationApp: App {
    static var analytics: Analytics? = nil
    static var appsflyerDest: AppsFlyerDestination!
    init() {
        self.requestTrackingAuthorization()
        NewAnalyticsAppsflyerIntegrationApp.analytics = Analytics(configuration: Configuration(writeKey: "<WRITE_KEY>")
                            .flushAt(3)
                            .trackApplicationLifecycleEvents(true)
                            )
        AppsFlyerLib.shared().isDebug = true
//        AppsFlyerLib.shared().waitForATTUserAuthorization(timeoutInterval: 60)
        NewAnalyticsAppsflyerIntegrationApp.appsflyerDest = AppsFlyerDestination(segDelegate: sfdelegate, segDLDelegate: sfdelegate, manualMode: true)
        NewAnalyticsAppsflyerIntegrationApp.analytics?.add(plugin: NewAnalyticsAppsflyerIntegrationApp.appsflyerDest)
    }
...

To start the AppsFlyer SDK, use the startAppsflyerSDK() API, like the following :

swift
// check cmp response or check manually for the User's response.
// if decided to start the Appsflyer SDK manually do it like here:
NewAnalyticsAppsflyerIntegrationApp.appsflyerDest.startAppsflyerSDK()

<a id="getconversiondata"> Get Conversion Data

In order for Conversion Data to be sent to Segment, make sure you have enabled "Track Attribution Data" and specified App ID in AppsFlyer destination settings:

[image]

<a id="gcd-swift"> Swift

In order to get Conversion Data you need to:

1. Create a class applies the AppsFlyerLibDelegate delgeate 2. Pass the initialized class to the AppsflyerDestination 3. Implement methods of the protocol in the class, passed as a delegate. See sample code below where AppDelegate is used for that:

```swift struct NewAnalyticsAppsflyerIntegrationApp: App { static var afDelegate: AFDelgate! // Add strong reference to delegate

init() { ... NewAnalyticsAppsflyerIntegrationApp.afDelegate = AFDelgate()

NewAnalyticsAppsflyerIntegrationApp.analytics = Analytics(configuration: Configuration(writeKey: "<WRITE_KEY>") .flushAt(3) .trackApplicationLifecycleEvents(true) )

AppsFlyerLib.shared().isDebug = true

// Use the stored delegate NewAnalyticsAppsflyerIntegrationApp.appsflyerDest = AppsFlyerDestination( segDelegate: NewAnalyticsAppsflyerIntegrationApp.afDelegate, segDLDelegate: nil ) NewAnalyticsAppsflyerIntegrationApp.analytics?.add(plugin: NewAnalyticsAppsflyerIntegrationApp.appsflyerDest) } ... ... class AFDelgate: NSObject, AppsFlyerLibDelegate{ func onConversionDataSuccess(_ conversionInfo: [AnyHashable : Any]) { print("moris testing onConversionDataSuccess") }

func onConversionDataFail(_ error: any Error) { print("moris testing onConversionDataFail") } } ```

<a id="DDL"> Unified Deep linking

<a id="ddl-swift"> Swift

In order to use Unified Deep linking you need to:

1. Create a class applies the DeepLinkDelegate delgeate 2. Pass the initialized class to the AppsflyerDestination ``swift let factoryWithDelegate: SEGAppsFlyerIntegrationFactory = SEGAppsFlyerIntegrationFactory.create(withLaunch: self, andDeepLinkDelegate: self) ``

3. Implement methods of the protocol in the class, passed as a delegate. See sample code below where AppDelegate is used for that:

```swift struct NewAnalyticsAppsflyerIntegrationApp: App { static var afDelegate: AFDelgate! // Add strong reference to delegate

init() { ... NewAnalyticsAppsflyerIntegrationApp.afDelegate = AFDelgate()

NewAnalyticsAppsflyerIntegrationApp.analytics = Analytics(configuration: Configuration(writeKey: "<WRITE_KEY>") .flushAt(3) .trackApplicationLifecycleEvents(true) )

AppsFlyerLib.shared().isDebug = true

// Use the stored delegate NewAnalyticsAppsflyerIntegrationApp.appsflyerDest = AppsFlyerDestination( segDelegate: nil, segDLDelegate: NewAnalyticsAppsflyerIntegrationApp.afDelegate ) NewAnalyticsAppsflyerIntegrationApp.analytics?.add(plugin: NewAnalyticsAppsflyerIntegrationApp.appsflyerDest) } ... ... class AFDelgate: NSObject, DeepLinkDelegate{ func didResolveDeepLink(_ result: DeepLinkResult) { print("Deep Link: \(result)") } } ```

<a id="usage"> Usage

First of all, you must provide values for AppsFlyer Dev Key, Apple App ID (iTunes) and client secret in Segment's dashboard for AppsFlyer integration

Support

Please use Github issues, Pull Requests, or feel free to reach out to our support team.

Integrating with Segment

Interested in integrating your service with us? Check out our Partners page for more details.

License

MIT License

Copyright (c) 2021 Segment

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Package Metadata

Repository: segment-integrations/analytics-swift-appsflyer

Default branch: main

README: README.md