ThinkingAnalyticsSDK (thinkingsdk 2.6.2 API)

java.lang.Object
- cn.thinkingdata.android.ThinkingAnalyticsSDK

public class ThinkingAnalyticsSDK
extends java.lang.Object

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`ThinkingAnalyticsSDK.AutoTrackEventType` 自动采集事件类型
`static interface`	`ThinkingAnalyticsSDK.DynamicSuperPropertiesTracker` 动态公共属性接口.
`static class`	`ThinkingAnalyticsSDK.ThinkingdataNetworkType` 允许上报的网络类型

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static void`	`calibrateTime(long timestamp)` 校准时间
`static void`	`calibrateTimeWithNtp(java.lang.String... ntpServer)` 使用指定的 NTP Server 校准时间
`static void`	`calibrateTimeWithNtpForUnity(java.lang.String ntpServer)`
`void`	`clearSuperProperties()` 清除所有公共事件属性
`ThinkingAnalyticsSDK`	`createLightInstance()` 创建轻量级的 SDK 实例.
`void`	`enableAutoTrack(int types)`
`void`	`enableAutoTrack(java.util.List<ThinkingAnalyticsSDK.AutoTrackEventType> eventTypeList)` 开启自动采集事件功能
`void`	`enableTracking(boolean enabled)` 打开/关闭实例功能.
`static void`	`enableTrackLog(boolean enableLog)` 打开/关闭日志打印
`void`	`flush()` 清空缓存队列.
`protected DataHandle`	`getDataHandleInstance(Context context)`
`java.lang.String`	`getDeviceId()` 获取设备ID
`java.lang.String`	`getDistinctId()` 获取访客 ID: 上报数据中的 #distinct_id 值
`JSONObject`	`getSuperProperties()` 获得已设置的公共事件属性
`java.lang.String`	`getTimeString(java.util.Date date)`
`java.lang.String`	`getToken()` 获取当前实例的 APP ID
`boolean`	`hasOptOut()` 当前实例 OptOut 状态.
`void`	`identify(java.lang.String identity)` 设置访客 ID，替换掉默认的 UUID 访客 ID
`void`	`ignoreAutoTrackActivities(java.util.List<java.lang.Class<?>> activitiesList)` 忽略多个页面的自动采集事件，包括页面浏览和控件点击事件
`void`	`ignoreAutoTrackActivity(java.lang.Class<?> activity)` 忽略指定页面的自动采集事件，包括页面浏览和控件点击事件
`void`	`ignoreView(View view)` 忽略指定元素的点击事件
`void`	`ignoreViewType(java.lang.Class viewType)` 忽略指定类型的控件点击事件
`boolean`	`isEnabled()` 当前实例 Enable 状态.
`void`	`login(java.lang.String loginId)` 设置账号ID，每次设置会覆盖之前的值。
`void`	`logout()` 清空账号ID, 不会上传用户登出事件
`void`	`optInTracking()` 允许此实例的上报.
`void`	`optOutTracking()` 停止上报此用户的数据.
`void`	`optOutTrackingAndDeleteUser()` 停止上报此用户数据，并且发送 user_del (不会重试)
`static void`	`setCustomerLibInfo(java.lang.String libName, java.lang.String libVersion)` 谨慎调用此接口。
`void`	`setDynamicSuperPropertiesTracker(ThinkingAnalyticsSDK.DynamicSuperPropertiesTracker dynamicSuperPropertiesTracker)` 设置动态公共属性。
`void`	`setJsBridge(WebView webView)` 支持 H5 与原生 APP SDK 打通.
`void`	`setJsBridgeForX5WebView(java.lang.Object x5WebView)` 腾讯 X5 WebView 与原生 APP SDK 打通.
`void`	`setNetworkType(int type)`
`void`	`setNetworkType(ThinkingAnalyticsSDK.ThinkingdataNetworkType type)` 设置上传的网络条件，默认情况下，SDK 将会网络条件为在 3G、4G 及 Wifi 时上传数据
`void`	`setSuperProperties(JSONObject superProperties)` 设置公共事件属性，之后上传的每个事件都会包含公共事件属性。
`void`	`setViewID(android.app.Dialog view, java.lang.String viewID)` 自定义控件ID，如果不设置，默认使用 android:id
`void`	`setViewID(View view, java.lang.String viewID)` 自定义控件ID，如果不设置，默认使用 android:id
`void`	`setViewProperties(View view, JSONObject properties)` 自定义控件点击事件的属性
`static ThinkingAnalyticsSDK`	`sharedInstance(Context context, java.lang.String appId)` 当 SDK 初始化完成后，可以通过此接口获得保存的单例
`static ThinkingAnalyticsSDK`	`sharedInstance(Context context, java.lang.String appId, java.lang.String url)` 初始化 SDK.
`static ThinkingAnalyticsSDK`	`sharedInstance(Context context, java.lang.String appId, java.lang.String url, boolean trackOldData)` 谨慎使用此接口，大多数情况下会默认绑定老版本数据到第一个实例化的 SDK 中
`static ThinkingAnalyticsSDK`	`sharedInstance(TDConfig config)`
`void`	`timeEvent(java.lang.String eventName)` 记录事件时长，调用此方法开始计时，目标事件上传时停止计时，并在事件属性中加入#duration属性，单位为秒
`void`	`track(java.lang.String eventName)` 上传单个事件，只包含预置属性和已设置的公共属性
`void`	`track(java.lang.String eventName, JSONObject properties)` 上传事件及其相关属性
`void`	`track(java.lang.String eventName, JSONObject properties, java.util.Date time)` 上传事件，可以设定事件触发时间。
`void`	`track(java.lang.String eventName, JSONObject properties, java.util.Date time, java.util.TimeZone timeZone)` 上传事件，并设定事件触发时间。
`void`	`track(cn.thinkingdata.android.ThinkingAnalyticsEvent event)` 上传特殊类型的事件.
`void`	`trackAppInstall()` 开启采集安装事件. added for unity3D.
`void`	`trackFragmentAppViewScreen()` 开启自动采集 Fragment 浏览事件
`void`	`trackViewScreen(Activity activity)` 手动触发页面浏览事件上传
`void`	`trackViewScreen(android.app.Fragment fragment)` 手动触发页面浏览事件上传
`void`	`unsetSuperProperty(java.lang.String superPropertyName)` 清除一条公共事件属性
`void`	`user_add(JSONObject properties)` 对数值类型用户属性进行累加操作
`void`	`user_add(JSONObject properties, java.util.Date date)`
`void`	`user_add(java.lang.String propertyName, java.lang.Number propertyValue)` 对数值类型用户属性进行累加操作，只设置一个属性
`void`	`user_append(JSONObject properties)` 对 List 类型的用户属性进行追加操作
`void`	`user_append(JSONObject properties, java.util.Date date)`
`void`	`user_delete()` 删除用户属性，但会保留已上传的事件数据。
`void`	`user_delete(java.util.Date date)`
`void`	`user_set(JSONObject properties)` 设置用户属性，如果属性已存在，则用新值替换原值
`void`	`user_set(JSONObject properties, java.util.Date date)`
`void`	`user_setOnce(JSONObject properties)` 设置单次用户属性，如果属性已经存在，则忽略新的属性值
`void`	`user_setOnce(JSONObject properties, java.util.Date date)`
`void`	`user_unset(JSONObject properties, java.util.Date date)`
`void`	`user_unset(java.lang.String... properties)` 重置用户属性

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - sharedInstance
```
public static ThinkingAnalyticsSDK sharedInstance(Context context,
                                                  java.lang.String appId)
