设置用户属性

最新更新:2025-03-18

调用地址

POST /v1/user/property

调用验证

EngageLab REST API 采用 HTTP 基本认证 的验证方式:HTTP Header(头)里加 Authorization:

Authorization: Basic ${base64_auth_string}
          Authorization: Basic ${base64_auth_string}

        
此代码块在浮窗中显示

上述 base64_auth_string 的生成算法为:base64(api_key:api_secret)

  • Header 名称是 "Authorization",值是 base64 转换过的 "username:password" 对(中间有个冒号)。
  • 在 MA API 的场景里,username 是 APIKey,password 是 APISecret。请在数据来源中添加 API 类型的数据源获得 APIKey 与 API Secret。

请求示例

请求头

> POST /v1/user/property > Content-Type: application/json > Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
          > POST /v1/user/property
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

        
此代码块在浮窗中显示

请求体

{ "euid":10362473, "type": "set", "properties":{ "user_number_once":46.2, //用户属性名称和属性值 "user_string_once":"refef", "user_datetime_once": "2023-12-12 00:56:23" } }
          {
    "euid":10362473,
    "type": "set",
    "properties":{
        "user_number_once":46.2, //用户属性名称和属性值
        "user_string_once":"refef",
        "user_datetime_once": "2023-12-12 00:56:23"
    }
}

        
此代码块在浮窗中显示

请求参数

字段 类型 必填 描述
euid Long EngageLab MA 用户唯一ID
type String 对属性进行更新的操作类型,支持 set、increase、add、remove、delete 5 种类型。
  • set:覆盖更新属性的值
  • increase:对 int 类型的属性,对所有上报的数据进行累加,如果这个用户属性之前不存在,则初始值当做 0 来处理。
  • add:对 List 类型的属性,追加某个属性值
  • remove:对 List 类型的属性,移除某个属性值
  • delete:删除属性的所有属性值
  • properties JSON 用户属性列表,key 是属性名,value 是属性值

    返回参数

    字段 类型 必填 描述
    code Int 接口调用是否成功,0 表示成功或者部分成功,其他值代表失败
    message String 接口调用结果描述,对返回码的说明

    全部成功

    { "code": 0, "message": "success" }
              {
        "code": 0,
        "message": "success"
    }
    
            
    此代码块在浮窗中显示

    全部失败

    { "code": 55102, "message": "Invalid user attributes exist" }
              {
        "code": 55102,
        "message": "Invalid user attributes exist"
    }
    
            
    此代码块在浮窗中显示

    错误码

    错误码 错误码说明 解决措施
    40050 接口鉴权失败 确认密钥是否正确
    55004 业务参数不合法 请检查 properties 字段是否正确
    55102 存在无效的用户属性 确认属性key是否合法
    55103 用户属性值不能为空 确认请求体中用户属性的值是否为空
    在文档中心打开
    icon
    联系销售