# Installing Trackingplan in Your Apps Docs DocsFor Apps [All docs](/docs) Get Started - [Overview](/docs/overview) - [How It Works](/docs/how-it-works) - [Your First Plan](/docs/your-first-plan) - [Post-Install Warm-Up](/docs/post-install-warm-up) - [Multi Account Management](/docs/multi-account-management) Install - [Installing Trackingplan](/docs/installing-trackingplan) - [For Websites](/docs/installing-trackingplan/installing-trackingplan-on-your-websites) - [For Apps](/docs/installing-trackingplan/installing-trackingplan-in-your-apps) - [Webhooks](/docs/installing-trackingplan/installing-trackingplan-using-webhooks) - [For ssGTM](/docs/installing-trackingplan/for-ssgtm) - [Environments](/docs/environments) - [SDK Update](/docs/sdk-update) The Agent - [Threads](/docs/threads) - [Reports](/docs/reports) - [Audits](/docs/audits) Use Cases - [Investigate a Warning](/docs/debug-warnings) - [For Analytics Teams](/docs/analytics-use-cases) - [For Performance & Paid Media](/docs/paid-media-use-cases) - [For Compliance & Legal](/docs/compliance-use-cases) - [For Agencies & Consultancies](/docs/agency-use-cases) Monitoring - [Warnings & Updates](/docs/warning-and-updates) - [Data Validation](/docs/data-validation) - [Data Layer Monitoring](/docs/data-layer-monitoring) - [Consent & Cookie Monitoring](/docs/consent-and-cookie-monitoring) - [Privacy Monitoring](/docs/data-privacy-monitoring) - [Pixel Monitoring](/docs/pixels-presence-monitoring) - [Naming Conventions Monitoring](/docs/naming-conventions-monitoring) - [Releases & GTM Monitoring](/docs/autodiscover-releases) Explore - [Explore](/docs/explore) - [Health Summary](/docs/health-summary) - [Data Explorer](/docs/data-explorer) - [Tracks Explorer](/docs/tracks-explorer) - [Presence Map](/docs/presence-map) - [Advanced Views](/docs/advanced-views) - [Session Finder](/docs/session-finder) - [Filters & Data Segmentation](/docs/attribution) - [Tags](/docs/tags) - [Notes & Labels](/docs/notes-labels) - [Starred Items](/docs/starred-items) - [Sharing](/docs/sharing) Your Trackingplan - [Destinations](/docs/destinations) - [Split Destinations](/docs/split-destinations) - [Events](/docs/events) - [Properties](/docs/properties) - [Attributes](/docs/user-attributes) - [Pages](/docs/pages) - [Compliance](/docs/compliance) - [Privacy](/docs/privacy) - [Consent](/docs/consent) - [Platform](/docs/platform) - [Daily Checks](/docs/daily-checks) - [Vitals](/docs/platform-metrics) - [Acquisition](/docs/acquisition) Connect - [Slack](/docs/slack) - [MCP Endpoint](/docs/mcp-endpoint) - [Ad Platforms](/docs/ad-platforms) - [Trackingplan Exploration API](/docs/trackingplan-exploration-api) - [Trackingplan Export API](/docs/trackingplan-export-api) - [Data Studio Connector](/docs/trackingplan-connector-for-data-studio) - [Chrome Extension](/docs/trackingplans-chrome-extension) - [Omnibug Extension](/docs/trackingplan-omnibug-extension) Account & Security - [Settings & Members](/docs/settings) - [Privacy & Security](/docs/privacy-and-security) - [JSON Export/Import](/docs/export-import-json-schemas) [Install](/docs) Updated July 14, 2026 # Installing Trackingplan in Your Apps Install Trackingplan in your iOS and Android apps with Swift Package Manager, Cocoapods, Android Studio, Flutter or Ionic, step by step. For apps, you install Trackingplan’s iOS SDK, Android SDK or both. > In this section: > > - iOS SDK > - [Installing Trackingplan’s iOS SDK using Swift Package Manager](#installing-trackingplan-s-ios-sdk-using-swift-package-manager) > - [Installing iOS SDK with Cocoapods](#installing-ios-sdk-with-cocoapods) > - [Installing iOS SDK in a Flutter Project](#installing-ios-sdk-in-a-flutter-project) > - [Installing Trackingplan in Ionic for iOS platform](#installing-trackingplan-in-ionic-for-ios-platform) > - [Advanced Options](#advanced-options) > - Android SDK > - [Installing Trackingplan’s Android SDK using Android Studio](#installing-trackingplan-s-android-sdk-using-android-studio) > - [Installing Android SDK in a Flutter project](#installing-android-sdk-in-a-flutter-project) > - [Installing Trackingplan in Ionic for Android platform](#installing-trackingplan-in-ionic-for-android-platform) > - [Advanced Options](#advanced-options) > Throughout these instructions, `X.X.X` stands for the version number, so the page never shows an outdated one. > > **Before installing, check the latest version in our official repositories:** > > - **iOS SDK** → [https://github.com/trackingplan/trackingplan-ios/releases](https://github.com/trackingplan/trackingplan-ios/releases) > - **Android SDK** → [https://github.com/trackingplan/trackingplan-android/releases](https://github.com/trackingplan/trackingplan-android/releases) > - **React Native SDK** → [https://github.com/trackingplan/trackingplan-react-native/releases](https://github.com/trackingplan/trackingplan-react-native/releases) > > The latest version gives you compatibility, stability and the newest features and fixes. ## iOS SDK ### Installing Trackingplan’s iOS SDK using Swift Package Manager With Trackingplan for iOS, you can check your tracking works as planned without changing your analytics stack or your code. Trackingplan monitors the traffic between your app and your data destinations and sends you [warnings](/docs/warning-and-updates) when something changes or breaks in your analytics, such as hit drops, missing properties, rogue events and more. > The recommended way to install Trackingplan for iOS is Swift Package Manager: it makes installing and upgrading Trackingplan simpler. Follow these steps. 1. In Xcode, add the Trackingplan dependency by navigating to **File** -> ** Swift Packages** -> ** Add Package Dependency...** ![](/images/spr-61a47434-Untitled.jpg) 2. If you’re asked to choose a project, select the project you want to add Trackingplan to. If not, proceed to step 3. ![](/images/spr-99bae2c1-Untitled.jpg) 3. When choosing a package repository, copy and paste `https://github.com/trackingplan/trackingplan-ios` into the search box and click **Next**. ![](/images/spr-a7f8202d-Untitled.jpg) 4. Choose `Version` and keep the default, the latest version, or change it if you need to. To install an earlier version of Trackingplan, type that version in this field. > Check the latest version in the official iOS repository: [https://github.com/trackingplan/trackingplan-ios/releases](https://github.com/trackingplan/trackingplan-ios/releases) ![](/images/spr-123fdf9d-Untitled.jpg) 5. Check the box next to Trackingplan and click **Finish**. ![](/images/spr-185d423e-Untitled.jpg) 6. Verify that the Trackingplan library has been added to the Swift Package Dependencies section. ![](/images/spr-54991235-Untitled.jpg) 7. Then, in your application delegate’s - `application(_:didFinishLaunchingWithOptions:)` method, set up the SDK like so: ```javascript // // 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: ```javascript // // AppDelegate.swift // ... import TrackingPlan ``` All set. You have installed the Trackingplan iOS SDK. Now [check that Trackingplan is collecting data correctly](/faqs/how-can-i-validate-trackingplan-is-collecting-data-after-its-installation), so you know it is monitoring and documenting all the customer data you use for analytics, marketing and sales. Questions or problems along the way? [Contact support](mailto:support@trackingplan.com). ### Installing iOS SDK with Cocoapods > Trackingplan also supports **iOS installation using Cocoapods**. Here is how. 1. First, add the Trackingplan dependency to your Podfile, like so: ```javascript 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: ```javascript // // 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: ```javascript // // AppDelegate.swift // ... import TrackingPlan ``` That’s it. Now [check that Trackingplan is collecting data correctly](/faqs/how-can-i-validate-trackingplan-is-collecting-data-after-its-installation). Questions or problems along the way? [Contact support](mailto:support@trackingplan.com). ### Installing iOS SDK in a Flutter project You can manage the Trackingplan iOS dependency with Cocoapods ([https://guides.cocoapods.org/using/getting-started.html#getting-started](https://guides.cocoapods.org/using/getting-started.html#getting-started)) **Your Flutter project is not using Cocoapods yet?** - Move to the iOS folder inside your Flutter project folder. `{project_name}/ios/` - **Initialise Cocoapods**: `$ pod init`: this will create the `Podfile`. **Install:** - Open the `Podfile`, uncomment, and set the platform and version at the top. - `platform : ios, 'X.X.X'` - 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 **Sample Podfile (Project without Cocoapods):** ```ruby platform :ios, 'X.X.X' ... 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` **Sample Podfile (Project already using Cocoapods):** ```ruby 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 ``` **Setup:** - 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 Trackingplan at the top ![](/images/spr-44ee44c1-Captura_de_pantalla_2023-01-05_a_las_10.59.png) - Initialise Trackingplan with the identifier provided inside the `didFinishLaunchingWithOptions` ### Installing Trackingplan in Ionic for iOS platform To use Trackingplan in an Ionic app, you set it up on each platform. It works much like installing Trackingplan in any mobile app. Once that's done, Trackingplan captures and monitors every tracking request from any version of the app. > These instructions are for Capacitor Ionic apps, but they capture data from any analytics and marketing SDK, whether it is Capacitor, Cordova or JS. For Cordova apps without Capacitor, the installation is very similar. 1. Open the **Podfile**, uncomment, and set the platform and version at the top. 2. Add the following lines for the Trackingplan pod inside the target block: ```ruby use_frameworks! use_modular_headers! pod 'Trackingplan', :git => '' ``` 3. Move to the `ios/App` folder and run: ```shell pod install ``` 4. Update **AppDelegate.swift** in `ios/App/App` to import Trackingplan at the top: ```swift import Trackingplan ``` 5. Initialize Trackingplan with the provided Trackingplan ID inside the `didFinishLaunchingWithOptions` function: ```swift Trackingplan.initialize(tpId: "YourTrackingplanId") ``` 6. Run the following commands: ```shell ionic build npx cap sync ios npx cap run ios ``` ### Installing Trackingplan in Ionic for web apps You need this step if your analytics and marketing use JS SDKs instead of native ones (Cordova, Capacitor), or if you publish your app as a website. 1. Add the Trackingplan snippet to your app's index.html. 2. You'll find the snippet in your Trackingplan dashboard. See the instructions [here](/docs/installing-trackingplan/installing-trackingplan-on-your-websites). ### Advanced Options Trackingplan for iOS supports the following `advanced options` during its initialization: | | | | | --- | --- | --- | | **Parameter** | ** Description** | ** Default** | | `enableDebug()` | Enables debug mode. Prints debug information in the console. | `disabled` | | `environment(value)` | Allows to isolate the data between [production and testing environments](/docs/environments). | `PRODUCTION` | | `dryRun()` | Enables dry run mode, which allows you test Trackingplan for Android without actually sending any data to Trackingplan. | `disabled` | | `customDomains(map)` | Allows extending the list of monitored domains. Any request made to these domains will also be forwarded to Trackingplan. The `map argument` must be a `key-value` with the domain to be looked for and the alias you want to use for that analytics domain. Only define a custom domain if your analytics or marketing platform sends data to a non-standard endpoint (for example, a server-side tagging setup or a vendor configured with your own domain). Learn more about [custom domains](/docs/installing-trackingplan/installing-trackingplan-in-your-apps). | `empty map` | | `sourceAlias(value)` | Allows to differentiate between sources. | `android` | | `tags(map)` | Allows to [tag](/docs/tags) the data sent to Trackingplan. The `map argument` must be a `key-value` with the tag name and the tag value. | `empty map` | | `getDataLayer` | Allows you to capture a real-data representation with browser-captured context, acting as a bridge between your website or applications and various analytics tools and helping essential data move between them. If your data layer isn’t named `DataLayer` (e.g.: `customDataLayer`) be sure to specify the correct variable name accordingly. | `empty` | | `usePrivacy` | When set to `usePrivacy: true`, Trackingplan automatically encrypts any detected personal data in Trackingplan's Privacy Report. | `false` | [Tags](/docs/tags) are key-value pairs of strings that label the data you send to Trackingplan. You choose them, and they help you filter the warnings that affect a specific app version, country and so on, or run root-cause analysis on them. > **Automatic tagging.** For iOS and Android SDKs, the `app_version` tag is included automatically, with no extra setup. To add other tags, such as `country`, `build number` or `test name`, add them by hand as in the example below: ```javascript Trackingplan.init("YOUR_TP_ID") .environment("development") .sourceAlias("iOS app") // .tags(new HashMap<>(){{ // put("tag1", "value1"); // }}) // .customDomains(new HashMap<>(){{ // put("my.domain.com", "myanalytics"); // }}) // .enableDebug() // .dryRun() .start(this) ``` ### Using Custom domains Trackingplan recognizes requests sent to the standard collection domains of the analytics and marketing platforms it supports, automatically. Each domain maps to a Trackingplan parser, which turns the raw requests into the enriched event format you see across the platform. If your implementation sends data to a custom collection domain instead of the platform's default one, Trackingplan can't identify it automatically. In that case, **configure the custom domain** when you install Trackingplan. To configure a custom domain, you need: - **The custom domain** that your implementation sends requests to (for example, your own collection domain instead of the platform's default endpoint). - **The parser ID** that tells Trackingplan which platform those requests belong to. > The parser value is **not** the name you'll see in Trackingplan. It is the internal identifier that tells Trackingplan how to read requests from that domain. Some common parser IDs include: | Platform | Parser ID | | --- | --- | | Server-side Google Tag Manager | `ssgtm` | | Stape | `stape` | | Tealium | `tealium` | | Adobe Analytics | `adobe` | | Adobe Target | `adobe_target` | | Jentis | `jentis` | | Piano | `piano` | ## Android SDK ### Installing Trackingplan’s Android SDK using Android Studio With Trackingplan for Android, you can check your tracking works as planned without changing your analytics stack or your code. > The recommended way to install Trackingplan for Android is **Android Studio**. Follow these steps: **Note:** Before you start, make sure your project targets API level 24 (Lollipop) or later. 1. First, add the Trackingplan dependency. To do this, expand the `Gradle Scripts` section. ![](/images/spr-87214783-Untitled.jpg) 2. Then, select the `project-level build.gradle` file and add `com.trackingplan.client:adapter:X.X.X` as a classpath dependency to the **dependencies section**: ```javascript dependencies { // ... classpath "com.trackingplan.client:adapter:X.X.X " // ... } ``` > Check the latest version in the official Android repository: [https://github.com/trackingplan/trackingplan-android/releases](https://github.com/trackingplan/trackingplan-android/releases) 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**. ```javascript plugins { // ... id 'com.trackingplan.client' // ... } ``` - Add `implementation 'com.trackingplan.client:sdk:X.X.X'` to the **dependencies section**. ```javascript dependencies { // ... implementation 'com.trackingplan.client:sdk:X.X.X' // ... } ``` 4. Next, in the `onCreate` method of your **Application's Main Activity**, set up the SDK like so: ```javascript Trackingplan.init("YOUR_TP_ID").start(this) ``` 5. Then import the SDK with the following command: ```javascript import com.trackingplan.client.sdk.Trackingplan; ``` You have installed the Trackingplan Android SDK. All set. Now [check that Trackingplan is collecting data correctly](/faqs/how-can-i-validate-trackingplan-is-collecting-data-after-its-installation). > You can also build Trackingplan for Android from the source code. To learn how, see our [Github documentation](https://github.com/trackingplan/trackingplan-android). ### Installing Android SDK in a Flutter project To add Trackingplan to your Flutter app, open the android directory inside your Flutter project and add the Trackingplan dependency: - Add `com.trackingplan.client:adapter:X.X.X`  as a classpath dependency to the dependencies section of the `android/build.gradle` file. ```groovy dependencies { // ... classpath "com.trackingplan.client:adapter:X.X.X" // ... } ``` > Check the latest version in the official Android repository: [https://github.com/trackingplan/trackingplan-android/releases](https://github.com/trackingplan/trackingplan-android/releases) - Add `implementation 'com.trackingplan.client:sdk:X.X.X'` to the dependencies section of the `android/app/build.gradle` file. ```groovy dependencies { // ... implementation 'com.trackingplan.client:sdk:X.X.X'// ... } ``` - Apply `com.trackingplan.client` plugin in your `android/app/build.gradle` file. ```groovy apply plugin: 'com.android.application' apply plugin: 'com.trackingplan.client' // <-- Trackingplan Plugin ``` Finally, find the MainActivity class (android/app/src/main/kotlin) and, in the `onCreate` method, set up the SDK like so: ```javascript Trackingplan.init("YOUR_TP_ID").start(this) ``` Then import the SDK: ```javascript import com.trackingplan.client.sdk.Trackingplan; ``` All set. ### Installing Trackingplan in Ionic for Android platform 1. Add the Trackingplan classpath dependency to A**ndroid/build.gradle** (the project-level `build.gradle`, not the one inside `android/app` , but the one at the root of the `android` folder): ``` classpath "com.trackingplan.client:adapter:X.X.X" ``` > Check the latest version in the official Android repository: [https://github.com/trackingplan/trackingplan-android/releases](https://github.com/trackingplan/trackingplan-android/releases) 2. Open the **app/build.gradle** file (the module-level Gradle file) at `android/app/build.gradle`. In the dependencies block, add: ``` implementation 'com.trackingplan.client:sdk:X.X.X' ``` 3. At the top level, add: ``` apply plugin: 'com.trackingplan.client' ``` 4. Initialize the Trackingplan SDK in your **MainActivity.java** file located at `android/app/src/main/java/MainActivity.java`. Add an `onCreate` method inside the `MainActivity` class and initialize Trackingplan with your Trackingplan ID: ```java import com.getcapacitor.BridgeActivity; import android.os.Bundle; import com.trackingplan.client.sdk.Trackingplan; public class MainActivity extends BridgeActivity { @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); // Initialize Trackingplan with your TP ID Trackingplan.init("YourTrackingplanId").start(this); } } ``` 5. Set `minSdkVersion = 24` or higher in `android/variables.gradle`. 6. Run the commands: ```shell ionic build npx cap sync android npx cap run android ``` ### Advanced Options Trackingplan for Android supports the following `advanced options` during its initialization: | | | | | --- | --- | --- | | **Parameter** | ** Description** | ** Default** | | `enableDebug()` | Enables debug mode. Prints debug information in the console. | `disabled` | | `environment(value)` | Allows to isolate the data between [production and testing environments](/docs/environments). | `PRODUCTION` | | `dryRun()` | Enables dry run mode, which allows you test Trackingplan for Android without actually sending any data to Trackingplan. | `disabled` | | `customDomains(map)` | Allows to extend the list of monitored domains. Any request made to these domains will also be forwarded to Trackingplan. The `map argument` must be a `key-value` with the domain to be looked for and the alias you want to use for that analytics domain. | `empty map` | | `sourceAlias(value)` | Allows to differentiate between sources. | `android` | | `tags(map)` | Allows to [tag](/docs/tags) the data sent to Trackingplan. The `map argument` must be a `key-value` with the tag name and the tag value. | `empty map` | | `getDataLayer` | Allows you to capture a real-data representation with browser-captured context, acting as a bridge between your website or applications and various analytics tools and helping essential data move between them. If your data layer isn’t named `DataLayer` (e.g.: `customDataLayer`) be sure to specify the correct variable name accordingly. | `empty` | | `usePrivacy` | When set to `usePrivacy: true`, Trackingplan automatically encrypts any detected personal data in Trackingplan's Privacy Report. | `false` | > **Automatic tagging.** For iOS and Android SDKs, the `app_version` tag is included automatically, with no extra setup. To add other tags, such as `country`, `build number` or `test name`, add them by hand as in the example below: ```javascript 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) ``` [← Previous**Installing Trackingplan on Your Websites**](/docs/installing-trackingplan/installing-trackingplan-on-your-websites) [Next →** Installing Trackingplan Using Webhooks**](/docs/installing-trackingplan/installing-trackingplan-using-webhooks) Was this useful? Write to [support@trackingplan.com](mailto:support@trackingplan.com) On this page 1. [*01*iOS SDK](#ios-sdk) 2. [*02*Android SDK](#android-sdk)