In-app features

In addition to its tracking functionalities, the SDKs incorporate certain features tailored for Contentsquare users, including Snapshot Capture and SDK Logs.

In order to allow Contentsquare users to enable in-app features:

1. Add the custom URL scheme in your app Info
2. Call the SDK when the app is launched via a deeplink

For in-app features to function, your app needs to be accessible via a custom URL scheme. This can be achieved by implementing ONE of the following approaches:

1. Open your project settings
2. Select the app target
3. Select the Info settings
4. Scroll to URL Types
5. Set the URL scheme to cs-$(PRODUCT_BUNDLE_IDENTIFIER)

1. Open the Info.plist of your project

2. Add the following snippet:

   <key>CFBundleURLTypes</key>
   <array>
       <dict>
           <key>CFBundleURLSchemes</key>
           <array>
               <string>cs-$(PRODUCT_BUNDLE_IDENTIFIER)</string>
           </array>
       </dict>
   </array>

In ios/Runner/AppDelegate.swift, add a new method to the AppDelegate class:

import ContentsquareModule

override func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
    Contentsquare.handle(url: url)
    return super.application(app, open: url, options: options)
  }

Here is what your AppDelegate class should look like after adding the in-app features:

import UIKit
import Flutter
import ContentsquareModule

@UIApplicationMain
@objc class AppDelegate: FlutterAppDelegate {
  override func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
  ) -> Bool {
    GeneratedPluginRegistrant.register(with: self)
    return super.application(application, didFinishLaunchingWithOptions: launchOptions)
  }

  // Add this method:
  override func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
      Contentsquare.handle(url: url)
      return super.application(app, open: url, options: options)
  }
}

In-app features can be enabled in different ways:

If you have access to the Contentsquare platform, you can open the in-app features modal from the menu and scan the QR code displayed with your phone.

Take a look at the native documentation for further information.

We provide alternative methods to enable in-app features especially for iOS Simulator and Android Emulator.

Contentsquare provides Logging capabilities that allow you to see the raw event data logged by your app. Use this for validation purposes during the instrumentation phase of development and can help you discover errors and mistakes in your analytics implementation and confirm that all events are being logged correctly.

In order to unlock the full data-visualization capabilities of Contentsquare, the SDK provides a way to capture snapshots of your app screens. These snapshots can only be taken by Contentsquare’s users on their device. They are not captured from your end-users device. It means your Personal Data is safe, as long as you use a test user account.