In-app features

Alongside its tracking capabilities, the SDK embeds some features aimed at Contentsquare users such as Snapshot Capture and SDK Logs.

In order to allow Contentsquare users to enable in-app features in your Flutter app, the implementation depends on the native platform.

Android

To enable in-app features within your app, you have to first make sure your app is launched in the background. To do so, start it and press the Android home button. Then, follow the appropriate method described as follows.

On a device: scan the QR code

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

On an emulator: use the ADB command

If you are using an emulator, you can use the ADB command to enable in-app features.

If you have access to the Contentsquare platform, you can open the in-app features modal from the menu and select “Copy this ADB command”.

It will look like this:

adb shell am start -W -a android.intent.action.VIEW -d "cs-{{packageName}}://contentsquare.com?activationKey={{uniqueActivationKey}}\&userId={{userId}}"

If you don’t have access to the Contentsquare platform, you can ask the Contentsquare team to share the link with you.

iOS

In order to allow Contentsquare users to enable in-app features, you must perform 2 implementation tasks:

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

Add the custom URL scheme in your app Info

You have to allow your app to be opened via a custom URL scheme which can be done using one of the following methods:

Xcode

Open your project settings
Select the app target
Select the Info settings
Scroll to URL Types
Set the URL scheme to cs-$(PRODUCT_BUNDLE_IDENTIFIER)

Text editor

Open the Info.plist of your project

Add the following snippet:

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

Call the SDK when the app is launched via a deeplink

Depending on the project, there are multiple ways to handle the deeplink opening. Choose the method matching your project structure:

In your AppDelegate class, complete or implement the function application(app, open url:, options:) with: CSQ.handle(url: url)

In your WindowSceneDelegate class, you need to:

Update func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) with:
```
if let url = connectionOptions.urlContexts.first?.url {
      CSQ.handle(url: url)
}
```
Complete or implement func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) with:
```
if let url = URLContexts.first?.url {
    CSQ.handle(url: url)
}
```

In the body of your main App struct, add the onOpenURL modifier and call the Contentsquare SDK to handle the URL:

@main
struct MyApp: App {
  var body: some Scene {
    WindowGroup {
      MyView()
        .onOpenURL { url in
          CSQ.handle(url: url)
        }
    }
  }
}

Enable in-app features

Once the implementation is done, in-app features can be enabled in different ways:

Scan the QR code

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 iPhone.

Use the custom link for simulator

If you have access to the Contentsquare platform, you can open the in-app features modal from the menu and select “Copy link” (to copy the deeplink) and paste it in Safari on your Simulator to trigger the in-app features.

Using the Terminal

In a Terminal console, open an URL in your current simulator with the following command (replacing CUSTOM_LINK with yours):

xcrun simctl openurl booted "CUSTOM_LINK"

Debugging and Logging

Contentsquare provides Logging capabilities that allow you to see the raw event data logged by your app in the macOS Console App, Xcode or in the Contentsquare platform. 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.

Viewing local logs

By default, almost all logs are disabled. There is only one log that is always visible to notify that the SDK has started:

┌───────────────────────────────────────────────────────────────────────────────
│ 🔔 IMPORTANT 🔔 (CSLIB 4.0.0)
├───────────────────────────────────────────────────────────────────────────────
│ Contentsquare Flutter SDK 4.0.0 starting in app:
│ com.example.testapp
└───────────────────────────────────────────────────────────────────────────────

In order to enable all logs, activate in-app features. Logging is directly linked to in-app features state: it starts when in-app features are enabled and stops when you disable in-app features.

Viewing logs in the Contentsquare platform

To view logs directly on the platform, you can use Log visualizer. Log visualizer is a helper tool to see SDK logs without logging tools. It requires having platform access for your project and enabling in-app features. See the SDK Log Visualizer Help Center Article ↗ for more information.

Snapshot Capture

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.

Snapshots are used in the Zoning Analysis module to look at zone-level metrics (Tap rate, Swipe rate…):