You need to enable JavaScript to run this app.
导航
客户数据平台
  • 文档首页
    • /客户数据平台/开放能力/OpenAPI/在线服务/查询用户标签和属性V2版本 - GetUserProfileWithPrivacyV2
查询用户标签和属性V2版本 - GetUserProfileWithPrivacyV2
最近更新时间：2024.12.06 13:08:26首次发布时间：2024.07.12 14:50:50
我的收藏

请求说明

  • 请求方式：POST
  • 接口名称：GetUserProfileWithPrivacyV2
  • 请求地址：https://console.volcengine.com/cdp/open_platform/openapi

请求参数

参数

类型

是否必选

示例值

描述

Authorization

String

是

HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx

详细介绍请查阅调用方式文档

Query

参数

类型

是否必选

示例值

描述

ApiAction

String

是

GetUserProfileWithPrivacyV2

固定值，对应“请求说明”中的“接口名称”

ApiVersion

String

是

2024-01-25

固定值，版本号： 2024-01-25

Body

参数

类型

是否必选

示例值

描述

project

String

是

项目ID

profile_request

Object

是

具体的参数如下

profile_request 字段信息

参数

类型

是否必选

示例值

描述

备注

id

String

是

用户的id

id_type

Object

是

用户的id 类型，例如baseid, uid

properties

Array[Int]

是

属性id，即属性任务的资源ID，可参考在线服务-任务管理中的资源ID列

properties和tags两个入参，不能同时为空

tags

Array[Int]

是

标签id

ignore_illegal_data

Int

否

1.21版本新增功能
0表示不做任何的过滤
1 表示过滤没有权限的标签和未导入到在线服务的标签

返回参数

参数

类型

示例值

描述

code

Int

0

message

String

成功

properties

Object

{
    "additionalProperties": "String"
 }

属性的结果，key 是属性id, value 是属性的值

{
    "additionalProperties": "String"
 }

tags

Object

标签的结果，key 是标签id, value 是标签的值

{
    "additionalProperties": "String"
 }

propertiesMapping

Object

{
    "additionalProperties": "String"
 }

tagsMapping

Object

{
    "additionalProperties": "String"
 }

illegal_data

Array[str]

请求示例

{
    "project": "1",
    "profile_request": {
        "id": "576465150349934594",
        "id_type": "baseid",
        "tags": [
            3
        ]
    }
}

返回示例

{
    "code": 0,
    "message": "",
    "properties": {

    },
    "tags": {
        "3": "男"
    },
    "propertiesMapping": {

    },
    "tagsMapping": {
        "3": "男"
    },
    "illegalData": [

    ]
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法，检查入参。