com.sensorsdata.analytics.javasdk

Class SensorsAnalytics

java.lang.Object

com.sensorsdata.analytics.javasdk.SensorsAnalytics

public class SensorsAnalytics
extends Object

Sensors Analytics SDK

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SensorsAnalytics.AsyncBatchConsumer Deprecated. Async模式下，开发者需要仔细处理缓存中的数据，如由于异步发送不及时导致缓存队列过大、程序停止时缓 存队列清空等问题。因此我们建议开发者使用 LoggingConsumer 结合 LogAgent 工具导入数据。
static interface	SensorsAnalytics.AsyncBatchConsumerCallback Deprecated.
static class	SensorsAnalytics.BatchConsumer
static class	SensorsAnalytics.ConcurrentLoggingConsumer
static class	SensorsAnalytics.ConsoleConsumer
static class	SensorsAnalytics.DebugConsumer
static class	SensorsAnalytics.LoggingConsumer

Constructor Summary

Constructors

Constructor and Description
SensorsAnalytics(com.sensorsdata.analytics.javasdk.SensorsAnalytics.Consumer consumer)

Method Summary

Modifier and Type	Method and Description
void	clearSuperProperties() 清除公共属性
void	flush() 立即发送缓存中的所有日志
boolean	isEnableTimeFree()
void	profileAppend(String distinctId, boolean isLoginId, Map<String,Object> properties) 为用户的一个或多个数组类型的属性追加字符串，属性取值类型必须为 List，且列表中元素的类型 必须为 String
void	profileAppend(String distinctId, boolean isLoginId, String property, String value) 为用户的数组类型的属性追加一个字符串
void	profileDelete(String distinctId, boolean isLoginId) 删除用户所有属性
void	profileIncrement(String distinctId, boolean isLoginId, Map<String,Object> properties) 为用户的一个或多个数值类型的属性累加一个数值，若该属性不存在，则创建它并设置默认值为0。属性取值只接受 Number类型
void	profileIncrement(String distinctId, boolean isLoginId, String property, long value) 为用户的数值类型的属性累加一个数值，若该属性不存在，则创建它并设置默认值为0
void	profileSet(String distinctId, boolean isLoginId, Map<String,Object> properties) 设置用户的属性。属性取值可接受类型为Number, String, Date和List， 若属性包含 $time 字段，则它会覆盖事件的默认时间属性，该字段只接受Date类型 如果要设置的properties的key，之前在这个用户的profile中已经存在，则覆盖，否则，新创建
void	profileSet(String distinctId, boolean isLoginId, String property, Object value) 设置用户的属性。这个接口只能设置单个key对应的内容，同样，如果已经存在，则覆盖，否则，新创建
void	profileSetOnce(String distinctId, boolean isLoginId, Map<String,Object> properties) 首次设置用户的属性。 属性取值可接受类型为Number, String, Date和List， 若属性包含 $time 字段，则它会覆盖事件的默认时间属性，该字段只接受Date类型 与profileSet接口不同的是： 如果要设置的properties的key，在这个用户的profile中已经存在，则不处理，否则，新创建
void	profileSetOnce(String distinctId, boolean isLoginId, String property, Object value) 首次设置用户的属性。这个接口只能设置单个key对应的内容。 与profileSet接口不同的是，如果key的内容之前已经存在，则不处理，否则，重新创建
void	profileUnset(String distinctId, boolean isLoginId, String property) 删除用户某一个属性
void	registerSuperProperties(Map<String,Object> superPropertiesMap) 设置每个事件都带有的一些公共属性 当track的Properties，superProperties和SDK自动生成的automaticProperties有相同的key时，遵循如下的优先级： track.properties 高于 superProperties 高于 automaticProperties 另外，当这个接口被多次调用时，是用新传入的数据去merge先前的数据 例如，在调用接口前，dict是 {"a":1, "b": "bbb"}，传入的dict是 {"b": 123, "c": "asd"}，则merge后 的结果是 {"a":1, "b": 123, "c": "asd"}
void	setEnableTimeFree(boolean enableTimeFree)
void	shutdown() 停止SensorsDataAPI所有线程，API停止前会清空所有本地数据
void	track(String distinctId, boolean isLoginId, String eventName) 记录一个没有任何属性的事件
void	track(String distinctId, boolean isLoginId, String eventName, Map<String,Object> properties) 记录一个拥有一个或多个属性的事件。属性取值可接受类型为Number, String, Date和 List，若属性包含 $time 字段，则它会覆盖事件的默认时间属性，该字段只接受Date类型
void	trackSignUp(String loginId, String anonymousId) 记录用户注册事件 这个接口是一个较为复杂的功能，请在使用前先阅读相关说明: http://www.sensorsdata.cn/manual/track_signup.html 并在必要时联系我们的技术支持人员。
void	trackSignUp(String loginId, String anonymousId, Map<String,Object> properties) 记录用户注册事件 这个接口是一个较为复杂的功能，请在使用前先阅读相关说明: http://www.sensorsdata.cn/manual/track_signup.html 并在必要时联系我们的技术支持人员。

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SensorsAnalytics

