海纳嗨数-帮助中心
SDK接入
帮助中心 > 技术文档 > 服务端SDK > PHP SDK > SDK接入
1. 初始化SDK
# 使用 Consumer 来构造 sdk 对象
$ha = new HinaSdk($consumer);
参数解释:
参数 | 默认值 | 说明 |
---|---|---|
consumer | String | consumer |
2. 设置用户ID
SDK 实例登录前使用匿名ID发送事件,登录后使用登录后ID发送事件,匿名ID和登录后ID
用户登录后,可以将登录ID和匿名ID绑定
$ha->bindId($account_id,$anonymous_id);
参数解释:
参数 | 默认值 | 说明 |
---|---|---|
account_id | String | 登录ID |
anonymous_id | String | 匿名ID |
3. 设置用户属性
3.1 设置用户属性
直接设置用户的属性,如果存在则覆盖
$ha->userSet($account_id,$is_login_id, $profiles);
参数解释:
参数 | 默认值 | 说明 |
---|---|---|
account_id | String | 您平台用户唯一标识 |
is_login_id | boolean | 是否登录 |
profiles | Map<String, Object> | 用户属性 |
3.2 固定初始值的属性,首次设置
如果不存在则设置,存在就不设置
$ha->userSetOnce($account_id,$is_login_id, $profiles);
参数解释:
参数 | 默认值 | 说明 |
---|---|---|
account_id | String | 您平台用户唯一标识 |
is_login_id | boolean | 是否登录 |
profiles | Map<String, Object> | 用户属性 |
3.3 数值类型的属性
对当前用户的属性做递增或者递减
$ha->userAdd($account_id,$is_login_id, $profiles);
参数解释:
参数 | 默认值 | 说明 |
---|---|---|
account_id | String | 您平台用户唯一标识 |
is_login_id | boolean | 是否登录 |
profiles | Map<String, Object> | 用户属性 |
3.4 属性取消
删除当前用户的一些属性
$ha->userUnset($account_id,$is_login_id, $profiles);
参数解释:
参数 | 默认值 | 说明 |
---|---|---|
account_id | String | 您平台用户唯一标识 |
is_login_id | boolean | 是否登录 |
profiles | Map<String, Object> | 用户属性 |
4. 设置公共事件属性
对于所有事件都需要添加的属性,可在初始化 SDK 后,调用 registerCommonProperties
将属性注册为公共属性
$super_properties=array(
"super_property1"=>"value1",
"super_property2"=>"value2",
"super_property3"=>"value3"
);
$ha->registerSuperProperties($super_properties);
参数解释:
参数 | 默认值 | 说明 |
---|---|---|
super_properties | array | 属性值集合 |
5. 发送事件
在 SDK 初始化完成之后,您就可以进行数据埋点,收集用户的的行为信息
可以调用 track
来上传事件,以下是示例
# 使用 Consumer 来构造 sdk 对象
$ha = new HinaSdk($consumer);
# 以下是触发一个事件测试数据发送
$account_id = 'ABCDEF123456789';
$ha->track($account_id, $is_login_id, $event_name);
/* 正常情况,事件数只有累积到一个批次数,才会发送,使用flush方法,可以立即提交未发送的所有事件。
您系统为了批量上报数据不丢失,需要注意点:
1、在你做实时数据上报时,您应用系统shudown 时触发强推,将缓存中数据上报;
2、在您做历史数据导入时,在导入结束后,触发强推,将缓存中数据上报;*/
$ha->flush();
参数解释:
参数 | 默认值 | 说明 |
---|---|---|
consumer | Consumer | 操作对象 |
account_id | String | 您平台用户唯一标识 |
is_login_id | boolean | 是否登录 |
event_name | string | 事件名 |
6. 立即上报(强制推送)
$ha->flush();
注意:
1、正常情况,事件数只有累积到一个批次数,才会发送
2、使用flush方法,可以立即提交未发送的所有事件。
作者:涂泽 创建时间:2024-10-12 16:55
最后编辑:涂泽 更新时间:2024-10-31 14:08
最后编辑:涂泽 更新时间:2024-10-31 14:08