macOS

TIP

Before you begin, please read Preparation before Data Ingestion

The minumum system version required by Mac SDK is OSX 10.10

The size of macOS SDK (Framework format) is around 176 KB

Latest version: 1.0.0

Update time: July 18, 2022

Resource download: Source Code (opens new window)

1. SDK Integration

1.1 Automatic Integration

• CocoaPods

1. Create a Podfile in your Xcode project directory by running pod init in your terminal.

Edit the generated Podfile , and add the following lines:

platform :osx, '10.10'
target 'YourProjectTarget' do
  pod 'ThinkingSDKMacOS'
end

1. Navigate to your project's root folder and run pod install in your terminal

After success, the following tip will appear in the terminal:

pod install

1. Open project

After the command is executed successfully, .xcworkspace file will be generated, indicating that you have successfully imported the macOS SDK. Open the .xcworkspace file to start the project (note: the .xcodeproj file cannot be opened at the same time)

2. Initialization

Complete the initialization operation in main thread, the sample code is as follows:

ThinkingAnalyticsSDK *instance = [ThinkingAnalyticsSDK startWithAppId:APP_ID withUrl:SERVER_URL];

let instance = ThinkingAnalyticsSDK.start(withAppId: "YOUR_APPID", withUrl: "YOUR_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 .

3. Common Features

We suggested that you read User Identification Rules 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 used 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
[instance login:@"TE"];

// The login unique identifier of the user, corresponding to the #account_id in data tracking. #Account_id now is TE
instance.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.

NSDictionary *params = @{
    @"channel": @"TE", //string
    @"age": @(1), //number
    @"isSuccess": @(YES), //boolean
    @"birthday": [NSDate date], //time
    @"object": @{@"key": @"value"}, //object
    @"object_arr": @[@{@"key": @"value"}], //array object
    @"arr": @[@"value"] //array
};
//set super properties
[instance setSuperProperties:params];

let params: [String: Any] = [
    "channel": "TE", // string
    "age": 1, // number
    "isSuccess": true, //boolean
    "birthday": Date(), //time
    "object": ["key": "value"], //object
    "object_arr": [["key": "value"]], //array object
    "arr": ["value"] //array
]
//set super properties
instance.setSuperProperties(params)

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 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:

NSDictionary *eventProperties = @{@"product_name": @"product name"};
[instance track:@"product_buy" properties:eventProperties];

let properties = ["productName": "product name"] as [String: Any]
ThinkingAnalyticsSDK.sharedInstance()?.track("event_name", properties: properties)

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.4 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. If no user properties are set before, user properties would be created. 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:

[instance user_set:@{@"userName": @"TE"}];

instance.user_set(["username": "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:

ThinkingAnalyticsSDK *instance = [ThinkingAnalyticsSDK startWithAppId:APP_ID withUrl:SERVER_URL];
//if the user has logged in, the account ID of the user could be set as the unique identifier 
[instance login:@"TE"];
//After setting super properties, each event would have super properties
NSDictionary *params = @{
    @"channel": @"TE", //string
    @"age": @(1), // number
    @"isSuccess": @(YES), // boolean
    @"birthday": [NSDate date], // time
    @"object": @{@"key": @"value"}, // object
    @"object_arr": @[@{@"key": @"value"}], // array object
    @"arr": @[@"value"] // array
};
//set super properties
[instance setSuperProperties:params];

//send event
NSDictionary *eventProperties = @{@"product_name": @"product name"};
[instance track:@"product_buy" properties:eventProperties];

//Set user properties
instance.user_set(["username": "TE"])

let instance = ThinkingAnalyticsSDK.start(withAppId: "YOUR_APPID", withUrl: "YOUR_SERVER_URL");
//if the user has logged in, the account ID of the user could be set as the unique identifier 
instance.login("TE");
//After setting super properties, each event would have super properties
let params: [String: Any] = [
    "channel": "TE", // string
    "age": 1, // number
    "isSuccess": true, // boolean
    "birthday": Date(), // time
    "object": ["key": "value"], // object
    "object_arr": [["key": "value"]], // array object
    "arr": ["value"] // array
]
//set super properties
instance.setSuperProperties(params)
//send event
let properties = ["productName": "product name"] as [String: Any]
ThinkingAnalyticsSDK.sharedInstance()?.track("event_name", properties: properties)
//Set user properties
instance.user_set(["UserName": "TE", "Age": 20])