设置用户属性

 

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

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

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

注：

1. 用户属性格式要求与事件属性保持一致。
2. 所有用户属性设置事件上报时设置的自定义属性均不能为"_"下划线开头，"_"下划线开头为SDK保留字段，开发者设置则直接报错丢弃。

 

userInit

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

方法示例

static void userInit(TSharedPtr<FJsonObject> Properties);

参数说明

调用示例

TSharedPtr<FJsonObject> Properties = MakeShareable(new FJsonObject);
Properties->SetStringField(TEXT("user_name"), TEXT("John Doe"));
Properties->SetNumberField(TEXT("user_age"), 25);
Properties->SetBoolField(TEXT("is_vip"), true);
USEAnalytics::userInit(Properties);

 

userUpdate

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

方法示例

static void userUpdate(TSharedPtr<FJsonObject> Properties);

参数说明

调用示例

TSharedPtr<FJsonObject> Properties = MakeShareable(new FJsonObject);
Properties->SetStringField(TEXT("user_level"), TEXT("Gold"));
Properties->SetNumberField(TEXT("user_score"), 1500);
Properties->SetBoolField(TEXT("has_premium"), true);
USEAnalytics::userUpdate(Properties);

 

userAdd

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

方法示例

static void userAdd(TSharedPtr<FJsonObject> Properties);

参数说明

调用示例

TSharedPtr<FJsonObject> Properties = MakeShareable(new FJsonObject);
Properties->SetNumberField(TEXT("coins"), 100);
Properties->SetNumberField(TEXT("gems"), 50);
Properties->SetNumberField(TEXT("experience"), 250);
USEAnalytics::userAdd(Properties);

注：本方法只对 value 值为数值类型的 key 值进行 add 累加操作

 

userUnset

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

方法示例

static void userUnset(const TArray<FString>& keys);

参数说明

调用示例

TArray<FString> KeysToUnset;
KeysToUnset.Add(TEXT("age"));
KeysToUnset.Add(TEXT("gender"));
KeysToUnset.Add(TEXT("level"));
USEAnalytics::userUnset(KeysToUnset);

 

userAppend

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

方法示例

static void userAppend(TSharedPtr<FJsonObject> Properties);

参数说明

调用示例

TSharedPtr<FJsonObject> Properties = MakeShareable(new FJsonObject);
Properties->SetNumberField(TEXT("action"), 100);
USEAnalytics::userAppend(Properties);

 

userDelete

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

方法示例

static void userDelete(int32 DeleteType);

调用示例

const int32 DeleteType = 0;
USEAnalytics::userDelete(DeleteType);