```
    当 SDK 初始化完成后，可以通过此接口获得保存的单例
    
    参数:
    
    context - app context
    
    appId - APP ID
    
    返回:
    
    SDK 实例
  - sharedInstance
```
public static ThinkingAnalyticsSDK sharedInstance(Context context,
                                                  java.lang.String appId,
                                                  java.lang.String url)
```
    初始化 SDK. 在调用此接口之前，track 功能不可用.
    
    参数:
    
    context - app context
    
    appId - APP ID
    
    url - 接收端地址
    
    返回:
    
    SDK 实例
  - sharedInstance
```
public static ThinkingAnalyticsSDK sharedInstance(Context context,
                                                  java.lang.String appId,
                                                  java.lang.String url,
                                                  boolean trackOldData)
```
    谨慎使用此接口，大多数情况下会默认绑定老版本数据到第一个实例化的 SDK 中
    
    参数:
    
    trackOldData - 是否绑定老版本(1.2.0 及之前)的数据
  - sharedInstance
```
public static ThinkingAnalyticsSDK sharedInstance(TDConfig config)
```
  - getDataHandleInstance
```
protected DataHandle getDataHandleInstance(Context context)
```
  - enableTrackLog
```
public static void enableTrackLog(boolean enableLog)
```
    打开/关闭日志打印
    
    参数:
    
    enableLog - true 打开日志; false 关闭日志
  - setCustomerLibInfo
```
public static void setCustomerLibInfo(java.lang.String libName,
                                      java.lang.String libVersion)