public SensorsAnalytics(com.sensorsdata.analytics.javasdk.SensorsAnalytics.Consumer consumer)

Method Detail

isEnableTimeFree

public boolean isEnableTimeFree()

setEnableTimeFree

public void setEnableTimeFree(boolean enableTimeFree)

registerSuperProperties

public void registerSuperProperties(Map<String,Object> superPropertiesMap)

设置每个事件都带有的一些公共属性 当track的Properties，superProperties和SDK自动生成的automaticProperties有相同的key时，遵循如下的优先级： track.properties 高于 superProperties 高于 automaticProperties 另外，当这个接口被多次调用时，是用新传入的数据去merge先前的数据 例如，在调用接口前，dict是 {"a":1, "b": "bbb"}，传入的dict是 {"b": 123, "c": "asd"}，则merge后 的结果是 {"a":1, "b": 123, "c": "asd"}

Parameters:

superPropertiesMap - 一个或多个公共属性

clearSuperProperties

public void clearSuperProperties()

清除公共属性

track

public void track(String distinctId,
                  boolean isLoginId,
                  String eventName)
           throws InvalidArgumentException

记录一个没有任何属性的事件

Parameters:

distinctId - 用户 ID

isLoginId - 用户 ID 是否是登录 ID，false 表示该 ID 是一个匿名 ID

eventName - 事件名称

Throws:

InvalidArgumentException - eventName 或 properties 不符合命名规范和类型规范时抛出该异常

track

public void track(String distinctId,
                  boolean isLoginId,
                  String eventName,
                  Map<String,Object> properties)
           throws InvalidArgumentException

记录一个拥有一个或多个属性的事件。属性取值可接受类型为Number, String, Date和 List，若属性包含 $time 字段，则它会覆盖事件的默认时间属性，该字段只接受Date类型

Parameters:

distinctId - 用户 ID

isLoginId - 用户 ID 是否是登录 ID，false 表示该 ID 是一个匿名 ID

eventName - 事件名称

properties - 事件的属性

Throws:

InvalidArgumentException - eventName 或 properties 不符合命名规范和类型规范时抛出该异常

trackSignUp

public void trackSignUp(String loginId,
                        String anonymousId)
                 throws InvalidArgumentException

记录用户注册事件 这个接口是一个较为复杂的功能，请在使用前先阅读相关说明: http://www.sensorsdata.cn/manual/track_signup.html 并在必要时联系我们的技术支持人员。

Parameters:

loginId - 登录 ID

anonymousId - 匿名 ID

Throws:

InvalidArgumentException - eventName 或 properties 不符合命名规范和类型规范时抛出该异常

trackSignUp

public void trackSignUp(String loginId,
                        String anonymousId,
                        Map<String,Object> properties)
                 throws InvalidArgumentException

记录用户注册事件 这个接口是一个较为复杂的功能，请在使用前先阅读相关说明: http://www.sensorsdata.cn/manual/track_signup.html 并在必要时联系我们的技术支持人员。

属性取值可接受类型为Number, String, Date和List，若属性包 含 $time 字段，它会覆盖事件的默认时间属性，该字段只接受Date类型

Parameters:

loginId - 登录 ID

anonymousId - 匿名 ID

properties - 事件的属性

Throws:

InvalidArgumentException - eventName 或 properties 不符合命名规范和类型规范时抛出该异常

profileSet

public void profileSet(String distinctId,
                       boolean isLoginId,
                       Map<String,Object> properties)
                throws InvalidArgumentException

设置用户的属性。属性取值可接受类型为Number, String, Date和List， 若属性包含 $time 字段，则它会覆盖事件的默认时间属性，该字段只接受Date类型 如果要设置的properties的key，之前在这个用户的profile中已经存在，则覆盖，否则，新创建

Parameters:

distinctId - 用户 ID

isLoginId - 用户 ID 是否是登录 ID，false 表示该 ID 是一个匿名 ID

properties - 用户的属性

Throws:

InvalidArgumentException - eventName 或 properties 不符合命名规范和类型规范时抛出该异常

profileSet

public void profileSet(String distinctId,
                       boolean isLoginId,
                       String property,
                       Object value)
                throws InvalidArgumentException

设置用户的属性。这个接口只能设置单个key对应的内容，同样，如果已经存在，则覆盖，否则，新创建

Parameters:

distinctId - 用户 ID

isLoginId - 用户 ID 是否是登录 ID，false 表示该 ID 是一个匿名 ID

