From Contentsquare SDK to CSQ SDK

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

Increment the Contentsquare SDK in pubspec.yaml to the latest version.

dependencies:
  contentsquare: ^3.19.1
  contentsquare: ^4.0.0

Sync your dependencies by running flutter pub get.

Replace the Contentsquare SDK import with a CSQ SDK import.

import 'package:contentsquare/contentsquare.dart';
import 'package:contentsquare/csq.dart';

1. Optional: If you were using ContentsquareRoot widget - remove it from your widget tree.

   void main() {
     runApp(const MyApp());
   }
   
   class MyApp extends StatelessWidget {
     @override
     Widget build(BuildContext context) {
       return ContentsquareRoot(
         child: MaterialApp(
       return MaterialApp(
         title: 'My Flutter App',
         home: Home()
         ),
       );
     }
   }

2. Start the CSQ SDK manually.

   If you were using before manual start by calling Contentsquare().start(), simply replace it with CSQ().start():

   import 'package:contentsquare/csq.dart';
   void main() async {
     await Contentsquare().start();
     await CSQ().start();
   }

   If you were relying on ContentsquareRoot, you need from now on always start the SDK manually. Ideally the SDK should be started as soon as possible, for example from the main() function:

   import title="main.dart" 'package:contentsquare/csq.dart';
   
   void main() async {
     await CSQ().start();
   }

3. (Optional) If you were relying on the Contentsquare SDK autostart, remove the CSDisableAutostart property and calls to Contentsquare.start().

   • Swift
   • Objective-C

   <key>CSDisableAutostart</key>
   <true/>

   Contentsquare.start()

4. (Optional) If you have chosen to deactivate the autostart of the Contentsquare SDK, you can now remove the entry in the manifest, as the CSQ SDK doesn’t have an autostart.

   <application>
     ...
       <meta-data
         android:name="com.contentsquare.android.autostart"
         android:value="false"
       />
     ...
   </application>

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

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

It can be done immediately after start is called:

void main() async {
  // ...
  await CSQ().start();
  await CSQ().optIn();
  // ...
}

Alternatively, you can call optIn() in response to a user action, such as tapping an “I agree” button:

class UserConsentScreen extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('User Consent'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: () async {
            await CSQ().optIn();
          },
          child: Text('Agree with Terms and Conditions'),
        ),
      ),
    );
  }
}

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.

Contentsquare().start()
CSQ().start()

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

GDPR / Identification

Contentsquare().forgetMe()

You can use CSQ().optOut() instead to forget user id and stop tracking. If needed call CSQ().optIn() when you want to resume tracking.

Property tracking

CSInApp (iOS only)

Interoperability

Event tracking

Error tracking

Personal Data Handling and Masking

SDK initialization and manipulation