```
    谨慎调用此接口。此接口用于使用第三方框架或者游戏引擎的场景中，更准确的设置上报方式。
    
    参数:
    
    libName - 对应事件表中 #lib 预置属性
    
    libVersion - 对应事件标准 #lib_version 预置属性
  - setNetworkType
```
public void setNetworkType(ThinkingAnalyticsSDK.ThinkingdataNetworkType type)
```
    设置上传的网络条件，默认情况下，SDK 将会网络条件为在 3G、4G 及 Wifi 时上传数据
    
    参数:
    
    type - 上传数据的网络类型
  - setNetworkType
```
public void setNetworkType(int type)
```
  - track
```
public void track(java.lang.String eventName,
                  JSONObject properties)
```
    上传事件及其相关属性
    
    参数:
    
    eventName - 事件名称
    
    properties - 事件属性
  - track
```
public void track(java.lang.String eventName,
                  JSONObject properties,
                  java.util.Date time)
```
    上传事件，可以设定事件触发时间。 SDK 1.1.5 版本开始支持. 该方法在 v2.2.0+ 被废弃 time 将按照设备默认时区被序列化为指定格式的字符串上报，但是 #zone_offset 将不会被设置
    
    参数:
    
    eventName - 事件名称
    
    properties - 事件属性
    
    time - 事件触发时间
  - track
```
public void track(java.lang.String eventName,
                  JSONObject properties,
                  java.util.Date time,
                  java.util.TimeZone timeZone)
```
    上传事件，并设定事件触发时间。SDK v2.2.0 开始支持.
    
    参数:
    
    eventName - 事件名称
    
    properties - 事件属性
    
    time - 事件触发时间
    
    timeZone - 事件时区
  - track
```
public void track(java.lang.String eventName)
```
    上传单个事件，只包含预置属性和已设置的公共属性
    
    参数:
    
    eventName - 事件名称
  - track
```
public void track(cn.thinkingdata.android.ThinkingAnalyticsEvent event)
```
    上传特殊类型的事件.
    
    参数:
    
    event - 事件对象 TDUniqueEvent / TDUpdatableEvent / TDOverWritableEvent
  - user_add
```
public void user_add(java.lang.String propertyName,
                     java.lang.Number propertyValue)
```
    对数值类型用户属性进行累加操作，只设置一个属性
    
    参数:
    
    propertyName - 属性名称
    
    propertyValue - 属性值，可为负数
  - user_append
```
public void user_append(JSONObject properties)
```
    对 List 类型的用户属性进行追加操作
    
    参数:
    
    properties - 用户属性，JSONObject
  - user_append
```
public void user_append(JSONObject properties,
                        java.util.Date date)
```
  - user_add
```
public void user_add(JSONObject properties)
```
    对数值类型用户属性进行累加操作
    
    参数:
    
    properties - 用户属性，JSONObject
  - user_add
```
public void user_add(JSONObject properties,
                     java.util.Date date)
```
  - user_setOnce
```
public void user_setOnce(JSONObject properties)
```
    设置单次用户属性，如果属性已经存在，则忽略新的属性值
    
    参数:
    
    properties - 用户属性
  - user_setOnce
```
public void user_setOnce(JSONObject properties,
                         java.util.Date date)
```
  - user_set
```
public void user_set(JSONObject properties)
```
    设置用户属性，如果属性已存在，则用新值替换原值
    
    参数:
    
    properties - 用户属性
  - user_set
```
public void user_set(JSONObject properties,
                     java.util.Date date)
```
  - user_delete
```
public void user_delete()
```
    删除用户属性，但会保留已上传的事件数据。该操作不可逆，需要慎重使用
  - user_delete
```
public void user_delete(java.util.Date date)
```
  - user_unset
```
public void user_unset(java.lang.String... properties)
```
    重置用户属性
  - user_unset
```
public void user_unset(JSONObject properties,
                       java.util.Date date)