property - 属性名称

value - 属性的值

Throws:

InvalidArgumentException - eventName 或 properties 不符合命名规范和类型规范时抛出该异常

profileSetOnce

public void profileSetOnce(String distinctId,
                           boolean isLoginId,
                           Map<String,Object> properties)
                    throws InvalidArgumentException

首次设置用户的属性。 属性取值可接受类型为Number, String, Date和List， 若属性包含 $time 字段，则它会覆盖事件的默认时间属性，该字段只接受Date类型 与profileSet接口不同的是： 如果要设置的properties的key，在这个用户的profile中已经存在，则不处理，否则，新创建

Parameters:

distinctId - 用户 ID

isLoginId - 用户 ID 是否是登录 ID，false 表示该 ID 是一个匿名 ID

properties - 用户的属性

Throws:

InvalidArgumentException - eventName 或 properties 不符合命名规范和类型规范时抛出该异常

profileSetOnce

public void profileSetOnce(String distinctId,
                           boolean isLoginId,
                           String property,
                           Object value)
                    throws InvalidArgumentException

首次设置用户的属性。这个接口只能设置单个key对应的内容。 与profileSet接口不同的是，如果key的内容之前已经存在，则不处理，否则，重新创建

Parameters:

distinctId - 用户 ID

isLoginId - 用户 ID 是否是登录 ID，false 表示该 ID 是一个匿名 ID

property - 属性名称

value - 属性的值

Throws:

InvalidArgumentException - eventName 或 properties 不符合命名规范和类型规范时抛出该异常

profileIncrement

public void profileIncrement(String distinctId,
                             boolean isLoginId,
                             Map<String,Object> properties)
                      throws InvalidArgumentException

为用户的一个或多个数值类型的属性累加一个数值，若该属性不存在，则创建它并设置默认值为0。属性取值只接受 Number类型

Parameters:

distinctId - 用户 ID

isLoginId - 用户 ID 是否是登录 ID，false 表示该 ID 是一个匿名 ID

properties - 用户的属性

Throws:

InvalidArgumentException - eventName 或 properties 不符合命名规范和类型规范时抛出该异常

profileIncrement

public void profileIncrement(String distinctId,
                             boolean isLoginId,
                             String property,
                             long value)
                      throws InvalidArgumentException

为用户的数值类型的属性累加一个数值，若该属性不存在，则创建它并设置默认值为0

Parameters:

distinctId - 用户 ID

isLoginId - 用户 ID 是否是登录 ID，false 表示该 ID 是一个匿名 ID

property - 属性名称

value - 属性的值

Throws:

InvalidArgumentException - eventName 或 properties 不符合命名规范和类型规范时抛出该异常

profileAppend

public void profileAppend(String distinctId,
                          boolean isLoginId,
                          Map<String,Object> properties)
                   throws InvalidArgumentException

为用户的一个或多个数组类型的属性追加字符串，属性取值类型必须为 List，且列表中元素的类型 必须为 String

Parameters:

distinctId - 用户 ID

isLoginId - 用户 ID 是否是登录 ID，false 表示该 ID 是一个匿名 ID

properties - 用户的属性

Throws:

InvalidArgumentException - eventName 或 properties 不符合命名规范和类型规范时抛出该异常

profileAppend

public void profileAppend(String distinctId,
                          boolean isLoginId,
                          String property,
                          String value)
                   throws InvalidArgumentException

为用户的数组类型的属性追加一个字符串

Parameters:

distinctId - 用户 ID

isLoginId - 用户 ID 是否是登录 ID，false 表示该 ID 是一个匿名 ID

property - 属性名称

value - 属性的值

Throws:

InvalidArgumentException - eventName 或 properties 不符合命名规范和类型规范时抛出该异常

profileUnset

public void profileUnset(String distinctId,
                         boolean isLoginId,
                         String property)
                  throws InvalidArgumentException

删除用户某一个属性

Parameters:

distinctId - 用户 ID

isLoginId - 用户 ID 是否是登录 ID，false 表示该 ID 是一个匿名 ID

property - 属性名称

Throws:

InvalidArgumentException - eventName 或 properties 不符合命名规范和类型规范时抛出该异常

profileDelete

public void profileDelete(String distinctId,
                          boolean isLoginId)
                   throws InvalidArgumentException

删除用户所有属性

Parameters:

distinctId - 用户 ID

isLoginId - 用户 ID 是否是登录 ID，false 表示该 ID 是一个匿名 ID

Throws:

InvalidArgumentException - distinctId 不符合命名规范时抛出该异常

flush

public void flush()

立即发送缓存中的所有日志

shutdown

public void shutdown()

停止SensorsDataAPI所有线程，API停止前会清空所有本地数据