From Heap Classic SDK to CSQ SDK

Heap Classic SDK

→

CSQ SDK

The latest version of our SDK provides a unified set of APIs for Product Analytics, Experience Analytics, and Experience Monitoring, eliminating redundant APIs that perform the same actions.

Upgrading to the latest version ensures you benefit from all our newest features and product enhancements.

Replace the Heap Classic SDK dependencies by the CSQ SDK dependency.

Replace the Heap Classic SDK import with a unified CSQ SDK import.

import Heap
import HeapIOSAutocapture
import HeapNotificationAutocapture
import ContentsquareSDK

@import Heap;
@import HeapIOSAutocapture;
@import HeapNotificationAutocapture;
@import ContentsquareSDK;

Follow these steps to start the CSQ SDK with your current configuration.

1. Migrate configuration options from Heap.init() to CSQ.configureProductAnalytics().
   • Swift
   • Objective-C

   Heap.init("YOUR_ENVIRONMENT_ID",
   CSQ.configureProductAnalytics(
     environmentID: "YOUR_ENVIRONMENT_ID",
     additionalOptions: [
       .uploadInterval: 5,
       .baseUrl: "https://example.com/",
       .captureVendorId: true,
       .disablePageviewTitleCapture: true
     ]
   )

2. Recommended for UIKit Enable Autocapture with .enableUIKitAutocapture: true and remove the call to Heap.iOSAutocaptureSource.register()

   • Swift
   • Objective-C

   CSQ.configureProductAnalytics(
     environmentID: "YOUR_ENVIRONMENT_ID",
     additionalOptions: [
       .enableUIKitAutocapture: true
     ]
   )
   
   Heap.iOSAutocaptureSource.register(isDefault: true)

3. Add a call to CSQ.start(this) after the configuration call.

   • Swift
   • Objective-C

   CSQ.configureProductAnalytics(
     environmentID: "YOUR_ENVIRONMENT_ID",
     additionalOptions: [
       .enableUIKitAutocapture: true
     ]
   )
   
   CSQ.start(this)

4. (Optional) To start HeapNotification, add .enablePushNotificationAutocapture: true and remove the call to Heap.NotificationAutocaptureSource.register().
   • Swift
   • Objective-C

   CSQ.configureProductAnalytics(
     environmentID: "YOUR_ENVIRONMENT_ID",
     additionalOptions: [
       .uploadInterval: 5,
       .baseUrl: "https://example.com/",
       .captureVendorId: true,
       .disablePageviewTitleCapture: true,
       .enablePushNotificationAutocapture: true
     ]
   )
   
   Heap.NotificationAutocaptureSource.register()

5. (Optional) Configure HeapNotification using .enablePushNotificationTitleAutocapture and .enablePushNotificationBodyAutocapture and remove the call to Heap.NotificationAutocaptureSource.register().
   • Swift
   • Objective-C

   CSQ.configureProductAnalytics(
     environmentID: "YOUR_ENVIRONMENT_ID",
     additionalOptions: [
       .enablePushNotificationAutocapture: true,
       .enablePushNotificationTitleAutocapture: true|false,
       .enablePushNotificationBodyAutocapture: true|false
     ]
   )
   
   Heap.NotificationAutocaptureSource.register(captureTitle: true|false, captureBody: true|false)

The CSQ SDK treats users as opted-out by default.

import UIKit
import ContentsquareSDK

optinButton.addTarget(self, action: #selector(optInButtonTapped), for: .touchUpInside)

@objc func optInButtonTapped(_ sender: UIButton) {
    CSQ.start()
    CSQ.optIn()
    ...
}

#import <UIKit/UIKit.h>
#import <ContentsquareSDK/ContentsquareSDK.h>
[optinButton addTarget:self action:@selector(optInButtonTapped:) forControlEvents:UIControlEventTouchUpInside];

- (void)optInButtonTapped:(UIButton *)sender {
    [CSQ start];
    [CSQ optIn];
    // Additional initialization or navigation code...
}

Implement the optIn() API to forward user consent to the SDK and generate a user ID.

Search and replace all legacy SDK API calls in your app to the latest CSQ APIs using the following mappings. Updating your API calls ensures continued functionality without disruption.

In most cases, this process consists in updating the namespace and method names, with no changes to parameters.

Heap.init()
CSQ.start()

For more information on SDK methods, see the SDK API reference.

GDPR / Identification

Logging

Property tracking

Event tracking

Personal Data Handling and Masking

SDK initialization and manipulation

Congratulations! You’re all set. Use this checklist to ensure everything is correctly updated.

Ensure that your build files no longer reference https://github.com/heap/heap-ios-sdk.git.

Your import Heap declarations have been updated to import ContentsquareSDK.

You no longer have references to Heap. methods in your codebase.

All calls to the CSQ SDK use the CSQ. namespace.