For Apps

Installing Trackingplan in Your Apps

Important Considerations Before Getting Started

iOS SDK

Installing Trackingplan’s iOS SDK using Swift Package Manager

1. In Xcode, add the Trackingplan dependency by navigating to File -> Swift Packages -> Add Package Dependency...

2. If you’re asked to choose a project, select the project you want to add Trackingplan to. If not, proceed to step 3.

3. When choosing a package repository, copy and paste https://github.com/trackingplan/trackingplan-ios into the search box and click Next.

4. Now, choose Version and leave the default selection for the latest version or customize if needed. To install previous versions of Trackingplan, you can manually complete this field with the appropriate version information.

5. Check the box next to Trackingplan and click Finish.

6. Verify that the Trackingplan library has been added to the Swift Package Dependencies section.

7. Then, in your application delegate’s - application(_:didFinishLaunchingWithOptions:) method, set up the SDK like so:
Copy

//
//  AppDelegate.swift
//  ...

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        // Override point for customization after application launch.
        
        // Initialize Trackingplan SDK
        TrackingPlan.initialize(tpId: "#YourTrackingplanId")
        
        return true
}

8. Finally, import the SDK using the following command:
Copy

//
//  AppDelegate.swift
//  ...

import TrackingPlan

Installing iOS SDK with Cocoapods

1. First, add the Trackingplan dependency to your Podfile, like so:

pod 'Trackingplan', :git => 'https://github.com/trackingplan/trackingplan-ios.git'

2. In your application delegate’s - application(_:didFinishLaunchingWithOptions:) method, set up the SDK like so:

//
//  AppDelegate.swift
//  ...

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        // Override point for customization after application launch.
        
        // Initialize Trackingplan SDK
        TrackingPlan.initialize(tpId: "#YourTrackingplanId")
        
        return true
}

3. Import the SDK with this command:

//
//  AppDelegate.swift
//  ...

import TrackingPlan

Installing iOS SDK in a Flutter project

• Move to the iOS folder inside your Flutter project folder. {project_name}/ios/
• Initialise Cocoapods: $ pod init : this will create the Podfile.

• Open the Podfile, uncomment, and set the platform and version at the top.
• platform : ios, '13.0.0'
• Add a line for the Trackingplan pod inside the target block:
• pod 'Trackingplan', :git => 'https://github.com/trackingplan/trackingplan-ios.git'
• Make sure that use_frameworks! is in place to disable dynamic frameworks

platform :ios, '13.0.0'

...

target 'Runner' do
  use_frameworks!
    # Pods for Runner
  pod 'Trackingplan', :git => 'https://github.com/trackingplan/trackingplan-ios.git'
end

• Move to the ios folder path {project_name}/ios/ and run the command $ pod install

target 'Runner' do
  use_frameworks!
  use_modular_headers!
  pod 'Trackingplan', :git => 'https://github.com/trackingplan/trackingplan-ios.git'
  flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__))
end

• Include Pods files in debug and release config:
• Edit the file {project_name}/ios/Flutter/Debug.xcconfig and add at the end:

#include "Pods/Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig”

• Edit the file {project_name}/ios/Flutter/Release.xcconfig and add at the end:

#include "Pods/Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig" #include "Pods/Target Support Files/Pods-Runner/Pods-Runner.profile.xcconfig"

• Update AppDelegate.swift in {project_name}/ios/Runner/
• Import tracking plan at the top

• Initialise tracking plan with the identifier provided inside the didFinishLaunchingWithOptions

Set up Tags in iOS SDK

// Initialize Trackingplan SDK
Trackingplan.initialize(
		tpId: "YOUR_TP_ID".
		tags: [
			// "app_version": "1.0.0", Omitted, this is automatically set
			"lang": "en",
			"country": "us"
	]
)

Android SDK

Installing Trackingplan’s Android SDK using Android Studio

1. First, add the Trackingplan dependency. To do this, expand the Gradle Scripts section.

2. Then, select the project-level build.gradle file and add com.trackingplan.client:adapter:1.7.0 as a classpath dependency to the dependencies section:
Copy

dependencies {   
    // ...
    classpath "com.trackingplan.client:adapter:1.7.0"
    // ...
}

3. After that, select the module-level build.gradle file and modify it as indicated below:
• Add id 'com.trackingplan.client' to the plugins section.
Copy

plugins {
    // ...
    id 'com.trackingplan.client'
    // ...
}

• Add implementation 'com.trackingplan.client:sdk:1.7.0' to the dependencies section.
Copy

dependencies {
    // ...
    implementation 'com.trackingplan.client:sdk:1.7.0'
    // ...
}

4. Next, in the onCreate method of your Application's Main Activity, set up the SDK like so:
Copy

Trackingplan.init("YOUR_TP_ID").start(this)

5. Then import the SDK with the following command:
Copy

import com.trackingplan.client.sdk.Trackingplan;

Installing Android SDK in a Flutter project

dependencies {   
    // ...
    classpath "com.trackingplan.client:adapter:1.3.0"
    // ...
}

• Add implementation 'com.trackingplan.client:sdk:1.3.0' to the dependencies section of the android/app/build.gradle file.

dependencies {
    // ...
    implementation 'com.trackingplan.client:sdk:1.3.0'// ...
}

• Apply com.trackingplan.client plugin in your android/app/build.gradle file.

apply plugin: 'com.android.application'
apply plugin: 'com.trackingplan.client' // <-- Trackingplan Plugin

Trackingplan.init("YOUR_TP_ID").start(this)

import com.trackingplan.client.sdk.Trackingplan;

Advanced Options

Trackingplan.init("YOUR_TP_ID")
    .environment("development")
    .sourceAlias("Android app")
//  .tags(new HashMap<>(){{
//      put("tag1", "value1");
//  }})
//  .customDomains(new HashMap<>(){{
//      put("my.domain.com", "myanalytics");
//  }})
//  .enableDebug()
//  .dryRun()
    .start(this)

Trackingplan for Regression Testing

1. Add com.trackingplan.client:junit-tools:1.7.0 as a androidTestImplementation dependency to the dependencies section of your module-level build.gradle file:

dependencies {
    // ...
    androidTestImplementation "com.trackingplan.client:junit-tools:1.7.0"// ...
}

2. Import the TrackingplanJUnit:

import com.trackingplan.client.junit.TrackingplanJUnit;

3. In each JUnit file, add the imported rule to your instrumented test code:

@Rule
public TrackingplanRule trackingplanRule =
    TrackingplanJUnit.init("YOUR_TP_ID", "YOUR_ENVIRONMENT")
            .tags(new HashMap<>() {{
                put("test_title", "My test");
                put("test_session_name", "My session");
            }})
            //.dryRun()
            .newRule();

@get:Rule
val trackingplanRule = TrackingplanJUnit.init("YOUR_TP_ID", "YOUR_ENVIRONMENT")
    .tags(mapOf(
        "test_title" to "My Test",
        "test_session_name" to "My Session"
    ))
    //.dryRun()
    .newRule()

← Previous

Webhooks

Next →

Post-Install Warm-Up