目录
此内容是否有帮助?

# Flutter

::: Tips

Before you begin, please read Preparation before Data Ingestion (opens new window)

:::

Latest version: 2.1.0

Update time: May 27, 2022

Resource download: SDK (opens new window)

# 1. SDK Integration

Add thinking_analytics dependencies to your pubspec.yaml file for your Flutter project:

dependencies:
  # 数数 Flutter 插件
  thinking_analytics: ^2.1.0

# 2. Initialization

The ThinkingData SDK needs to be initialized after the user agrees to the Privacy Policy

import 'package:thinking_analytics/thinking_analytics.dart';
if (authorized)
{
   //init
   final ThinkingAnalyticsAPI te = await ThinkingAnalyticsAPI.getInstance(APPID, SERVER_URL);
}

Instruction on parameters:

  • APPID: The APPID of your project, which can be found on the project management page of the TE.

  • SERVER_URL:

    • If you are using a SaaS version, please check the receiver URL on this page

  • If you use the private deployment version, you can customize the data tracking URL .

Since Android 9.0+ restricts HTTP requests by default, please use HTTPS protocol only.

# 3. Common Features

We suggested that you read User identification rules (opens new window) before using common features; SDK would generate a random number that would be used as the distinct ID, and save the ID locally. Before the user logs in, the distinct ID would be used as the identification ID. Note: The distinct ID would change after the user reinstalled the APP or use the APP with a new device.

# 3.1 Login

When the users log in , login could be called to set the account ID of the user. TE would use the account ID as the identification ID, and this ID would be saved before logout is called. The previous account ID would be replaced if login has been called multiple times.

// The login unique identifier of the user, corresponding to the #account_id in data tracking. #Account_id now is TE
te.login('TE');

Login events wouldn't be uploaded in this method.

# 3.2 Super Properties

Super Properties refer to properties that each event might have. You can call setSuperProperties to set Super Properties. It is recommended that you set Super Properties first before sending data. Some important properties (e.g., the membership class of users, source channels, etc.) should be set in each event. At this time, you can set these properties as Super Properties.

te.setSuperProperties({
  "channel": "ta",//character string
  "age": 1,//number
  "isSuccess": true,//boolean
  "birthday": DateTime.now(),//time
  "object": {"key": "value"},//object
  "object_arr": [{"key": "value"}],//array object
  "arr": ["value"]//array
});

Super Properties would be saved in local storage, and will not need to be called every time the App is opened. If the Super Properties set previously are uploaded after calling setSuperProperties, previous properties would be replaced.

  • Key is the name of the property and refers to the string type. It must start with a character, and contain numbers, characters (insensitive to case, and upper cases would be transformed into lower cases by TE) and underscores "_", with a maximum length of 50 characters.
  • Value, the value of the property, supports string, numbers, Boolean, time, object, array object, and array

The requirements for event properties and user properties are the same with that for super properties

# 3.3 Automatically Track Events

The following code is an example of install, active and inactive events. To get more information about the automatic tracking of SDK, please refer to Detailed introduction of automatic tracking function

te.enableAutoTrack([
  ThinkingAnalyticsAutoTrackType.APP_INSTALL,//APP install event
  ThinkingAnalyticsAutoTrackType.APP_START, //APP start event
  ThinkingAnalyticsAutoTrackType.APP_END //APP end event
]);

# 3.4 Sending Events

You can call track to upload events. It is suggested that you set event properties based on the data tracking plan drafted previously. Here is an example of a user buying an item:

te.track('product_buy', properties: <String, dynamic>{'product_name': 'tv'});

The event name is string type. It could only start with a character and could contain figures, characters, and an underline "_", with a maximum length of 50 characters.

# 3.5 User Properties

You can set general user properties by calling user_set API. The original properties would be replaced by the properties uploaded via this API. The data type of newly-created user properties must be the same as the uploaded properties. User name setting is taken as the example here:

te.userSet(<String, dynamic>{'user_name': 'TA'});  //the username now is TA
te.userSet(<String, dynamic>{'user_name': 'TE'});  //the username now is TE

# 4. Best Practice

The following sample code covers all the above-mentioned operations. It is recommended that the SDK be used in the following steps:

import 'package:thinking_analytics/thinking_analytics.dart';
if (authorized)
{
   //SDK init
   final ThinkingAnalyticsAPI te = await ThinkingAnalyticsAPI.getInstance('APP_ID', 'https://SERVER_URL');
   //if the user has logged in, the account ID of the user could be set as the unique identifier 
   te.login('TE');
   //After setting super properties, each event would have super properties
   te.setSuperProperties({
     "channel": "ta",//string
     "age": 1,//number
     "isSuccess": true,//boolean
     "birthday": DateTime.now(),//time
     "object": {"key": "value"},//object
     "object_arr": [{"key": "value"}],//array object
     "arr": ["value"]//array
    });
   //Enable auto-tracking
   te.enableAutoTrack([ThinkingAnalyticsAutoTrackType.APP_INSTALL,ThinkingAnalyticsAutoTrackType.APP_START,ThinkingAnalyticsAutoTrackType.APP_END]);
   //upload events
   te.track('product_buy', properties: <String, dynamic>{'product_name': 'productName'});
   //Set user properties
   te.userSet(<String, dynamic>{'user_name': 'TE'});
}