获取用户的用户信息、设备信息、用户标签与用户属性值--增长分析 DataFinder-火山引擎

文档中心

立即注册

导航

获取用户的用户信息、设备信息、用户标签与用户属性值

最近更新时间：2024.06.30 18:36:03首次发布时间：2024.06.30 18:36:03

请求说明

Path：openapi/v1/{app_id}/behaviors/profiles
Method: POST
Content-type: application/json

请求参数

Body: 参考公共参数说明

返回参数

Response:

{
    "code": 200,
    "message": "success",
    "data": {
        "user_info": {
            "register_time": 1670310396,
            "first_event_time": 1670310396,
            "last_use": "2023-01-18",
            "city": "",
            "ssid": "32cee072-0c1d-4bb4-8a24-31b605dfe673",
            "user_unique_id": "data_quality_report_38",
            "id_info": {
                "ssid": "32cee072-0c1d-4bb4-8a24-31b605dfe673",
                "user_unique_id": "data_quality_report_38",
                "device_id": ""
            }
        },
        "device_info": {
            "device_model": "",
            "app_version": "",
            ....
        },
        "custom_user_props": {
            "profile_1": "profile_value",
            ...
        },
        "user_tag_props"： {
            "tag_1": "标签值",
            ...
        }
}

字段含义说明

参数	类型	示例值	描述
user_info	object	参见下文的返回示例	用户信息，包含注册时间、首次事件发生时间、最近使用时间、最近ip所在城市、id信息等。 *上述信息如果不存在会用null或空串填充。
device_info	object		设备信息，包含设备型号、操作系统、应用版本、应用渠道、小程序应用版本、设备品牌、浏览器、分辨率、语言、设备价格等。 saas版本中，设备信息仅从app_launch或predefine_pageview事件中抽取。私有化版本中，设备信息仅从用户的最新一条事件中抽取，假设该用户的最新一条事件没有上报设备型号，那本接口也不会返回。 *上述信息如果不存在会用null或空串填充
custom_user_props	object		用户属性，包含客户通过dataprofile或者sdk上报的last_value类型的用户属性的最新值。
user_tag_props	object		用户标签，包含该用户对应的所有标签值

请求示例

bc 为创建的 RangersClient, 其初始化请参考使用说明，各语言的 SDK 都提供了类似的接口
调用(Python)：

body={
    "query_id": "test_1",
    "query_type": "user_unique_id"
}
res = bc.data_finder('/openapi/v1/12345/behaviors/profiles', body=body)
print(res.content)

返回示例

返回结果：

{
    "code": 200,
    "message": "success",
    "data": {
        "user_info": {
            "register_time": 1670315402,
            "first_event_time": 1670315402,
            "last_use": "2023-01-28",
            "city": "",
            "ssid": "172020d7-2261-47d8-ae0d-5721d4445f79",
            "user_unique_id": "test_1",
            "id_info": {
                "ssid": "172020d7-2261-47d8-ae0d-5721d4445f79",
                "user_unique_id": "test_1",
                "device_id": ""
            }
        },
        "device_info": {
            "device_model": "",
            "app_version": "",
            "app_channel": "",
            "browser": "",
            "resolution": "",
            "language": "",
            "device_price": "",
            "device_brand": "",
            "os": "",
            "platform_version": ""
        },
        "custom_user_props": {
            "profile_name_a": "a",
        },
        "user_tag_props": {
            "66 (tag_66)": "2022-12-14 00:00:00.000",
            "77 (tag_77)": 7
        }
    }
}