Preset Properties

1. Preset Properties of All Events

All Events in iOS SDK(including auto-tracking events) would have the following preset property.

2. Preset Properties of Auto-tracking Event

The following preset properties are the properties set specially for each auto-tracking event

• Preset properties of APP start event (ta_app_start)

Property name	Display name	Property type	Instruction
#resume_from_background	Resume from the background or not	Bool	Indicating whether the APP is enabled by the user or resumed from the background. If the value is true, it means the APP is resumed from the background; if the value is false, it means the APP is enabled by the user directly.
#start_reason	APP enable source	Text	Displays the reason for APP starting, and the value is string. Currently supports favorite deeplink, push, 3dtouch start reason. For the sample, please refer to: {url:"thinkingdata://","data":{}}
#background_duration	Background duration	Numeric value	Record the background duration of the APP in the time interval between two start events (Unit: second)

- Preset properties of APP end event (ta_app_end)

Property name	Display name	Property type	Instruction
#duration	Event duration	Numeric value	Indicating the duration of the APP access (Unit: second).

- Preset properties of APP view screen event (ta_app_view)

Property name	Display name	Property type	Instruction
#title	Screen title	Text	Title of the ViewController, to be set by invoking controller.navigationItem.title.
#screen_name	Screen name	Text	Class name of ViewController.
#url	Screen URL	Text	The url of current screen, to be set by invoking getScreenUrl
#referrer	Forward address	Text	The address of the screen before skipping, to be set by invoking getScreenUrl

- Preset properties of APP control(view) click event

Property name	Display name	Property type	Instruction
#title	Screen title	Text	Title of the ViewController, to be set by invoking controller.navigationItem.title.
#screen_name	Screen name	Text	Class name of ViewController.
#element_id	Element ID	Text	The ID of the UIView. e.g. button.thinkingAnalyticsViewID
#element_type	Element type	Text	Type of the UIView
#element_selector	Element selector	Text	Splicing of the viewPath of the UIView
#element_position	Element position	Text	UIView position information that exists only if the control type is UITableView or UICollectionView. The value is Section, Row.
#element_content	Element content	Text	Content on the UIView

- Preset properties of APP crash event (ta_app_crash)

Property name	Display name	Property type	Instruction
#app_crashed_reason	Abnormal information	Text	Character string type, record the stack trace upon crash

3. Other Preset Properties

In addition to the Preset properties above, some preset properties would only be recorded after corresponding API is called:

Property name	Display name	Property type	Instruction
#duration	Event duration	Numeric value	Timing function timeEvent should be invoked to record the event duration (Unit: second)
#background_duration	Background duration	Numeric value	Timing function timeEvent should be called to record the background duration within an event interval (Unit: second)

Getting Preset Properties

When some preset properties of the APP is required for Server data tracking, this method can be invoked to get the preset properties of the App side and then send them to the server

//get property objects
TDPresetProperties *presetProperties = [TDAnalytics getPresetProperties];

//Preset properties of Event
NSDictionary *properties = [presetProperties toEventPresetProperties];
/*
   {
        "#carrier": "T-Mobile",
        "#os": "iOS",
        "#device_id": "A8B1C00B-A6AC-4856-8538-0FBC642C1BAD",
        "#screen_height": 2264,
        "#bundle_id": "com.sw.thinkingdatademo",
        "#manufacturer": "Apple",
        "#device_model": "iPhone7",
        "#screen_width": 1080,
        "#system_language": "zh",
        "#os_version": "10",
        "#network_type": "WIFI",
        "#zone_offset": 8,
        "#app_version":"1.0.0"
    }
*/

//get a certain preset properties
NSString *bundle_id = presetProperties.bundle_id;//app bundle id
NSString *os = presetProperties.os; //os type, e.g., iOS
NSString *system_language = presetProperties.system_language;//type of mobile phone system language
NSNumber *screen_width = presetProperties.screen_width;//screen width
NSNumber *screen_height = presetProperties.screen_height;//screen height
NSString *device_model = presetProperties.device_model;//device model
NSString *device_id = presetProperties.device_id;//unique identifier of device
NSString *carrier = presetProperties.carrier;//information about operator of the SIM card. Operation information of the primary card should be geted under dual-card dual-standby mode 
NSString *manufacture = presetProperties.manufacturer;//mobile phone manufacturer, e.g., Apple
NSString *network_type = presetProperties.network_type;//network type
NSString *os_version = presetProperties.os_version;//system version number
NSNumber *zone_offset = presetProperties.zone_offset;//timezone offset value
NSString *app_version = presetProperties.app_version;//app version number

//get property objects
let presetProperties = TDAnalytics.getPresetProperties();

//Preset properties of Event
let properties = presetProperties.toEventPresetProperties();
/*
   {
        "#carrier": "T-Mobile",
        "#os": "iOS",
        "#device_id": "A8B1C00B-A6AC-4856-8538-0FBC642C1BAD",
        "#screen_height": 2264,
        "#bundle_id": "com.sw.thinkingdatademo",
        "#manufacturer": "Apple",
        "#device_model": "iPhone7",
        "#screen_width": 1080,
        "#system_language": "zh",
        "#os_version": "10",
        "#network_type": "WIFI",
        "#zone_offset": 8,
        "#app_version":"1.0.0"
    }
*/

//get a certain preset properties
let bundle_id = presetProperties.bundle_id; //app bundle id
let os = presetProperties.os; //os type, e.g., iOS
let system_language = presetProperties.system_language; //type of mobile phone system language
let screen_width = presetProperties.screen_width;;//screen width
let screen_height = presetProperties.screen_height; //screen height
let device_model = presetProperties.device_model; //device model
let device_id = presetProperties.device_id; //unique identifier of device
let carrier = presetProperties.carrier; //information about operator of the SIM card. Operation information of the primary card should be geted under dual-card dual-standby mode 
let manufacture = presetProperties.manufacturer; //mobile phone manufacturer, e.g., Apple
let network_type = presetProperties.network_type; //network type
let os_version = presetProperties.os_version; //system version number
let zone_offset = presetProperties.zone_offset; //timezone offset value

IP, nation and city information are parsed and generated by the server. The client shall not provide the interface to get such properties

5. Disable preset property tracking

Under certain scenarios, you may want to forbid tracking certain preset properties to ensure compliance and meet actual business requirements. Add TDDisPresetProperties field of array type in the info.plist, Add the prefab properties that not allowed to be tracked to this field. e.g. "#fps", @"#ram", @"#disk", @"#start_reason", @"#simulator", the configuration is as follows: