参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Authorization | String | 是 | HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx | 详细介绍请查阅调用方式文档 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ApiAction | String | 是 | GetUserProfileWithPrivacyV2 | 固定值,对应“请求说明”中的“接口名称” |
ApiVersion | String | 是 | 2024-01-25 | 固定值,版本号: 2024-01-25 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
project | String | 是 | 1 | 项目ID |
profile_request | OnlineUserProfileRequest | 是 | {} | 请求 |
OnlineUserProfileRequest
参数 | 类型 | 是否必选 | 示例值 | 描述 | 备注 |
---|---|---|---|---|---|
id | String | 是 | 576465150349934594 | 用户的id | |
id_type | Sting | 是 | baseid | 用户的id 类型,例如baseid, uid | |
properties | Array | 是 | [1] | 属性id,即属性任务的资源ID,可参考在线服务-任务管理中的资源ID列 | properties和tags两个入参,不能同时为空 |
tags | Array | 是 | [3] | 标签id | |
ignore_illegal_data | Int | 否 | 0 | 1.21版本新增功能 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int | 0 | 状态码,0表示正常 |
message | String | "" | 接口返回信息 |
properties | Map<String,Object> |
| 属性的结果,key 是属性id, value 是属性的值
|
tags | Map<String,Object> |
| 标签的结果,key 是标签id, value 是标签的值 |
propertiesMapping | Map<String,Object> |
| 属性结果,key是属性id,value是属性值 |
tagsMapping | Map<String,Object> |
| 标签的结果,key 是标签id, value 是标签的值 |
illegal_data | Array | [1001] | 非法数据 |
{ "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 | 参数非法,检查入参。 |