```
  - identify
```
public void identify(java.lang.String identity)
```
    设置访客 ID，替换掉默认的 UUID 访客 ID
    
    参数:
    
    identity - 字符串类型的访客 ID.
  - login
```
public void login(java.lang.String loginId)
```
    设置账号ID，每次设置会覆盖之前的值。不会上传登录事件
    
    参数:
    
    loginId - 账号 ID
  - logout
```
public void logout()
```
    清空账号ID, 不会上传用户登出事件
  - getDistinctId
```
public java.lang.String getDistinctId()
```
    获取访客 ID: 上报数据中的 #distinct_id 值
    
    返回:
    
    访客 ID
  - getSuperProperties
```
public JSONObject getSuperProperties()
```
    获得已设置的公共事件属性
    
    返回:
    
    JSONObejct 已设置的公共事件属性
  - setSuperProperties
```
public void setSuperProperties(JSONObject superProperties)
```
    设置公共事件属性，之后上传的每个事件都会包含公共事件属性。公共事件属性会被保存，无需每次设置
    
    参数:
    
    superProperties - 公共事件属性
  - setDynamicSuperPropertiesTracker
```
public void setDynamicSuperPropertiesTracker(ThinkingAnalyticsSDK.DynamicSuperPropertiesTracker dynamicSuperPropertiesTracker)
```
    设置动态公共属性。之后上传的每个事件都会包含公共事件属性
    
    参数:
    
    dynamicSuperPropertiesTracker - 动态公共属性接口
  - unsetSuperProperty
```
public void unsetSuperProperty(java.lang.String superPropertyName)
```
    清除一条公共事件属性
    
    参数:
    
    superPropertyName - 要清除的公共事件属性key
  - clearSuperProperties
```
public void clearSuperProperties()
```
    清除所有公共事件属性
  - timeEvent
```
public void timeEvent(java.lang.String eventName)
```
    记录事件时长，调用此方法开始计时，目标事件上传时停止计时，并在事件属性中加入#duration属性，单位为秒
    
    参数:
    
    eventName - 目标事件名称
  - trackViewScreen
```
public void trackViewScreen(Activity activity)
```
    手动触发页面浏览事件上传
  - trackViewScreen
```
public void trackViewScreen(android.app.Fragment fragment)
```
    手动触发页面浏览事件上传
  - trackAppInstall
```
public void trackAppInstall()
```
    开启采集安装事件. added for unity3D.
  - enableAutoTrack
```
public void enableAutoTrack(int types)
```
  - enableAutoTrack
```
public void enableAutoTrack(java.util.List<ThinkingAnalyticsSDK.AutoTrackEventType> eventTypeList)
```
    开启自动采集事件功能
    
    参数:
    
    eventTypeList - 枚举 AutoTrackEventType 的列表，表示需要开启的自动采集事件类型
  - flush
```
public void flush()
```
    清空缓存队列. 当调用此函数时，会将目前缓存队列中的数据尝试上报. 如果上报成功会删除本地缓存数据.
  - ignoreViewType
```
public void ignoreViewType(java.lang.Class viewType)
```
    忽略指定类型的控件点击事件
    
    参数:
    
    viewType - 控件类型，如Dialog、CheckBox等
  - trackFragmentAppViewScreen
```
public void trackFragmentAppViewScreen()
```
    开启自动采集 Fragment 浏览事件
  - ignoreAutoTrackActivity
```
public void ignoreAutoTrackActivity(java.lang.Class<?> activity)
```
    忽略指定页面的自动采集事件，包括页面浏览和控件点击事件
    
    参数:
    
    activity - 指定页面
  - ignoreAutoTrackActivities
```
public void ignoreAutoTrackActivities(java.util.List<java.lang.Class<?>> activitiesList)
```
    忽略多个页面的自动采集事件，包括页面浏览和控件点击事件
    
    参数:
    
    activitiesList - 指定页面列表
  - setViewID
```
public void setViewID(View view,
                      java.lang.String viewID)
```
    自定义控件ID，如果不设置，默认使用 android:id
    
    参数:
    
    view - 控件
    
    viewID - 控件ID
  - setViewID
```
public void setViewID(android.app.Dialog view,
                      java.lang.String viewID)
```
    自定义控件ID，如果不设置，默认使用 android:id
    
    参数:
    
    view - 控件
    
    viewID - 控件ID
  - setViewProperties
```
public void setViewProperties(View view,
                              JSONObject properties)
