跳到主要内容

根据 OpenID 增加用户自定义字段

AddAttributesByOpenID:根据 OpenID 增加用户自定义字段。需在 SmartLink > 所有联系人 > 字段设置 先创建好字段。

POST /api/v3/userinfo/add_attributes_by_openid

请求参数

了解关于查询参数的更多信息,请参见 查询参数

属性数据类型备注描述
openidstring必填唯一用户 ID(最多20个数字字符)
modify_tsbigint必填最后更新时间戳(以毫秒为单位)
attributesobject必填自定义用户属性。支持更新联系人的其他属性,例如性别、生日等。
用于用户分层,进而创建更个性化的活动:
  • 需在 SmartLink > 所有联系人 > 字段设置 先创建好字段,若导入不存在的字段则会更新失败。
  • 用户属性只能增加或更新,未更新的字段不会覆盖原来数据。
  • 每用户自定义属性字段累计不超过50个。
attributes 类型与格式:
  • Text 类型:格式为 { "key":"value" }
    - key:自定义属性名称
    - value:string 类型,范围不超过1000个字符
  • Number 类型:格式为 { "key":"value" }
    - key:自定义属性名称
    - value:string 类型,范围 -92233720368547758089223372036854775807 之间
  • Date 类型:格式为 { "key":"value" }
    - key:自定义属性名称
    - value:string 类型,日期格式为 2001-03-31+08:002001-03-31 00:00:00+08:00
  • Drop down 类型:格式为 { "key":["value"] }
    - key:自定义属性名称
    - value:[]string 类型,单个 string 不超过1000字符,如 ["选项1","选项2"]
update_strategyint选填是否更新 subscribe 字段,详见 更新策略

请求示例

curl --request POST "https://openapi.smartlink.intlgame.com/api/v3/userinfo/add_attributes_by_openid?gameid=${GAME_ID}&seq=${YOUR_RANDOM_STRING}&sig=${SIGNATURE}&ts=${TS}" \
--header 'Content-Type: application/json' \
--data-raw '{
"openid": "1012156612344364",
"modify_ts": 1691225447577,
"attributes": {
"nickname": "tang",
"level": "10",
"birthday": "1990-05-09 00:00:00+08:00",
"prop":["option1","option2"]
}
}'

响应参数

属性数据类型描述
codeint返回码
msgstring返回消息

响应示例

{
"code": 0,
"msg": "Success",
"seq": "{YOUR_RANDOM_STRING}"
}