Java SDK API说明--增长分析 DataFinder-火山引擎

文档中心

导航

Java SDK API说明

最近更新时间：2025.08.27 10:35:34首次发布时间：2025.08.26 20:15:36

sendEvent

作用：上报事件
定义：这个方法有多个接口定义，功能都是一样的，只不过参数有区别。

void sendEvent(String userUniqueId, int appId, Map<String, Object> custom, String eventName, Map<String, Object> eventParams,long localTimeMs);
void sendEvent(String userUniqueId, int appId, Map<String, Object> custom, String eventName, Map<String, Object> eventParams);
void sendEvent(Header header, String eventName, Map<String, Object> eventParams);
void sendEvent(Header header, String eventName, Map<String, Object> eventParams, long localTimeMs);

参数说明：

参数名	类型	说明
userUniqueId	string	用户的唯一身份标识，需要保证同一个用户在本应用内全局唯一，即需要与客户端上报一致，不能为null
appId	int	应用ID
custom	map	事件公共属性，不能为null
eventName	string	事件名称，不能为null
eventParams	map	事件属性，不能为null
localTimeMs	long	时间发生的本地时间戳，如果没有传的话，那么就会用sdk本地自身生成的
header	Header	上报的header参数，通过调用`HeaderV3.Builder().build()`构建一个header。 header中 userUniqueId 和 appId 必传，其他非必须。 header支持的参数可以参考HTTP API。

sendEvents

作用：上报事件，接口支持传入多个event
定义：void sendEvents(Header header, List<Event> events)
参数说明：

参数名

类型

说明

header

Header

上报的header参数，通过调用HeaderV3.Builder().build()构建一个header。

header中 userUniqueId 和 appId 必传，其他非必须。
header支持的参数可以参考HTTP API。

events

List

事件数组，不推荐您自己构建事件数组，我们推荐使用EventsBuilder这个类对多事件进行构造，调用build方法生成事件数组。

用户属性相关接口

作用: 设置用户属性，不同的方法作用不一样

函数名	作用
profileSet	设置用户属性，存在则覆盖，不存在则创建。
profileSetOnce	设置用户属性，存在则不设置，不存在则创建，适合首次相关的用户属性，比如首次访问时间等。与profileSet接口不同的是：若某profile已成功通过profileSetOnce接口设置，那么对该profile再次调用profileSetOnce接口无效。
profileIncrement	设置数值类型的属性，可进行累加。
profileAppend	设置List类型的用户属性，可持续向List内添加。
profileUnset	删除用户的属性。

定义：profile相关的接口有多个，参数含义一致。

void profileSet(String userUniqueId, int appId, Map<String, Object> profiles);
void profileSetOnce(String userUniqueId, int appId, Map<String, Object> profiles);
void profileIncrement(String userUniqueId, int appId, Map<String, Object> profiles);
void profileAppend(String userUniqueId, int appId, Map<String, Object> profiles);
void profileUnset(String userUniqueId, int appId, List<String> profileNames);
void profileSet(Header header, Map<String, Object> profiles)
void profileSetOnce(Header header, Map<String, Object> profiles);
void profileIncrement(Header header, Map<String, Object> profiles);
void profileAppend(Header header, Map<String, Object> profiles);
void profileUnset(Header header, List<String> profiles);

参数说明：

参数名	类型	说明
header	Header	上报的header参数，通过调用`HeaderV3.Builder().build()`构建一个header。 header中 userUniqueId 和 appId 必传，其他非必须。 header支持的参数可以参考HTTP API。
userUniqueId	string	用户的唯一身份标识，需要保证同一个用户在本应用内全局唯一，即需要与客户端上报一致，不能为null。
appId	int	appId。
profiles	Map<String,Object>	用户属性，key为用户属性名称，value为用户属性value。
profileNames	List	用户属性名称列表。

业务对象相关接口

作用: 设置业务对象属性，不同的方法作用不一样

函数名	作用
itemSet	设置Item属性，存在则覆盖，不存在则创建。
itemUnset	删除Item属性。

定义：profile相关的接口有多个，参数含义一致。

void itemSet(int appId, String name, List<Item> items);
void itemUnset(int appId, String id, String name, List<String> params);

参数说明：

参数名	类型	说明
appId	int	应用ID
name	String	业务对象名称
items	List	业务对象类，需要继承Item类
id	String	业务对象id
params	List	业务对象属性名称列表