```
    自定义控件点击事件的属性
    
    参数:
    
    view - 需要设置自定义属性的控件
    
    properties - 控件自定义属性
  - ignoreView
```
public void ignoreView(View view)
```
    忽略指定元素的点击事件
    
    参数:
    
    view - 指定元素
  - setJsBridge
```
public void setJsBridge(WebView webView)
```
    支持 H5 与原生 APP SDK 打通. 在 WebView 初始化时调用此函数.
    
    参数:
    
    webView - 传入 WebView 实例
  - setJsBridgeForX5WebView
```
public void setJsBridgeForX5WebView(java.lang.Object x5WebView)
```
    腾讯 X5 WebView 与原生 APP SDK 打通.
    
    参数:
    
    x5WebView - WebView 实例
  - getDeviceId
```
public java.lang.String getDeviceId()
```
    获取设备ID
    
    返回:
    
    设备ID
  - enableTracking
```
public void enableTracking(boolean enabled)
```
    打开/关闭实例功能. 当关闭 SDK 功能时，之前的缓存数据会保留，并继续上报; 但是不会追踪之后的数据和改动.
    
    参数:
    
    enabled - true 打开上报; false 关闭上报
  - optOutTrackingAndDeleteUser
```
public void optOutTrackingAndDeleteUser()
```
    停止上报此用户数据，并且发送 user_del (不会重试)
  - optOutTracking
```
public void optOutTracking()
```
    停止上报此用户的数据. 调用此接口之后，会删除本地缓存数据和之前设置; 后续的上报和设置都无效.
  - optInTracking
```
public void optInTracking()
```
    允许此实例的上报.
  - isEnabled
```
public boolean isEnabled()
```
    当前实例 Enable 状态. 通过 enableTracking 设置
    
    返回:
    
    true 已经恢复上报; false 已暂停上报.
  - hasOptOut
```
public boolean hasOptOut()
```
    当前实例 OptOut 状态. 通过 optOutTracking(), optInTracking() 设置
    
    返回:
    
    true 已停止上报; false 未停止上报.
  - createLightInstance
```
public ThinkingAnalyticsSDK createLightInstance()
```
    创建轻量级的 SDK 实例. 轻量级的 SDK 实例不支持缓存本地账号ID，访客ID，公共属性等.
    
    返回:
    
    SDK 实例
  - getToken
```
public java.lang.String getToken()
```
    获取当前实例的 APP ID
    
    返回:
    
    APP ID
  - getTimeString
```
public java.lang.String getTimeString(java.util.Date date)
```
  - calibrateTime
```
public static void calibrateTime(long timestamp)
```
    校准时间
    
    参数:
    
    timestamp - 当前时间戳
  - calibrateTimeWithNtp
```
public static void calibrateTimeWithNtp(java.lang.String... ntpServer)
```
    使用指定的 NTP Server 校准时间
    
    参数:
    
    ntpServer - NTP Server 列表
  - calibrateTimeWithNtpForUnity
```
public static void calibrateTimeWithNtpForUnity(java.lang.String ntpServer)
```

类 ThinkingAnalyticsSDK

嵌套类概要

方法概要

从类继承的方法 java.lang.Object

方法详细资料

sharedInstance

sharedInstance

sharedInstance

sharedInstance

getDataHandleInstance

enableTrackLog

setCustomerLibInfo

setNetworkType

setNetworkType

track

track

track

track

track

user_add

user_append

user_append

user_add

user_add

user_setOnce

user_setOnce

user_set

user_set

user_delete

user_delete

user_unset

user_unset

identify

login

logout

getDistinctId

getSuperProperties

setSuperProperties

setDynamicSuperPropertiesTracker

unsetSuperProperty

clearSuperProperties

timeEvent

trackViewScreen

trackViewScreen

trackAppInstall

enableAutoTrack

enableAutoTrack

flush

ignoreViewType

trackFragmentAppViewScreen

ignoreAutoTrackActivity

ignoreAutoTrackActivities

setViewID

setViewID

setViewProperties

ignoreView

setJsBridge

setJsBridgeForX5WebView

getDeviceId

enableTracking

optOutTrackingAndDeleteUser

optOutTracking

optInTracking

isEnabled

hasOptOut

createLightInstance

getToken

getTimeString

calibrateTime

calibrateTimeWithNtp

calibrateTimeWithNtpForUnity