--- metadata: - name: generator content: Diplodoc Platform v5.50.6 alternate: - https://appmetrica.yandex.com/docs/en/sdk/ios/analytics/quick-start.md - https://appmetrica.yandex.com/docs/ru/sdk/ios/analytics/quick-start.md --- > **Documentation Index:** Fetch the complete configuration index at https://appmetrica.yandex.com/docs/en/llms.txt # SDK integration The SDK for iOS is provided as modules with source code. ## Step 1. Enable the library {#integration} {% list tabs %} - CocoaPods To connect the analytics library, add the following dependency to your project's Podfile: ```ruby translate=no pod 'AppMetricaAnalytics', '~> 6.6.0' ``` #### {#app-for-kids} {% cut "I have a children's app" %} If your app is intended for children, connect modules without the use of `AppMetricaAdSupport`: ```ruby translate=no pod 'AppMetricaCore', '~> 6.6.0' pod 'AppMetricaCrashes', '~> 6.6.0' pod 'AppMetricaWebKit', '~> 6.6.0' ``` {% endcut %} {% cut "I don't need all the features" %} If you don't need all the features of the AppMetrica SDK, connect only the required modules: ```ruby translate=no pod 'AppMetricaCore', '~> 6.6.0' # The main module for working with the AppMetrica SDK, mandatory for connection pod 'AppMetricaAdSupport', '~> 6.6.0' # Required for collecting IDs. IDFAs won't be collected without it pod 'AppMetricaCrashes', '~> 6.6.0' # The module for detecting crashes and sending errors pod 'AppMetricaWebKit', '~> 6.6.0' # The module for setting up event sending from the WebView's JS code ``` {% endcut %} - SPM in Xcode #### Integration via the Xcode interface To connect the library, follow these steps: 1. In the Xcode project navigator (**Project Navigator**) window, select your project (if **Workspace** is used). In the top menu, click **File** and select **Add Package Dependencies...**. ![Project Navigator](../../../../_images/xcode_add_package_dependency.png) 2. Specify the repository URL `https://github.com/appmetrica/appmetrica-sdk-ios`. ![repository URL](../../../../_images/appmetrica-spm-url.png) 3. Leave only the required modules (to disable a module, select `None` in `Add to Target`): ![required modules](../../../../_images/spm-select-packages.png) * `AppMetricaCore`: The mandatory main SDK module. It must be connected for working with AppMetrica. * `AppMetricaAdSupport`: The module is used to collect IDs, including IDFA. * `AppMetricaCrashes`: The module is intended for detecting crashes and sending errors. * `AppMetricaWebKit`: The module enables you to send events from JavaScript code in WebView. {% note info %} If your app is intended for children, connect modules without the use of `AppMetricaAdSupport`. {% endnote %} - Package.swift #### Integration via the Package.swift manifest First, add the following dependency to the `dependencies:` array of your package: ```swift translate=no dependencies: [ .package( url: "https://github.com/appmetrica/appmetrica-sdk-ios", from: "6.6.0" ) ], ``` The AppMetrica SDK modules that you can connect depending on the needs of your project: * `AppMetricaCore`: The mandatory main SDK module. It must be connected for working with AppMetrica. * `AppMetricaAdSupport`: The module is used to collect IDs, including IDFA. * `AppMetricaCrashes`: The module is intended for detecting crashes and sending errors. * `AppMetricaWebKit`: The module enables you to send events from JavaScript code in WebView. {% note info %} If your app is intended for children, connect modules without the use of `AppMetricaAdSupport`. {% endnote %} Example of connecting modules in the `dependencies:` array of the target: ```swift translate=no .target( name: "MyTargetName", dependencies: [ .product(name: "AppMetricaCore", package: "AppMetrica"), .product(name: "AppMetricaCrashes", package: "AppMetrica"), .product(name: "AppMetricaWebKit", package: "AppMetrica"), // .product(name: "AppMetricaAdSupport", package: "AppMetrica"), // This module is disabled ] ), ``` - Tuist with Package.swift #### Integration via Tuist with the Package.swift manifest Add AppMetrica into your Tuist/Package.swift ``` import PackageDescription #if TUIST import struct ProjectDescription.PackageSettings let packageSettings = PackageSettings( productTypes: [:] ) #endif let package = Package( name: "NewTuist", dependencies: [ .package(url: "https://github.com/appmetrica/appmetrica-sdk-ios", from: "5.0.0") ] ) ```` Now add dependencies for target in Project.swift. AppMetrica requires "-ObjC" linker flag. Append settings for all targets statically linked with AppMetrica, e. g.: ``` dependencies: [ .external(name: "AppMetricaCore"), ], settings: .settings( base: ["OTHER_LDFLAGS": "$(inherited) -ObjC"] ) ``` {% endlist %} ## Step 2. Initialize the library {#initialization} {% list tabs group=instructions %} - Swift Add the import: ```swift translate=no import AppMetricaCore ``` Initialize the library in the `application(_:didFinishLaunchingWithOptions:)` method of your `UIApplicationDelegate`: ```swift translate=no func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool { // Initializing the AppMetrica SDK. let configuration = AppMetricaConfiguration(apiKey: "API key") AppMetrica.activate(with: configuration!) } ``` - Objective-C Add the import: ```obj-c translate=no #import ``` Initialize the library in the `application:didFinishLaunchingWithOptions:` method of your `UIApplicationDelegate`: ```obj-c translate=no - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { // Initializing the AppMetrica SDK. AMAAppMetricaConfiguration *configuration = [[AMAAppMetricaConfiguration alloc] initWithAPIKey:@"API key"]; [AMAAppMetrica activateWithConfiguration:configuration]; return YES; } ``` {% endlist %} {% cut "What is the API key?" %} The API key is a unique app ID issued in the AppMetrica web interface at [app registration](https://appmetrica.yandex.com/application/new). You can find it under **Settings** → **Main**. {% endcut %} AppMetrica allows tracking pre-installed apps. For more information, see [Tracking pre-installed apps](https://appmetrica.yandex.com/docs/en/mobile-tracking/preinstalled-app-attr.md). ## Step 3. (Optional) Configure sending of events, profile attributes, and revenue {#send} 1. To collect information on user actions in the app, set up sending your own events. For more information, see [Sending your own events](https://appmetrica.yandex.com/docs/en/data-collection/about-events.md). 2. To collect information about users, set up sending profile attributes. For more information, see [Profiles](https://appmetrica.yandex.com/docs/en/data-collection/about-profiles.md). {% note info %} Unlike events, a profile attribute can take only one value. When you send a new attribute value, the old value is overwritten. {% endnote %} 4. To track in-app purchases, set up Revenue sending. For more information, see [In-App purchases](https://appmetrica.yandex.com/docs/en/data-collection/about-revenue.md). ## Step 4. Test the library operation {#test} To test how the library works: 1. Start the app with the AppMetrica SDK and use it for a while. 2. Make sure your device is connected to the internet. 3. In the AppMetrica interface, make sure that: * There is a new user in the [Audience](https://appmetrica.yandex.com/docs/en/mobile-reports/audience-report.md) report. * The number of sessions in the **Engagement** → **Sessions** report has increased. * There are events and profile attributes in the [Events](https://appmetrica.yandex.com/docs/en/mobile-reports/events-report.md) and [Profiles](https://appmetrica.yandex.com/docs/en/mobile-reports/profile-report.md) reports. ## Learn more {#learn-more} - [Sending a custom event](https://appmetrica.yandex.com/docs/en/sdk/ios/analytics/ios-operations.md#report-event) - [Sending profile attributes](https://appmetrica.yandex.com/docs/en/sdk/ios/analytics/ios-operations.md#send-attribute-profile) - [Sending E-commerce events](https://appmetrica.yandex.com/docs/en/sdk/ios/analytics/ios-operations.md#send-ecommerce) - [Sending Revenue data](https://appmetrica.yandex.com/docs/en/sdk/ios/analytics/ios-operations.md#send-revenue) - [Sending Ad Revenue data](https://appmetrica.yandex.com/docs/en/sdk/ios/analytics/ios-operations.md#send-adrevenue) - [How do I enable user location sending?](https://appmetrica.yandex.com/docs/en/troubleshooting/troubleshooting.md#region) ## Troubleshooting {#faq} - [The number of sessions does not increase](https://appmetrica.yandex.com/docs/en/sdk/ios/analytics/ios-errors.md#faq-session-count) - [There are no events in the report](https://appmetrica.yandex.com/docs/en/sdk/ios/analytics/ios-errors.md#no-events) - [Problems with Swift Package Manager](https://appmetrica.yandex.com/docs/en/sdk/ios/analytics/ios-errors.md#swift-manager) - [My problem is not listed](https://appmetrica.yandex.com/docs/en/sdk/ios/analytics/ios-errors.md#not-found) If you didn't find the answer you were looking for, you can use the feedback form to submit your question. Please describe the problem in as much detail as possible. Attach a screenshot if possible. Contact support Suggest an improvement for documentation