API 参考

本文介绍用户画像服务相关接口。

API 列表

请求方式	API	描述
GET	/v1.0/user-profile/group/users	获取画像中指定人群的用户信息
GET	/v1.0/user-profile/user/tags	获取单个用户详细标签信息
GET	/v1.0/user-profile/group/user/check	校验用户是否在某个人群中

用户画像人群用户信息

功能描述

获取用户画像服务中某个人群的用户信息，用户信息包括用户 ID，email，mobile 等。

接口地址

GET /v1.0/user-profile/group/users

请求参数

参数名	参数类型	必填	说明
bizType	Integer	是	App 用户域
groupId	Integer	是	用户画像人群 ID
pageSize	Integer	否	每一页几条用户数据
lastId	Integer	否	根据上一页查询结果中返回的 lastId，查询下一页时必须带上；不传参数默认查询第一页。

返回参数

参数名	类型	说明
code	Integer	参见 全局错误码
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Object	返回结果

Result

参数名	类型	说明
resultDO	List	用户列表信息

请求示例

GET /v1.0/user-profile/group/users?params={"bizType":2xxx32,"groupId":1xx,"pageSize":10,"lastId":"ay15xxxxxxxxwnass3"}

返回示例

{
    "result": {
        "resultDO": {
            "data": [
                {
                    "email": "",
                    "mobile": "86-15XXXXXX587",
                    "uid": "ay1xxxxxxx23101eifQI"
                },
                {
                    "email": "yuxixxxxx@tuya.com",
                    "mobile": "",
                    "uid": "ay157xxxxxx58yV66h"
                },
                {
                    "email": "zxxxx@tuya.com",
                    "mobile": "",
                    "uid": "ay15xxxxxxxxxx4fAYcu"
                }
            ],
            "lastUid": "ay15xxxxxxxxwnT43",
            "totalCount": 3
        },
        "success": true
    },
    "success": true,
    "t": 1628236323685
}

用户画像单个用户详细标签信息

功能描述

获取某个用户的详细标签信息数据。

接口地址

GET /v1.0/user-profile/user/tags

请求参数

参数名	类型	必填	说明
bizType	Integer	是	App 用户域
tags	Integer	否	可选择用户具体标签返回；标签参考 用户画像服务中提供的标签 ；不传则无任何标签信息返回
searchValue	String	是	用户查询关键字，与 searchType 参数结合使用
searchType	Integer	否	0：账号搜索 1：邮箱搜索 2：手机号搜索 3：uid搜索 说明：不传参数默认使用账号搜索方式
isEn	Boolean	否	判断返回标签信息内容是否为英文 true: 展示英文 false: 展示中文 说明：不传参数默认展示中文

返回参数

参数名	类型	说明
code	Integer	参见 全局错误码
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Object	返回结果

Result

参数名	类型	说明
resultDO	Map	用户具体标签值

请求示例

GET /v1.0/user-profile/user/tags?params={"bizType":12xx27 ,"searchValue":"ay162xxxxxxxxJmfe","tags":["username","user_level","city_cn"],"searchType":3,"isEn":false}

返回示例

{
    "result": {
        "resultDO": {
            "city_cn": "杭州",
            "user_level": "初级用户",
            "username": "yxxxxx@tuya.com"
        },
        "success": true
    },
    "success": true,
    "t": 1628236440462
}

用户画像校验用户是否在某个人群中

功能描述

校验某个用户是否在用户画像的某个人群中。

接口地址

GET /v1.0/user-profile/group/user/check

请求参数

参数名	类型	必填	说明
bizType	Integer	是	App 用户域
groupId	Integer	是	用户画像服务中的人群 ID
searchValue	String	是	用户查询关键字，与 searchType 参数结合使用
searchType	Integer	否	0：账号搜索 1：邮箱搜索 2：手机号搜索 3：uid 搜索 说明：不传参数默认使用账号搜索方式

返回参数

参数名	类型	说明
code	Integer	参见 全局错误码
success	Boolean	是否成功： true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Object	返回结果

Result

参数名	类型	说明
resultDO	Boolean	true：表示在人群中 false：不在人群中

请求示例

GET /v1.0/user-profile/group/user/check?params={"bizType":4xxx22,"groupId":9xx,"searchValue":"guxxxxx0153915","searchType":0}

返回示例

{
    "result": {
        "resultDO": true,
        "success": true
    },
    "success": true,
    "t": 1628236525772
}