菜单

设置用户属性

在热力引擎中,专门提供了针对用户属性设置数据的上报方法,针对用户的属性添加或变更,您可以通过该方法进行上报。

建议您将与用户相关的不变的、或变化频率比较低、或保存价值比较高的属性,比如年龄、创建角色时间、等级、所在地、首次付费时间、总付费金额等属性设置为用户属性,其它变化频率比较高的属性通过事件进行上报和记录。

用户属性设置分为以下几种方式:userUpdate、userInit、userAdd、userUnset、userAppend、userDelete,由开发者调用,对用户属性进行设置。

注:

  1. 用户属性格式要求与事件属性保持一致。
  2. 用户属性上报时设置的自定义属性均不支持开发者传入"_"下划线开头的 key 值,SDK 会默认丢弃该条属性。

 

userInit

 

如果您要上传一批用户属性,其中已经存在的用户属性不去更新属性值、不存在的属性进行创建并保存属性值,则可以调用 userInit 来进行设置。

调用示例:

[[SolarEngineSDK sharedInstance] userInit:@{ @"name" : @"Tom", @"city" : @"Beijing", @"age" : @(18)}];
 

 

userUpdate

 

对于一般的用户属性,您可以调用 userUpdate 来进行设置,使用该接口上传的属性将会覆盖原有的属性值,如果之前不存在该用户属性,则会新建该用户属性,类型与传入属性的类型一致。

此处以设置城市为例:

[[SolarEngineSDK sharedInstance] userUpdate:@{ @"city" : @"Shenzhen" }];
// 此时 "city" 为"Shenzhen"
 

 

userAdd

 

当您要上传数值型的属性时,您可以调用 userAdd 来对该属性进行累加操作,如果该属性还未被设置,则会赋值 0 后再进行计算,可传入负值,等同于相减操作。

此处以累计付费金额为例:

[[SolarEngineSDK sharedInstance] userAdd:@{ @"totalRevenue" : @(30) }];
// 此时 "totalRevenue" 为 30
[[SolarEngineSDK sharedInstance] userAdd:@{ @"totalRevenue" : @(648) }];
// 此时 "totalRevenue" 为 678
 

userAdd 设置的属性类型以及 key 值的限制与 userUpdate 一致,但 Value 只允许 NSNumber 类型。

 

 

userUnset

 

当您要清空用户的用户属性值时,您可以调用 userUnset 来对指定属性(字符串数组)进行清空操作,如果该属性还未在集群中被创建,则 不会 创建该属性。

调用示例:

[[SolarEngineSDK sharedInstance] userUnset:@[@"age"]];
 

userUnset 传入的参数是用户属性的属性名,类型是字符串数组。

 

 

userAppend

 

您可以调用 userAppend 对数组类型的用户属性进行追加操作。如果该属性不存在,则会新建该属性。

调用示例:

// 调用 userAppend 为用户属性 name 追加元素。如果不存在,会新建该元素
[[SolarEngineSDK sharedInstance] userAppend:@{ @"name" : @"sum"}];
 

 

userDelete

 

如果您要删除某个用户,可以调用 userDelete 将这名用户删除。用户删除后,您将无法再查询该名用户的用户属性,但该用户产生的事件仍然可以被查询到。

参数相关:

参数名称 参数含义 参数类型 是否必传
deleteType 通过什么类型删除 SEUserDeleteType 枚举SEUserDeleteTypeByAccountId: 通过AccountId删除用户SEUserDeleteTypeByVisitorId:通过VisitorId删除用户

调用示例:

[[SolarEngineSDK sharedInstance] userDelete:SEUserDeleteTypeByAccountId];
最近修改: 2025-05-20Powered by